contensis-cli 1.0.0-beta.95 → 1.0.0-beta.96

package/src/mappers/DevInit-to-CIWorkflow.ts

@@ -1,13 +1,14 @@
 import inquirer from 'inquirer';
 import { JSONPath, JSONPathOptions } from 'jsonpath-plus';
+import { Document } from 'yaml';
 import {
   GitHubActionPushBlockJob,
   GitHubActionPushBlockJobStep,
+  GitLabPushBlockJobStage,
 } from '~/models/DevService';
 import { readFile } from '~/providers/file-provider';
 import ContensisDev from '~/services/ContensisDevService';
 import { diffFileContent } from '~/util/diff';
-import { GitHelper } from '~/util/git';
 import { logError } from '~/util/logger';
 import { normaliseLineEndings } from '~/util/os';
 import { parseYamlDocument, validateWorkflowYaml } from '~/util/yaml';
@@ -19,252 +20,410 @@ type MappedWorkflowOutput = {
 };
 
 export const mapCIWorkflowContent = async (
-  cli: ContensisDev,
-  git: GitHelper
+  cli: ContensisDev
 ): Promise<MappedWorkflowOutput | undefined> => {
   // get existing workflow file
-  const workflowFile = readFile(git.ciFilePath);
+  const workflowFile = readFile(cli.git.ciFilePath);
   if (!workflowFile) return undefined;
 
-  const blockId = git.name;
-  if (git.type === 'github') {
-    const addGitHubActionJobStep: GitHubActionPushBlockJobStep = {
-      name: 'Push block to Contensis',
-      id: 'push-block',
-      uses: 'contensis/block-push@v1',
-      with: {
-        'block-id': blockId,
-        // 'image-uri': '${{ steps.build.outputs.image-uri }}',
-        alias: cli.currentEnv,
-        'project-id': cli.currentProject,
-        'client-id': '${{ secrets.CONTENSIS_CLIENT_ID }}',
-        'shared-secret': '${{ secrets.CONTENSIS_SHARED_SECRET }}',
-      },
-    };
+  const blockId = cli.git.name;
 
-    // parse yaml to js
-    const workflowDoc = parseYamlDocument(workflowFile);
-    const workflowJS = workflowDoc.toJS();
-    const setWorkflowElement = (path: string | any[], value: any) => {
-      const findPath =
-        typeof path === 'string' && path.includes('.')
-          ? path
-              .split('.')
-              .map(p => (Number(p) || Number(p) !== 0 ? p : Number(p)))
-          : path;
-
-      if (workflowDoc.hasIn(findPath)) {
-        workflowDoc.setIn(findPath, value);
-      } else {
-        workflowDoc.addIn(findPath, value);
-        // }
-      }
+  // parse yaml to js
+  const workflowDoc = parseYamlDocument(workflowFile);
+  const workflowJS = workflowDoc.toJS();
+
+  if (cli.git.type === 'github') {
+    const newWorkflow = await mapGitHubActionCIWorkflowContent(
+      cli,
+      blockId,
+      workflowDoc,
+      workflowJS
+    );
+    return {
+      existingWorkflow: workflowFile,
+      newWorkflow,
+      diff: diffFileContent(workflowFile, newWorkflow),
     };
-    const findExistingJobSteps = (
-      path: string,
-      resultType: JSONPathOptions['resultType']
-    ) => {
-      const existingJobStep = JSONPath({
-        path,
-        json: workflowJS,
-        resultType: resultType,
-      });
-
-      return existingJobStep;
+  } else if (cli.git.type === 'gitlab') {
+    const newWorkflow = await mapGitLabCIWorkflowContent(
+      cli,
+      blockId,
+      workflowDoc,
+      workflowJS
+    );
+    return {
+      existingWorkflow: workflowFile,
+      newWorkflow,
+      diff: diffFileContent(workflowFile, newWorkflow),
     };
+  }
+};
 
-    // look for line in job
-    //   jobs.x.steps[uses: contensis/block-push]
-    const existingJobStep = findExistingJobSteps(
-      git.type === 'github'
-        ? '$.jobs..steps.*[?(@property === "uses" && @.match(/^contensis\\/block-push/i))]^'
-        : // TODO: add jsonpath for gitlab file
-          '',
-      'all'
+const findExistingJobSteps = (
+  path: string,
+  json: any,
+  resultType: JSONPathOptions['resultType']
+) => {
+  const existingJobStep = JSONPath({
+    path,
+    json,
+    resultType: resultType,
+  });
+
+  return existingJobStep;
+};
+
+const setWorkflowElement = (
+  workflowDoc: Document,
+  path: string | any[],
+  value: any
+) => {
+  const findPath =
+    typeof path === 'string' && path.includes('.')
+      ? path.split('.').map(p => (Number(p) || Number(p) !== 0 ? p : Number(p)))
+      : path;
+
+  if (workflowDoc.hasIn(findPath)) {
+    workflowDoc.setIn(findPath, value);
+  } else {
+    workflowDoc.addIn(findPath, value);
+  }
+};
+
+const mapGitLabCIWorkflowContent = async (
+  cli: ContensisDev,
+  blockId: string,
+  workflowDoc: Document,
+  workflowJS: any
+) => {
+  const addGitLabJobStage: GitLabPushBlockJobStage = {
+    stage: 'push-block',
+    variables: {
+      block_id: blockId,
+      alias: cli.currentEnv,
+      project_id: cli.currentProject,
+      client_id: '$CONTENSIS_CLIENT_ID',
+      shared_secret: '$CONTENSIS_SHARED_SECRET',
+    },
+  };
+
+  const addAppImageUri = async () => {
+    // Look in document level "variables"
+    const appImageUri = await determineAppImageUri(
+      cli,
+      Object.entries(workflowJS.variables || {}),
+      '$CI_REGISTRY_IMAGE/$CI_COMMIT_REF_NAME/app:build-$CI_PIPELINE_IID'
     );
 
-    const addAppImageUri = async () => {
-      // Look in document level "env" vars
-      const appImageUri = await determineAppImageUri(
-        cli,
-        Object.entries(workflowJS.env || {})
+    if (appImageUri.addVar)
+      setWorkflowElement(
+        workflowDoc,
+        `variables.${appImageUri.var}`,
+        appImageUri.uri
       );
 
-      if (appImageUri.addVar)
-        setWorkflowElement(`env.${appImageUri.var}`, appImageUri.uri);
-      // workflowDoc.addIn(['env'], { [appImageUri.var]: appImageUri.uri });
+    if (appImageUri.var)
+      addGitLabJobStage.variables['image_uri'] = `\$${appImageUri.var}`;
+  };
 
-      if (appImageUri.var)
-        addGitHubActionJobStep.with[
-          'image-uri'
-        ] = `\${{ env.${appImageUri.var} }}`;
-    };
+  // look for line in job
+  //   jobname[stage: push-block]
+  const existingJobStep = findExistingJobSteps(
+    '$..[?(@property === "stage" && @.match(/^push-block/i))]^',
+    workflowJS,
+    'all'
+  );
 
-    // update job step
-    if (existingJobStep.length) {
-      //cli.log.json(existingJobStep);
+  // update job step
+  if (existingJobStep.length) {
+    // cli.log.json(existingJobStep);
+
+    // The [0] index means we're only looking at updating the first instance in the file
+    const step = existingJobStep[0];
+
+    // Path looks like this "$['job_name']"
+    // We want it to look like this "job_name"
+    const stepPath = step.path
+      .replace('$[', '')
+      .replaceAll('][', '.')
+      .replace(']', '')
+      .replaceAll("'", '');
+
+    cli.log.info(
+      `Found existing Job step:
+          ${stepPath}
+            stage: ${step.value.stage}\n`
+    );
 
-      // The [0] index means we're only looking at updating the first instance in the file
-      const step = existingJobStep[0];
+    setWorkflowElement(
+      workflowDoc,
+      `${stepPath}.variables.alias`,
+      cli.currentEnv
+    );
+    setWorkflowElement(
+      workflowDoc,
+      `${stepPath}.variables.project_id`,
+      cli.currentProject
+    );
+    setWorkflowElement(workflowDoc, `${stepPath}.variables.block_id`, blockId);
 
-      // Path looks like this "$['jobs']['build']['steps'][3]"
-      // We want it to look like this "jobs.build.steps.3"
-      const stepPath = step.path
-        .replace('$[', '')
-        .replaceAll('][', '.')
-        .replace(']', '')
-        .replaceAll("'", '');
+    // This is likely not needed when updating an existing push-block job step
+    // we are assuming this is a forked/copied workflow with an already working image-uri reference
+    // await addAppImageUri();
 
-      cli.log.info(
-        `Found existing Job step: ${stepPath}
-          - name: ${step.value.name}
-            id: ${step.value.id}\n`
-      );
+    setWorkflowElement(
+      workflowDoc,
+      `${stepPath}.variables.client_id`,
+      '$CONTENSIS_CLIENT_ID'
+    );
+    setWorkflowElement(
+      workflowDoc,
+      `${stepPath}.variables.shared_secret`,
+      '$CONTENSIS_SHARED_SECRET'
+    );
+  } else {
+    // create job with push step
+
+    // Does a series of checks and prompts to determine the correct image-uri
+    // for the app container build
+    await addAppImageUri();
+
+    // Add the new "job" to the Yaml Document
+    workflowDoc.addIn(['stages'], 'push-block');
+    workflowDoc.addIn([], {
+      key: 'push-to-contensis',
+      value: addGitLabJobStage,
+    });
+    setWorkflowElement(
+      workflowDoc,
+      `include`,
+      'https://gitlab.zengenti.com/ops/contensis-ci/-/raw/main/push-block.yml'
+    );
+  }
 
-      setWorkflowElement(`${stepPath}.with.alias`, cli.currentEnv);
-      setWorkflowElement(`${stepPath}.with.project-id`, cli.currentProject);
-      setWorkflowElement(`${stepPath}.with.block-id`, blockId);
+  cli.log.debug(`New file content to write\n\n${workflowDoc}`);
 
-      // This is likely not needed when updating an existing push-block job step
-      // we are assuming this is a forked/copied workflow with an already working image-uri reference
-      // await addAppImageUri();
+  const newWorkflow = normaliseLineEndings(
+    workflowDoc.toString({ lineWidth: 0 })
+  );
 
+  return newWorkflow;
+};
+
+const mapGitHubActionCIWorkflowContent = async (
+  cli: ContensisDev,
+  blockId: string,
+  workflowDoc: Document,
+  workflowJS: any
+) => {
+  const addGitHubActionJobStep: GitHubActionPushBlockJobStep = {
+    name: 'Push block to Contensis',
+    id: 'push-block',
+    uses: 'contensis/block-push@v1',
+    with: {
+      'block-id': blockId,
+      // 'image-uri': '${{ steps.build.outputs.image-uri }}',
+      alias: cli.currentEnv,
+      'project-id': cli.currentProject,
+      'client-id': '${{ secrets.CONTENSIS_CLIENT_ID }}',
+      'shared-secret': '${{ secrets.CONTENSIS_SHARED_SECRET }}',
+    },
+  };
+
+  const addAppImageUri = async () => {
+    // Look in document level "env" vars
+    const appImageUri = await determineAppImageUri(
+      cli,
+      Object.entries(workflowJS.env || {}),
+      'ghcr.io/${{ github.repository }}/${{ github.ref_name }}/app:build-${{ github.run_number }}'
+    );
+
+    if (appImageUri.addVar)
       setWorkflowElement(
-        `${stepPath}.with.client-id`,
-        '${{ secrets.CONTENSIS_CLIENT_ID }}'
-      );
-      setWorkflowElement(
-        `${stepPath}.with.shared-secret`,
-        '${{ secrets.CONTENSIS_SHARED_SECRET }}'
+        workflowDoc,
+        `env.${appImageUri.var}`,
+        appImageUri.uri
       );
-    } else {
-      // create job with push step
-
-      // is there already a job with a property name containing "build"?
-      const existingBuildJobStep = findExistingJobSteps(
-        git.type === 'github'
-          ? '$.jobs[?(@property.match(/build/i))]'
-          : // TODO: add jsonpath for gitlab file
-            '',
-        'all'
-      ) as JSONPathOptions[]; // This isn't the correct type for this object
-
-      let needs: string | undefined;
-      // There are multiple jobs called *build*
-      if (existingBuildJobStep.length > 1) {
-        // prompt which build job we should depend on before pushing the block
-        const choices = existingBuildJobStep.map(s => s.parentProperty);
-        choices.push(new inquirer.Separator() as any);
-        choices.push('none');
-
-        ({ needs } = await inquirer.prompt([
-          {
-            type: 'list',
-            prefix: '⌛',
-            message: cli.messages.devinit.ciMultipleBuildJobChoices(),
-            name: 'needs',
-            choices,
-            default: choices.find(
-              s => typeof s === 'string' && s.includes('docker')
-            ),
-          },
-        ]));
-        cli.log.raw('');
-      } else if (existingBuildJobStep.length === 1)
-        // Exactly one job step found containing a property name of *build*
-        // we'll assume that is the one the push-block job depends on
-        needs = existingBuildJobStep[0].parentProperty;
-
-      if (existingBuildJobStep.length === 0 || needs === 'none') {
-        // No existing build step found or chosen, offer all job steps in prompt
-        const choices = Object.keys(workflowJS.jobs);
-        choices.push(new inquirer.Separator() as any);
-        choices.push('none');
-
-        ({ needs } = await inquirer.prompt([
-          {
-            type: 'list',
-            prefix: '⌛',
-            message: cli.messages.devinit.ciMultipleJobChoices(),
-            name: 'needs',
-            choices,
-            default: choices.find(
-              j => typeof j === 'string' && j.includes('docker')
-            ),
-          },
-        ]));
-        if (needs === 'none') needs = undefined;
-        cli.log.raw('');
-      }
-
-      // Does a series of checks and prompts to determine the correct image-uri
-      // for the app container build
-      await addAppImageUri();
-
-      const newJob: GitHubActionPushBlockJob = {
-        name: 'Deploy container image to Contensis',
-        'runs-on': 'ubuntu-latest',
-        needs,
-        steps: [addGitHubActionJobStep],
-      };
-
-      // Add the new "job" to the Yaml Document
-      workflowDoc.addIn(['jobs'], {
-        key: 'deploy',
-        value: newJob,
-      });
-    }
+    // workflowDoc.addIn(['env'], { [appImageUri.var]: appImageUri.uri });
 
-    // Workflow validation provided by @action-validator/core package
-    const workflowIsValid = validateWorkflowYaml(workflowDoc.toString());
+    if (appImageUri.var)
+      addGitHubActionJobStep.with[
+        'image-uri'
+      ] = `\${{ env.${appImageUri.var} }}`;
+  };
 
-    // We could expand validation to check for having a build step to wait for
-    // or if a valid image-uri attribute is set
-    if (workflowIsValid === true) {
-      cli.log.success(`GitHub workflow YAML is valid`);
-      cli.log.debug(
-        `New file content to write to ${git.ciFilePath}\n\n${workflowDoc}`
-      );
-    } else if (Array.isArray(workflowIsValid)) {
-      // Errors
-      logError(
-        [
-          ...workflowIsValid.map(
-            res => new Error(`${res.code}: ${res.detail || res.title}`)
+  // look for line in job
+  //   jobs.x.steps[uses: contensis/block-push]
+  const existingJobStep = findExistingJobSteps(
+    '$.jobs..steps.*[?(@property === "uses" && @.match(/^contensis\\/block-push/i))]^',
+    workflowJS,
+    'all'
+  );
+
+  // update job step
+  if (existingJobStep.length) {
+    //cli.log.json(existingJobStep);
+
+    // The [0] index means we're only looking at updating the first instance in the file
+    const step = existingJobStep[0];
+
+    // Path looks like this "$['jobs']['build']['steps'][3]"
+    // We want it to look like this "jobs.build.steps.3"
+    const stepPath = step.path
+      .replace('$[', '')
+      .replaceAll('][', '.')
+      .replace(']', '')
+      .replaceAll("'", '');
+
+    cli.log.info(
+      `Found existing Job step: ${stepPath}
+          - name: ${step.value.name}
+            id: ${step.value.id}\n`
+    );
+
+    setWorkflowElement(workflowDoc, `${stepPath}.with.alias`, cli.currentEnv);
+    setWorkflowElement(
+      workflowDoc,
+      `${stepPath}.with.project-id`,
+      cli.currentProject
+    );
+    setWorkflowElement(workflowDoc, `${stepPath}.with.block-id`, blockId);
+
+    // This is likely not needed when updating an existing push-block job step
+    // we are assuming this is a forked/copied workflow with an already working image-uri reference
+    // await addAppImageUri();
+
+    setWorkflowElement(
+      workflowDoc,
+      `${stepPath}.with.client-id`,
+      '${{ secrets.CONTENSIS_CLIENT_ID }}'
+    );
+    setWorkflowElement(
+      workflowDoc,
+      `${stepPath}.with.shared-secret`,
+      '${{ secrets.CONTENSIS_SHARED_SECRET }}'
+    );
+  } else {
+    // create job with push step
+
+    // is there already a job with a property name containing "build"?
+    const existingBuildJobStep = findExistingJobSteps(
+      '$.jobs[?(@property.match(/build/i))]',
+      workflowJS,
+      'all'
+    ) as JSONPathOptions[]; // This isn't the correct type for this object
+
+    let needs: string | undefined;
+    // There are multiple jobs called *build*
+    if (existingBuildJobStep.length > 1) {
+      // prompt which build job we should depend on before pushing the block
+      const choices = existingBuildJobStep.map(s => s.parentProperty);
+      choices.push(new inquirer.Separator() as any);
+      choices.push('none');
+
+      ({ needs } = await inquirer.prompt([
+        {
+          type: 'list',
+          prefix: '⌛',
+          message: cli.messages.devinit.ciMultipleBuildJobChoices(),
+          name: 'needs',
+          choices,
+          default: choices.find(
+            s => typeof s === 'string' && s.includes('docker')
           ),
-          workflowDoc.toString(),
-        ],
-        `GitHub workflow YAML did not pass validation check`
-      );
+        },
+      ]));
+      cli.log.raw('');
+    } else if (existingBuildJobStep.length === 1)
+      // Exactly one job step found containing a property name of *build*
+      // we'll assume that is the one the push-block job depends on
+      needs = existingBuildJobStep[0].parentProperty;
+
+    if (existingBuildJobStep.length === 0 || needs === 'none') {
+      // No existing build step found or chosen, offer all job steps in prompt
+      const choices = Object.keys(workflowJS.jobs);
+      choices.push(new inquirer.Separator() as any);
+      choices.push('none');
+
+      ({ needs } = await inquirer.prompt([
+        {
+          type: 'list',
+          prefix: '⌛',
+          message: cli.messages.devinit.ciMultipleJobChoices(),
+          name: 'needs',
+          choices,
+          default: choices.find(
+            j => typeof j === 'string' && j.includes('docker')
+          ),
+        },
+      ]));
+      if (needs === 'none') needs = undefined;
+      cli.log.raw('');
     }
-    const newWorkflow = normaliseLineEndings(
-      workflowDoc.toString({ lineWidth: 0 })
-    );
 
-    return {
-      existingWorkflow: workflowFile,
-      newWorkflow,
-      diff: diffFileContent(workflowFile, newWorkflow),
+    // Does a series of checks and prompts to determine the correct image-uri
+    // for the app container build
+    await addAppImageUri();
+
+    const newJob: GitHubActionPushBlockJob = {
+      name: 'Deploy container image to Contensis',
+      'runs-on': 'ubuntu-latest',
+      needs,
+      steps: [addGitHubActionJobStep],
     };
+
+    // Add the new "job" to the Yaml Document
+    workflowDoc.addIn(['jobs'], {
+      key: 'deploy',
+      value: newJob,
+    });
+  }
+
+  // Workflow validation provided by @action-validator/core package
+  const workflowIsValid = validateWorkflowYaml(workflowDoc.toString());
+
+  // We could expand validation to check for having a build step to wait for
+  // or if a valid image-uri attribute is set
+  if (workflowIsValid === true) {
+    cli.log.success(`GitHub workflow YAML is valid`);
+    cli.log.debug(`New file content to write\n\n${workflowDoc}`);
+  } else if (Array.isArray(workflowIsValid)) {
+    // Errors
+    logError(
+      [
+        ...workflowIsValid.map(
+          res => new Error(`${res.code}: ${res.detail || res.title}`)
+        ),
+        workflowDoc.toString(),
+      ],
+      `GitHub workflow YAML did not pass validation check`
+    );
   }
+  const newWorkflow = normaliseLineEndings(
+    workflowDoc.toString({ lineWidth: 0 })
+  );
+
+  return newWorkflow;
 };
 
 const determineAppImageUri = async (
   cli: ContensisDev,
-  vars: [string, string][]
+  vars: [string, string][],
+  defaultUri: string
 ) => {
   // Determine container image-uri via variables and/or prompts
 
   // Find vars including the word "image"
-  const imageVars = vars.filter(([varname, value]) =>
+  const imageVars = vars.filter(([varname]) =>
     varname.toLowerCase().includes('image')
   );
   // Find vars named "image" that include the word "app"
   const appImageVars = imageVars.filter(
     ([varname, value]) =>
-      varname.toLowerCase().includes('app_') ||
-      varname.toLowerCase().includes('build_') ||
-      value?.toLowerCase().includes('/app')
+      !varname.toLowerCase().includes('builder_') &&
+      (varname.toLowerCase().includes('app_') ||
+        varname.toLowerCase().includes('build_') ||
+        value?.toLowerCase().includes('/app'))
   );
 
   const appImageUriGuess = appImageVars?.[0];
@@ -286,8 +445,7 @@ const determineAppImageUri = async (
     // prompt for an app image uri
     const choices = vars.map(v => v[0]);
     const enterOwnMsg = 'enter my own / use default';
-    const defaultUri =
-      'ghcr.io/${{ github.repository }}/${{ github.ref_name }}/app:build-${{ github.run_number }}';
+
     choices.push(new inquirer.Separator() as any);
     choices.push(enterOwnMsg);
     choices.push(defaultUri);
@@ -312,7 +470,7 @@ const determineAppImageUri = async (
           return [enterOwnMsg, defaultUri].includes(answers.appImageVar);
         },
         prefix: `\n \n🔗`,
-        message: cli.messages.devinit.ciEnterOwnAppImagePrompt(),
+        message: cli.messages.devinit.ciEnterOwnAppImagePrompt(cli.git),
         name: 'appImageUri',
         default: defaultUri,
       },
@@ -326,7 +484,13 @@ const determineAppImageUri = async (
       appImageVar = undefined;
   }
 
-  if (appImageVar) appImageUri = `\${{ env.${appImageVar} }}`;
+  if (appImageVar)
+    appImageUri =
+      cli.git.type === 'github'
+        ? `\${{ env.${appImageVar} }}`
+        : `\$${appImageVar}`;
+
+  // TODO: prompt further for image tag
 
   return {
     addVar: !appImageVar,

package/src/models/DevService.d.ts

@@ -24,3 +24,15 @@ export type GitHubActionPushBlockJob = {
   needs?: string;
   steps: GitHubActionPushBlockJobStep[];
 };
+
+export type GitLabPushBlockJobStage = {
+  stage: string;
+  variables: {
+    alias: string;
+    project_id: string;
+    block_id: string;
+    image_uri?: string;
+    client_id: string;
+    shared_secret: string;
+  };
+};