SAAS 1100 - Support ability to pass a one time codefresh.yaml for pipeline execution (#252)

Author: itai-codefresh

lib/interface/cli/commands/pipeline/run.cmd.js

@@ -3,10 +3,11 @@ const Command = require('../../Command');
 const _ = require('lodash');
 const CFError = require('cf-errors');
 const { prepareKeyValueFromCLIEnvOption, crudFilenameOption } = require('../../helpers/general');
-const ObjectID = require('mongodb').ObjectID;
 const { workflow, pipeline, log } = require('../../../../logic').api;
 const authManager = require('../../../../logic').auth.manager;
 const Docker = require('dockerode');
+const { validatePipelineYaml } = require('../../helpers/validation');
+const { printResult } = require('../root/validate.cmd');
 
 const regex = /##[0-9a-f]{24}##/i;
 const imageName = 'codefresh/engine:master';
@@ -81,6 +82,13 @@ const run = new Command({
             describe: 'Set build variables from a file',
         });
 
+        crudFilenameOption(yargs, {
+            name: 'yaml',
+            alias: 'y',
+            raw: true,
+            describe: 'Override codefresh.yaml for this execution',
+        });
+
         return yargs;
     },
     handler: async (argv) => {
@@ -92,6 +100,7 @@ const run = new Command({
         const resetVolume = argv['reset-volume'];
         const variablesFromFile = argv['var-file'];
         const contexts = argv['context'];
+        const userYamlDescriptor = argv['yaml'];
         const local = argv.local;
 
         try {
@@ -101,6 +110,12 @@ const run = new Command({
                 message: `Passed pipeline id: ${pipelineName} does not exist`,
             });
         }
+
+        if (userYamlDescriptor) {
+            const result = await validatePipelineYaml(undefined, userYamlDescriptor);
+            printResult(result);
+        }
+
         if (local) {
             const docker = new Docker();
             docker.pull(imageName, (err, stream) => {
@@ -110,9 +125,17 @@ const run = new Command({
                         console.log('\nDone pulling.');
                         const currentContext = authManager.getCurrentContext();
                         docker.run(imageName, [], [], {
-                            Env: [`ACCESS_TOKEN=${currentContext.token}`, `PIPELINE_ID=${pipelineName}`, `BRANCH=${branch}`, `CF_HOST=${currentContext.url}`, 'DOCKER_SOCKET_PATH=/var/run/docker.sock'],
+                            Env: [
+                                `ACCESS_TOKEN=${currentContext.token}`,
+                                `PIPELINE_ID=${pipelineName}`, `BRANCH=${branch}`,
+                                `CF_HOST=${currentContext.url}`,
+                                'DOCKER_SOCKET_PATH=/var/run/docker.sock',
+                                userYamlDescriptor && `OVERRIDE_WORKFLOW_YAML=${userYamlDescriptor}`,
+                            ],
                             Hostconfig: {
-                                Binds: ['/var/run/docker.sock:/var/run/docker.sock'],
+                                Binds: [
+                                    '/var/run/docker.sock:/var/run/docker.sock',
+                                ],
                             },
                         }, (err, data) => {
                             if (err) {
@@ -149,6 +172,7 @@ const run = new Command({
                     branch,
                     sha,
                     enableNotifications,
+                    userYamlDescriptor,
                 },
             };
 

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

@@ -7,7 +7,7 @@ const { pathExists, watchFile } = require('../../helpers/general');
 
 const VALID_MESSAGE = Style.green('Yaml is valid!');
 
-function _printResult(result) {
+function printResult(result) {
     console.log(result.valid ? VALID_MESSAGE : Style.red(result.message), '\n');
 }
 
@@ -68,7 +68,7 @@ const validateCmd = new Command({
 
             filenames.forEach(f => validatePipelineYaml(f).then((result) => {
                 console.log(`Validation result for ${f}:`);
-                _printResult(result);
+                printResult(result);
             }));
             return;
         }
@@ -79,14 +79,15 @@ const validateCmd = new Command({
             watchFile(filename, async () => {
                 console.log('File changed');
                 const result = await validatePipelineYaml(filename);
-                _printResult(result);
+                printResult(result);
             });
         }
 
         // even with --attach option validates file for first time
         const result = await validatePipelineYaml(filename);
-        _printResult(result);
+        printResult(result);
     },
 });
 
 module.exports = validateCmd;
+validateCmd.printResult = printResult;

lib/interface/cli/helpers/general.js

@@ -108,10 +108,11 @@ const crudFilenameOption = (yargs, options = {}) => {
         .option(options.name || 'filename', filenameOption)
         .coerce(options.name || 'filename', (arg) => {
             try {
+                const rawFile = fs.readFileSync(path.resolve(process.cwd(), arg), 'utf8');
                 if (arg.endsWith('.json')) {
-                    return JSON.parse(fs.readFileSync(path.resolve(process.cwd(), arg), 'utf8'));
+                    return options.raw ? rawFile : JSON.parse();
                 } else if (arg.endsWith('.yml') || arg.endsWith('yaml')) {
-                    return yaml.safeLoad(fs.readFileSync(path.resolve(process.cwd(), arg), 'utf8'));
+                    return options.raw ? rawFile : yaml.safeLoad();
                 } else {
                     throw new CFError('File extension is not recognized');
                 }

lib/interface/cli/helpers/validation.js

@@ -24,8 +24,8 @@ async function validatePipelineSpec(data) {
     return { valid: !!result.valid, message };
 }
 
-async function validatePipelineYaml(filename) {
-    const yamlContent = await readFile(filename, 'UTF-8');
+async function validatePipelineYaml(filename, fileContent) {
+    const yamlContent = fileContent || await readFile(filename, 'UTF-8');
     const result = await pipeline.validateYaml(yamlContent);
     let message;
     if (!result.valid) {

lib/logic/api/pipeline.js

@@ -142,6 +142,10 @@ const runPipelineByName = async (name, data) => {
         body.sha = data.sha;
     }
 
+    if (data.userYamlDescriptor) {
+        body.userYamlDescriptor = data.userYamlDescriptor;
+    }
+
     if (data.contexts) {
         let contexts = [];
         if (_.isString(data.contexts)) {

package.json

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