feat: add chaos mesh api description and table schema

docs/openapi3.yaml

@@ -64,6 +64,9 @@ tags:
   - name: Webhooks
     description: |
       This resource allows you to configure webhooks.
+  - name: Chaos Experiments
+    description: |
+      This resource allows you to add chaos mesh experiments as part of the running job
 x-tagGroups:
   - name: Reference
     tags:
@@ -1890,6 +1893,185 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/upload_file_response'
+  /v1/chaos-experiments:
+    parameters:
+      - $ref: '#/components/parameters/context_id'
+    post:
+      operationId: create-chaos-experiment
+      tags:
+        - Chaos Experiments
+      summary: Create chaos file
+      description: >-
+        Create a chaos experiment.
+      responses:
+        '201':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/chaosExperiment'
+        '400':
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '422':
+          description: Unprocessable entity
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/chaosExperiment'
+        description: The chaos experiment to create
+        required: true
+    get:
+      operationId: retrieve-all-choos-experiments
+      tags:
+        - Chaos Experiments
+      summary: Retrieve all chaos experiments
+      description: Retrieve all chaos experiments
+      parameters:
+        - in: query
+          name: from
+          description: From which result to start retrieve data - pagination
+          required: false
+          schema:
+            type: integer
+            minimum: 0
+            default: 0
+        - in: query
+          name: limit
+          description: Max results to return from this query ( Limit to 100 )
+          required: false
+          schema:
+            type: integer
+            maximum: 200
+            default: 100
+        - in: query
+          name: template
+          description: filter to get templates only
+          required: false
+          schema:
+            type: boolean
+            example: true
+        - in: query
+          name: exclude
+          description: fields to exclude from response
+          required: false
+          schema:
+            type: array
+            items:
+              type: string
+              enum:
+                - kubeObject
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/chaosExperiment'
+        '400':
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+  /v1/chaos-experiments/{experiment_id}:
+    parameters:
+      - $ref: '#/components/parameters/context_id'
+    get:
+      operationId: retrieve-chaos-experiment
+      tags:
+        - Chaos Experiments
+      summary: Retrieve chaos experiment
+      description: Retrieve a specific chaos experiment.
+      parameters:
+        - in: path
+          name: experiment_id
+          description: The id of the experiment to retrieve.
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/chaosExperiment'
+        '400':
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '404':
+          description: Not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+    delete:
+      operationId: delete-chaos-experiment
+      tags:
+        - Chaos Experiments
+      summary: Delete chaos experiment
+      description: Delete a specific chaos experiment
+      parameters:
+        - in: path
+          name: experiment_id
+          description: The id of the experiment to retrieve.
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: Success
+        '400':
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '409':
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+
 components:
   parameters:
     context_id:
@@ -2956,3 +3138,83 @@ components:
         url:
           type: string
           description: Webhook url to post events
+    chaosExperiment:
+      required:
+        - name
+        - kubeObject
+      properties:
+        id:
+          description: Unique experiment identifier
+          type: string
+          format: uuid
+          readOnly: true
+        name:
+          type: string
+          minLength: 1
+          description: The name of the experiment.
+          example: Custom javascript for logging
+        kubeObject:
+          $ref: '#/components/schemas/kubeObject'
+        updated_at:
+          type: string
+          format: date-time
+          description: The date and time that the procesor file was updated.
+          readOnly: true
+        created_at:
+          type: string
+          format: date-time
+          description: The date and time that the procesor file was created.
+          readOnly: true
+    kubeObject:
+      required:
+        - apiVersion
+        - kind
+        - metadata
+        - spec
+      properties:
+        apiVersion:
+          type: string
+          enum:
+            - "chaos-mesh.org/v1alpha1"
+        kind:
+          type: string
+          enum:
+            - 'dnschaos'
+            - 'PodChaos'
+            - 'AWSChaos'
+            - 'HTTPChaos'
+            - 'StressChaos'
+          description: A description of the experiment.
+          example: 'PodChaos'
+        metadata:
+          required:
+            - name
+            - namespace
+          properties:
+            namespace:
+              type: string
+              example: 'apps'
+            name:
+              type: string
+              example: "my-pod-chaos"
+            annotations:
+              type: object
+              additionalProperties:
+                type: string
+        namespace:
+          type: string
+          example: "apps"
+        name:
+          type: string
+          example: "my-pod-chaos"
+        spec:
+          type: object
+          example:
+            selector:
+              namespaces:
+                - apps
+              labelSelectors:
+                app: live-balances-api
+            mode: all
+            action: pod-kill
+            duration: 1m

src/app.js

@@ -18,6 +18,7 @@ const testsRouter = require('./tests/routes/testsRoute.js');
 const processorsRouter = require('./processors/routes/processorsRoute.js');
 const filesRouter = require('./files/routes/filesRoute.js');
 const webhooksRouter = require('./webhooks/routes/webhooksRouter');
+const chaosExperimentsRouter = require('./chaos-experiments/routes/chaosExperimentsRoute');
 const swaggerValidator = require('express-ajv-swagger-validation');
 const database = require('./database/database');
 const jobsManager = require('./jobs/models/jobManager');
@@ -72,7 +73,7 @@ module.exports = async () => {
     app.use(httpContext.middleware);
     app.use(contexts.middleware);
 
-    app.set('json replacer', (k, v) => (v === null ? undefined : v))
+    app.set('json replacer', (k, v) => (v === null ? undefined : v));
 
     app.use('/health', healthRouter);
     app.use('/v1/config', configRouter);
@@ -83,6 +84,7 @@ module.exports = async () => {
     app.use('/v1/processors', processorsRouter);
     app.use('/v1/files', filesRouter);
     app.use('/v1/webhooks', webhooksRouter);
+    app.use('/v1/chaos-experiments', chaosExperimentsRouter);
 
     app.use('/', function (req, res, next) {
         res.redirect('/ui');

src/chaos-experiments/controllers/chaosExperimentController.js

@@ -0,0 +1,46 @@
+'use strict';
+const processorManager = require('../models/chaosExperimentsManager');
+
+module.exports.createChaosExperiment = function (req, res, next) {
+    return processorManager.createChaosExperiment(req.body)
+        .then(function (result) {
+            return res.status(201).json(result);
+        })
+        .catch(function (err) {
+            return next(err);
+        });
+};
+
+module.exports.getAllChaosExperiments = async function (req, res, next) {
+    let { query: { from = 0, limit = 100 } } = req;
+    let processors;
+    try {
+        from = parseInt(from);
+        limit = parseInt(limit);
+        processors = await processorManager.getAllChaosExperiments(from, limit, req.query.exclude);
+        return res.status(200).json(processors);
+    } catch (err) {
+        return next(err);
+    }
+};
+
+module.exports.getChaosExperimentById = async function (req, res, next) {
+    let chaosExperiment;
+    const { params: { experiment_id: experimentId } } = req;
+    try {
+        chaosExperiment = await processorManager.getChaosExperimentById(experimentId);
+        return res.status(200).json(chaosExperiment);
+    } catch (err) {
+        return next(err);
+    }
+};
+
+module.exports.deleteChaosExperiment = async function (req, res, next) {
+    const { params: { experiment_id: experimentId } } = req;
+    try {
+        await processorManager.deleteChaosExperiment(experimentId);
+        return res.status(204).json();
+    } catch (err) {
+        return next(err);
+    }
+};