https://github.com/karimsa/frenzie

Collection of chaos hooks for your Node.js programs.
https://github.com/karimsa/frenzie

chaos-engineering hooks javascript library testing

Last synced: about 2 months ago
JSON representation

Collection of chaos hooks for your Node.js programs.

• Host: GitHub
• URL: https://github.com/karimsa/frenzie
• Owner: karimsa
• License: mit
• Created: 2018-03-14T23:25:41.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-01T02:09:57.000Z (almost 7 years ago)
• Last Synced: 2024-10-12T21:59:15.559Z (3 months ago)
• Topics: chaos-engineering, hooks, javascript, library, testing
• Language: JavaScript
• Homepage: https://npmjs.org/frenzie
• Size: 338 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README-tpl.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  



Run chaos stuff in Node.js.




  

    

  

  

    

  

  





  



**Table of Contents:**

 - [Configuration](#configuration)

 - [Supported Modules](#supported-modules)

 - [License](#license)

## Configuration

Put your config into a JSON file called `.frenzierc` file in your project root.

Each [supported module](#supported-modules) must be explicitly enabled. The name of

the module should be used as the key in the configuration object. For example, to enable

`mongodb`, your config file should be:

```json

{

  "mongodb": true

}

```

And to set specific configuration values:

```json

{

  "mongodb": {

    "enabled": true,

    "my-config-key": "some-value"

  }

}

```

For the possible configurations for each module, see the table below:

| Option name | Default | Possible values    | Description                                         |

|-------------|---------|--------------------|-----------------------------------------------------|

| `enabled`   | `false` | `true`, `false`    | Specifies whether to enable chaos for given module. |

| `threshold` | `0.5`   | any number below 1 | The probability of something chaotic occuring.      |

| `maxDelay`  | `100`   | any number         | Maximum amount of time to wait before actually doing something. Only used for asynchronous methods. |

| `maxTicks`  | `1e9`   | any number         | Maximum number to synchronously count up to before actually doing something. Only used for sychronous methods. Warning: this is done using a `for(;;);` - it's going to hang the entire event loop. |

## Supported Modules

{{= it.modules }}

## License

Licensed under [MIT license](LICENSE.md).

Copyright © 2018-present Karim Alibhai.