Merge pull request #2 from gunnargrosch/develop

Develop

Author: gunnargrosch

README.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-`failure-cloudfunctions` is a small Node module for injecting failure into Google Cloud Functions (https://cloud.google.com/functions/). It offers a simple failure injection wrapper for your Cloud Functions handler where you then can choose to inject failure by setting the `failureMode` to `latency`, `exception`, `blacklist`, `diskspace` or `statuscode`. You control your failure injection using a secret in Secret Manager.
+`failure-cloudfunctions` is a small Node module for injecting failure into Google Cloud Functions (https://cloud.google.com/functions/). It offers a simple failure injection wrapper for your Cloud Functions handler where you then can choose to inject failure by setting the `failureMode` to `latency`, `exception`, `denylist`, `diskspace` or `statuscode`. You control your failure injection using a secret in Secret Manager.
 
 ## How to install
 
@@ -22,11 +22,11 @@ exports.handler = failureCloudFunctions(async (req, res) => {
 ```
 4. Create a secret in Secret Manager.
 ```json
-{"isEnabled": false, "failureMode": "latency", "rate": 1, "minLatency": 100, "maxLatency": 400, "exceptionMsg": "Exception message!", "statusCode": 404, "diskSpace": 100, "blacklist": ["storage.googleapis.com"]}
+{"isEnabled": false, "failureMode": "latency", "rate": 1, "minLatency": 100, "maxLatency": 400, "exceptionMsg": "Exception message!", "statusCode": 404, "diskSpace": 100, "denylist": ["storage.googleapis.com"]}
 ```
 ```bash
 gcloud beta secrets create <your-secret-name> --replication-policy="automatic"
-echo -n "{\"isEnabled\": false, \"failureMode\": \"latency\", \"rate\": 1, \"minLatency\": 100, \"maxLatency\": 400, \"exceptionMsg\": \"Exception message!\", \"statusCode\": 404, \"diskSpace\": 100, \"blacklist\": [\"storage.googleapis.com\"]}" | gcloud beta secrets versions add <your-secret-name> --data-file=-
+echo -n "{\"isEnabled\": false, \"failureMode\": \"latency\", \"rate\": 1, \"minLatency\": 100, \"maxLatency\": 400, \"exceptionMsg\": \"Exception message!\", \"statusCode\": 404, \"diskSpace\": 100, \"denylist\": [\"storage.googleapis.com\"]}" | gcloud beta secrets versions add <your-secret-name> --data-file=-
 ```
 5. Add environment variables to your Cloud Function with values from above.
 ```bash
@@ -45,13 +45,13 @@ Edit the values of your parameter in Secret Manager to use the failure injection
 
 * `isEnabled: true` means that failure is injected into your Cloud Function.
 * `isEnabled: false` means that the failure injection module is disabled and no failure is injected.
-* `failureMode` selects which failure you want to inject. The options are `latency`, `exception`, `blacklist`, `diskspace` or `statuscode` as explained below.
+* `failureMode` selects which failure you want to inject. The options are `latency`, `exception`, `denylist`, `diskspace` or `statuscode` as explained below.
 * `rate` controls the rate of failure. 1 means that failure is injected on all invocations and 0.5 that failure is injected on about half of all invocations.
 * `minLatency` and `maxLatency` is the span of latency in milliseconds injected into your function when `failureMode` is set to `latency`.
 * `exceptionMsg` is the message thrown with the exception created when `failureMode` is set to `exception`.
 * `statusCode` is the status code returned by your function when `failureMode` is set to `statuscode`.
 * `diskSpace` is size in MB of the file created in tmp when `failureMode` is set to `diskspace`.
-* `blacklist` is an array of regular expressions, if a connection is made to a host matching one of the regular expressions it will be blocked.
+* `denylist` is an array of regular expressions, if a connection is made to a host matching one of the regular expressions it will be blocked.
 
 ## Example
 
@@ -63,6 +63,12 @@ Inspired by Yan Cui's articles on latency injection for Google Cloud Functions (
 
 ## Changelog
 
+### 2020-08-24 v0.3.0
+
+* Changed mitm mode from connect to connection for quicker enable/disable of failure injection.
+* Renamed block list failure injection to denylist (breaking change for that failure mode).
+* Updated dependencies.
+
 ### 2020-03-01 v0.2.1
 
 * Added permission info to documentation.

example/package.json

@@ -1,5 +1,5 @@
 {
     "dependencies": {
-        "failure-cloudfunctions": "^0.2.1"
+        "failure-cloudfunctions": ""
     }
 }

lib/failure.js

@@ -40,14 +40,14 @@ var injectFailure = function (fn) {
         } else if (config.failureMode === 'diskspace') {
           console.log('Injecting disk space: ' + config.diskSpace + ' MB')
           childProcess.spawnSync('dd', ['if=/dev/zero', 'of=/tmp/diskspace-failure-' + Date.now() + '.tmp', 'count=1000', 'bs=' + config.diskSpace * 1000])
-        } else if (config.failureMode === 'blacklist') {
-          console.log('Injecting dependency failure through a network blackhole for blacklisted sites: ' + config.blacklist)
+        } else if (config.failureMode === 'denylist') {
+          console.log('Injecting dependency failure through a network block for denylisted sites: ' + config.denylist)
           let mitm = Mitm()
           let blRegexs = []
-          config.blacklist.forEach(function (regexStr) {
+          config.denylist.forEach(function (regexStr) {
             blRegexs.push(new RegExp(regexStr))
           })
-          mitm.on('connect', function (socket, opts) {
+          mitm.on('connection', function (socket, opts) {
             let block = false
             blRegexs.forEach(function (blRegex) {
               if (blRegex.test(opts.host)) {