@catladder/pipeline 3.29.1 → 3.30.1

package/examples/cloud-run-with-sql.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./cloud-run-with-sql";
 

package/examples/cloud-run-with-worker.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./cloud-run-with-worker";
 

package/examples/custom-build-job-with-tests.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./custom-build-job-with-tests";
 

package/examples/custom-build-job.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./custom-build-job";
 

package/examples/custom-deploy.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./custom-deploy";
 

package/examples/custom-envs.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./custom-envs";
 

package/examples/custom-sbom-java.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./custom-sbom-java";
 

package/examples/custom-verify-job.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./custom-verify-job";
 

package/examples/git-submodule.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./git-submodule";
 

package/examples/kubernetes-application-customization.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./kubernetes-application-customization";
 

package/examples/kubernetes-with-cloud-sql.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./kubernetes-with-cloud-sql";
 

package/examples/kubernetes-with-jobs.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./kubernetes-with-jobs";
 

package/examples/kubernetes-with-mongodb.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./kubernetes-with-mongodb";
 

package/examples/local-dot-env.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./local-dot-env";
 

package/examples/meteor-kubernetes.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./meteor-kubernetes";
 

package/examples/modify-generated-files.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./modify-generated-files";
 

package/examples/modify-generated-yaml.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./modify-generated-yaml";
 

package/examples/multiline-var.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./multiline-var";
 

package/examples/native-app.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./native-app";
 

package/examples/node-build-with-custom-image.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./node-build-with-custom-image";
 

package/examples/node-build-with-docker-additions.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./node-build-with-docker-additions";
 

package/examples/override-secrets.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./override-secrets";
 

package/examples/rails-k8s-with-worker.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./rails-k8s-with-worker";
 

package/examples/referencing-other-vars.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./referencing-other-vars";
 

package/examples/wait-for-other-deploy.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./wait-for-other-deploy";
 

package/examples/workspace-api-www-turbo-cache.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./workspace-api-www-turbo-cache";
 

package/examples/workspace-api-www.test.ts

@@ -1,3 +1,4 @@
+import { it, expect } from "vitest";
 import { createYamlLocalPipeline } from "./__utils__/helpers";
 import config from "./workspace-api-www";
 

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "3.29.1",
+  "version": "3.30.1",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables",
@@ -73,9 +73,7 @@
     "@babel/core": "^7.25.2",
     "@babel/plugin-syntax-typescript": "^7.25.4",
     "@babel/preset-typescript": "^7.24.7",
-    "@jest/globals": "^29.7.0",
     "@types/child-process-promise": "^2.2.6",
-    "@types/jest": "^29.5.12",
     "@types/lodash": "^4.17.7",
     "@types/node": "^22.5.1",
     "babel-plugin-transform-inline-environment-variables": "^0.4.3",

package/scripts/generate-examples-test.ts

@@ -56,6 +56,7 @@ async function main() {
     exampleFiles.map(async (exampleFile) => {
       const kebabName = basename(exampleFile, ".ts");
       const testFileContent = [
+        `import { it, expect } from "vitest";`,
         `import { createYamlLocalPipeline } from "./__utils__/helpers";`,
         `import config from "./${kebabName}";`,
         `\n/**`,

package/src/build/base/__tests__/__snapshots__/createArtifactsConfig.test.ts.snap

@@ -1,6 +1,6 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`createArtifactsConfig merges junit files if both given 1`] = `
+exports[`createArtifactsConfig > merges junit files if both given 1`] = `
 {
   "artifacts": {
     "paths": [
@@ -17,7 +17,7 @@ exports[`createArtifactsConfig merges junit files if both given 1`] = `
 }
 `;
 
-exports[`createArtifactsConfig returns artifacts if no artifactsReports 1`] = `
+exports[`createArtifactsConfig > returns artifacts if no artifactsReports 1`] = `
 {
   "artifacts": {
     "paths": [
@@ -35,7 +35,7 @@ exports[`createArtifactsConfig returns artifacts if no artifactsReports 1`] = `
 }
 `;
 
-exports[`createArtifactsConfig returns junit parts of artifactsReports 1`] = `
+exports[`createArtifactsConfig > returns junit parts of artifactsReports 1`] = `
 {
   "artifacts": {
     "paths": [],

package/src/build/base/__tests__/createArtifactsConfig.test.ts

@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import { createArtifactsConfig } from "../createArtifactsConfig";
 
 describe("createArtifactsConfig", () => {

package/src/build/custom/__tests__/testJob.test.ts

@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import type { BuildContextStandalone, ComponentContext } from "../../..";
 import { createCustomTestJobs } from "../testJob";
 

package/src/build/rails/index.ts

@@ -1,7 +1,7 @@
 import type { ComponentContextWithBuild } from "../../types";
 import type { CatladderJob } from "../../types/jobs";
 import { createRailsBuildJobs } from "./build";
-import { createRailsTestJobs } from "./test";
+import { createRailsTestJobs } from "./testJob";
 
 export const createRailsJobs = (
   context: ComponentContextWithBuild,

package/src/config/__tests__/__snapshots__/getAllEnvs.test.ts.snap

@@ -1,6 +1,6 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`getAllEnvs() should return all envs for app1 1`] = `
+exports[`getAllEnvs() > should return all envs for app1 1`] = `
 [
   "dev",
   "review",
@@ -10,7 +10,7 @@ exports[`getAllEnvs() should return all envs for app1 1`] = `
 ]
 `;
 
-exports[`getAllEnvs() should return all envs for app2 1`] = `
+exports[`getAllEnvs() > should return all envs for app2 1`] = `
 [
   "dev",
   "review",
@@ -24,7 +24,7 @@ exports[`getAllEnvs() should return all envs for app2 1`] = `
 ]
 `;
 
-exports[`getAllEnvs() should return all envs for app3 1`] = `
+exports[`getAllEnvs() > should return all envs for app3 1`] = `
 [
   "local",
 ]

package/src/config/__tests__/__snapshots__/getAllEnvsInAllComponents.test.ts.snap

@@ -1,6 +1,6 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`getAllEnvsInAllComponents() should return all envs for SIMPLE_CONFIG1 1`] = `
+exports[`getAllEnvsInAllComponents() > should return all envs for SIMPLE_CONFIG1 1`] = `
 [
   "dev",
   "review",

package/src/config/__tests__/configruedEnvs.test.ts

@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import { getAllEnvsByTrigger } from "..";
 import type { DeployConfigKubernetesCluster } from "../..";
 import type { Config } from "../../types";

package/src/config/__tests__/getAllEnvs.test.ts

@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import { type DeployConfigKubernetesCluster } from "../..";
 import type { Config } from "../../types";
 import { getAllEnvs } from "../configruedEnvs";

package/src/config/__tests__/getAllEnvsInAllComponents.test.ts

@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import { type DeployConfigKubernetesCluster } from "../..";
 import type { Config } from "../../types";
 import { getAllEnvsInAllComponents } from "../configruedEnvs";

package/src/deploy/cloudRun/createJobs/execute/onDeploy.ts

@@ -1,10 +1,8 @@
 import type { StringOrBashExpression } from "../../../../bash";
 import type { ComponentContext } from "../../../../types/context";
-import type {
-  DeployConfigCloudRunExecuteOnDeploy,
-  DeployConfigCloudRunJob,
-  DeployConfigCloudRunService,
-} from "../../../types/googleCloudRun";
+import { ensureArray } from "../../../../utils";
+import type { DeployConfigBaseExecuteOnDeploy } from "../../../types/executeBase";
+import type { DeployConfigCloudRunExecuteOnDeploy } from "../../../types/googleCloudRun";
 import { createArgsString } from "../../utils/createArgsString";
 import { getCloudRunServiceOrJobArgsArg } from "../../utils/getJobOrServiceArgs";
 import { getFullJobName } from "../../utils/jobName";
@@ -17,7 +15,7 @@ import {
 
 type Execute = {
   jobName: StringOrBashExpression;
-  config: DeployConfigCloudRunExecuteOnDeploy;
+  config: DeployConfigCloudRunExecuteOnDeploy | DeployConfigBaseExecuteOnDeploy;
 };
 export const getOnDeployExecuteScript = (
   context: ComponentContext,
@@ -27,7 +25,7 @@ export const getOnDeployExecuteScript = (
 
   return executes
     .filter(({ config }) => config.when === when)
-    .map((execute) => {
+    .flatMap((execute) => {
       return getJobRunScriptForExecute(context, execute);
     });
 };
@@ -37,7 +35,8 @@ const getExecutes = (context: ComponentContext): Execute[] => {
   return [
     ...getLegacyExecutes(context),
     ...Object.entries(deployConfig.execute ?? {}).flatMap(([key, value]) => {
-      if (!value || (value.when !== "schedule" && value.type !== "job")) {
+      // remove all schedule executes
+      if (!value) {
         return [];
       }
       return [
@@ -81,22 +80,30 @@ const getLegacyExecutes = (context: ComponentContext): Execute[] => {
 const getJobRunScriptForExecute = (
   context: ComponentContext,
   { jobName, config }: Execute,
-) => {
-  const commonArgs = getCommonCloudRunArgs(context);
+): string[] => {
+  const type = config.type;
+  if (type === "script") {
+    return ensureArray(config.script);
+  } else if (type === "job") {
+    const commonArgs = getCommonCloudRunArgs(context);
 
-  // always wait for completion for preStop and postStop jobs
-  // since stop will delete the jobs afterwards, so they will fail
-  const waitForCompletion = ["preStop", "postStop"].includes(config.when)
-    ? true // always
-    : "waitForCompletion" in config
-      ? (config.waitForCompletion ?? false) // depends on config
-      : false;
+    // always wait for completion for preStop and postStop jobs
+    // since stop will delete the jobs afterwards, so they will fail
+    const waitForCompletion = ["preStop", "postStop"].includes(config.when)
+      ? true // always
+      : "waitForCompletion" in config
+        ? (config.waitForCompletion ?? false) // depends on config
+        : false;
 
-  const argString = createArgsString({
-    ...commonArgs,
-    wait: waitForCompletion === true ? true : undefined,
-    args: getCloudRunServiceOrJobArgsArg(config.args),
-  });
-  const fullJobName = getFullJobName(context, jobName);
-  return `${gcloudRunCmd()} jobs execute ${fullJobName.toString()} ${argString}`;
+    const argString = createArgsString({
+      ...commonArgs,
+      wait: waitForCompletion === true ? true : undefined,
+      args: getCloudRunServiceOrJobArgsArg(config.args),
+    });
+    const fullJobName = getFullJobName(context, jobName);
+    return [
+      `${gcloudRunCmd()} jobs execute ${fullJobName.toString()} ${argString}`,
+    ];
+  }
+  throw new Error(`unsupported execute type: ${type}`);
 };

package/src/deploy/types/base.ts

@@ -1,4 +1,5 @@
 import type { EnvVars } from "../../types/config";
+import type { DeployConfigBaseExecute } from "./executeBase";
 
 export type DeployConfigBase = {
   /**

package/src/deploy/types/executeBase.ts

@@ -0,0 +1,27 @@
+type DeployConfigBaseExecuteScript = {
+  type: "script";
+  script: string | string[];
+};
+/**
+ * currently only supported for cloud run deployments
+ */
+export type DeployConfigBaseExecuteOnDeploy = DeployConfigBaseExecuteScript &
+  (
+    | {
+        /**
+         * run the job before or after the deploy
+         */
+        when: "preDeploy" | "postDeploy";
+        /**
+         * whether to wait for completion of the job
+         */
+        waitForCompletion?: boolean;
+      }
+    | {
+        /**
+         * run the job before or after the environment is stopped
+         */
+        when: "preStop" | "postStop";
+      }
+  );
+export type DeployConfigBaseExecute = DeployConfigBaseExecuteOnDeploy;

package/src/deploy/types/googleCloudRun.ts

@@ -1,5 +1,9 @@
 import type { DBVariablesMode } from "../cloudRun/utils/database";
 import type { DeployConfigBase } from "./base";
+import type {
+  DeployConfigBaseExecute,
+  DeployConfigBaseExecuteOnDeploy,
+} from "./executeBase";
 
 export type Gcloudregion =
   | "asia-east1"
@@ -424,7 +428,7 @@ export type DeployConfigCloudRunJob =
   | DeployConfigCloudRunJobNormal
   | DeployConfigCloudRunJobWithSchedule;
 
-export type DeployConfigCloudRun = {
+export type DeployConfigCloudRun = Omit<DeployConfigBase, "execute"> & {
   /**
    * cloud run deployment.
    *
@@ -469,7 +473,7 @@ export type DeployConfigCloudRun = {
   execute?: Record<string, DeployConfigCloudRunExecute | null>;
 
   debug?: boolean;
-} & DeployConfigBase;
+};
 
 export type DeployConfigCloudRunVolumes = Record<
   string,
@@ -543,6 +547,7 @@ export type DeployConfigCloudRunExecuteOnDeploy =
     );
 
 export type DeployConfigCloudRunExecuteJob =
+  | DeployConfigBaseExecute
   | DeployConfigCloudRunExecuteJobScheduled
   | DeployConfigCloudRunExecuteOnDeploy;
 
@@ -573,6 +578,7 @@ export type DeployConfigCloudRunExecuteHttp = {
 } & WithSchedule;
 
 export type DeployConfigCloudRunExecute =
+  | DeployConfigBaseExecute
   | DeployConfigCloudRunExecuteJob
   | DeployConfigCloudRunExecuteHttp;
 

package/src/pipeline/__tests__/__snapshots__/getPipelineStages.test.ts.snap

@@ -1,6 +1,6 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`getPipelineStages() should return all envs for SIMPLE_CONFIG1 1`] = `
+exports[`getPipelineStages() > should return all envs for SIMPLE_CONFIG1 1`] = `
 [
   "setup",
   "setup dev",

package/src/pipeline/__tests__/getPipelineStages.test.ts

@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import { type DeployConfigKubernetesCluster } from "../..";
 import type { Config } from "../../types";
 import { getPipelineStages } from "../getPipelineStages";

package/src/variables/__tests__/resolveAllReferences.test.ts

@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import {
   VariableValueContainingReferences,
   createVariableValueContainingReferencesFromString,

package/src/variables/__tests__/resolveAllReferencesOnce.test.ts

@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import {
   VariableReference,
   VariableValueContainingReferences,

package/src/variables/__tests__/resolveReferencesOnce.test.ts

@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import {
   UnresolvableReference,
   VariableReference,

package/src/variables/__tests__/variableValue.test.ts

@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import {
   VariableReference,
   createVariableValueContainingReferencesFromString,

package/tsconfig.json

@@ -10,5 +10,6 @@
     "esModuleInterop": true,
     "incremental": true
   },
-  "include": ["./src", "tests"]
+  "include": ["./src"],
+  "exclude": ["**/__tests__", "**/*.test.ts", "**/*.test.tsx"]
 }

package/dist/build/base/__tests__/createArtifactsConfig.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/build/base/__tests__/createArtifactsConfig.test.js

@@ -1,42 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var createArtifactsConfig_1 = require("../createArtifactsConfig");
-describe("createArtifactsConfig", function () {
-  it("returns undefined if no artifacts or artifactsReports", function () {
-    expect((0, createArtifactsConfig_1.createArtifactsConfig)(".")).toBeUndefined();
-  });
-  it("returns artifacts if no artifactsReports", function () {
-    expect((0, createArtifactsConfig_1.createArtifactsConfig)(".", undefined, {
-      paths: ["testpath"],
-      reports: {
-        coverage_report: {
-          coverage_format: "cobertura",
-          path: "some"
-        },
-        terraform: "something"
-      }
-    })).toMatchSnapshot();
-  });
-  it("returns junit parts of artifactsReports", function () {
-    expect((0, createArtifactsConfig_1.createArtifactsConfig)(".", {
-      junit: ["report.xml"]
-    })).toMatchSnapshot();
-  });
-  it("merges junit files if both given", function () {
-    var _a, _b;
-    var result = (0, createArtifactsConfig_1.createArtifactsConfig)(".", {
-      junit: ["partial-report.xml"]
-    }, {
-      paths: ["testpath"],
-      reports: {
-        junit: "full-report.xml",
-        terraform: "something"
-      }
-    });
-    expect(result).toMatchSnapshot();
-    expect((_b = (_a = result === null || result === void 0 ? void 0 : result.artifacts) === null || _a === void 0 ? void 0 : _a.reports) === null || _b === void 0 ? void 0 : _b.junit).toHaveLength(2);
-  });
-});

package/dist/build/custom/__tests__/testJob.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/build/custom/__tests__/testJob.test.js

@@ -1,36 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var testJob_1 = require("../testJob");
-describe("createCustomTestJobs", function () {
-  var baseContext = {
-    name: "testComponent",
-    environment: {
-      jobOnlyVars: {
-        build: {}
-      }
-    },
-    build: {
-      config: {
-        type: "custom",
-        docker: {
-          type: "custom"
-        },
-        jobImage: ""
-      }
-    }
-  };
-  it("throws error when not build type custom", function () {
-    baseContext.build.config.type = "node";
-    expect(function () {
-      return (0, testJob_1.createCustomTestJobs)(baseContext);
-    }).toThrowError("deploy config is not custom");
-    baseContext.build.config.type = "custom";
-  });
-  it("returns empty array if no audit, lint, and test definition", function () {
-    var jobs = (0, testJob_1.createCustomTestJobs)(baseContext);
-    expect(jobs).toEqual([]);
-  });
-});

package/dist/config/__tests__/configruedEnvs.test.d.ts

@@ -1 +0,0 @@
-export {};