SAAS-5972 print errors in eslint style for pipeline validation (#412)

* SAAS-5972 As a user I want to see errors and warnings in eslint style when I validate pipeline from cli

* SAAS-5972 As a user I want to see errors and warnings in eslint style when I validate pipeline from cli

* SAAS-5972 As a user I want to see errors and warnings in eslint style when I validate pipeline from cli

* SAAS-5972 As a user I want to see errors and warnings in eslint style when I validate pipeline from cli

Author: vadim-kharin-codefresh

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

@@ -4,14 +4,24 @@ const Style = require('../../../../output/Style');
 const path = require('path');
 const { validatePipelineYaml } = require('../../helpers/validation');
 const { pathExists, watchFile } = require('../../helpers/general');
+const { PipelineValidationError } = require('../../../../logic/cli-config/errors');
 
 const VALID_MESSAGE = Style.green('Yaml is valid!');
 
 function _getResultMessage(result = {}) {
-    if (result.warning) {
-        return result.valid
-            ? `${Style.yellow(result.warning)}`
-            : `${Style.red(result.message)}\n${Style.yellow(result.warning)}\n`;
+    if (result.summarize) {
+        if (result.valid && !result.warning) {
+            return VALID_MESSAGE;
+        }
+        let message = '';
+        if (result.warning) {
+            message += `${result.warning}\n`;
+        }
+        if (result.message) {
+            message += `${result.message}\n`;
+        }
+        message += `${result.summarize}\n${result.documentationLinks}`;
+        return message;
     }
     return result.valid
         ? VALID_MESSAGE
@@ -26,7 +36,7 @@ function _handleResult(result = {}, attach) {
     if (result.valid || attach) {
         return printResult(result);
     }
-    throw Error(_getResultMessage(result));
+    throw new PipelineValidationError(_getResultMessage(result));
 }
 
 const validateCmd = new Command({

lib/interface/cli/helpers/validation.js

@@ -37,31 +37,41 @@ async function validatePipelineSpec(data) {
         yamlObj.stages = stages;
     }
     const validatedYaml = yaml.safeDump(yamlObj);
-    const result = await sdk.pipelines.validateYaml({ yaml: validatedYaml });
+    const result = await sdk.pipelines.validateYaml({ yaml: validatedYaml, outputFormat: 'lint' });
     let message;
-    let warning;
+    if (result.summarize) {
+        return {
+            valid: !!result.valid,
+            message: result.message,
+            warning: result.warningMessage,
+            summarize: result.summarize,
+            documentationLinks: result.documentationLinks,
+        };
+    }
     if (!result.valid) {
         message = _buildFinalMessage('Provided spec is not valid', result.details);
     }
-    if (!_.isEmpty(result.warningDetails)) {
-        warning = _buildFinalMessage('Yaml has warnings', result.warningDetails);
-    }
-    return { valid: !!result.valid, message, warning };
+    return { valid: !!result.valid, message };
 }
 
 async function validatePipelineYaml(filename, fileContent) {
     const yamlContent = fileContent || await readFile(filename, 'UTF-8');
     const name = _getPipelineName(filename);
-    const result = await sdk.pipelines.validateYaml({ yaml: yamlContent, name });
+    const result = await sdk.pipelines.validateYaml({ yaml: yamlContent, name, outputFormat: 'lint' });
     let message;
-    let warning;
+    if (result.summarize) {
+        return {
+            valid: !!result.valid,
+            message: result.message,
+            warning: result.warningMessage,
+            summarize: result.summarize,
+            documentationLinks: result.documentationLinks,
+        };
+    }
     if (!result.valid) {
         message = _buildFinalMessage('Yaml not valid', result.details);
     }
-    if (!_.isEmpty(result.warningDetails)) {
-        warning = _buildFinalMessage('Yaml has warnings', result.warningDetails);
-    }
-    return { valid: !!result.valid, message, warning };
+    return { valid: !!result.valid, message };
 }
 
 async function checkOrProjectExists(projectName) {

lib/logic/cli-config/errors/PipelineValidationError.js

@@ -0,0 +1,12 @@
+class PipelineValidationError extends Error {
+    constructor(message) {
+        super();
+        this.message = message;
+    }
+
+    toString() {
+        return this.message;
+    }
+}
+
+module.exports = PipelineValidationError;

lib/logic/cli-config/errors/index.js

@@ -2,10 +2,12 @@ const NoPropertyError = require('./NoPropertyError');
 const MultiplePropertiesError = require('./MultiplePropertiesError');
 const NotFullPropertyError = require('./NotFullPropertyError');
 const SchemaValidationError = require('./SchemaValidationError');
+const PipelineValidationError = require('./PipelineValidationError');
 
 module.exports = {
     NoPropertyError,
     MultiplePropertiesError,
     NotFullPropertyError,
     SchemaValidationError,
+    PipelineValidationError,
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codefresh",
-  "version": "0.43.5",
+  "version": "0.43.6",
 
   "description": "Codefresh command line utility",
   "main": "index.js",