Simmy 项目使用教程

Simmy 项目使用教程

Simmy Simmy is a chaos-engineering and fault-injection tool, integrating with the Polly resilience project for .NET 项目地址: https://gitcode.com/gh_mirrors/si/Simmy

1. 项目目录结构及介绍

Simmy 项目是一个用于 chaos-engineering 和 fault-injection 的工具，与 Polly resilience 项目集成，适用于 .NET 环境。以下是项目的目录结构及其介绍：

Simmy/
├── appveyor.yml              # CI/CD 配置文件
├── build.bat                # Windows 系统下的构建脚本
├── build.cake               # Cake 构建脚本
├── build.ps1                # PowerShell 构建脚本
├── CODE_OF_CONDUCT.md        # 项目行为准则
├── CONTRIBUTING.md           # 贡献者指南
├── GitVersionConfig.yaml     # GitVersion 配置文件
├── LICENSE.txt              # 项目许可证文件
├── README.md                # 项目说明文件
├── Simmy.png                # 项目图标
├── Simmy_jumbo.png          # 项目大图标
├── Simmy_lg.png             # 项目中图标
├── Simmy_mdm.png            # 项目中等图标
├── Simmy_monkey.png         # 项目猴子图标
├── Simmy_monkey_lg.png      # 项目大猴子图标
├── Simmy_sml.png            # 项目小图标
├── Simmy_xxl.png            # 项目超大图标
├── src/                     # 源代码目录
├── .gitignore               # Git 忽略文件

• appveyor.yml: 用于配置持续集成和持续部署的 CI/CD 配置文件。
• build.bat: Windows 系统下的构建脚本，用于构建项目。
• build.cake: Cake 构建脚本，用于自动化构建过程。
• build.ps1: PowerShell 构建脚本，用于构建项目。
• CODE_OF_CONDUCT.md: 项目行为准则，规定了项目参与者的行为规范。
• CONTRIBUTING.md: 贡献者指南，指导贡献者如何参与项目开发。
• GitVersionConfig.yaml: GitVersion 配置文件，用于版本号自动化。
• LICENSE.txt: 项目许可证文件，指定了项目的授权方式。
• README.md: 项目说明文件，提供了项目的基本信息和使用方法。
• Simmy.png: 项目图标，用于展示项目形象。

2. 项目的启动文件介绍

Simmy 项目中并没有明确的启动文件，因为它是一个库项目，用于在现有的 .NET 项目中引入 chaos-engineering 功能。要在项目中使用 Simmy，您需要通过 NuGet 包管理器将 Simmy 包添加到您的项目中。

在您的 .NET 项目中，通过以下命令安装 Simmy：

Install-Package Polly.Contrib.Simmy

安装完成后，您可以在代码中配置和使用 Simmy 的 chaos-injection 政策。

3. 项目的配置文件介绍

Simmy 的配置主要是通过代码进行，而不是通过配置文件。您可以在代码中定义不同的 chaos-injection 政策，例如异常注入、结果替换、延迟注入和行为注入。

以下是一个配置 Simmy 的示例：

var chaosPolicy = MonkeyPolicy.InjectException(
    with => with
        .Fault<Exception>(ex => new SocketException(10013))
        .InjectionRate(0.05)
        .Enabled()
);

在上面的示例中，我们定义了一个异常注入政策，该政策将以 5% 的概率抛出 SocketException。

要使用 Simmy，您需要将定义好的 chaos 政策应用到您的代码执行过程中，例如：

chaosPolicy.Execute(() => someMethod());

这样，当 someMethod 被调用时，将按照定义的 chaos 政策进行 chaos-injection。

Simmy Simmy is a chaos-engineering and fault-injection tool, integrating with the Polly resilience project for .NET 项目地址: https://gitcode.com/gh_mirrors/si/Simmy