Add Grpc fault injection (#1108)

* Add grpc faults to API
* Add grpc example

Signed-off-by: Pablo Chacin <[email protected]>

Author: pablochacin

.eslintignore

@@ -4,4 +4,5 @@ node_modules/
 docs/sources/get-started/run-cloud-tests-from-the-CLI.md
 docs/sources/get-started/run-your-first-tests.md
 CONTRIBUTING_FILE_FORMAT.md
-src/data/markdown/docs/40 xk6-disruptor/04 Examples/01 Inject HTTP faults into Pod.md
+src/data/markdown/docs/40 xk6-disruptor/04 Examples/01 Inject Grpc faults into Service.md
+src/data/markdown/docs/40 xk6-disruptor/04 Examples/02 Inject HTTP faults into Pod.md

src/data/markdown/docs/40 xk6-disruptor/03 API/01 Faults.md

@@ -7,4 +7,5 @@ A fault is as an abnormal condition that affects a system component and which ma
 
 | Fault type | Description |
 | ---------- | ---------- |
+| [gRPC Fault](/javascript-api/xk6-disruptor/api/faults/grpc) | Fault affecting gRPC requests from a target |
 | [HTTP Fault](/javascript-api/xk6-disruptor/api/faults/http) | Fault affecting HTTP requests from a target |

src/data/markdown/docs/40 xk6-disruptor/03 API/01 Faults/01 Grpc.md

@@ -0,0 +1,36 @@
+---
+title: 'gRPC'
+excerpt: 'xk6-disruptor: gRPC Fault attributes'
+---
+
+A gRPC Fault describes the characteristics of the faults to be injected in the gRPC requests served by a target.
+
+A gRPC fault is described by the following attributes:
+
+| Attribute | Description |
+| --------- | ------------|
+| averageDelay | average delay added to requests in milliseconds (default `0ms`) |
+| delayVariation| variation in the injected delay in milliseconds (default `0ms`) |
+| statusMessage | message to be returned when an error is injected |
+| statusCode | status to be returned when an error is injected |
+| errorRate | rate of requests that will return an error, represented as a float in the range `0.0` to `1.0` (default `0.0`) |
+| exclude | comma-separated list of services to be excluded from disruption |
+| port | port on which the requests will be intercepted |
+
+<Blockquote mod="note">
+
+`averageDelay` and `delayVariation` are applied to all requests affected by the fault, regardless of the value of `errorRate`. `statusCode` is returned only to a fraction of requests defined by `errorRate`.
+
+</Blockquote>
+
+## Example
+
+This example defines a gRPC fault that introduces a delay of `50ms` in all requests and returns a status code `13` in `10%` of the requests.
+
+```javascript
+const fault = {
+  averageDelay: 50,
+  statusCode: 10,
+  errorRate: 0.1,
+};
+```

…6-disruptor/03 API/01 Faults/01 HTTP .md …6-disruptor/03 API/01 Faults/02 HTTP .mdsrc/data/markdown/docs/40 xk6-disruptor/03 API/01 Faults/01 HTTP .md renamed to src/data/markdown/docs/40 xk6-disruptor/03 API/01 Faults/02 HTTP .md src/data/markdown/docs/40 xk6-disruptor/03 API/01 Faults/01 HTTP .md renamed to src/data/markdown/docs/40 xk6-disruptor/03 API/01 Faults/02 HTTP .md

@@ -11,6 +11,7 @@ To construct a `PodDisruptor`, use the [PodDisruptor() constructor](/javascript-
 
 | Method | Description |
 | ------ | ----------- |
+| [PodDisruptor.injectGrpcFaults()](/javascript-api/xk6-disruptor/api/poddisruptor/injectgrpcfaults) |  Inject [gRPC faults](/javascript-api/xk6-disruptor/api/faults/grpc) in the target Pods|
 | [PodDisruptor.injectHTTPFaults()](/javascript-api/xk6-disruptor/api/poddisruptor/injecthttpfaults) |  Inject [HTTTP faults](/javascript-api/xk6-disruptor/api/faults/http) in the target Pods|
 | PodDisruptor.targets() | Returns the list of target Pods of the PodDisruptor |
 

src/data/markdown/docs/40 xk6-disruptor/03 API/02 PodDisruptor.md

@@ -0,0 +1,36 @@
+---
+title: 'injectGrpcFaults()'
+excerpt: 'xk6-disruptor: PodDisruptor.injectGrpcFaults method'
+---
+
+injectGrpcFaults injects gRPC faults in the requests served by a target Pod.
+
+| Parameter | Description |
+| ---------- | ----------- |
+| fault | description of the [gRPC faults](/javascript-api/xk6-disruptor/api/faults/grpc) to be injected |
+| duration | duration of the disruption in seconds |
+| [options](#options) | options that control the injection of the fault |
+
+
+## options
+
+The injection of the fault is controlled by the following options:
+
+| Option | Description |
+| ------ | ----------- |
+| proxyPort | port the agent will use to listen for requests in the target pods ( default `8080`) |
+| iface | network interface where the agent will capture the traffic ( default `eth0`) |
+
+
+## Example
+
+<!-- eslint-skip -->
+
+```javascript
+    const fault = {
+        averageDelay: 50,
+        statusCode: 13,
+        errorRate: 0.1
+    }
+    disruptor.injectGrpcFaults(fault, 30)
+```

src/data/markdown/docs/40 xk6-disruptor/03 API/02 PodDisruptor/02 injectGrpcFaults.md

@@ -12,6 +12,7 @@ To construct a `ServiceDisruptor`, use the [ServiceDisruptor() constructor](/jav
 
 | Method | Description |
 | ------ | ----------- |
+| [ServiceDisruptor.injectGrpcFaults()](/javascript-api/xk6-disruptor/api/servicedisruptor/injectgrpcfaults) | Inject [gRPC faults](/javascript-api/xk6-disruptor/api/faults/Grpc) in the target Pods|
 | [ServiceDisruptor.injectHTTPFaults()](/javascript-api/xk6-disruptor/api/servicedisruptor/injecthttpfaults) | Inject [HTTTP faults](/javascript-api/xk6-disruptor/api/faults/http) in the target Pods|
 
 

…I/02 PodDisruptor/02 injectHTTPFaults.md …I/02 PodDisruptor/03 injectHTTPFaults.mdsrc/data/markdown/docs/40 xk6-disruptor/03 API/02 PodDisruptor/02 injectHTTPFaults.md renamed to src/data/markdown/docs/40 xk6-disruptor/03 API/02 PodDisruptor/03 injectHTTPFaults.md src/data/markdown/docs/40 xk6-disruptor/03 API/02 PodDisruptor/02 injectHTTPFaults.md renamed to src/data/markdown/docs/40 xk6-disruptor/03 API/02 PodDisruptor/03 injectHTTPFaults.md

@@ -0,0 +1,35 @@
+---
+title: 'injectGrpcFaults'
+excerpt: 'xk6-disruptor: ServiceDisruptor.injectGrpcFaults method'
+---
+
+injectGrpcFaults injects gRPC faults in the requests served by a target Service.
+
+| Parameters | Description |
+| ---------- | ----------- |
+| fault | description of the [gRPC faults](/javascript-api/xk6-disruptor/api/faults/grpc) to be injected |
+| duration | duration of the disruption in seconds |
+| [options](#options) | options that control the injection of the fault |
+
+## Options
+
+The injection of the fault is controlled by the following options:
+
+| Option | Description |
+| ------ | ----------- |
+| proxyPort | port the agent will use to listen for requests in the target pods ( default `8080`) |
+| iface | network interface where the agent will capture the traffic ( default `eth0`) |
+
+
+## Example
+
+<!-- eslint-skip -->
+
+```javascript
+    const fault = {
+        averageDelay: 50,
+        statusCode: 13,
+        errorRate: 0.1
+    }
+    disruptor.injectGrpcFaults(fault, 30)
+```