@catladder/pipeline 4.6.4 → 4.7.1

package/dist/constants.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.DOCKER_REGISTRY = exports.PIPELINE_IMAGE_TAG = void 0;
-exports.PIPELINE_IMAGE_TAG = "v4-6-4-d6efbf06" || "latest";
+exports.PIPELINE_IMAGE_TAG = "v4-7-1-890e599f" || "latest";
 exports.DOCKER_REGISTRY = "git.panter.ch:5001/catladder/catladder" || "git.panter.ch:5001/catladder/catladder";

package/dist/context/getEnvironmentVariables.js

@@ -182,7 +182,7 @@ var getEnvironmentVariables = function (ctx_1) {
     args_1[_i - 1] = arguments[_i];
   }
   return __awaiter(void 0, __spreadArray([ctx_1], __read(args_1), false), void 0, function (ctx, options) {
-    var environmentContext, config, env, componentName, envConfigRaw, deployConfigRaw, buildConfigRaw, envType, basePredefinedVariables, predefinedVariables, host, url, devLocalConfig, port, additionalEnvVars, HOSTNAME_INTERNAL, publicEnvVarsRaw, additionalSecretKeys, secretEnvVarKeys, secretEnvVars, publicEnvVarsRawSanitized, publicEnvVarsUnresolved, publicEnvVars, _a, envVars;
+    var environmentContext, config, env, componentName, envConfigRaw, deployConfigRaw, buildConfigRaw, envType, basePredefinedVariables, predefinedVariables, host, url, devLocalConfig, port, additionalEnvVars, HOSTNAME_INTERNAL, publicEnvVarsRaw, additionalSecretKeys, secretEnvVarKeys, secretEnvVars, publicEnvVarsRawSanitized, publicEnvVarsUnresolved, mergedEnvVars, resolvedEnvVars, _a, envVars;
     var _b, _c;
     var _d, _e, _f, _g, _h, _j, _k, _l;
     if (options === void 0) {
@@ -238,8 +238,9 @@ var getEnvironmentVariables = function (ctx_1) {
               componentName: ctx.componentName
             })];
           }));
+          mergedEnvVars = __assign(__assign(__assign({}, predefinedVariables), secretEnvVars), publicEnvVarsUnresolved);
           if (!((_l = options.shouldResolveReferences) !== null && _l !== void 0 ? _l : true)) return [3 /*break*/, 2];
-          return [4 /*yield*/, (0, resolveAllReferences_1.resolveAllReferences)(publicEnvVarsUnresolved, function (otherComponentName) {
+          return [4 /*yield*/, (0, resolveAllReferences_1.resolveAllReferences)(mergedEnvVars, function (otherComponentName) {
             return __awaiter(void 0, void 0, void 0, function () {
               var otherEnvVars;
               return __generator(this, function (_a) {
@@ -261,11 +262,11 @@ var getEnvironmentVariables = function (ctx_1) {
           _a = _m.sent();
           return [3 /*break*/, 3];
         case 2:
-          _a = publicEnvVarsUnresolved;
+          _a = mergedEnvVars;
           _m.label = 3;
         case 3:
-          publicEnvVars = _a;
-          envVars = addIndexVar(__assign(__assign(__assign({}, predefinedVariables), secretEnvVars), publicEnvVars));
+          resolvedEnvVars = _a;
+          envVars = addIndexVar(resolvedEnvVars);
           _b = {
             envVars: envVars,
             secretEnvVarKeys: secretEnvVarKeys

package/dist/deploy/cloudRun/index.js

@@ -78,8 +78,8 @@ var getCloudSqlVariables = function (_a) {
       DB_PASSWORD: "$" + (0, context_1.getSecretVarName)(env, componentName, "DB_PASSWORD")
     };
     return __assign(__assign({}, dbVars), {
-      DATABASE_URL: (0, database_1.getDatabaseConnectionString)(deployConfigRaw.cloudSql, dbVars).concat(additionalQueryParamsString),
-      DATABASE_JDBC_URL: (0, database_1.getDatabaseJdbcUrl)(dbVars, (_d = deployConfigRaw.cloudSql.dbConnectionStringVariablesMode) !== null && _d !== void 0 ? _d : database_1.DEFAULT_DB_VARIABLES_MODE)
+      DATABASE_URL: (0, database_1.getDatabaseConnectionString)(deployConfigRaw.cloudSql, dbVars, componentName).concat(additionalQueryParamsString),
+      DATABASE_JDBC_URL: (0, database_1.getDatabaseJdbcUrl)(dbVars, (_d = deployConfigRaw.cloudSql.dbConnectionStringVariablesMode) !== null && _d !== void 0 ? _d : database_1.DEFAULT_DB_VARIABLES_MODE, componentName)
     });
   }
   return {};
@@ -137,5 +137,17 @@ exports.GCLOUD_RUN_DEPLOY_TYPE = {
       DEPLOY_CLOUD_RUN_PROJECT_ID: deployConfigRaw ? deployConfigRaw.projectId : undefined,
       DEPLOY_CLOUD_RUN_REGION: deployConfigRaw ? deployConfigRaw.region : undefined
     });
+  },
+  verifyJobSetupScript: function (context) {
+    var _a;
+    var deployConfig = (_a = context.deploy) === null || _a === void 0 ? void 0 : _a.config;
+    var service = deployConfig === null || deployConfig === void 0 ? void 0 : deployConfig.service;
+    var serviceConfig = typeof service === "object" ? service : undefined;
+    if ((serviceConfig === null || serviceConfig === void 0 ? void 0 : serviceConfig.allowUnauthenticated) !== false) {
+      return [];
+    }
+    // the service requires IAM auth: provide application default credentials
+    // so the verify command can fetch identity tokens for the deployed service
+    return (0, gitlab_1.collapseableSection)("verifygcloudauth", "Setup google application credentials")(["echo \"$".concat(exports.GCLOUD_DEPLOY_CREDENTIALS_KEY, "\" > \"$CI_PROJECT_DIR/.gcloud-sa.json\""), "export GOOGLE_APPLICATION_CREDENTIALS=\"$CI_PROJECT_DIR/.gcloud-sa.json\""]);
   }
 };

package/dist/deploy/cloudRun/utils/database.d.ts

@@ -1,5 +1,6 @@
 import { type StringOrBashExpression } from "../../../bash";
 import type { ComponentContext } from "../../../types";
+import type { VariableValue } from "../../../variables/VariableValue";
 import type { DeployConfigCloudRun, DeployConfigCloudRunCloudSql } from "../../types";
 export declare const getDatabaseDeleteScript: (context: ComponentContext, deployConfig: DeployConfigCloudRun) => string[];
 export declare const getDatabaseCreateScript: (context: ComponentContext, deployConfig: DeployConfigCloudRun) => string[];
@@ -13,13 +14,13 @@ export type DBVariables = {
  * controls how variables in the connection string are handled
  *
  * - legacy: variables like $DB_USER will be kept as environment variables to be replaced at runtime (default). It is not using BashExpressions as this was not the case in the past.
- * - embedded: variables will be replaced with their actual values in the connection string
+ * - embedded: variables will be replaced with the component's final values in the connection string. This makes the connection string usable from other components (e.g. via ${otherComponent:DATABASE_URL}) and respects overrides of DB_USER, DB_PASSWORD, etc. in vars.public (e.g. DB_PASSWORD: "${otherComponent:DB_PASSWORD}" when reusing another component's database)
  *
  * We will remove the legacy mode in the future, as it is confusing. But its unclear whether its a breaking change in some edge cases
  */
 export type DBVariablesMode = "legacy" | "embedded";
 export declare const DEFAULT_DB_VARIABLES_MODE: DBVariablesMode;
-export declare const getDatabaseJdbcUrl: (variables: DBVariables, mode: DBVariablesMode) => StringOrBashExpression;
-export declare const getRailsDatabaseConnectionString: (variables: DBVariables, mode: DBVariablesMode) => StringOrBashExpression;
-export declare const getPrismaDatabaseConnectionString: (variables: DBVariables, mode: DBVariablesMode) => StringOrBashExpression;
-export declare const getDatabaseConnectionString: (config: DeployConfigCloudRunCloudSql, variables: DBVariables) => StringOrBashExpression;
+export declare const getDatabaseJdbcUrl: (variables: DBVariables, mode: DBVariablesMode, componentName: string) => VariableValue;
+export declare const getRailsDatabaseConnectionString: (variables: DBVariables, mode: DBVariablesMode, componentName: string) => VariableValue;
+export declare const getPrismaDatabaseConnectionString: (variables: DBVariables, mode: DBVariablesMode, componentName: string) => VariableValue;
+export declare const getDatabaseConnectionString: (config: DeployConfigCloudRunCloudSql, variables: DBVariables, componentName: string) => VariableValue;

package/dist/deploy/cloudRun/utils/database.js

@@ -28,6 +28,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.getDatabaseConnectionString = exports.getPrismaDatabaseConnectionString = exports.getRailsDatabaseConnectionString = exports.getDatabaseJdbcUrl = exports.DEFAULT_DB_VARIABLES_MODE = exports.getDatabaseCreateScript = exports.getDatabaseDeleteScript = void 0;
 var bash_1 = require("../../../bash");
 var gitlab_1 = require("../../../utils/gitlab");
+var VariableValueContainingReferences_1 = require("../../../variables/VariableValueContainingReferences");
 var getDatabaseDeleteScript = function (context, deployConfig) {
   if (!deployConfig.cloudSql || !deployConfig.cloudSql.deleteDatabaseOnStop) {
     throw new Error("not possible");
@@ -64,35 +65,41 @@ var getDatabaseCreateScript = function (context, deployConfig) {
 };
 exports.getDatabaseCreateScript = getDatabaseCreateScript;
 exports.DEFAULT_DB_VARIABLES_MODE = "legacy";
-var getVariableOrValue = function (key, variables, mode) {
-  return mode === "legacy" ? "$".concat(key) : variables[key];
+var getVariableOrValue = function (key, mode, componentName) {
+  // in embedded mode we reference the component's own env var, which gets
+  // resolved to its final value (including vars.public overrides) after all
+  // env vars have been merged
+  return mode === "legacy" ? "$".concat(key) : new VariableValueContainingReferences_1.VariableReference(componentName, key);
 };
-var getDatabaseJdbcUrl = function (variables, mode) {
-  var parts = ["jdbc:postgresql:///", getVariableOrValue("DB_NAME", variables, mode), "?cloudSqlInstance=", getVariableOrValue("CLOUD_SQL_INSTANCE_CONNECTION_NAME", variables, mode), "&socketFactory=com.google.cloud.sql.postgres.SocketFactory&user=", getVariableOrValue("DB_USER", variables, mode), "&password=", getVariableOrValue("DB_PASSWORD", variables, mode)];
-  return (0, bash_1.joinBashExpressions)(parts);
+var joinDbUrlParts = function (parts, mode) {
+  return mode === "legacy" ? (0, bash_1.joinBashExpressions)(parts) : new VariableValueContainingReferences_1.VariableValueContainingReferences(parts);
+};
+var getDatabaseJdbcUrl = function (variables, mode, componentName) {
+  var parts = ["jdbc:postgresql:///", getVariableOrValue("DB_NAME", mode, componentName), "?cloudSqlInstance=", getVariableOrValue("CLOUD_SQL_INSTANCE_CONNECTION_NAME", mode, componentName), "&socketFactory=com.google.cloud.sql.postgres.SocketFactory&user=", getVariableOrValue("DB_USER", mode, componentName), "&password=", getVariableOrValue("DB_PASSWORD", mode, componentName)];
+  return joinDbUrlParts(parts, mode);
 };
 exports.getDatabaseJdbcUrl = getDatabaseJdbcUrl;
-var getRailsDatabaseConnectionString = function (variables, mode) {
-  var parts = ["postgresql://", getVariableOrValue("DB_USER", variables, mode), ":", getVariableOrValue("DB_PASSWORD", variables, mode), "@", encodeURIComponent("/cloudsql/".concat(variables.CLOUD_SQL_INSTANCE_CONNECTION_NAME)), "/", getVariableOrValue("DB_NAME", variables, mode), "?"];
-  return (0, bash_1.joinBashExpressions)(parts);
+var getRailsDatabaseConnectionString = function (variables, mode, componentName) {
+  var parts = ["postgresql://", getVariableOrValue("DB_USER", mode, componentName), ":", getVariableOrValue("DB_PASSWORD", mode, componentName), "@", encodeURIComponent("/cloudsql/".concat(variables.CLOUD_SQL_INSTANCE_CONNECTION_NAME)), "/", getVariableOrValue("DB_NAME", mode, componentName), "?"];
+  return joinDbUrlParts(parts, mode);
 };
 exports.getRailsDatabaseConnectionString = getRailsDatabaseConnectionString;
-var getPrismaDatabaseConnectionString = function (variables, mode) {
-  var parts = ["postgresql://", getVariableOrValue("DB_USER", variables, mode), ":", getVariableOrValue("DB_PASSWORD", variables, mode), "@localhost/", getVariableOrValue("DB_NAME", variables, mode), "?host=/cloudsql/", getVariableOrValue("CLOUD_SQL_INSTANCE_CONNECTION_NAME", variables, mode)];
-  return (0, bash_1.joinBashExpressions)(parts);
+var getPrismaDatabaseConnectionString = function (variables, mode, componentName) {
+  var parts = ["postgresql://", getVariableOrValue("DB_USER", mode, componentName), ":", getVariableOrValue("DB_PASSWORD", mode, componentName), "@localhost/", getVariableOrValue("DB_NAME", mode, componentName), "?host=/cloudsql/", getVariableOrValue("CLOUD_SQL_INSTANCE_CONNECTION_NAME", mode, componentName)];
+  return joinDbUrlParts(parts, mode);
 };
 exports.getPrismaDatabaseConnectionString = getPrismaDatabaseConnectionString;
-var getDatabaseConnectionString = function (config, variables) {
+var getDatabaseConnectionString = function (config, variables, componentName) {
   var _a;
   var mode = (_a = config.dbConnectionStringVariablesMode) !== null && _a !== void 0 ? _a : exports.DEFAULT_DB_VARIABLES_MODE;
   switch (config.dbConnectionStringFormat) {
     case "jdbc":
-      return (0, exports.getDatabaseJdbcUrl)(variables, mode);
+      return (0, exports.getDatabaseJdbcUrl)(variables, mode, componentName);
     case "rails":
-      return (0, exports.getRailsDatabaseConnectionString)(variables, mode);
+      return (0, exports.getRailsDatabaseConnectionString)(variables, mode, componentName);
     default:
       // prisma
-      return (0, exports.getPrismaDatabaseConnectionString)(variables, mode);
+      return (0, exports.getPrismaDatabaseConnectionString)(variables, mode, componentName);
   }
 };
 exports.getDatabaseConnectionString = getDatabaseConnectionString;

package/dist/deploy/index.d.ts

@@ -1,9 +1,9 @@
 import type { BuildConfig, SecretEnvVar } from "..";
-import type { BashExpression } from "../bash/BashExpression";
 import type { ComponentContext } from "../types/context";
 import type { EnvironmentContext } from "../types/environmentContext";
 import type { CatladderJob } from "../types/jobs";
 import type { PartialDeep } from "../types/utils";
+import type { VariableValue } from "../variables/VariableValue";
 import type { DeployConfig, DeployConfigGeneric, DeployConfigType } from "./types";
 export * from "./cloudRun";
 export * from "./kubernetes";
@@ -13,7 +13,12 @@ export type DeployTypeDefinition<D extends DeployConfig> = {
   jobs: (context: ComponentContext) => CatladderJob[] | Promise<CatladderJob[]>;
   defaults: (envContext: EnvironmentContext<BuildConfig, D>) => PartialDeep<D>;
   additionalSecretKeys: (envContext: EnvironmentContext<BuildConfig, D>) => SecretEnvVar[];
-  getAdditionalEnvVars: (envContext: EnvironmentContext<BuildConfig, D>) => Record<string, string | BashExpression | undefined | null>;
+  getAdditionalEnvVars: (envContext: EnvironmentContext<BuildConfig, D>) => Record<string, VariableValue | undefined | null>;
+  /**
+   * script lines the deploy type contributes to the start of the verify job,
+   * e.g. to authenticate against a non-public service
+   */
+  verifyJobSetupScript?: (context: ComponentContext) => string[];
 };
 export type DeployTypes = { [T in DeployConfigType]: DeployTypeDefinition<DeployConfigGeneric<T>> };
 export declare const DEPLOY_TYPES: DeployTypes;

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export * from "./config";
 export * from "./context";
 export * from "./build";
 export * from "./deploy";
+export * from "./verify";
 export * from "./utils/writeFiles";
 export * from "./utils/measureTime";
 export * from "./variables/VariableValue";

package/dist/index.js

@@ -30,6 +30,7 @@ __exportStar(require("./config"), exports);
 __exportStar(require("./context"), exports);
 __exportStar(require("./build"), exports);
 __exportStar(require("./deploy"), exports);
+__exportStar(require("./verify"), exports);
 __exportStar(require("./utils/writeFiles"), exports);
 __exportStar(require("./utils/measureTime"), exports);
 __exportStar(require("./variables/VariableValue"), exports);

package/dist/pipeline/createJobsForComponent.js

@@ -170,6 +170,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.createJobsForComponentContext = void 0;
 var build_1 = require("../build");
 var deploy_1 = require("../deploy");
+var createVerifyJobs_1 = require("../verify/createVerifyJobs");
 var injectDefaultVarsInCustomJobs = function (context, jobs) {
   return jobs.map(function (_a) {
     var _b;
@@ -189,15 +190,15 @@ var getCustomJobs = function (context) {
 };
 var createJobsForComponentContext = function (context) {
   return __awaiter(void 0, void 0, void 0, function () {
-    var _a, buildJobs, deployJobs, customJobs;
+    var _a, buildJobs, deployJobs, verifyJobs, customJobs;
     return __generator(this, function (_b) {
       switch (_b.label) {
         case 0:
-          return [4 /*yield*/, Promise.all([context.build.type !== "disabled" ? build_1.BUILD_TYPES[context.build.buildType].jobs(context) : [], context.componentConfig.deploy !== false ? deploy_1.DEPLOY_TYPES[context.componentConfig.deploy.type].jobs(context) : []])];
+          return [4 /*yield*/, Promise.all([context.build.type !== "disabled" ? build_1.BUILD_TYPES[context.build.buildType].jobs(context) : [], context.componentConfig.deploy !== false ? deploy_1.DEPLOY_TYPES[context.componentConfig.deploy.type].jobs(context) : [], (0, createVerifyJobs_1.createVerifyJobs)(context)])];
         case 1:
-          _a = __read.apply(void 0, [_b.sent(), 2]), buildJobs = _a[0], deployJobs = _a[1];
+          _a = __read.apply(void 0, [_b.sent(), 3]), buildJobs = _a[0], deployJobs = _a[1], verifyJobs = _a[2];
           customJobs = getCustomJobs(context);
-          return [2 /*return*/, __spreadArray(__spreadArray(__spreadArray([], __read(buildJobs), false), __read(deployJobs), false), __read(customJobs), false)];
+          return [2 /*return*/, __spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(buildJobs), false), __read(deployJobs), false), __read(verifyJobs), false), __read(customJobs), false)];
       }
     });
   });