@catladder/cli 0.0.0-refactor-docker-45f6e733 → 0.0.0-refactor-cache-b38c122b

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@catladder/cli",
-  "description": "Panter cli tool for Kubernetes",
+  "description": "Panter cli tool for cloud CI/CD and DevOps",
   "author": "Marco Wettstein <maw@panter.ch>",
-  "homepage": "https://git.panter.ch/catladder/catladder/#readme",
+  "homepage": "https://catladder.git.panter.biz/catladder/docs",
   "bugs": "https://git.panter.ch/catladder/catladder/issues",
+  "readme": "https://git.panter.ch/catladder/catladder/-/blob/main/cli/README.md",
   "repository": {
     "type": "git",
     "url": "git+https://git.panter.ch/catladder/catladder.git",
@@ -52,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "0.0.0-refactor-docker-45f6e733",
+  "version": "0.0.0-refactor-cache-b38c122b",
   "scripts": {
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix",
@@ -70,10 +71,7 @@
   "types": "dist/cli/src/index.d.ts",
   "main": "dist/cli/src/index.js",
   "engines": {
-    "node": ">=12.0.0"
-  },
-  "dependencies": {
-    "ts-node": "^10.9.1"
+    "node": ">=18.0.0"
   },
   "devDependencies": {
     "@gitbeaker/rest": "^39.28.0",
@@ -110,5 +108,8 @@
     "vorpal": "^1.12.0",
     "yaml": "^2.4.5"
   },
+  "dependencies": {
+    "tsx": "^4.16.2"
+  },
   "stableVersion": "0.0.0"
 }

package/scripts/bundle

@@ -1,6 +1,6 @@
 #!/bin/bash
-ncc build dist/cli/src/catenv.js -o dist/bundles/catenv -e 'ts-node' $( ((SHOULD_MINIFY == 1)) && printf %s '-m')
+ncc build dist/cli/src/catenv.js -o dist/bundles/catenv -e 'tsx/cjs/api' $( ((SHOULD_MINIFY == 1)) && printf %s '-m')
 
-ncc build dist/cli/src/cli.js -o dist/bundles/cli -e 'ts-node' $( ((SHOULD_MINIFY == 1)) && printf %s '-m')
+ncc build dist/cli/src/cli.js -o dist/bundles/cli -e 'tsx/cjs/api' $( ((SHOULD_MINIFY == 1)) && printf %s '-m')
 
-ncc build dist/cli/src/catci.js -o dist/bundles/catci -e 'ts-node' $( ((SHOULD_MINIFY == 1)) && printf %s '-m')
+ncc build dist/cli/src/catci.js -o dist/bundles/catci -e 'tsx/cjs/api' $( ((SHOULD_MINIFY == 1)) && printf %s '-m')

package/src/apps/cli/commands/project/cloudSql/commandProjectRestoreDb.ts

@@ -36,8 +36,8 @@ export default async (vorpal: Vorpal) =>
 
       const sourceEnvVars = await getEnvVarsResolved(
         this,
-        sourceContext.environment.shortName,
-        sourceContext.componentName,
+        sourceContext.env,
+        sourceContext.name,
       );
 
       let sourceProxy: CloudSqlBackgroundProxy;
@@ -99,8 +99,8 @@ export default async (vorpal: Vorpal) =>
 
       const targetEnvVars = await getEnvVarsResolved(
         this,
-        targetContext.environment.shortName,
-        targetContext.componentName,
+        targetContext.env,
+        targetContext.name,
       );
 
       if (targetEnv === "local") {

package/src/apps/cli/commands/project/commandCloudSqlProxy.ts

@@ -83,11 +83,7 @@ const getProxyInfoForKubernetes = async (
     throw new Error("unsupported");
   }
 
-  const envVars = await getEnvVarsResolved(
-    vorpal,
-    context.environment.shortName,
-    context.componentName,
-  );
+  const envVars = await getEnvVarsResolved(vorpal, context.env, context.name);
   // bit hacky, would be nicer if we would also declare this through env vars
   const cloudSqlValues = createKubernetesCloudsqlBaseValues(context);
 
@@ -116,11 +112,7 @@ const getProxyInfoForCloudRun = async (
     throw new Error("unsupported");
   }
 
-  const envVars = await getEnvVarsResolved(
-    vorpal,
-    context.environment.shortName,
-    context.componentName,
-  );
+  const envVars = await getEnvVarsResolved(vorpal, context.env, context.name);
 
   const DB_PASSWORD = envVars?.DB_PASSWORD;
   const DB_USER = envVars?.DB_USER;

package/src/apps/cli/commands/project/commandRenewToken.ts

@@ -0,0 +1,12 @@
+import type Vorpal from "vorpal";
+import { setupAccessTokens } from "./setup/setupAccessTokens";
+
+export default async (vorpal: Vorpal) =>
+  vorpal
+    .command(
+      "project-renew-token",
+      "Configures the project access token for semantic release.",
+    )
+    .action(async function () {
+      await setupAccessTokens(this);
+    });

package/src/apps/cli/commands/project/index.ts

@@ -9,6 +9,7 @@ import commandGetMyTotalWorktime from "./commandGetMyTotalWorktime";
 import commandGetShell from "./commandGetShell";
 import commandGitlabCi from "./commandGitlabCi";
 import commandSetup from "./commandSetup";
+import commandRenewToken from "./commandRenewToken";
 import commandListPods from "./commandListPods";
 import commandMigrateHelm3 from "./commandMigrateHelm3";
 import commandNamespace from "./commandNamespace";
@@ -29,6 +30,7 @@ import commandSecurityEvaluate from "./commandSecurityEvaluate";
 
 export default async (vorpal: Vorpal) => {
   commandSetup(vorpal);
+  commandRenewToken(vorpal);
 
   commandEnvVars(vorpal);
 

package/src/apps/cli/commands/project/setup/setupAccessTokens.ts

@@ -1,57 +1,70 @@
-import open from "open";
 import type { CommandInstance } from "vorpal";
+import dayjs from "dayjs";
 import { doGitlabRequest, getProjectInfo } from "../../../../../utils/gitlab";
 
+const TOKEN_NAME = "semantic-release";
+
 export const setupAccessTokens = async (instance: CommandInstance) => {
-  const { id: projectId, web_url: projectWebUrl } =
-    await getProjectInfo(instance);
+  const { id: projectId } = await getProjectInfo(instance);
+
+  const projectTokens = await doGitlabRequest(
+    instance,
+    `projects/${projectId}/access_tokens`,
+  );
+  const token = projectTokens.find(
+    (t) => t.name === TOKEN_NAME && t.active === true,
+  );
+
+  const expires_at = dayjs()
+    .add(1, "year")
+    .subtract(1, "day")
+    .format("YYYY-MM-DD");
+
+  const newToken = token
+    ? await doGitlabRequest(
+        instance,
+        `projects/${projectId}/access_tokens/${token.id}/rotate`,
+        { expires_at },
+        "POST",
+      )
+    : await doGitlabRequest(
+        instance,
+        `projects/${projectId}/access_tokens`,
+        {
+          name: TOKEN_NAME,
+          scopes: ["api", "read_repository"],
+          access_level: 40, // Maintainer
+          expires_at,
+        },
+        "POST",
+      );
+
   try {
     await doGitlabRequest(instance, `projects/${projectId}/variables/GL_TOKEN`);
+    await doGitlabRequest(
+      instance,
+      `projects/${projectId}/variables/GL_TOKEN`,
+      { value: newToken.token },
+      "PUT",
+    );
   } catch (e) {
     if (e.message !== "not found") {
       throw e;
     }
     // not found
-
-    instance.log(
-      "I need add a GL_TOKEN to the project, so that semantic release will work\n",
-    );
-    instance.log(
-      "👉 Please please create a project access token in gitlab and copy its value into clipboard\n\n - name: something like 'semantic-release'\n - expires: leave empty\n - role: maintainer - scopes: api, read_repository",
-    );
-    instance.log("\n");
-
-    const { understood } = await instance.prompt({
-      default: true,
-      message: "Understood and open gitlab now? 🤔",
-      name: "understood",
-      type: "confirm",
-    });
-    if (!understood) {
-      instance.log("continuing anyway...");
-    }
-    open(`${projectWebUrl}/-/settings/access_tokens`);
-
-    instance.log("\n");
-
-    instance.log("Enter your copied token now: ");
-
-    instance.log("\n");
-    const { GL_TOKEN } = await instance.prompt({
-      type: "password",
-      name: "GL_TOKEN",
-      message: "Access Token: ",
-    });
-
     await doGitlabRequest(
       instance,
       `projects/${projectId}/variables`,
       {
         key: "GL_TOKEN",
-        value: GL_TOKEN,
+        value: newToken.token,
         masked: true,
       },
       "POST",
     );
   }
+
+  instance.log(
+    "Token configured for semantic release. Renew me again in a year!",
+  );
 };

package/src/apps/cli/commands/project/setup/setupCloudRun.ts

@@ -76,8 +76,8 @@ export const setupCloudRun = async (
     {
       [GCLOUD_RUN_CANONICAL_HOST_SUFFIX]: suffix,
     },
-    context.environment.shortName,
-    context.componentName,
+    context.env,
+    context.name,
     false, // backup
     false, // masked
   );

package/src/apps/cli/commands/project/setup/setupContext.ts

@@ -14,13 +14,7 @@ export const setupContext = async (
     "==================================================================================",
   );
 
-  instance.log(
-    "🐱 🔧 setting up " +
-      context.environment.shortName +
-      ":" +
-      context.componentName +
-      "...",
-  );
+  instance.log("🐱 🔧 setting up " + context.env + ":" + context.name + "...");
   instance.log("");
   if (isOfDeployType(context.deploy?.config, "google-cloudrun")) {
     await setupCloudRun(instance, context);
@@ -32,13 +26,7 @@ export const setupContext = async (
   }
 
   instance.log("");
-  instance.log(
-    "✅ " +
-      context.environment.shortName +
-      ":" +
-      context.componentName +
-      " done!",
-  );
+  instance.log("✅ " + context.env + ":" + context.name + " done!");
 
   instance.log("");
 };

package/src/apps/cli/commands/project/setup/setupKubernetes.ts

@@ -63,7 +63,7 @@ export const setupKubernetes = async (
   // we name the service account and the role and the role binding with the same name
   // we currently create one per component to better separate them
   instance.log("ensuring service accounts...");
-  const serviceAccountName = `cl-${context.componentName}-deploy`;
+  const serviceAccountName = `cl-${context.name}-deploy`;
   const KUBE_URL = await exec(
     `TERM=dumb kubectl cluster-info | grep -E 'Kubernetes master|Kubernetes control plane' | awk '/http/ {print $NF}'`,
   ).then((s) => s.stdout.trim());
@@ -163,8 +163,8 @@ EOF
   await upsertAllVariables(
     instance,
     vars,
-    context.environment.shortName,
-    context.componentName,
+    context.env,
+    context.name,
     false, // no backup
   );
   instance.log("done!");

package/src/apps/cli/commands/project/utils/ensureNamespace.ts

@@ -5,29 +5,16 @@ import { V1Namespace } from "@kubernetes/client-node";
 import { getk8sApi } from "../../../../../k8sApi";
 
 export default async function (context: ComponentContext) {
-  const namespace = getKubernetesNamespace(
-    context.fullConfig,
-    context.environment.shortName,
-  );
+  const namespace = getKubernetesNamespace(context.fullConfig, context.env);
   const namespaceBody = new V1Namespace();
   const metadata: V1ObjectMeta = {
     name: namespace,
     labels: {
       customerName: context.fullConfig.customerName,
       appName: context.fullConfig.appName,
-      environment: context.environment.shortName,
+      environment: context.env,
       components: Object.keys(context.fullConfig.components).join("_"), // limited chars available...
-      buildTypes: Object.values(context.fullConfig.components)
-        .map((config) => config.build.type)
-        .join("_"), // limited chars available...
-      ...Object.fromEntries(
-        Object.entries(context.fullConfig.components).map(
-          ([componentName, config]) => [
-            "buildType_" + componentName,
-            config.build.type,
-          ],
-        ),
-      ),
+
       ...(context.fullConfig.meta?.labels ?? {}),
     },
   };

package/src/catenv.ts

@@ -2,9 +2,19 @@ import catenv from "./apps/catenv/catenv";
 
 import { parseChoice } from "./config/parseChoice";
 
-const choice = process.argv[2] ? parseChoice(process.argv[2]) : null;
+const args = process.argv.slice(2);
 
-catenv(choice).then(() => {
+const helpFlags = ["--help", "-h", "help"];
+if (args.some((arg) => helpFlags.includes(arg))) {
+  const docLink =
+    "https://git.panter.ch/catladder/catladder/-/blob/main/docs/1_VARS.md";
+  console.log(
+    `\nUsage: catenv [env|env:component]\n\nEnv variable and catenv documentation:\n${docLink}`,
+  );
+  process.exit(0);
+}
+
+catenv(args[0] ? parseChoice(args[0]) : null).then(() => {
   // we have to exit manually, because we have some file watches
   process.exit();
 });

package/src/config/getProjectConfig.ts

@@ -1,6 +1,6 @@
 import type { Config, EnvironmentEnvVars } from "@catladder/pipeline";
 import {
-  readConfigSync,
+  readConfig,
   getAllEnvs,
   getEnvironment as _getEnvironment,
   createComponentContext,
@@ -21,7 +21,10 @@ let currentConfig: Config | null = null;
 // reload the config on change
 const reloadConfigAndObserve = async () => {
   const gitRoot = await getGitRoot();
-  const result = readConfigSync(gitRoot);
+  if (!gitRoot) {
+    return;
+  }
+  const result = await readConfig(gitRoot);
   if (!result) {
     // can't do anything, there is no config
     return;
@@ -120,23 +123,22 @@ const resolveSecrets = async (
   const allVariablesInGitlab = await getAllVariables(vorpal);
 
   return Object.fromEntries(
-    varSets.flatMap((set) =>
-      Object.entries(set.envVars)
-        .map(([key, value]) => {
-          const secretKey = set.secretEnvVarKeys.find((k) => k.key === key);
-
-          if (secretKey?.hidden || value === undefined) {
-            return null;
-          }
-
-          for (const variable of allVariablesInGitlab) {
-            value = value
-              .toString()
-              .replace(new RegExp("\\$" + variable.key, "g"), variable.value);
-          }
-          return [key, value];
-        })
-        .filter(Boolean),
+    varSets.flatMap(({ envVars, secretEnvVarKeys }) =>
+      Object.entries(envVars)
+        .filter(
+          ([key, value]) =>
+            value !== undefined &&
+            value !== null &&
+            !secretEnvVarKeys.find((k) => k.key === key)?.hidden,
+        )
+        .map(([key, value]) => [
+          key,
+          allVariablesInGitlab.reduce(
+            (acc, curr) =>
+              acc.replace(new RegExp("\\$" + curr.key, "g"), curr.value),
+            `${value}`,
+          ),
+        ]),
     ),
   );
 };

package/src/gcloud/serviceAccounts.ts

@@ -28,16 +28,34 @@ const upsertGcloudServiceAccount = async (
   const { projectId, name, displayName, roles, description } = account;
 
   // name has limit of 30
-  const namePrefix = `${name}-`;
-  const nameSuffix = `-${context.environment.shortName}-${context.componentName}`;
-  const nameMiddleLength = 30 - namePrefix.length - nameSuffix.length;
-  const nameMiddle = `${context.fullConfig.customerName}-${context.fullConfig.appName}`;
-
-  const middle = hashIfNessecary(nameMiddle, nameMiddleLength);
+  const namePrefix = `${name}`;
+  const nameSuffixRaw = `${context.env}-${context.name}`;
+  const nameMiddleRaw = `${context.fullConfig.customerName}-${context.fullConfig.appName}`;
+  const MAX_LENGTH = 30;
+  const NUM_SEPARATORS = 2;
+
+  // we want to first hash middle, then suffix
+  // if for middle we have at least 1 char left, its ok, so we don't hash nameSuffix, otherwise we need to hash that as well
+
+  const middleMaxLength =
+    MAX_LENGTH - namePrefix.length - nameSuffixRaw.length - NUM_SEPARATORS;
+
+  let nameMiddle: string;
+  let nameSuffix: string;
+  if (middleMaxLength < 1) {
+    nameMiddle = hashIfNessecary(nameMiddleRaw, 1);
+    nameSuffix = hashIfNessecary(
+      nameSuffixRaw,
+      MAX_LENGTH - namePrefix.length - 1 - NUM_SEPARATORS,
+    );
+  } else {
+    nameMiddle = hashIfNessecary(nameMiddleRaw, middleMaxLength);
+    nameSuffix = nameSuffixRaw;
+  }
 
-  const fullName = `${namePrefix}${middle}${nameSuffix}`;
+  const fullName = `${namePrefix}-${nameMiddle}-${nameSuffix}`;
 
-  const fullDisplayName = `${context.fullConfig.customerName}-${context.fullConfig.appName} ${context.environment.shortName}:${context.componentName} | ${displayName}`;
+  const fullDisplayName = `${context.fullConfig.customerName}-${context.fullConfig.appName} ${context.env}:${context.name} | ${displayName}`;
 
   const fullIdentifier = `${fullName}@${projectId}.iam.gserviceaccount.com`;
 
@@ -88,8 +106,8 @@ export const upsertGcloudServiceAccountAndSaveSecret = async (
     {
       [secretName]: key,
     },
-    context.environment.shortName,
-    context.componentName,
+    context.env,
+    context.name,
   );
   instance.log("done!");
 };

package/src/utils/projects/index.ts

@@ -4,8 +4,13 @@ import { getProjectConfig, parseChoice } from "../../config/getProjectConfig";
 import { readFileOrError } from "../files";
 import { exec } from "child-process-promise";
 
-export const getGitRoot = async (): Promise<string> => {
-  return (await exec(`git rev-parse --show-toplevel`)).stdout.trim();
+export const getGitRoot = async (): Promise<string | null> => {
+  try {
+    return (await exec(`git rev-parse --show-toplevel`)).stdout.trim();
+  } catch (e) {
+    // not a git repo
+    return null;
+  }
 };
 
 export const getRootGitlabCiFile = async () => {

package/tsconfig.json

@@ -1,10 +1,10 @@
 {
   "compilerOptions": {
-    "lib": ["es2021", "DOM"],
+    "lib": ["es2022", "DOM"],
     "module": "CommonJS",
     "downlevelIteration": true,
     "declaration": true,
-
+    "target": "ES2018",
     "moduleResolution": "node",
     "esModuleInterop": true,
     "sourceMap": true,

package/.nvmrc

@@ -1 +0,0 @@
-16