@catladder/cli 0.0.0-refactore-catenv-command-validates-argument-78d05852 → 0.0.0-reference-database-url-1befbbee

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

@@ -1,12 +1,14 @@
 import type Vorpal from "vorpal";
 import { setupProject } from "./setup";
+import { allComponents } from "./utils/autocompletions";
 
 export default async (vorpal: Vorpal) =>
   vorpal
     .command(
-      "project-setup",
-      "Initializes all environments and creates requires resources, service accounts, etc."
+      "project-setup [component]",
+      "Initializes all environments and creates requires resources, service accounts, etc.",
     )
-    .action(async function () {
-      await setupProject(this);
+    .autocomplete(await allComponents())
+    .action(async function ({ component }) {
+      await setupProject(this, component);
     });

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

@@ -9,27 +9,23 @@ import commandGetMyTotalWorktime from "./commandGetMyTotalWorktime";
 import commandGetShell from "./commandGetShell";
 import commandGitlabCi from "./commandGitlabCi";
 import commandSetup from "./commandSetup";
-//import commandInitProject from "./commandInitProject.old";
+import commandRenewToken from "./commandRenewToken";
 import commandListPods from "./commandListPods";
-import commandMigrateHelm3 from "./commandMigrateHelm3";
 import commandNamespace from "./commandNamespace";
-import commandOpenCostDashboard from "./commandOpenCostDashboard";
-import commandOpenDashboard from "./commandOpenDashboard";
+
 import commandOpenEnv from "./commandOpenEnv";
 import commandOpenGit from "./commandOpenGit";
 import commandOpenLogs from "./commandOpenLogs";
 import commandPauseProject from "./commandPauseProject";
-import commandOpenGrafana from "./commandOpenGrafana";
 import commandPortForward from "./commandPortForward";
 import commandTriggerCronjob from "./commandTriggerCronjob";
-
-import commandOpenGrafanaPod from "./commandOpenGrafanaPod";
 import commandSecretsClearBackups from "./commandSecretsClearBackups";
 import commandProjectRestoreDb from "./cloudSql/commandProjectRestoreDb";
 import commandSecurityEvaluate from "./commandSecurityEvaluate";
 
 export default async (vorpal: Vorpal) => {
   commandSetup(vorpal);
+  commandRenewToken(vorpal);
 
   commandEnvVars(vorpal);
 
@@ -38,14 +34,8 @@ export default async (vorpal: Vorpal) => {
   commandPauseProject(vorpal);
   commandDeleteProject(vorpal);
 
-  commandOpenDashboard(vorpal);
-
   commandOpenLogs(vorpal);
 
-  commandOpenCostDashboard(vorpal);
-
-  commandOpenGrafana(vorpal);
-  commandOpenGrafanaPod(vorpal);
   commandCloudSqlProxy(vorpal);
   commandProjectRestoreDb(vorpal);
   commandOpenGit(vorpal);
@@ -61,6 +51,6 @@ export default async (vorpal: Vorpal) => {
   commandGitlabCi(vorpal);
 
   commandGetMyTotalWorktime(vorpal);
-  commandMigrateHelm3(vorpal);
+
   commandSecurityEvaluate(vorpal);
 };

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

@@ -1,34 +1,24 @@
 import type { CommandInstance } from "vorpal";
 import { getAllPipelineContexts } from "../../../../../config/getProjectConfig";
-import { projectConfigSecrets } from "../commandConfigSecrets";
 import { setupAccessTokens } from "./setupAccessTokens";
 import { setupContext } from "./setupContext";
 import { setupTopic } from "./setupTopic";
 
-export const setupProject = async (instance: CommandInstance) => {
-  const allContext = await getAllPipelineContexts();
-
+export const setupProject = async (
+  instance: CommandInstance,
+  onlyComponents?: string | string[],
+) => {
+  const allContext = await getAllPipelineContexts(onlyComponents);
+  instance.log("will setup those contexts:");
+  allContext.forEach((context) => {
+    instance.log(` - ${context.name}:${context.env}`);
+  });
   for (const context of allContext) {
     await setupContext(instance, context);
   }
   await setupAccessTokens(instance);
   await setupTopic(instance);
   instance.log("");
-  const { configSecrets } = await instance.prompt({
-    default: true,
-    message: "Before deployments work, you need to config secrets. Do it now?",
-    name: "configSecrets",
-    type: "confirm",
-  });
-  instance.log("");
-  if (configSecrets) {
-    await projectConfigSecrets(instance);
-  } else {
-    instance.log(
-      "👆 don't forget to config secret using `project-config-secrets`"
-    );
-  }
-  instance.log("");
   instance.log("gitlab is ready! 🥂");
   instance.log("\n");
   instance.log("do not forget to make sure that:");

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

@@ -1,84 +1,70 @@
-import open from "open";
 import type { CommandInstance } from "vorpal";
+import { add, format } from "date-fns";
 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 = format(
+    add(new Date(), { years: 1, days: -1 }),
+    "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"
+      "POST",
     );
   }
 
-  const deploy_tokens = await doGitlabRequest(
-    instance,
-    `projects/${projectId}/deploy_tokens`
+  instance.log(
+    "Token configured for semantic release. Renew me again in a year!",
   );
-
-  if (
-    !deploy_tokens.find(
-      (v: { name: string }) => v.name === "gitlab-deploy-token"
-    )
-  ) {
-    instance.log(
-      "I will setup the 'GitLab Deploy Token', so Kubernetes can pull images from this project."
-    );
-
-    await doGitlabRequest(
-      instance,
-      `projects/${projectId}/deploy_tokens`,
-      {
-        id: projectId,
-        name: "gitlab-deploy-token",
-        scopes: ["read_registry"],
-      },
-      "POST"
-    );
-  }
 };

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

@@ -1,4 +1,4 @@
-import type { Context } from "@catladder/pipeline";
+import type { ComponentContext } from "@catladder/pipeline";
 import {
   GCLOUD_DEPLOY_CREDENTIALS_KEY,
   GCLOUD_RUN_CANONICAL_HOST_SUFFIX,
@@ -14,17 +14,17 @@ import { upsertAllVariables } from "../../../../../utils/gitlab";
 
 export const setupCloudRun = async (
   instance: CommandInstance,
-  context: Context
+  context: ComponentContext,
 ) => {
-  if (!isOfDeployType(context.componentConfig.deploy, "google-cloudrun")) {
+  if (!isOfDeployType(context.deploy?.config, "google-cloudrun")) {
     throw new Error("deploy config is not of type 'google-cloudrun'");
   }
 
-  const config = context.componentConfig.deploy;
+  const config = context.deploy?.config;
 
   // enable services
 
-  instance.log("enable required servies...");
+  instance.log("enable required services...");
   await enableGCloudServices(
     [
       "run.googleapis.com",
@@ -35,7 +35,7 @@ export const setupCloudRun = async (
         ? ["sqladmin.googleapis.com", "sql-component.googleapis.com"]
         : []),
     ],
-    config
+    config,
   );
   instance.log("upsert artifacts registry...");
   await upsertGcloudArtifactsRegistry(config);
@@ -58,7 +58,7 @@ export const setupCloudRun = async (
         ...(config.cloudSql ? ["roles/cloudsql.admin"] : []),
       ],
     },
-    GCLOUD_DEPLOY_CREDENTIALS_KEY
+    GCLOUD_DEPLOY_CREDENTIALS_KEY,
   );
 
   // gcloud run automatically gives us a hostname
@@ -66,7 +66,7 @@ export const setupCloudRun = async (
   // so we get this through some magic and add this as a ci/cd variable
   // the pipeline than can use this to construct the canonical host
   instance.log(
-    "get service domain suffix... that might take a while initially"
+    "get service domain suffix... that might take a while initially",
   );
   const suffix = await getCloudRunDomainSuffix(config);
   instance.log("domain suffix: " + suffix);
@@ -76,9 +76,9 @@ export const setupCloudRun = async (
     {
       [GCLOUD_RUN_CANONICAL_HOST_SUFFIX]: suffix,
     },
-    context.environment.shortName,
-    context.componentName,
+    context.env,
+    context.name,
     false, // backup
-    false // masked
+    false, // masked
   );
 };

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

@@ -1,4 +1,4 @@
-import type { Context } from "@catladder/pipeline";
+import type { ComponentContext } from "@catladder/pipeline";
 import { isOfDeployType } from "@catladder/pipeline";
 import type { CommandInstance } from "vorpal";
 import { setupCloudRun } from "./setupCloudRun";
@@ -7,38 +7,26 @@ import { setupKubernetes } from "./setupKubernetes";
 
 export const setupContext = async (
   instance: CommandInstance,
-  context: Context
+  context: ComponentContext,
 ) => {
   instance.log("");
   instance.log(
-    "=================================================================================="
+    "==================================================================================",
   );
 
-  instance.log(
-    "🐱 🔧 setting up " +
-      context.environment.shortName +
-      ":" +
-      context.componentName +
-      "..."
-  );
+  instance.log("🐱 🔧 setting up " + context.env + ":" + context.name + "...");
   instance.log("");
-  if (isOfDeployType(context.componentConfig.deploy, "google-cloudrun")) {
+  if (isOfDeployType(context.deploy?.config, "google-cloudrun")) {
     await setupCloudRun(instance, context);
   }
 
-  const deployConfig = context.componentConfig.deploy;
+  const deployConfig = context.deploy?.config;
   if (isOfDeployType(deployConfig, "kubernetes")) {
     await setupKubernetes(instance, context);
   }
 
   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

@@ -1,4 +1,4 @@
-import type { Context } from "@catladder/pipeline";
+import type { ComponentContext } from "@catladder/pipeline";
 import {
   getFullKubernetesClusterName,
   isOfDeployType,
@@ -6,18 +6,49 @@ import {
 import type { CommandInstance } from "vorpal";
 import { exec } from "child-process-promise";
 import { connectToCluster } from "../../../../../utils/cluster";
-import { upsertAllVariables } from "../../../../../utils/gitlab";
+import {
+  doGitlabRequest,
+  getProjectInfo,
+  upsertAllVariables,
+} from "../../../../../utils/gitlab";
 import ensureNamespace from "../utils/ensureNamespace";
 
 export const setupKubernetes = async (
   instance: CommandInstance,
-  context: Context
+  context: ComponentContext,
 ) => {
-  const deployConfig = context.componentConfig.deploy;
+  const deployConfig = context.deploy?.config;
   if (!isOfDeployType(deployConfig, "kubernetes")) {
     throw new Error("cannot run setupKubernetes on non-kubernetes deployments");
   }
 
+  const { id: projectId } = await getProjectInfo(instance);
+  const deploy_tokens = await doGitlabRequest(
+    instance,
+    `projects/${projectId}/deploy_tokens`,
+  );
+
+  if (
+    !deploy_tokens.find(
+      (v: { name: string }) => v.name === "gitlab-deploy-token",
+    )
+  ) {
+    instance.log(
+      "I will setup the 'GitLab Deploy Token', so Kubernetes can pull images from this project.",
+    );
+
+    await doGitlabRequest(
+      instance,
+      `projects/${projectId}/deploy_tokens`,
+      {
+        id: projectId,
+        name: "gitlab-deploy-token",
+        scopes: ["read_registry"],
+      },
+      "POST",
+    );
+  }
+
   const fullName = getFullKubernetesClusterName(deployConfig.cluster);
   instance.log(`cluster: ${fullName}`);
 
@@ -32,28 +63,28 @@ 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}'`
+    `TERM=dumb kubectl cluster-info | grep -E 'Kubernetes master|Kubernetes control plane' | awk '/http/ {print $NF}'`,
   ).then((s) => s.stdout.trim());
 
   // first upsert service acount in the ns
   try {
     await exec(
-      `kubectl delete serviceaccount --namespace ${namespace} ${serviceAccountName}`
+      `kubectl delete serviceaccount --namespace ${namespace} ${serviceAccountName}`,
     );
     await exec(
-      `kubectl delete rolebinding --namespace ${namespace} ${serviceAccountName}`
+      `kubectl delete rolebinding --namespace ${namespace} ${serviceAccountName}`,
     );
     await exec(
-      `kubectl delete role --namespace ${namespace} ${serviceAccountName}`
+      `kubectl delete role --namespace ${namespace} ${serviceAccountName}`,
     );
   } catch (e) {
     // ignore
   }
 
   await exec(
-    `kubectl create serviceaccount --namespace ${namespace} ${serviceAccountName}`
+    `kubectl create serviceaccount --namespace ${namespace} ${serviceAccountName}`,
   );
 
   // upsert role in the ns
@@ -101,10 +132,10 @@ EOF
   `);
 
   const KUBE_CA_PEM = await exec(
-    `kubectl get secret ${secretName} --namespace ${namespace} -o jsonpath="{['data']['ca\\.crt']}"`
+    `kubectl get secret ${secretName} --namespace ${namespace} -o jsonpath="{['data']['ca\\.crt']}"`,
   ).then((c) => c.stdout.trim());
   const KUBE_TOKEN = await exec(
-    `kubectl get secret ${secretName} --namespace ${namespace} -o jsonpath="{['data']['token']}" | base64 --decode`
+    `kubectl get secret ${secretName} --namespace ${namespace} -o jsonpath="{['data']['token']}" | base64 --decode`,
   ).then((c) => c.stdout.trim());
 
   const vars = {
@@ -120,7 +151,7 @@ EOF
         missing.map((m) => m[0]).join(", ") +
         ". Check whether your local kubectl is still working for '" +
         fullName +
-        "'"
+        "'",
     );
   }
 
@@ -132,9 +163,9 @@ EOF
   await upsertAllVariables(
     instance,
     vars,
-    context.environment.shortName,
-    context.componentName,
-    false // no backup
+    context.env,
+    context.name,
+    false, // no backup
   );
   instance.log("done!");
 };

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

@@ -1,22 +1,17 @@
 import type { CommandInstance } from "vorpal";
 import { doGitlabRequest, getProjectInfo } from "../../../../../utils/gitlab";
 
-const catladderTopic = "catladder"
+const catladderTopic = "catladder";
 
 export const setupTopic = async (instance: CommandInstance) => {
-  const { id: projectId } = await getProjectInfo(
-    instance
-  );
+  const { id: projectId } = await getProjectInfo(instance);
 
-  const { topics } = await doGitlabRequest(
-    instance,
-    `projects/${projectId}`
-  );
+  const { topics } = await doGitlabRequest(instance, `projects/${projectId}`);
 
   await doGitlabRequest(
     instance,
     `projects/${projectId}`,
     { topics: [catladderTopic, ...topics] },
-    "PUT"
+    "PUT",
   );
 };

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

@@ -12,12 +12,21 @@ export const allEnvs = async () => {
   return getAllEnvsInAllComponents(config);
 };
 
+export const allComponents = async () => {
+  const config = await getProjectConfig();
+  if (!config) {
+    return [];
+  }
+
+  return Object.keys(config.components);
+};
+
 export const envAndComponents = async () => {
   const allEnvAndcomponents = await getAllComponentsWithAllEnvsFlat();
 
   return allEnvAndcomponents.reduce<string[]>(
     (acc, { env, componentName }) => [...acc, env + ":" + componentName],
-    []
+    [],
   );
 };
 

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

@@ -13,17 +13,15 @@ import {
 export default async function (envComponent: string) {
   const { env, componentName } = parseChoice(envComponent);
   const context = await getPipelineContextByChoice(env, componentName);
-  if (!isOfDeployType(context.componentConfig.deploy, "kubernetes")) {
+  if (!isOfDeployType(context.deploy?.config, "kubernetes")) {
     throw new Error("can't ensure cluster for non-kubernetes deployments");
   }
-  const cluster = getFullKubernetesClusterName(
-    context.componentConfig.deploy.cluster
-  );
+  const cluster = getFullKubernetesClusterName(context.deploy?.config.cluster);
   const connectedClusterName = await getCurrentConnectedClusterName();
 
   if (cluster !== connectedClusterName) {
     this.log(
-      `you are currently connected to cluster '${connectedClusterName}'`
+      `you are currently connected to cluster '${connectedClusterName}'`,
     );
     this.log(`but the project requires cluster '${cluster}'`);
     const { shouldContinue } = await this.prompt({

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

@@ -1,33 +1,20 @@
-import type { Context} from "@catladder/pipeline";
+import type { ComponentContext } from "@catladder/pipeline";
 import { getKubernetesNamespace } from "@catladder/pipeline";
 import type { V1ObjectMeta } from "@kubernetes/client-node";
 import { V1Namespace } from "@kubernetes/client-node";
 import { getk8sApi } from "../../../../../k8sApi";
 
-export default async function (context: Context) {
-  const namespace = getKubernetesNamespace(
-    context.fullConfig,
-    context.environment.shortName
-  );
+export default async function (context: ComponentContext) {
+  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 ?? {}),
     },
   };
@@ -44,7 +31,7 @@ export default async function (context: Context) {
       undefined,
       undefined,
       undefined,
-      { headers: { "content-type": "application/merge-patch+json" } } // see https://github.com/kubernetes-client/javascript/issues/443
+      { headers: { "content-type": "application/merge-patch+json" } }, // see https://github.com/kubernetes-client/javascript/issues/443
     ); // update meta data
   } catch (e) {
     if (e.response?.body?.reason === "NotFound") {

package/src/apps/cli/utils/getGoogleAuthUserNumber.ts

@@ -8,7 +8,7 @@ const KEY = "googleAuthUserNumber";
 export const getGoogleAuthUserNumber = async function () {
   if (!(await hasPreference(KEY))) {
     this.log(
-      "Please type in your google auth user number (0 if you have only one google account or maybe 1 if you have multiple)"
+      "Please type in your google auth user number (0 if you have only one google account or maybe 1 if you have multiple)",
     );
 
     const { authUserNumber } = await this.prompt({

package/src/apps/cli/verify/index.ts

@@ -1,10 +1,6 @@
 import type Vorpal from "vorpal";
-import {
-  getGitlabCi,
-  getProjectConfig,
-} from "../../../config/getProjectConfig";
+
 import { hasGitlabToken, setupGitlabToken } from "../../../utils/gitlab";
-import { isV2, migrateV2 } from "./migration/fromv2";
 
 export const verify = async (vorpal: Vorpal) => {
   // check if has all settings
@@ -15,16 +11,4 @@ export const verify = async (vorpal: Vorpal) => {
     });
     vorpal.exec("setup-gitlab-token");
   }
-
-  const projectConfig = await getProjectConfig();
-  try {
-    const gitlabCi = getGitlabCi();
-
-    if (gitlabCi && !projectConfig && (await isV2())) {
-      vorpal.log("no project config, needs migration");
-      await migrateV2(vorpal);
-    }
-  } catch (e) {
-    // no gitroot, ignore
-  }
 };

package/src/catenv.ts

@@ -1,6 +1,20 @@
-import catenv from './apps/catenv/catenv';
+import catenv from "./apps/catenv/catenv";
 
-catenv().then(() => {
+import { parseChoice } from "./config/parseChoice";
+
+const args = process.argv.slice(2);
+
+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();
 });