@catladder/pipeline 1.87.0 → 1.89.0

package/examples/kubernetes-application-customization.ts

@@ -0,0 +1,57 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "kubernetes",
+        cluster: {
+          name: "some-cluster-name",
+          region: "europe-west6",
+          projectId: "some-project-id",
+          type: "gcloud",
+          domainCanonical: "panter.cloud",
+        },
+
+        values: {
+          application: {
+            command: "node main.js",
+            autoscale: {
+              minReplicas: 2,
+              maxReplicas: 5,
+              metrics: [
+                {
+                  type: "Resource",
+                  resource: {
+                    name: "cpu",
+
+                    target: {
+                      type: "Utilization",
+                      averageUtilization: 0.5,
+                    },
+                  },
+                },
+              ],
+            },
+            resources: {
+              limits: {
+                cpu: "1",
+                memory: "2048Mi",
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@catladder/pipeline",
-  "version": "1.87.0",
+  "version": "1.89.0",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",

package/src/build/docker.ts

@@ -45,20 +45,24 @@ export const requiresDockerBuild = (context: Context) => {
   return false;
 };
 
+const getDockerBaseVariables = () => ({
+  DOCKER_HOST: "tcp://0.0.0.0:2375",
+  DOCKER_TLS_CERTDIR: "",
+  DOCKER_DRIVER: "overlay2",
+  DOCKER_BUILDKIT: "1", // see https://docs.docker.com/develop/develop-images/build_enhancements/
+});
+
 export const getDockerBuildVariables = (context: Context) => {
   return {
     ...DOCKER_RUNNER_BUILD_VARIABLES,
-    DOCKER_BUILDKIT: "1", // see https://docs.docker.com/develop/develop-images/build_enhancements/
     DOCKERFILE_ADDITIONS:
       context.componentConfig.build.docker?.additionsBegin?.join("\n"),
     DOCKERFILE_ADDITIONS_END:
       context.componentConfig.build.docker?.additionsEnd?.join("\n"),
     APP_DIR: context.componentConfig.dir,
-    DOCKER_HOST: "tcp://0.0.0.0:2375",
-    DOCKER_TLS_CERTDIR: "",
-    DOCKER_DIR: ".", // relative to componentdir
 
-    DOCKER_DRIVER: "overlay2",
+    DOCKER_DIR: ".", // relative to componentdir
+    ...getDockerBaseVariables(),
 
     ...getDockerImageVariables(context),
   };
@@ -74,7 +78,7 @@ export const getDockerJobBaseProps = (context: Context) => {
         command: ["--tls=false"],
       },
     ],
-    variables: getDockerBuildVariables(context),
+    variables: getDockerBaseVariables(),
   };
 };
 export const createDockerBuildJobBase = (
@@ -89,6 +93,9 @@ export const createDockerBuildJobBase = (
       ...getDockerJobBaseProps(context),
       script: script || [],
     },
+    {
+      variables: getDockerBuildVariables(context),
+    },
     def
   );
 };

package/src/deploy/base.ts

@@ -44,7 +44,7 @@ export const getBaseDeploymentJob = (context: Context): JobWithoutScript => {
     name: DEPLOY_JOB_NAME,
     envMode: "stagePerEnv", // makes it easier to run manual tasks er env
 
-    needsOtherComponent: context.componentConfig.deploy
+    needs: context.componentConfig.deploy
       ? context.componentConfig.deploy.waitFor?.map((c) => ({
           componentName: c,
           job: DEPLOY_JOB_NAME,

package/src/deploy/kubernetes/kubeValues.ts

@@ -20,27 +20,29 @@ const createAppConfig = (
     };
   }
 
+  const { healthRoute, command, ...rest } = application ?? {};
+
   return mergeWithMergingArrays(
     {
       host: context.environment.host,
-      command: context.componentConfig.build.startCommand,
+      command: command ?? context.componentConfig.build.startCommand,
       livenessProbe: {
         httpGet: {
-          path: application?.healthRoute ?? "__health",
+          path: healthRoute ?? "__health",
         },
       },
       readinessProbe: {
         httpGet: {
-          path: application?.healthRoute ?? "__health",
+          path: healthRoute ?? "__health",
         },
       },
       startupProbe: {
         httpGet: {
-          path: application?.healthRoute ?? "__health",
+          path: healthRoute ?? "__health",
         },
       },
     }, // default
-    application // merge rest in
+    rest // merge rest in
   );
 };
 

package/src/deploy/types/kubernetes.ts

@@ -192,6 +192,11 @@ export type DeployConfigKubernetesValues = AllowUnknownProps<{
   application?:
     | false
     | AllowUnknownProps<{
+        /**
+         * command to start, defaults to build's startCommand
+         */
+        command?: string;
+
         /**
          * enable, disable app deployment, defaults to true
          */
@@ -240,7 +245,7 @@ export type DeployConfigKubernetesValues = AllowUnknownProps<{
          */
         jobDefaults?: {
           resources: KubernetesResourcesDef;
-        }
+        };
       }>;
 
   /**
@@ -292,5 +297,5 @@ export type DeployConfigKubernetes = {
    * Custom Helm chart location.
    * Not recommended to use.
    */
-  chartName?: string
+  chartName?: string;
 } & DeployConfigBase;

package/src/pipeline/createJobs.ts

@@ -5,7 +5,7 @@ import { DEPLOY_TYPES } from "../deploy";
 import type { PipelineJob, PipelineType } from "../types";
 import type { Config, PipelineTrigger } from "../types/config";
 import type { CommitInfo, Context } from "../types/context";
-import type { CatladderJob, CatladderJobNeed } from "../types/jobs";
+import type { CatladderJob } from "../types/jobs";
 import { notNil } from "../utils";
 import { getBaseCommitInfo } from "./commitInfo/getCommitInfo";
 import { makeGitlabJob } from "./gitlab/makeGitlabJob";
@@ -78,28 +78,25 @@ const replaceReferences = (
   const stage =
     job.envMode === "stagePerEnv" ? `${job.stage} ${env}` : job.stage;
 
-  const needsFromNeeds: CatladderJob["needs"] = job.needs?.map((n) =>
+  const cleanedNeeds: CatladderJob["needs"] = [
+    ...(job.needs ?? []),
+    // pull in legacy needs from other component, which is now identical to needs
+    ...(job.needsOtherComponent ?? []),
+  ];
+  const needs: CatladderJob["needs"] = cleanedNeeds?.map((n) =>
     isObject(n)
       ? {
-          job: getFullReferencedJobName(n.job, componentName, env, allRawJobs),
+          job: getFullReferencedJobName(
+            n.job,
+            n.componentName ?? componentName,
+            env,
+            allRawJobs
+          ),
           artifacts: n.artifacts,
         }
       : getFullReferencedJobName(n, componentName, env, allRawJobs)
   );
-  const needsFromOtherComponents: CatladderJob["needs"] =
-    job.needsOtherComponent?.map((other) => ({
-      artifacts: other.artifacts,
-      job: getFullReferencedJobName(
-        other.job,
-        other.componentName,
-        env,
-        allRawJobs
-      ),
-    }));
-  const needs = [
-    ...(needsFromNeeds ?? []),
-    ...(needsFromOtherComponents ?? []),
-  ];
+
   return {
     ...job,
     stage,

package/src/pipeline/gitlab/makeGitlabJob.ts

@@ -16,7 +16,9 @@ export const makeGitlabJob = ({
   return {
     ...rest,
     // sort in a predictable manner for snapshot tests
-    needs: needs?.sort((a, b) => getJobName(a).localeCompare(getJobName(b))),
+    needs: needs
+      ? [...needs].sort((a, b) => getJobName(a).localeCompare(getJobName(b)))
+      : undefined,
     retry: BASE_RETRY,
     interruptible: true,
   };

package/src/types/jobs.ts

@@ -19,7 +19,9 @@ export const BASE_STAGES = [
 ] as const;
 export type BaseStage = typeof BASE_STAGES[number];
 
-export type CatladderJobNeed = string | { job: string; artifacts: boolean };
+export type CatladderJobNeed =
+  | string
+  | { job: string; artifacts: boolean; componentName?: string };
 export type CatladderJob<S = BaseStage> = {
   /**
    * the name of the job (without any env or app prefix and suffix)
@@ -53,9 +55,15 @@ export type CatladderJob<S = BaseStage> = {
 
   /**
    * does this require another job (from the same component)?
+   *
+   * You can also require a job from another component if you set `componentName`
+   *
    */
   needs?: Array<CatladderJobNeed>;
 
+  /**
+   * @deprecated set `componentName` to `needs` if you want to wait for a job from another component
+   */
   needsOtherComponent?: Array<{
     componentName: string;
     job: string;