codefresh 0.82.9 → 0.83.2

package/codefresh-release.yml

@@ -445,14 +445,13 @@ steps:
   update_documentation:
     stage: documentation
     title: "Update documentation http://cli.codefresh.io"
-    image: docker:18.01
+    image: codefresh/build-cli
     commands:
-      - "apk update && apk add git nodejs"
-      - "npm install"
+      - "yarn"
       - "echo cleaning previous public dir and recreating worktree"
-      - "rm -rf public && git worktree prune &&   git worktree add -B gh-pages public origin/gh-pages"
+      - "rm -rf public && git worktree prune && git worktree add -B gh-pages public origin/gh-pages"
       - "echo Building public docs"
-      - "npm run build-public-docs"
+      - "yarn run build-public-docs"
       - "echo Push new docs to gh-pages detached branch"
       - 'git config --global user.email "auto-ci@codefresh.io" && git config --global user.name "Automated CI"'
       - 'cd public && git add --all && git commit -m "Publish new documentation for version ${{PACKAGE_VERSION}}" && git push https://${{GITHUB_TOKEN}}@github.com/codefresh-io/cli.git'

package/codefresh.yml

@@ -328,7 +328,7 @@ steps:
     type: codefresh-run
     arguments:
       PIPELINE_ID: 'codefresh-io/cli/release'
-      DETACH: true
+      TRIGGER_ID: codefresh-io/cli_1
       BRANCH: master
       VARIABLE:
         - PACKAGE_VERSION=${{PACKAGE_VERSION}}
@@ -342,3 +342,18 @@ steps:
         - name: create_manifest_list
           on:
             - success
+
+  build_documentation:
+    stage: test
+    title: "build documentation http://cli.codefresh.io"
+    image: codefresh/build-cli
+    commands:
+      - "echo Building public docs"
+      - "npm run build-public-docs"
+    environment:
+      - HUGO_VERSION=0.32.0
+    when:
+      steps:
+        - name: install_dependencies
+          on:
+            - success

package/docs/content/pipelines/Run Pipeline.md

@@ -15,22 +15,44 @@ The pipeline will be triggered multiple times according to the array length.
 
 #### Variable yaml file with 2 sets of variables
 ```yaml
-- key: value
-  key2: key1
-- key: value
-  key2: key2
+- VARIABLE_A: value_a_for_the_first_build
+  VARIABLE_B: value_b_for_the_first_build
+- VARIABLE_A: value_a_for_the_first_build
+  VARIABLE_B: value_b_for_the_first_build
 ```
 
 #### Variable json file with 2 sets of variables
 ```json
 [
   {
-    "key": "value",
-    "key2": "key1"
+    "VARIABLE_A": "value_a_for_the_first_build",
+    "VARIABLE_B": "value_b_for_the_first_build"
   },
   {
-    "key": "value",
-    "key2": "key2"
+    "VARIABLE_A": "value_a_for_the_first_build",
+    "VARIABLE_B": "value_b_for_the_first_build"
+  }
+]
+```
+### Use encrypted variables in Codefresh build runs; supported from CLI version: 0.83.1
+#### Variable yaml file with single variable set with encrypted variables
+```yaml
+- key:
+    val: value
+    encrypted: true
+  key2: val2
+
+```
+
+#### Variable json file single variable set with encrypted variables
+```json
+[
+  {
+    "key": {
+      "val": "value",
+      "encrypted": true
+    },
+    "key2": "key1"
   }
 ]
 ```

package/lib/interface/cli/commands/annotation/create.cmd.js

@@ -31,7 +31,7 @@ const command = new Command({
         .example('codefresh create annotation image 2dfacdaad466 coverage=75%', 'Annotate entity with a single label')
         .example('codefresh create annotation image 2dfacdaad466 coverage=75% tests_passed=true', 'Annotate entity with multiple labels')
         // eslint-disable-next-line max-len
-        .example('codefresh create annotation image 2dfacdaad466 coverage=75% tests_passed=true --display coverage', 'Annotate entity with multiple labels and display selection'),
+        .example('codefresh create annotation workflow 643d807b85bbe35931ae2282 ENV=prod tests_passed=true --display ENV', 'Annotate entity with multiple labels and display selection'),
     handler: async (argv) => {
         const { entityType, entityId, labels, display } = argv;
 

package/lib/interface/cli/commands/pipeline/pipeline.sdk.spec.js

@@ -1,3 +1,7 @@
+const yaml = require('js-yaml');
+const request = require('requestretry');
+const fs = require('fs');
+const _ = require('lodash');
 const DEFAULTS = require('../../defaults');
 const getCmd = require('./get.cmd').toCommand();
 const deleteCmd = require('./delete.cmd').toCommand();
@@ -10,18 +14,21 @@ jest.mock('../../helpers/validation'); // eslint-disable-line
 jest.mock('../../../../../check-version');
 jest.mock('../../completion/helpers', () => { // eslint-disable-line
     return {
-        authContextWrapper: func => func,
+        authContextWrapper: (func) => func,
     };
 });
 
+jest.mock('../../helpers/general', () => ({
+    ...jest.requireActual('../../helpers/general'),
+    isCompatibleApiVersion: () => true,
+}));
+
 jest.mock('../../../../logic/entities/Pipeline', () => { // eslint-disable-line
     return {
-        fromResponse: res => res,
+        fromResponse: (res) => res,
     };
 });
 
-const request = require('requestretry');
-
 const DEFAULT_RESPONSE = request.__defaultResponse();
 
 describe('pipeline', () => {
@@ -57,11 +64,11 @@ describe('pipeline', () => {
             });
 
             it('should return default limit', async () => {
-                expect(_getLimit(undefined,false)).toEqual(DEFAULTS.GET_LIMIT_RESULTS);
+                expect(_getLimit(undefined, false)).toEqual(DEFAULTS.GET_LIMIT_RESULTS);
             });
 
             it('should return `unlimited` value', async () => {
-                expect(_getLimit(undefined,true)).toEqual(DEFAULTS.GET_ALL_PIPELINES_LIMIT);
+                expect(_getLimit(undefined, true)).toEqual(DEFAULTS.GET_ALL_PIPELINES_LIMIT);
             });
         });
 
@@ -84,6 +91,69 @@ describe('pipeline', () => {
                     });
                 });
 
+                describe('run', () => {
+                    it('should handle running pipeline with encrypted variables', async () => {
+                        const argv = { name: 'some name',
+                            detach: true,
+                            annotation: [],
+                            variable: [
+                                'secret=secret',
+                                'VAR1=VAL1',
+                            ],
+                            encrypted: ['secret'],
+                        };
+                        const pip = new CfPipeline(argv);
+                        await pip.run();
+                        expect(pip.executionRequests[0].options.variables).toEqual([
+                            {
+                                key: 'secret',
+                                value: 'secret',
+                                encrypted: true,
+                            },
+                            {
+                                key: 'VAR1',
+                                value: 'VAL1',
+                            },
+                        ]);
+                        await verifyResponsesReturned([DEFAULT_RESPONSE]); // eslint-disable-line
+                    });
+
+                    it('should handle running pipeline with encrypted variables passing inside json file', async () => {
+                        const rawFile = fs.readFileSync('lib/interface/cli/commands/pipeline/var.json', 'utf8');
+
+                        const argv = { name: 'some name',
+                            detach: true,
+                            annotation: [],
+                            'var-file': JSON.parse(rawFile),
+                        };
+                        const pip = new CfPipeline(argv);
+                        await pip.run();
+                        expect(pip.executionRequests[0].options.variables).toEqual(
+                            [{ key: 'help6', value: '85858' },
+                                { key: 'should_be_encrepted', value: '0000' },
+                                { encrypted: true, key: 'help7', value: 'test' }],
+                        );
+                        await verifyResponsesReturned([DEFAULT_RESPONSE]); // eslint-disable-line
+                    });
+
+                    it('should handle running pipeline with encrypted variables passing inside yaml file', async () => {
+                        const rawFile = fs.readFileSync('lib/interface/cli/commands/pipeline/var.yml', 'utf8');
+
+                        const argv = { name: 'some name',
+                            detach: true,
+                            annotation: [],
+                            'var-file': yaml.safeLoad(rawFile),
+                        };
+                        const pip = new CfPipeline(argv);
+                        await pip.run();
+                        expect(pip.executionRequests[0].options.variables).toEqual(
+                            [{ key: 'VAR1', value: 'VAL1' },
+                                { encrypted: true, key: 'VAR2', value: 'VAL2' }],
+                        );
+                        await verifyResponsesReturned([DEFAULT_RESPONSE]); // eslint-disable-line
+                    });
+                });
+
                 describe('runImpl', () => {
                     it('should handle running pipeline', async () => {
                         const argv = { name: 'some name', detach: true };

package/lib/interface/cli/commands/pipeline/run.base.js

@@ -1,10 +1,16 @@
 const _ = require('lodash');
 const Promise = require('bluebird');
-const { prepareKeyValueFromCLIEnvOption } = require('../../helpers/general');
+const CFError = require('cf-errors');
+const { prepareKeyValueFromCLIEnvOption,
+    markEncryptedFlagOnRequestedVariables,
+    prepareKeyValueObjectsFromEnvFileOption,
+    prepareKeyValueObjectsFromCLIEnvOption,
+    isCompatibleApiVersion,
+} = require('../../helpers/general');
 const { validatePipelineYaml } = require('../../helpers/validation');
 const { printResult } = require('../root/validate.cmd');
-const CFError = require('cf-errors');
 const { sdk } = require('../../../../logic');
+const defaults = require('../../defaults');
 
 class RunBaseCommand {
     constructor(argv) {
@@ -55,22 +61,34 @@ class RunBaseCommand {
                 packName,
             },
         };
-
+        const encryptedVarsSupported = await isCompatibleApiVersion({
+            supportedVersion: defaults.MIN_API_VERSION_FOR_ENCRYPTED_VARS_SUPPORT_IN_RUN_CMD,
+        });
         if (variablesFromFile) {
             _.forEach(variablesFromFile, (variables) => {
                 const request = _.cloneDeep(executionRequestTemplate);
-                request.options.variables = variables;
+                if (encryptedVarsSupported) {
+                    request.options.variables = prepareKeyValueObjectsFromEnvFileOption(variables);
+                } else {
+                    request.options.variables = variables;
+                }
                 this.executionRequests.push(request);
             });
         } else {
-            const variables = prepareKeyValueFromCLIEnvOption(this.argv.variable);
+            let variables;
+            if (encryptedVarsSupported) {
+                const varsArr = prepareKeyValueObjectsFromCLIEnvOption(this.argv.variable);
+                variables = markEncryptedFlagOnRequestedVariables(varsArr, this.argv.encrypted);
+            } else {
+                variables = prepareKeyValueFromCLIEnvOption(this.argv.variable);
+            }
             const request = _.cloneDeep(executionRequestTemplate);
             request.options.variables = variables;
             request.options.contexts = contexts;
             this.executionRequests.push(request);
         }
 
-        const results = await Promise.all(this.executionRequests.map(request => this.runImpl(request)));
+        const results = await Promise.all(this.executionRequests.map((request) => this.runImpl(request)));
         const findMaxReducer = (accumulator, currentValue) => (currentValue > accumulator ? currentValue : accumulator);
         const exitCode = results.reduce(findMaxReducer);
         await this.postRunRequest();

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

@@ -86,6 +86,12 @@ const run = new Command({
                 default: [],
                 alias: 'v',
             })
+            .option('encrypted', {
+                array: true,
+                alias: 'e',
+                describe: 'Variable names to encrypt',
+                default: [],
+            })
             .option('detach', {
                 alias: 'd',
                 describe: 'Run pipeline and print build ID',
@@ -126,6 +132,7 @@ const run = new Command({
             .example('codefresh run PIPELINE_ID | PIPELINE_NAME -b=master', 'Defining the source control context using a branch')
             .example('codefresh run PIPELINE_ID | PIPELINE_NAME -s=52b992e783d2f84dd0123c70ac8623b4f0f938d1', 'Defining the source control context using a commit')
             .example('codefresh run PIPELINE_ID | PIPELINE_NAME -b=master -v key1=value1 -v key2=value2', 'Setting variables through the command')
+            .example('codefresh run PIPELINE_ID | PIPELINE_NAME -b=master -v key1=value1 -v key2=value2 -e key1', 'Setting variables through the command with encrypted option')
             .example('codefresh run PIPELINE_ID | PIPELINE_NAME -b=master --var-file ./var_file.yml', 'Settings variables through a yml file')
             .example('codefresh run PIPELINE_ID | PIPELINE_NAME -b=master --context context', 'Inject contexts to the pipeline execution')
             .example('codefresh run PIPELINE_ID | PIPELINE_NAME --skip step1 step2 step3', 'Skip specific steps');

package/lib/interface/cli/commands/pipeline/var.json

@@ -0,0 +1,12 @@
+{
+  "build1": {
+    "help6": "85858",
+    "should_be_encrepted": "0000",
+    "help7": {
+      "value": "test",
+      "encrypted": true
+    }
+  }
+}
+
+

package/lib/interface/cli/commands/pipeline/var.yml

@@ -0,0 +1,5 @@
+build1:
+  VAR1: 'VAL1'
+  VAR2:
+    value: VAL2
+    encrypted: true

package/lib/interface/cli/commands/project/apply.cmd.js

@@ -4,7 +4,7 @@ const _ = require('lodash');
 const { sdk } = require('../../../../logic');
 
 const applyRoot = require('../root/apply.cmd');
-const { prepareKeyValueObjectsFromCLIEnvOption, ignoreHttpError } = require('../../helpers/general');
+const { prepareKeyValueObjectsFromCLIEnvOption, ignoreHttpError, markEncryptedFlagOnRequestedVariables } = require('../../helpers/general');
 
 const command = new Command({
     command: 'project [id|name]',
@@ -61,14 +61,7 @@ const command = new Command({
             encrypted,
         } = argv;
 
-        const variableMap = _.reduce(variables, (acc, v) => _.assign(acc, { [v.key]: v }), {});
-        _.forEach(encrypted, (varName) => {
-            const variable = variableMap[varName];
-            if (!variable) {
-                throw new CFError(`Variable is not provided: "${varName}"`);
-            }
-            variable.encrypted = true;
-        });
+        const requestedProjectVariables = markEncryptedFlagOnRequestedVariables(variables, encrypted);
 
         let project = await sdk.projects.get({ id }).catch(ignoreHttpError);
         project = project || await sdk.projects.getByName({ name }).catch(ignoreHttpError);
@@ -81,7 +74,7 @@ const command = new Command({
         const updatePayload = _.pickBy({
             projectName,
             tags: tags || existingTags,
-            variables: variables || existingVariables,
+            variables: requestedProjectVariables || existingVariables,
         }, _.identity);
 
         await sdk.projects.patch({ id: project.id }, updatePayload);

package/lib/interface/cli/commands/project/create.cmd.js

@@ -1,10 +1,8 @@
 const Command = require('../../Command');
-const CFError = require('cf-errors');
-const _ = require('lodash');
 const { sdk } = require('../../../../logic');
 const createRoot = require('../root/create.cmd');
 const { checkOrProjectExists } = require('../../helpers/validation');
-const { prepareKeyValueObjectsFromCLIEnvOption } = require('../../helpers/general');
+const { prepareKeyValueObjectsFromCLIEnvOption, markEncryptedFlagOnRequestedVariables } = require('../../helpers/general');
 
 const command = new Command({
     command: 'project <name>',
@@ -52,17 +50,10 @@ const command = new Command({
             encrypted,
         } = argv;
 
-        const variableMap = _.reduce(variables, (acc, v) => _.assign(acc, { [v.key]: v }), {});
-        _.forEach(encrypted, (varName) => {
-            const variable = variableMap[varName];
-            if (!variable) {
-                throw new CFError(`Variable is not provided: "${varName}"`);
-            }
-            variable.encrypted = true;
-        });
+        const requestedProjectVariables = markEncryptedFlagOnRequestedVariables(variables, encrypted);
 
         await checkOrProjectExists(projectName);
-        await sdk.projects.create({ projectName, tags, variables });
+        await sdk.projects.create({ projectName, tags, variables: requestedProjectVariables });
         console.log(`Project: "${projectName}" created`);
     },
 });

package/lib/interface/cli/completion/tree.json

@@ -1 +1 @@
-{"codefresh":{"analyze":{},"completion":{},"completions":{"alias":"completion"},"tag":{},"untag":{},"offline-logs":{"ensure-index":{},"offload-to-collection":{},"offload-to-file":{}},"run":{"__optionHandlers":["../commands/pipeline/run.completion.js"]},"add":{"repository":{},"repo":{"alias":"repository"}},"patch":{"__optionHandlers":["../commands/root/apply.completion.js"],"agent":{"__optionHandlers":["../commands/root/apply.completion.js"]},"board":{"__optionHandlers":["../commands/root/apply.completion.js"]},"project":{"__optionHandlers":["../commands/root/apply.completion.js"]},"runtime-environments":{"__optionHandlers":["../commands/root/apply.completion.js"]},"re":{"alias":"runtime-environments"},"runtime-environment":{"alias":"runtime-environments"},"section":{"__optionHandlers":["../commands/root/apply.completion.js"]},"system-runtime-environments":{"__optionHandlers":["../commands/root/apply.completion.js"]},"sys-re":{"alias":"system-runtime-environments"},"system-runtime-environment":{"alias":"system-runtime-environments"},"teams":{"__optionHandlers":["../commands/root/apply.completion.js"]},"team":{"alias":"teams"},"tm":{"alias":"teams"},"tokens":{"__optionHandlers":["../commands/root/apply.completion.js"]},"token":{"alias":"tokens"},"helm-repo":{"__optionHandlers":["../commands/root/apply.completion.js"]},"context":{"__optionHandlers":["../commands/root/apply.completion.js"]},"ctx":{"alias":"context"}},"annotate":{"image":{},"img":{"alias":"image"}},"auth":{"create-context":{},"current-context":{},"get-contexts":{},"use-context":{}},"components":{"download":{},"update":{}},"create":{"__optionHandlers":["../commands/root/create.completion.js"],"agent":{"__optionHandlers":["../commands/root/create.completion.js"]},"clusters":{"__optionHandlers":["../commands/root/create.completion.js"]},"cluster":{"alias":"clusters"},"annotation":{"__optionHandlers":["../commands/root/create.completion.js"]},"board":{"__optionHandlers":["../commands/root/create.completion.js"]},"composition":{"__optionHandlers":["../commands/composition/create.completion.js","../commands/root/create.completion.js"]},"com":{"alias":"composition"},"project":{"__optionHandlers":["../commands/root/create.completion.js"]},"runtime-environments":{"__optionHandlers":["../commands/root/create.completion.js"]},"re":{"alias":"runtime-environments"},"runtime-environment":{"alias":"runtime-environments"},"section":{"__optionHandlers":["../commands/root/create.completion.js"]},"teams":{"__optionHandlers":["../commands/root/create.completion.js"]},"team":{"alias":"teams"},"tm":{"alias":"teams"},"token":{"__optionHandlers":["../commands/root/create.completion.js"]},"helm-repo":{"__optionHandlers":["../commands/root/create.completion.js"]},"registry":{"__optionHandlers":["../commands/root/create.completion.js"],"standard":{"__optionHandlers":["../commands/root/create.completion.js"]}},"trigger":{"__optionHandlers":["../commands/root/create.completion.js"]},"t":{"alias":"trigger"},"trigger-event":{"__optionHandlers":["../commands/root/create.completion.js"]},"te":{"alias":"trigger-event"},"workflow-data-item":{"__optionHandlers":["../commands/root/create.completion.js"]},"wdi":{"alias":"workflow-data-item"},"context":{"__optionHandlers":["../commands/root/create.completion.js"],"config":{"__optionHandlers":["../commands/root/create.completion.js"]},"secret":{"__optionHandlers":["../commands/root/create.completion.js"]},"secret-yaml":{"__optionHandlers":["../commands/root/create.completion.js"]},"yaml":{"__optionHandlers":["../commands/root/create.completion.js"]},"git":{"__optionHandlers":["../commands/root/create.completion.js"],"bitbucket":{"__optionHandlers":["../commands/root/create.completion.js"]},"github":{"__optionHandlers":["../commands/root/create.completion.js"]},"gitlab":{"__optionHandlers":["../commands/root/create.completion.js"]},"stash":{"__optionHandlers":["../commands/root/create.completion.js"]}},"secret-store":{"__optionHandlers":["../commands/root/create.completion.js"],"hashicorp-vault":{"__optionHandlers":["../commands/root/create.completion.js"]},"kubernetes-runtime":{"__optionHandlers":["../commands/root/create.completion.js"]},"kubernetes":{"__optionHandlers":["../commands/root/create.completion.js"]}},"helm-repository":{"__optionHandlers":["../commands/root/create.completion.js"],"http":{"__optionHandlers":["../commands/root/create.completion.js"]},"s3":{"__optionHandlers":["../commands/root/create.completion.js"]}}},"ctx":{"alias":"context","config":{"__optionHandlers":["../commands/root/create.completion.js"]},"secret":{"__optionHandlers":["../commands/root/create.completion.js"]},"secret-yaml":{"__optionHandlers":["../commands/root/create.completion.js"]},"yaml":{"__optionHandlers":["../commands/root/create.completion.js"]},"git":{"__optionHandlers":["../commands/root/create.completion.js"],"bitbucket":{"__optionHandlers":["../commands/root/create.completion.js"]},"github":{"__optionHandlers":["../commands/root/create.completion.js"]},"gitlab":{"__optionHandlers":["../commands/root/create.completion.js"]},"stash":{"__optionHandlers":["../commands/root/create.completion.js"]}},"secret-store":{"__optionHandlers":["../commands/root/create.completion.js"],"hashicorp-vault":{"__optionHandlers":["../commands/root/create.completion.js"]},"kubernetes-runtime":{"__optionHandlers":["../commands/root/create.completion.js"]},"kubernetes":{"__optionHandlers":["../commands/root/create.completion.js"]}},"helm-repository":{"__optionHandlers":["../commands/root/create.completion.js"],"http":{"__optionHandlers":["../commands/root/create.completion.js"]},"s3":{"__optionHandlers":["../commands/root/create.completion.js"]}}}},"delete":{"__optionHandlers":["../commands/root/delete.completion.js"],"agent":{"__optionHandlers":["../commands/root/delete.completion.js"]},"annotation":{"__optionHandlers":["../commands/root/delete.completion.js"]},"board":{"__optionHandlers":["../commands/root/delete.completion.js"]},"cluster":{"__optionHandlers":["../commands/root/delete.completion.js"]},"clusters":{"alias":"cluster"},"composition":{"__optionHandlers":["../commands/root/delete.completion.js"]},"com":{"alias":"composition"},"environment":{"__optionHandlers":["../commands/root/delete.completion.js"]},"env":{"alias":"environment"},"pipeline":{"__optionHandlers":["../commands/root/delete.completion.js"]},"pip":{"alias":"pipeline"},"project":{"__optionHandlers":["../commands/root/delete.completion.js"]},"repository":{"__optionHandlers":["../commands/root/delete.completion.js"]},"repo":{"alias":"repository"},"runtime-environments":{"__optionHandlers":["../commands/root/delete.completion.js"]},"re":{"alias":"runtime-environments"},"runtime-environment":{"alias":"runtime-environments"},"section":{"__optionHandlers":["../commands/root/delete.completion.js"]},"step-type":{"__optionHandlers":["../commands/root/delete.completion.js"]},"system-runtime-environments":{"__optionHandlers":["../commands/root/delete.completion.js"]},"sys-re":{"alias":"system-runtime-environments"},"system-runtime-environment":{"alias":"system-runtime-environments"},"teams":{"__optionHandlers":["../commands/root/delete.completion.js"]},"team":{"alias":"teams"},"tm":{"alias":"teams"},"tokens":{"__optionHandlers":["../commands/root/delete.completion.js"]},"token":{"alias":"tokens"},"helm-repo":{"__optionHandlers":["../commands/root/delete.completion.js"]},"registry":{"__optionHandlers":["../commands/root/delete.completion.js"]},"trigger":{"__optionHandlers":["../commands/root/delete.completion.js"]},"t":{"alias":"trigger"},"trigger-event":{"__optionHandlers":["../commands/root/delete.completion.js"]},"te":{"alias":"trigger-event"},"context":{"__optionHandlers":["../commands/root/delete.completion.js"]},"ctx":{"alias":"context"}},"diff":{"__optionHandlers":["../commands/root/diff.completion.js"],"runtime-environments":{"__optionHandlers":["../commands/root/diff.completion.js"]},"re":{"alias":"runtime-environments"},"runtime-environment":{"alias":"runtime-environments"},"system-runtime-environments":{"__optionHandlers":["../commands/root/diff.completion.js"]},"sys-re":{"alias":"system-runtime-environments"},"system-runtime-environment":{"alias":"system-runtime-environments"}},"download":{"audit":{}},"generate":{"image-pull-secret":{}},"get":{"__optionHandlers":["../commands/root/get.completion.js"],"agents":{"__optionHandlers":["../commands/root/get.completion.js"]},"agent":{"alias":"agents"},"annotation":{"__optionHandlers":["../commands/root/get.completion.js"]},"boards":{"__optionHandlers":["../commands/root/get.completion.js"]},"board":{"alias":"boards"},"clusters":{"__optionHandlers":["../commands/root/get.completion.js"]},"cluster":{"alias":"clusters"},"compositions":{"__optionHandlers":["../commands/root/get.completion.js"]},"com":{"alias":"compositions"},"composition":{"alias":"compositions"},"environments":{"__optionHandlers":["../commands/root/get.completion.js"]},"env":{"alias":"environments"},"environment":{"alias":"environments"},"images":{"__optionHandlers":["../commands/root/get.completion.js"]},"img":{"alias":"images"},"image":{"alias":"images"},"pipelines":{"__positionalHandler":"../commands/pipeline/get.completion.js","__optionHandlers":["../commands/root/get.completion.js"]},"pip":{"alias":"pipelines"},"pipeline":{"alias":"pipelines"},"projects":{"__optionHandlers":["../commands/root/get.completion.js"]},"project":{"alias":"projects"},"repository":{"__optionHandlers":["../commands/root/get.completion.js"]},"repo":{"alias":"repository"},"runtime-environments":{"__optionHandlers":["../commands/root/get.completion.js"]},"re":{"alias":"runtime-environments"},"runtime-environment":{"alias":"runtime-environments"},"sections":{"__optionHandlers":["../commands/root/get.completion.js"]},"section":{"alias":"sections"},"step-types":{"__positionalHandler":"../commands/step/get.completion.js","__optionHandlers":["../commands/root/get.completion.js"]},"step-type":{"alias":"step-types"},"system-runtime-environments":{"__optionHandlers":["../commands/root/get.completion.js"]},"sys-re":{"alias":"system-runtime-environments"},"system-runtime-environment":{"alias":"system-runtime-environments"},"teams":{"__optionHandlers":["../commands/root/get.completion.js"]},"team":{"alias":"teams"},"tm":{"alias":"teams"},"tokens":{"__optionHandlers":["../commands/root/get.completion.js"]},"token":{"alias":"tokens"},"helm-repo":{"__optionHandlers":["../commands/root/get.completion.js"]},"registry":{"__optionHandlers":["../commands/root/get.completion.js"]},"triggers":{"__optionHandlers":["../commands/root/get.completion.js"]},"trigger":{"alias":"triggers"},"t":{"alias":"triggers"},"trigger-events":{"__optionHandlers":["../commands/root/get.completion.js"]},"trigger-event":{"alias":"trigger-events"},"te":{"alias":"trigger-events"},"trigger-types":{"__optionHandlers":["../commands/root/get.completion.js"]},"trigger-type":{"alias":"trigger-types"},"tt":{"alias":"trigger-types"},"builds":{"__optionHandlers":["../commands/root/get.completion.js"]},"build":{"alias":"builds"},"workflow-data-item":{"__optionHandlers":["../commands/root/get.completion.js"]},"wdi":{"alias":"workflow-data-item"},"contexts":{"__optionHandlers":["../commands/root/get.completion.js"]},"ctx":{"alias":"contexts"},"context":{"alias":"contexts"}},"install":{"runtime":{},"agent":{},"app-proxy":{},"monitor":{},"gitops":{}},"replace":{"__optionHandlers":["../commands/root/replace.completion.js"],"composition":{"__optionHandlers":["../commands/composition/replace.completion.js","../commands/root/replace.completion.js"]},"com":{"alias":"composition"}},"runner":{"delete":{},"execute-test-pipeline":{},"info":{},"init":{},"upgrade":{}},"synchronize":{"teams":{},"team":{"alias":"teams"},"tm":{"alias":"teams"}},"uninstall":{"agent":{},"app-proxy":{},"runtime":{},"monitor":{},"gitops":{}},"upgrade":{"app-proxy":{},"gitops":{}},"validate":{"__positionalHandler":"../commands/root/validate.completion.js"},"version":{},"attach":{},"cli-config":{"get":{},"help":{},"profile":{},"set":{}},"set-helm-config":{},"install-chart":{},"helm-promotion":{},"delete-release":{},"rollback-release":{},"test-release":{},"approve":{},"deny":{},"restart":{},"logs":{},"terminate":{},"wait":{}}}
+{"codefresh":{"analyze":{},"completion":{},"completions":{"alias":"completion"},"tag":{},"untag":{},"offline-logs":{"ensure-index":{},"offload-to-collection":{},"offload-to-file":{}},"run":{"__optionHandlers":["../commands/pipeline/run.completion.js"]},"attach":{},"add":{"repository":{},"repo":{"alias":"repository"}},"annotate":{"image":{},"img":{"alias":"image"}},"patch":{"__optionHandlers":["../commands/root/apply.completion.js"],"agent":{"__optionHandlers":["../commands/root/apply.completion.js"]},"board":{"__optionHandlers":["../commands/root/apply.completion.js"]},"project":{"__optionHandlers":["../commands/root/apply.completion.js"]},"runtime-environments":{"__optionHandlers":["../commands/root/apply.completion.js"]},"re":{"alias":"runtime-environments"},"runtime-environment":{"alias":"runtime-environments"},"section":{"__optionHandlers":["../commands/root/apply.completion.js"]},"system-runtime-environments":{"__optionHandlers":["../commands/root/apply.completion.js"]},"sys-re":{"alias":"system-runtime-environments"},"system-runtime-environment":{"alias":"system-runtime-environments"},"teams":{"__optionHandlers":["../commands/root/apply.completion.js"]},"team":{"alias":"teams"},"tm":{"alias":"teams"},"tokens":{"__optionHandlers":["../commands/root/apply.completion.js"]},"token":{"alias":"tokens"},"helm-repo":{"__optionHandlers":["../commands/root/apply.completion.js"]},"context":{"__optionHandlers":["../commands/root/apply.completion.js"]},"ctx":{"alias":"context"}},"auth":{"create-context":{},"current-context":{},"get-contexts":{},"use-context":{}},"components":{"download":{},"update":{}},"create":{"__optionHandlers":["../commands/root/create.completion.js"],"agent":{"__optionHandlers":["../commands/root/create.completion.js"]},"clusters":{"__optionHandlers":["../commands/root/create.completion.js"]},"cluster":{"alias":"clusters"},"annotation":{"__optionHandlers":["../commands/root/create.completion.js"]},"board":{"__optionHandlers":["../commands/root/create.completion.js"]},"composition":{"__optionHandlers":["../commands/composition/create.completion.js","../commands/root/create.completion.js"]},"com":{"alias":"composition"},"project":{"__optionHandlers":["../commands/root/create.completion.js"]},"runtime-environments":{"__optionHandlers":["../commands/root/create.completion.js"]},"re":{"alias":"runtime-environments"},"runtime-environment":{"alias":"runtime-environments"},"section":{"__optionHandlers":["../commands/root/create.completion.js"]},"teams":{"__optionHandlers":["../commands/root/create.completion.js"]},"team":{"alias":"teams"},"tm":{"alias":"teams"},"token":{"__optionHandlers":["../commands/root/create.completion.js"]},"helm-repo":{"__optionHandlers":["../commands/root/create.completion.js"]},"registry":{"__optionHandlers":["../commands/root/create.completion.js"],"standard":{"__optionHandlers":["../commands/root/create.completion.js"]}},"trigger":{"__optionHandlers":["../commands/root/create.completion.js"]},"t":{"alias":"trigger"},"trigger-event":{"__optionHandlers":["../commands/root/create.completion.js"]},"te":{"alias":"trigger-event"},"workflow-data-item":{"__optionHandlers":["../commands/root/create.completion.js"]},"wdi":{"alias":"workflow-data-item"},"context":{"__optionHandlers":["../commands/root/create.completion.js"],"config":{"__optionHandlers":["../commands/root/create.completion.js"]},"secret":{"__optionHandlers":["../commands/root/create.completion.js"]},"secret-yaml":{"__optionHandlers":["../commands/root/create.completion.js"]},"yaml":{"__optionHandlers":["../commands/root/create.completion.js"]},"git":{"__optionHandlers":["../commands/root/create.completion.js"],"bitbucket":{"__optionHandlers":["../commands/root/create.completion.js"]},"github":{"__optionHandlers":["../commands/root/create.completion.js"]},"gitlab":{"__optionHandlers":["../commands/root/create.completion.js"]},"stash":{"__optionHandlers":["../commands/root/create.completion.js"]}},"helm-repository":{"__optionHandlers":["../commands/root/create.completion.js"],"http":{"__optionHandlers":["../commands/root/create.completion.js"]},"s3":{"__optionHandlers":["../commands/root/create.completion.js"]}},"secret-store":{"__optionHandlers":["../commands/root/create.completion.js"],"hashicorp-vault":{"__optionHandlers":["../commands/root/create.completion.js"]},"kubernetes-runtime":{"__optionHandlers":["../commands/root/create.completion.js"]},"kubernetes":{"__optionHandlers":["../commands/root/create.completion.js"]}}},"ctx":{"alias":"context","config":{"__optionHandlers":["../commands/root/create.completion.js"]},"secret":{"__optionHandlers":["../commands/root/create.completion.js"]},"secret-yaml":{"__optionHandlers":["../commands/root/create.completion.js"]},"yaml":{"__optionHandlers":["../commands/root/create.completion.js"]},"git":{"__optionHandlers":["../commands/root/create.completion.js"],"bitbucket":{"__optionHandlers":["../commands/root/create.completion.js"]},"github":{"__optionHandlers":["../commands/root/create.completion.js"]},"gitlab":{"__optionHandlers":["../commands/root/create.completion.js"]},"stash":{"__optionHandlers":["../commands/root/create.completion.js"]}},"helm-repository":{"__optionHandlers":["../commands/root/create.completion.js"],"http":{"__optionHandlers":["../commands/root/create.completion.js"]},"s3":{"__optionHandlers":["../commands/root/create.completion.js"]}},"secret-store":{"__optionHandlers":["../commands/root/create.completion.js"],"hashicorp-vault":{"__optionHandlers":["../commands/root/create.completion.js"]},"kubernetes-runtime":{"__optionHandlers":["../commands/root/create.completion.js"]},"kubernetes":{"__optionHandlers":["../commands/root/create.completion.js"]}}}},"delete":{"__optionHandlers":["../commands/root/delete.completion.js"],"agent":{"__optionHandlers":["../commands/root/delete.completion.js"]},"annotation":{"__optionHandlers":["../commands/root/delete.completion.js"]},"board":{"__optionHandlers":["../commands/root/delete.completion.js"]},"cluster":{"__optionHandlers":["../commands/root/delete.completion.js"]},"clusters":{"alias":"cluster"},"composition":{"__optionHandlers":["../commands/root/delete.completion.js"]},"com":{"alias":"composition"},"environment":{"__optionHandlers":["../commands/root/delete.completion.js"]},"env":{"alias":"environment"},"pipeline":{"__optionHandlers":["../commands/root/delete.completion.js"]},"pip":{"alias":"pipeline"},"project":{"__optionHandlers":["../commands/root/delete.completion.js"]},"repository":{"__optionHandlers":["../commands/root/delete.completion.js"]},"repo":{"alias":"repository"},"runtime-environments":{"__optionHandlers":["../commands/root/delete.completion.js"]},"re":{"alias":"runtime-environments"},"runtime-environment":{"alias":"runtime-environments"},"section":{"__optionHandlers":["../commands/root/delete.completion.js"]},"step-type":{"__optionHandlers":["../commands/root/delete.completion.js"]},"system-runtime-environments":{"__optionHandlers":["../commands/root/delete.completion.js"]},"sys-re":{"alias":"system-runtime-environments"},"system-runtime-environment":{"alias":"system-runtime-environments"},"teams":{"__optionHandlers":["../commands/root/delete.completion.js"]},"team":{"alias":"teams"},"tm":{"alias":"teams"},"tokens":{"__optionHandlers":["../commands/root/delete.completion.js"]},"token":{"alias":"tokens"},"helm-repo":{"__optionHandlers":["../commands/root/delete.completion.js"]},"registry":{"__optionHandlers":["../commands/root/delete.completion.js"]},"trigger":{"__optionHandlers":["../commands/root/delete.completion.js"]},"t":{"alias":"trigger"},"trigger-event":{"__optionHandlers":["../commands/root/delete.completion.js"]},"te":{"alias":"trigger-event"},"context":{"__optionHandlers":["../commands/root/delete.completion.js"]},"ctx":{"alias":"context"}},"diff":{"__optionHandlers":["../commands/root/diff.completion.js"],"runtime-environments":{"__optionHandlers":["../commands/root/diff.completion.js"]},"re":{"alias":"runtime-environments"},"runtime-environment":{"alias":"runtime-environments"},"system-runtime-environments":{"__optionHandlers":["../commands/root/diff.completion.js"]},"sys-re":{"alias":"system-runtime-environments"},"system-runtime-environment":{"alias":"system-runtime-environments"}},"download":{"audit":{}},"generate":{"image-pull-secret":{}},"get":{"__optionHandlers":["../commands/root/get.completion.js"],"agents":{"__optionHandlers":["../commands/root/get.completion.js"]},"agent":{"alias":"agents"},"annotation":{"__optionHandlers":["../commands/root/get.completion.js"]},"boards":{"__optionHandlers":["../commands/root/get.completion.js"]},"board":{"alias":"boards"},"clusters":{"__optionHandlers":["../commands/root/get.completion.js"]},"cluster":{"alias":"clusters"},"compositions":{"__optionHandlers":["../commands/root/get.completion.js"]},"com":{"alias":"compositions"},"composition":{"alias":"compositions"},"environments":{"__optionHandlers":["../commands/root/get.completion.js"]},"env":{"alias":"environments"},"environment":{"alias":"environments"},"images":{"__optionHandlers":["../commands/root/get.completion.js"]},"img":{"alias":"images"},"image":{"alias":"images"},"pipelines":{"__positionalHandler":"../commands/pipeline/get.completion.js","__optionHandlers":["../commands/root/get.completion.js"]},"pip":{"alias":"pipelines"},"pipeline":{"alias":"pipelines"},"projects":{"__optionHandlers":["../commands/root/get.completion.js"]},"project":{"alias":"projects"},"repository":{"__optionHandlers":["../commands/root/get.completion.js"]},"repo":{"alias":"repository"},"runtime-environments":{"__optionHandlers":["../commands/root/get.completion.js"]},"re":{"alias":"runtime-environments"},"runtime-environment":{"alias":"runtime-environments"},"sections":{"__optionHandlers":["../commands/root/get.completion.js"]},"section":{"alias":"sections"},"step-types":{"__positionalHandler":"../commands/step/get.completion.js","__optionHandlers":["../commands/root/get.completion.js"]},"step-type":{"alias":"step-types"},"system-runtime-environments":{"__optionHandlers":["../commands/root/get.completion.js"]},"sys-re":{"alias":"system-runtime-environments"},"system-runtime-environment":{"alias":"system-runtime-environments"},"teams":{"__optionHandlers":["../commands/root/get.completion.js"]},"team":{"alias":"teams"},"tm":{"alias":"teams"},"tokens":{"__optionHandlers":["../commands/root/get.completion.js"]},"token":{"alias":"tokens"},"helm-repo":{"__optionHandlers":["../commands/root/get.completion.js"]},"registry":{"__optionHandlers":["../commands/root/get.completion.js"]},"triggers":{"__optionHandlers":["../commands/root/get.completion.js"]},"trigger":{"alias":"triggers"},"t":{"alias":"triggers"},"trigger-events":{"__optionHandlers":["../commands/root/get.completion.js"]},"trigger-event":{"alias":"trigger-events"},"te":{"alias":"trigger-events"},"trigger-types":{"__optionHandlers":["../commands/root/get.completion.js"]},"trigger-type":{"alias":"trigger-types"},"tt":{"alias":"trigger-types"},"builds":{"__optionHandlers":["../commands/root/get.completion.js"]},"build":{"alias":"builds"},"workflow-data-item":{"__optionHandlers":["../commands/root/get.completion.js"]},"wdi":{"alias":"workflow-data-item"},"contexts":{"__optionHandlers":["../commands/root/get.completion.js"]},"ctx":{"alias":"contexts"},"context":{"alias":"contexts"}},"install":{"runtime":{},"agent":{},"app-proxy":{},"monitor":{},"gitops":{}},"replace":{"__optionHandlers":["../commands/root/replace.completion.js"],"composition":{"__optionHandlers":["../commands/composition/replace.completion.js","../commands/root/replace.completion.js"]},"com":{"alias":"composition"}},"runner":{"delete":{},"execute-test-pipeline":{},"info":{},"init":{},"upgrade":{}},"synchronize":{"teams":{},"team":{"alias":"teams"},"tm":{"alias":"teams"}},"uninstall":{"agent":{},"app-proxy":{},"runtime":{},"monitor":{},"gitops":{}},"upgrade":{"app-proxy":{},"gitops":{}},"validate":{"__positionalHandler":"../commands/root/validate.completion.js"},"version":{},"cli-config":{"get":{},"help":{},"profile":{},"set":{}},"set-helm-config":{},"install-chart":{},"helm-promotion":{},"delete-release":{},"rollback-release":{},"test-release":{},"approve":{},"deny":{},"logs":{},"restart":{},"terminate":{},"wait":{}}}

package/lib/interface/cli/defaults.js

@@ -13,6 +13,7 @@ const DEFAULTS = {
     MAX_CONSECUTIVE_ERRORS_LIMIT: 10,
     CODEFRESH_PATH: path.resolve(homedir(), '.Codefresh'),
     ENGINE_IMAGE: process.env.ENGINE_IMAGE || 'codefresh/engine:master',
+    MIN_API_VERSION_FOR_ENCRYPTED_VARS_SUPPORT_IN_RUN_CMD: '21.221.14',
 };
 
 module.exports = DEFAULTS;

package/lib/interface/cli/helpers/general.js

@@ -1,15 +1,43 @@
+const debug = require('debug')('codefresh:cli:helpers:general');
 const Promise = require('bluebird');
 const _ = require('lodash');
 const fs = require('fs');
 const yaml = require('js-yaml');
-const defaults = require('../defaults');
 const CFError = require('cf-errors');
 const path = require('path');
+const semver = require('semver');
+const request = require('requestretry');
+const defaults = require('../defaults');
 const Output = require('../../../output/Output');
 const { sdk } = require('../../../logic');
 
 const isDebug = () => (process.env.DEBUG || '').includes(defaults.DEBUG_PATTERN);
 
+async function getApiVersion(token, url) {
+    const RequestOptions = {
+        url: `${url}/api/user`,
+        headers: {
+            Authorization: token,
+        },
+        json: true,
+        maxAttempts: 3, // Retry up to 3 times
+        timeout: 10000,
+    };
+    try {
+        const res = await request(RequestOptions);
+        return _.get(res, 'headers.api_version');
+    } catch (error) {
+        debug('Failed to get API version:', error);
+        return null;
+    }
+}
+
+async function isCompatibleApiVersion({ supportedVersion }) {
+    const token = _.get(sdk, 'config.context.token');
+    const url = _.get(sdk, 'config.context.url', defaults.URL);
+    const apiVersion = token ? await getApiVersion(token, url) : null;
+    return apiVersion && semver.gte(apiVersion, supportedVersion);
+}
 
 const wrapHandler = (handler, requiresAuthentication) => {
     return async (argv) => {
@@ -106,6 +134,39 @@ const prepareKeyValueObjectsFromCLIEnvOption = (environmentVariables) => {
     return variables;
 };
 
+/**
+ * will return an array of objects { key, value, encrypted } from parsing an array of objects: key=value ,key: {value: "value", encrypted: true }
+ * @param environmentVariables
+ * @returns Array of { key, value, encrypted }
+ */
+const prepareKeyValueObjectsFromEnvFileOption = (environmentVariables) => _.map(environmentVariables, (value, key) => {
+    if (_.isObject(value)) {
+        const { value: val, encrypted } = value;
+        return { key, value: val, encrypted };
+    }
+    return { key, value };
+});
+
+/**
+ * The function takes in a list of requested variables and an array of encrypted variable names,
+ * and sets the encrypted flag to true on each corresponding variable object in the list.
+ * @param environmentVariables
+ * @param encrypted
+ * @returns Array of { key, value, encrypted }
+ */
+const markEncryptedFlagOnRequestedVariables = (requestedVariables, encrypted) => {
+    const variables = _.cloneDeep(requestedVariables);
+    const variableMap = _.reduce(variables, (acc, v) => _.assign(acc, { [v.key]: v }), {});
+    _.forEach(encrypted, (varName) => {
+        const variable = variableMap[varName];
+        if (!variable) {
+            throw new CFError(`Variable is not provided: "${varName}"`);
+        }
+        variable.encrypted = true;
+    });
+    return variables;
+};
+
 const crudFilenameOption = (yargs, options = {}) => {
     const filenameOption = {
         alias: options.alias || 'f',
@@ -122,13 +183,19 @@ const crudFilenameOption = (yargs, options = {}) => {
         .coerce(options.name || 'filename', (arg) => {
             try {
                 const rawFile = fs.readFileSync(path.resolve(process.cwd(), arg), 'utf8');
+                let content;
                 if (arg.endsWith('.json')) {
-                    return options.raw ? rawFile : JSON.parse(rawFile);
+                    content = options.raw ? rawFile : JSON.parse(rawFile);
+                } else if (arg.endsWith('.yml') || arg.endsWith('yaml')) {
+                    content = options.raw ? rawFile : yaml.safeLoad(rawFile);
+                } else {
+                    throw new CFError('File extension is not recognized');
                 }
-                if (arg.endsWith('.yml') || arg.endsWith('yaml')) {
-                    return options.raw ? rawFile : yaml.safeLoad(rawFile);
+                if (_.isObject(content)) {
+                    return content;
                 }
-                throw new CFError('File extension is not recognized');
+                throw new CFError('Not a valid file.\n'
+                    + 'For more information how to pass a valid file, go to https://codefresh-io.github.io/cli/pipelines/run-pipeline/');
             } catch (err) {
                 const error = new CFError({
                     message: 'Failed to read file',
@@ -161,15 +228,15 @@ const selectColumnsOption = (yargs, options = {}) => {
 };
 
 function pathExists(p) {
-    return new Promise(resolve => fs.access(p, resolve))
-        .then(err => !err);
+    return new Promise((resolve) => fs.access(p, resolve))
+        .then((err) => !err);
 }
 
 const readFile = Promise.promisify(fs.readFile);
 
 function watchFile(filename, listener) {
     fs.watchFile(filename, { interval: 500 }, listener);
-    const unwatcher = f => () => fs.unwatchFile(f);
+    const unwatcher = (f) => () => fs.unwatchFile(f);
     ['exit', 'SIGINT', 'SIGUSR1', 'SIGUSR2', 'uncaughtException', 'SIGTERM'].forEach((eventType) => {
         process.on(eventType, unwatcher(filename));
     });
@@ -177,7 +244,7 @@ function watchFile(filename, listener) {
 
 function ignoreHttpError(e) {
     if (!e.statusCode) {
-        throw e
+        throw e;
     }
     return undefined;
 }
@@ -232,4 +299,7 @@ module.exports = {
     detectProxy,
     keyValueArrayToObject,
     addProxyVariables,
+    markEncryptedFlagOnRequestedVariables,
+    prepareKeyValueObjectsFromEnvFileOption,
+    isCompatibleApiVersion,
 };

package/package.json

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