spec validation for pipeline (#245)

* spec validation for pipeline

* version updated

Author: yaroslav-codefresh

lib/interface/cli/commands/root/create.cmd.js

@@ -3,6 +3,7 @@ const Command = require('../../Command');
 const { crudFilenameOption } = require('../../helpers/general');
 const { context, pipeline } = require('../../../../logic').api;
 const yargs = require('yargs');
+const { validatePipelineFile } = require('../../helpers/validation');
 
 const get = new Command({
     root: true,
@@ -22,6 +23,7 @@ const get = new Command({
     handler: async (argv) => {
         if (!argv.filename) {
             yargs.showHelp();
+            return;
         }
 
         const data = argv.filename;
@@ -38,13 +40,18 @@ const get = new Command({
                 console.log(`Context: ${name} created`);
                 break;
             case 'pipeline':
+                try {
+                    await validatePipelineFile(data);
+                } catch (e) {
+                    console.warn(e.message);
+                    return;
+                }
                 await pipeline.createPipeline(data);
                 console.log(`Pipeline '${name}' created`);
                 break;
             default:
                 throw new CFError(`Entity: ${entity} not supported`);
         }
-
     },
 });
 

lib/interface/cli/commands/root/replace.cmd.js

@@ -3,6 +3,7 @@ const Command = require('../../Command');
 const { crudFilenameOption } = require('../../helpers/general');
 const { context, pipeline } = require('../../../../logic').api;
 const yargs = require('yargs');
+const { validatePipelineFile } = require('../../helpers/validation');
 
 const annotate = new Command({
     root: true,
@@ -38,6 +39,12 @@ const annotate = new Command({
                 console.log(`Context: ${name} created`);
                 break;
             case 'pipeline':
+                try {
+                    await validatePipelineFile(data);
+                } catch (e) {
+                    console.warn(e.message);
+                    return;
+                }
                 await pipeline.replaceByName(name, data);
                 console.log(`Pipeline '${name}' updated`);
                 break;

lib/interface/cli/helpers/validation.js

@@ -0,0 +1,23 @@
+const _ = require('lodash');
+const yaml = require('js-yaml');
+const { pipeline } = require('../../../logic').api;
+
+
+async function validatePipelineFile(data) {
+    const validatedYaml = yaml.safeDump(Object.assign({ version: data.version }, data.spec));
+    const validationResult = await pipeline.validateYaml(validatedYaml);
+    if (!validationResult.valid) {
+        let finalMessage;
+        if (_.isArray(validationResult.details)) {
+            const errors = validationResult.details.map(({ message }) => `  - ${message}`).join('\n');
+            finalMessage = `Provided spec is not valid:\n${errors}`;
+        } else {
+            finalMessage = 'Provided spec is not valid!';
+        }
+        throw new Error(finalMessage);
+    }
+}
+
+module.exports = {
+    validatePipelineFile,
+};

lib/logic/api/pipeline.js

@@ -66,6 +66,15 @@ const createPipeline = async (data) => {
     return sendHttpRequest(options);
 };
 
+const validateYaml = async (yaml) => {
+    const optionsValidate = {
+        url: '/api/pipelines/yaml/validator',
+        method: 'POST',
+        body: { yaml },
+    };
+    return sendHttpRequest(optionsValidate);
+};
+
 const replaceByName = async (name, data) => {
     const body = data;
 
@@ -164,6 +173,7 @@ module.exports = {
     getAll,
     getPipelineByName,
     createPipeline,
+    validateYaml,
     replaceByName,
     patchPipelineByName,
     deletePipelineByName,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codefresh",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Codefresh command line utility",
   "main": "index.js",
   "preferGlobal": true,