codefresh 0.84.10 → 0.86.0

package/Dockerfile

@@ -10,20 +10,26 @@ ENV PATH="/pyinstaller:$PATH"
 RUN pip install yq==${YQ_VERSION}
 RUN pyinstaller --noconfirm --onefile --log-level DEBUG --clean --distpath /tmp/ $(which yq)
 
+# kubectl binary
+FROM bitnami/kubectl:1.27.4 as kubectl
+
 # Main
-FROM node:18.17.1-alpine3.17
+FROM node:18.17.1-alpine3.18
 
-RUN apk --update add --no-cache ca-certificates git curl bash jq
+RUN apk --update add --no-cache \
+    bash \
+    ca-certificates \
+    curl \
+    git \
+    jq
 
 COPY --from=go /go/bin/hub /usr/local/bin/hub
 COPY --from=yq /tmp/yq /usr/local/bin/yq
+COPY --from=kubectl /opt/bitnami/kubectl/bin/kubectl /usr/local/bin/
 
 WORKDIR /cf-cli
 
-COPY package.json /cf-cli
-COPY yarn.lock /cf-cli
-COPY check-version.js /cf-cli
-COPY run-check-version.js /cf-cli
+COPY package.json yarn.lock check-version.js run-check-version.js /cf-cli/
 
 RUN yarn install --prod --frozen-lockfile && \
     yarn cache clean

package/Dockerfile-debian

@@ -10,21 +10,30 @@ ENV PATH="/pyinstaller:$PATH"
 RUN pip install yq==${YQ_VERSION}
 RUN pyinstaller --noconfirm --onefile --log-level DEBUG --clean --distpath /tmp/ $(which yq)
 
+# kubectl binary
+FROM bitnami/kubectl:1.27.4 as kubectl
+
 # Main
 FROM node:18.17.1-bullseye-slim
 
-RUN apt update
-RUN apt -y install ca-certificates git curl bash jq busybox && ln -s /bin/busybox /usr/bin/[[
+RUN apt update \
+    && apt -y install \
+    apt-transport-https \
+    bash \
+    busybox \
+    ca-certificates \
+    curl \
+    git \
+    jq \
+    && ln -s /bin/busybox /usr/bin/[[
 
 COPY --from=go /go/bin/hub /usr/local/bin/hub
 COPY --from=yq /tmp/yq /usr/local/bin/yq
+COPY --from=kubectl /opt/bitnami/kubectl/bin/kubectl /usr/local/bin/
 
 WORKDIR /cf-cli
 
-COPY package.json /cf-cli
-COPY yarn.lock /cf-cli
-COPY check-version.js /cf-cli
-COPY run-check-version.js /cf-cli
+COPY package.json yarn.lock check-version.js run-check-version.js /cf-cli/
 
 RUN yarn install --prod --frozen-lockfile && \
     yarn cache clean

package/Dockerfile-debian-rootless

@@ -10,21 +10,29 @@ ENV PATH="/pyinstaller:$PATH"
 RUN pip install yq==${YQ_VERSION}
 RUN pyinstaller --noconfirm --onefile --log-level DEBUG --clean --distpath /tmp/ $(which yq)
 
+# kubectl binary
+FROM bitnami/kubectl:1.27.4 as kubectl
+
 # Main
 FROM node:18.17.1-bullseye-slim
 
-RUN apt update
-RUN apt -y install ca-certificates git curl bash jq busybox && ln -s /bin/busybox /usr/bin/[[
+RUN apt update \
+    && apt -y install \
+    bash \
+    busybox \
+    ca-certificates \
+    curl \
+    git \
+    jq \
+    && ln -s /bin/busybox /usr/bin/[[
 
 COPY --from=go /go/bin/hub /usr/local/bin/hub
 COPY --from=yq /tmp/yq /usr/local/bin/yq
+COPY --from=kubectl /opt/bitnami/kubectl/bin/kubectl /usr/local/bin/
 
 WORKDIR /cf-cli
 
-COPY package.json /cf-cli
-COPY yarn.lock /cf-cli
-COPY check-version.js /cf-cli
-COPY run-check-version.js /cf-cli
+COPY package.json yarn.lock check-version.js run-check-version.js /cf-cli/
 
 RUN yarn install --prod --frozen-lockfile && \
     yarn cache clean
@@ -38,7 +46,7 @@ RUN ln -s $(pwd)/lib/interface/cli/codefresh /usr/local/bin/codefresh
 RUN codefresh components update --location components
 
 # we keep /root as home directory because cli by default looks for $HOME/.cfconfig
-# and we do not want to break user automation if he used to bind his .cfconfig
+# and we do not want to break user automation if they used to bind their .cfconfig
 # to the /root/.cfconfig
 RUN useradd -m -d /root -s /bin/sh cfu \
    && chown -R $(id -g cfu) /root /cf-cli \

package/Dockerfile-rootless

@@ -10,20 +10,26 @@ ENV PATH="/pyinstaller:$PATH"
 RUN pip install yq==${YQ_VERSION}
 RUN pyinstaller --noconfirm --onefile --log-level DEBUG --clean --distpath /tmp/ $(which yq)
 
+# kubectl binary
+FROM bitnami/kubectl:1.27.4 as kubectl
+
 # Main
-FROM node:18.17.1-alpine3.17
+FROM node:18.17.1-alpine3.18
 
-RUN apk --update add --no-cache ca-certificates git curl bash jq
+RUN apk --update add --no-cache \
+    bash \
+    ca-certificates \
+    curl \
+    git \
+    jq
 
 COPY --from=go /go/bin/hub /usr/local/bin/hub
 COPY --from=yq /tmp/yq /usr/local/bin/yq
+COPY --from=kubectl /opt/bitnami/kubectl/bin/kubectl /usr/local/bin/
 
 WORKDIR /cf-cli
 
-COPY package.json /cf-cli
-COPY yarn.lock /cf-cli
-COPY check-version.js /cf-cli
-COPY run-check-version.js /cf-cli
+COPY package.json yarn.lock check-version.js run-check-version.js /cf-cli/
 
 RUN yarn install --prod --frozen-lockfile && \
     yarn cache clean
@@ -37,7 +43,7 @@ RUN ln -s $(pwd)/lib/interface/cli/codefresh /usr/local/bin/codefresh
 RUN codefresh components update --location components
 
 # we keep /root as home directory because cli by default looks for $HOME/.cfconfig
-# and we do not want to break user automation if he used to bind his .cfconfig
+# and we do not want to break user automation if they used to bind their .cfconfig
 # to the /root/.cfconfig
 RUN adduser -D -h /root -s /bin/sh cfu \
    && chown -R $(id -g cfu) /root /cf-cli \

package/__mocks__/codefresh.yml

@@ -0,0 +1,40 @@
+# More examples of Codefresh YAML can be found at
+# https://codefresh.io/docs/docs/yaml-examples/examples/
+
+version: "1.0"
+# Stages can help you organize your steps in stages
+stages:
+  - "clone"
+  - "build"
+  - "test"
+
+steps:
+  clone:
+    title: "Cloning repository"
+    type: "git-clone"
+    repo: "https://github.com/codefresh-io/cli/"
+    # Clone the master branch. Or, use ${{CF_BRANCH}} to get branch name from trigger
+    # Learn more at https://codefresh.io/docs/docs/codefresh-yaml/variables/
+    revision: "master"
+    stage: "clone"
+
+  build:
+    title: "Building Docker image"
+    type: "build"
+    image_name: "codefresh-io/cli"
+    working_directory: "${{clone}}"
+    # Set 'latest' tag on the image. Or, use built-in variables
+    # like ${{CF_BRANCH_TAG_NORMALIZED}} to use the current branch name/tag.
+    tag: "latest"
+    dockerfile: "Dockerfile"
+    stage: "build"
+
+  test:
+    title: "Running test"
+    type: "freestyle" # Run any command
+    image: "ubuntu:latest" # The image in which command will be executed
+    working_directory: "${{clone}}" # Running command where code cloned
+    commands:
+      - "ls"
+    stage: "test"
+

package/docs/index.js

@@ -16,21 +16,21 @@ const ALLOW_BETA_COMMANDS = process.env.ALLOW_BETA_COMMANDS;
 const categoriesOrder = {
     completion: 30,
     authentication: 31,
-    'operate on resources' : 32,
-    pipelines : 40,
-    'pipelines v2 (beta)' : 42,
-    projects : 45,
+    'operate on resources': 32,
+    pipelines: 40,
+    'pipelines v2 (beta)': 42,
+    projects: 45,
     builds: 50,
-    contexts : 70 ,
-    images : 80 ,
-    triggers : 90,
-    environments : 100 ,
-    compositions : 110 ,
-    'helm repos' : 111 ,
+    contexts: 70,
+    images: 80,
+    triggers: 90,
+    environments: 100,
+    compositions: 110,
+    'helm repos': 111,
     'predefined pipelines': 120,
     'cli config': 121,
     teams: 130,
-    more : 150,
+    more: 150,
 };
 
 
@@ -115,7 +115,7 @@ const getWeight = async (command) => {
     }
 };
 
-const createCommandFile = async (nestedCategory,command) => {
+const createCommandFile = async (nestedCategory, command) => {
     const docs = command.prepareDocs();
     const dir = path.resolve(baseDir, `${(nestedCategory || 'undefined').toLowerCase()}`);
 
@@ -216,7 +216,7 @@ const createCategoryFile = async (content, category) => {
  * updates the category main file with a specific command
  * possible extensions are: HEADER, COMMANDS
  */
-const updateCategoryFileArray = async (nestedCategory,command, existingContent) => {
+const updateCategoryFileArray = async (nestedCategory, command, existingContent) => {
     const docs = command.prepareDocs();
     const { category } = docs;
     const finalCategoryArr = existingContent || {};
@@ -253,7 +253,7 @@ const updateCategoryFileArray = async (nestedCategory,command, existingContent)
     finalCategoryArr.category = category;
     newCmd.weight = await getWeight(command);
     newCmd.content = commandString;
-    if (!finalCategoryArr.commands){
+    if (!finalCategoryArr.commands) {
         finalCategoryArr.commands = [];
 
     }
@@ -318,16 +318,16 @@ const createAutomatedDocs = async () => {
 
         // document only in case category field exists and there are no sub commands under it
         const docs = command.prepareDocs();
-        const {category} = docs;
+        const { category } = docs;
         if (!category || await hasSubCommands(command)) {
             continue;
         }
 
         nestedCategories[category] = await getNestedCategories(command);
         const nestedCategory = nestedCategories[category];
-        categories[category] = await updateCategoryFileArray(nestedCategory,command, categories[category]);
+        categories[category] = await updateCategoryFileArray(nestedCategory, command, categories[category]);
         await upsertCategoryFolder(nestedCategory);
-        await createCommandFile(nestedCategory,command);
+        await createCommandFile(nestedCategory, command);
     }
 
     let categoriesFinalContent = {};
@@ -356,7 +356,7 @@ const createDownloadPage = async () => {
             links.push(asset.browser_download_url);
         }));
         const commandFilePath = path.resolve(baseDir, './installation/download.md');
-        const finalContent=
+        const finalContent =
             '+++\n' +
             'title = "Download"\n' +
             'description = "asd"\n' +
@@ -372,6 +372,7 @@ const createDownloadPage = async () => {
             '    <li><a href=' + links[1] + ' target="_blank">Linux-x64</a></li>\n' +
             '    <li><a href=' + links[2] + ' target="_blank">Macos-x64</a></li>\n' +
             '    <li><a href=' + links[3] + ' target="_blank">Windows-x64</a></li>\n' +
+            '    <li><a href=' + links[4] + ' target="_blank">Alpine-arm64</a></li>\n' +
             '</ul> \n' +
             '\n' +
             'After downloading the binary, untar or unzip it and your are good to go.<br>\n' +

package/lib/interface/cli/commands/agent/install.cmd.js

@@ -1,17 +1,160 @@
 /* eslint-disable max-len */
+const cliProgress = require('cli-progress');
+const colors = require('colors');
 const Command = require('../../Command');
 const installRoot = require('../root/install.cmd');
 const { sdk } = require('../../../../logic');
 const installRuntimeCmd = require('../runtimeEnvironments/install.cmd');
 const { getKubeContext } = require('../../helpers/kubernetes');
 const ProgressEvents = require('../../helpers/progressEvents');
-const cliProgress = require('cli-progress');
-const colors = require('colors');
 const { getNewAgentName } = require('./helper');
-const { DefaultLogFormatter } = require('./../hybrid/helper');
+const { DefaultLogFormatter } = require('../hybrid/helper');
+const Output = require('../../../../output/Output');
 
 const defaultNamespace = 'codefresh';
 
+async function createAgent(argv) {
+    const {
+        name,
+        kubeConfigPath,
+        kubeContextName = getKubeContext(kubeConfigPath),
+        kubeNamespace = defaultNamespace,
+    } = argv;
+    const finalName = name || await getNewAgentName(kubeContextName, kubeNamespace);
+    try {
+        const { token } = await sdk.agents.create({ name: finalName });
+        console.log(`A Codefresh Runner with the name: ${colors.cyan(finalName)} has been created.`);
+        return token;
+    } catch (err) {
+        const msg = Output._extractErrorMessage(err);
+        if (msg.includes('Agent name duplication')) {
+            throw new Error(`A Codefresh Runner with the name "${colors.cyan(finalName)}" already exists. Please choose a different name, or delete the current agent from the platform.`);
+        }
+
+        throw err;
+    }
+}
+
+async function getAgentNameByToken(token) {
+    const [apiKey] = token.split('.');
+    const agentData = await sdk.tokens.getById({ id: apiKey });
+    if (!agentData) {
+        throw new Error('token is not valid');
+    }
+
+    const {
+        subject: {
+            type,
+            ref,
+        },
+    } = agentData;
+
+    if (type !== 'agent') {
+        throw new Error('token is not assosicated with a runner');
+    }
+
+    const { name } = await sdk.agents.get({ agentId: ref });
+    return name;
+}
+
+async function installAgentInCluster(argv, token, agentName) {
+    const {
+        kubeNodeSelector,
+        dryRun,
+        inCluster,
+        tolerations,
+        dockerRegistry,
+        skipVersionCheck,
+        kubeConfigPath,
+        kubeContextName = getKubeContext(kubeConfigPath),
+        kubeNamespace = defaultNamespace,
+        envVars,
+        verbose,
+        terminateProcess,
+    } = argv;
+
+    const apiHost = sdk.config.context.url;
+    const events = new ProgressEvents();
+    const format = 'downloading [{bar}] {percentage}% | {value}/{total}';
+    const progressBar = new cliProgress.SingleBar({ stopOnComplete: true, format }, cliProgress.Presets.shades_classic);
+    let totalSize;
+    events.onStart((size) => {
+        console.log('Downloading Codefresh Runner installer \n');
+        progressBar.start(size, 0);
+        totalSize = size;
+    });
+    events.onProgress((progress) => {
+        progressBar.update(progress);
+        if (progress >= totalSize) {
+            console.log('\n');
+        }
+    });
+    const agentInstallStatusCode = await sdk.agents.install({
+        agentId: agentName,
+        apiHost,
+        token,
+        kubeConfigPath,
+        kubeContextName,
+        kubeNamespace,
+        kubeNodeSelector,
+        inCluster,
+        dockerRegistry,
+        tolerations,
+        skipVersionCheck,
+        envVars,
+        events,
+        dryRun,
+        verbose,
+        terminateProcess,
+        logFormatting: DefaultLogFormatter,
+    });
+    if (agentInstallStatusCode !== 0) {
+        throw new Error(`\nRunner installation failed with code ${agentInstallStatusCode}`);
+    }
+}
+
+async function installRuntimeFunc(argv, agentName) {
+    const {
+        runtimeName,
+        skipReCreation,
+        buildNodeSelector,
+        storageClassName,
+        setValue,
+        setFile,
+        agentKubeContextName,
+        agentKubeNamespace,
+        kubeConfigPath,
+        kubeContextName,
+        kubeNamespace,
+        skipClusterCreation,
+        makeDefaultRuntime,
+        platformOnly,
+        verbose,
+        terminateProcess,
+    } = argv;
+    await installRuntimeCmd.handler({
+        runtimeName,
+        skipReCreation,
+        skipClusterCreation,
+        runtimeKubeConfigPath: kubeConfigPath,
+        runtimeKubeContextName: kubeContextName,
+        runtimeKubeNamespace: kubeNamespace,
+        kubeNodeSelector: buildNodeSelector,
+        storageClassName,
+        setValue,
+        setFile,
+        makeDefaultRuntime,
+        attachRuntime: true,
+        agentName,
+        agentKubeContextName,
+        agentKubeNamespace,
+        restartAgent: true,
+        platformOnly,
+        verbose,
+        terminateProcess,
+    });
+}
+
 const installAgentCmd = new Command({
     root: false,
     parent: installRoot,
@@ -22,7 +165,7 @@ const installAgentCmd = new Command({
         title: 'Install',
         weight: 100,
     },
-    builder: yargs => yargs
+    builder: (yargs) => yargs
         .env('CF_ARG_') // this means that every process.env.CF_ARG_* will be passed to argv
         .option('name', {
             describe: 'Agent\'s name to be created if token is not provided',
@@ -57,6 +200,24 @@ const installAgentCmd = new Command({
         .option('install-runtime', {
             describe: 'Install and attach runtime on the same namespace as the agent (default is false)',
         })
+        .option('runtime-name', {
+            describe: 'The name of the runtime to install',
+        })
+        .option('build-node-selector', {
+            describe: 'The kubernetes node selector "key=value" to be used by runner build resources (default is no node selector) (string)',
+        })
+        .option('skip-re-creation', {
+            description: 'If set to true, will skip runtime creation in the platform',
+        })
+        .option('set-value', {
+            describe: 'Set values for templates, example: --set-value LocalVolumesDir=/mnt/disks/ssd0/codefresh-volumes',
+        })
+        .option('set-file', {
+            describe: 'Set values for templates from file, example: --set-file Storage.GoogleServiceAccount=/path/to/service-account.json',
+        })
+        .option('skip-cluster-creation', {
+            description: 'If set to true, will skip cluster integration creation for this runtime',
+        })
         .option('make-default-runtime', {
             describe: 'should all pipelines run on the hybrid runtime (default is false)',
         })
@@ -73,132 +234,49 @@ const installAgentCmd = new Command({
             describe: 'The prefix for the container registry that will be used for pulling the required components images. Example: --docker-registry="docker.io"',
             type: 'string',
         })
+        .option('platform-only', {
+            describe: 'Set to true to create runtime on the platform side only',
+        })
         .option('verbose', {
             describe: 'Print logs',
         }),
     handler: async (argv) => {
-        let {
-            name, token,
-        } = argv;
         const {
-            'runtime-name': reName,
-            'skip-re-creation': skipRuntimeCreation,
-            'kube-node-selector': kubeNodeSelector,
-            'build-node-selector': buildNodeSelector,
-            'dry-run': dryRun,
-            'in-cluster': inCluster,
-            tolerations,
-            'kube-config-path': kubeConfigPath,
-            'skip-version-check': skipVersionCheck,
-            'install-runtime': installRuntime,
-            'make-default-runtime': shouldMakeDefaultRe,
-            'storage-class-name': storageClassName,
-            verbose,
-            terminateProcess,
-            'set-value': setValue,
-            'set-file': setFile,
-            'agent-kube-context-name': agentKubeContextName,
-            'agent-kube-namespace': agentKubeNamespace,
-            'docker-registry': dockerRegistry,
-            envVars,
+            agentKubeNamespace,
+            installRuntime,
+            platformOnly,
         } = argv;
-        let agent;
         let {
-            'kube-context-name': kubeContextName,
-            'kube-namespace': kubeNamespace,
+            name,
+            token,
         } = argv;
-        if (!kubeContextName) {
-            kubeContextName = getKubeContext(kubeConfigPath);
-        }
-        if (!kubeNamespace) {
-            kubeNamespace = defaultNamespace;
-        }
-        if (installRuntime && !agentKubeNamespace) {
+
+        if (installRuntimeFunc && !agentKubeNamespace) {
             throw new Error('agent-kube-namespace is a mandatory parameter when installing runtime');
         }
 
-        if (!token) { // Create an agent if not provided
-            name = name || await getNewAgentName(kubeContextName, kubeNamespace);
-            agent = await sdk.agents.create({ name });
-            // eslint-disable-next-line prefer-destructuring
-            token = agent.token;
-            console.log(`A Codefresh Runner with the name: ${colors.cyan(name)} has been created.`);
+        if (!token) {
+            // Create an agent if not provided
+            token = await createAgent(argv);
         } else {
-            // take the agent id from the token
-            const apiKey = token.split('.')[0];
-            const agentData = await sdk.tokens.getById({ id: apiKey });
-            if (!agentData) {
-                throw new Error('token is not valid');
+            // take the agent name from the token
+            const nameFromToken = await getAgentNameByToken(token);
+            if (!name) {
+                name = nameFromToken;
+            } else if (name !== nameFromToken) {
+                throw new Error(`token is assosicated with agent ${nameFromToken}, different from supplied '--name ${name}'`);
             }
-            const { subject } = agentData;
-
-            if (subject.type !== 'agent') {
-                throw new Error('token is not assosicated with a runner');
-            }
-            const agentId = agentData.subject.ref;
-            const data = await sdk.agents.get({ agentId });
-            // eslint-disable-next-line prefer-destructuring
-            name = data.name;
         }
-        const apiHost = sdk.config.context.url;
-        const events = new ProgressEvents();
-        const format = 'downloading [{bar}] {percentage}% | {value}/{total}';
-        const progressBar = new cliProgress.SingleBar({ stopOnComplete: true, format }, cliProgress.Presets.shades_classic);
-        let totalSize;
-        events.onStart((size) => {
-            console.log('Downloading Codefresh Runner installer \n');
-            progressBar.start(size, 0);
-            totalSize = size;
-        });
-        events.onProgress((progress) => {
-            progressBar.update(progress);
-            if (progress >= totalSize) {
-                console.log('\n');
-            }
-        });
-        const agentInstallStatusCode = await sdk.agents.install({
-            apiHost,
-            kubeContextName,
-            kubeNamespace,
-            token,
-            dryRun,
-            inCluster,
-            kubeNodeSelector,
-            dockerRegistry,
-            tolerations,
-            kubeConfigPath,
-            skipVersionCheck,
-            verbose,
-            agentId: name,
-            terminateProcess,
-            events,
-            logFormatting: DefaultLogFormatter,
-            envVars,
-        });
-        if (agentInstallStatusCode !== 0) {
-            throw new Error(`\nRunner installation failed with code ${agentInstallStatusCode}`);
+
+        if (!platformOnly) {
+            await installAgentInCluster(argv, token, name);
         }
+
         if (installRuntime) {
-            return installRuntimeCmd.handler({
-                'runtime-name': reName,
-                'skip-re-creation': skipRuntimeCreation,
-                'runtime-kube-context-name': kubeContextName,
-                'runtime-kube-namespace': kubeNamespace,
-                'agent-name': name,
-                'runtime-kube-config-path': kubeConfigPath,
-                'attach-runtime': true,
-                'restart-agent': true,
-                'make-default-runtime': shouldMakeDefaultRe,
-                'kube-node-selector': buildNodeSelector,
-                'storage-class-name': storageClassName,
-                'set-value': setValue,
-                'set-file': setFile,
-                'agent-kube-namespace': agentKubeNamespace,
-                'agent-kube-context-name': agentKubeContextName,
-                verbose,
-                terminateProcess,
-            });
+            await installRuntimeFunc(argv, name);
         }
+
+        console.log(token);
     },
 });
 

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

@@ -140,7 +140,7 @@ describe('root commands', () => {
         describe('Not valid yaml ', async () => {
             it('should throw error for not valid file', async () => {
                 const argv = {
-                    filenames: ['./codefresh.yml'],
+                    filenames: ['./__mocks__/codefresh.yml'],
                 };
                 const result = await validateCmd.handler(argv)
                     .catch(err => err);