@catladder/cli 0.0.0-node16-ddfae617 → 0.0.0-prettier-cbceeed9

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

@@ -1,17 +1,23 @@
+import type { Context } from "@catladder/pipeline";
 import { isOfDeployType } from "@catladder/pipeline";
 import { spawn } from "child-process-promise";
 import { writeFile } from "fs-extra";
 import { withFile } from "tmp-promise";
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 import {
   getEnvVars,
   getGitlabVar,
   getPipelineContextByChoice,
-  getProjectConfig,
   parseChoice,
 } from "../../../../config/getProjectConfig";
 import { envAndComponents } from "./utils/autocompletions";
 
+type ProxyInfo = {
+  instanceName: string;
+  DB_NAME: string;
+  DB_PASSWORD: string;
+  DB_USER: string;
+};
 export default async (vorpal: Vorpal) =>
   vorpal
     .command("project-cloud-sql-proxy <envComponent>", "proxy to cloud sql db")
@@ -19,9 +25,26 @@ export default async (vorpal: Vorpal) =>
     .action(async function ({ envComponent }) {
       const { env, componentName } = parseChoice(envComponent);
 
-      const config = await getProjectConfig();
-      // skynet-164509:europe-west6:pvl-cyclomania-review=tcp:5432
+      const context = await getPipelineContextByChoice(env, componentName);
+      let proxyInfo: ProxyInfo;
+
+      if (env === "review") {
+        vorpal.log(
+          "⚠️ connection string does not include mr information on review environments"
+        );
+      }
+      if (isOfDeployType(context.componentConfig.deploy, "kubernetes")) {
+        proxyInfo = await getProxyInfoForKubernetes(context);
+      } else if (
+        isOfDeployType(context.componentConfig.deploy, "google-cloudrun")
+      ) {
+        proxyInfo = await getProxyInfoForCloudRun(context);
+      } else {
+        throw new Error("unsupported environment");
+      }
 
+      // skynet-164509:europe-west6:pvl-cyclomania-review=tcp:5432
+      const { DB_PASSWORD, DB_NAME, DB_USER, instanceName } = proxyInfo;
       const { localPort } = await this.prompt({
         type: "number",
         name: "localPort",
@@ -29,35 +52,16 @@ export default async (vorpal: Vorpal) =>
         message: "Local port: ",
       });
 
-      const envVars = await getEnvVars(this, env, componentName);
-      const POSTGRESQL_PASSWORD = envVars?.POSTGRESQL_PASSWORD;
-
-      const context = await getPipelineContextByChoice(env, componentName);
-      if (!isOfDeployType(context.componentConfig.deploy, "kubernetes")) {
-        throw new Error("currently only supported for kubernetes deployment");
-      }
       this.log("");
-      this.log(`postgres-PW: ${POSTGRESQL_PASSWORD}`);
+      this.log(`postgres-PW: ${DB_PASSWORD}`);
       this.log("");
       this.log(
-        `POSTGRESQL_URL=postgresql://postgres:${POSTGRESQL_PASSWORD}@localhost:${localPort}/${context.environment.envVars.KUBE_APP_NAME}?schema=public`
+        `POSTGRESQL_URL=postgresql://${DB_USER}:${DB_PASSWORD}@localhost:${localPort}/${DB_NAME}?schema=public`
       );
       this.log("");
 
-      const values = context.componentConfig.deploy.values;
-
-      const projectId =
-        values?.cloudsql?.projectId ||
-        context.componentConfig.deploy.cluster?.projectId;
-
-      const defaultInstanceId = `${config.customerName}-${config.appName}-${env}`;
-      const instanceId = values?.cloudsql?.instanceId || defaultInstanceId;
-
-      const defaultRegion = "europe-west6"; // currently hardcoded
-      const region = values?.cloudsql?.region || defaultRegion;
-
-      const instanceName = `${projectId}:${region}:${instanceId}=tcp:${localPort}`;
-
+      // legacy, some projects have the cloudsqlProxyCredentials in the secrets
+      // actually it works without, if the current local shell user has access to the db through google cloud
       const cloudsqlProxyCredentials = await getGitlabVar(
         this,
         env,
@@ -65,20 +69,20 @@ export default async (vorpal: Vorpal) =>
         "cloudsqlProxyCredentials"
       );
 
-      if (!cloudsqlProxyCredentials) {
-        // we store cloudsqlProxyCredentials on gitlab, but its currently get pushed via bitwarden due to legacy reasons
-        // this will be fixed with when https://git.panter.ch/catladder/catladder/-/merge_requests/32/ is merged
-        this.log(
-          "cloudsqlProxyCredentials env var missing in gitlab. Please contact gilde-ci-cd about that."
-        );
-        throw new Error("cloudsqlProxyCredentials missing in secrets");
-      }
       await withFile(async ({ path: tmpFilePath }) => {
-        await writeFile(tmpFilePath, cloudsqlProxyCredentials);
+        if (cloudsqlProxyCredentials) {
+          await writeFile(tmpFilePath, cloudsqlProxyCredentials);
+        }
 
         await spawn(
           "cloud_sql_proxy",
-          ["-instances", instanceName, "-credential_file", tmpFilePath],
+          [
+            "-instances",
+            `${instanceName}=tcp:${localPort}`,
+            ...(cloudsqlProxyCredentials
+              ? ["-credential_file", tmpFilePath]
+              : []),
+          ],
           {
             stdio: "inherit",
             shell: true,
@@ -86,3 +90,72 @@ export default async (vorpal: Vorpal) =>
         );
       });
     });
+
+const getProxyInfoForKubernetes = async (
+  context: Context
+): Promise<ProxyInfo> => {
+  if (!isOfDeployType(context.componentConfig.deploy, "kubernetes")) {
+    throw new Error("unsupported");
+  }
+
+  const envVars = await getEnvVars(
+    this,
+    context.environment.shortName,
+    context.componentName
+  );
+
+  const DB_PASSWORD = envVars?.DB_PASSWORD || envVars?.POSTGRESQL_PASSWORD;
+
+  const DB_NAME = context.environment.envVars.KUBE_APP_NAME;
+
+  const values = context.componentConfig.deploy.values;
+
+  const projectId =
+    values?.cloudsql?.projectId ||
+    context.componentConfig.deploy.cluster?.projectId;
+
+  const defaultInstanceId = `${context.fullConfig.customerName}-${context.fullConfig.appName}-${context.environment.shortName}`;
+  const instanceId = values?.cloudsql?.instanceId || defaultInstanceId;
+
+  const defaultRegion = "europe-west6"; // currently hardcoded
+  const region = values?.cloudsql?.region || defaultRegion;
+
+  const instanceName = `${projectId}:${region}:${instanceId}`;
+
+  return {
+    instanceName,
+    DB_PASSWORD,
+    DB_NAME,
+    DB_USER: "postgres",
+  };
+};
+
+const getProxyInfoForCloudRun = async (
+  context: Context
+): Promise<ProxyInfo> => {
+  if (
+    !isOfDeployType(context.componentConfig.deploy, "google-cloudrun") ||
+    !context.componentConfig.deploy.cloudSql
+  ) {
+    throw new Error("unsupported");
+  }
+
+  const envVars = await getEnvVars(
+    this,
+    context.environment.shortName,
+    context.componentName
+  );
+
+  const DB_PASSWORD = envVars?.DB_PASSWORD;
+  const DB_USER = envVars?.DB_USER;
+
+  const DB_NAME = context.environment.envVars.DB_NAME;
+
+  return {
+    instanceName:
+      context.componentConfig.deploy.cloudSql.instanceConnectionName,
+    DB_PASSWORD,
+    DB_NAME,
+    DB_USER,
+  };
+};

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

@@ -1,19 +1,18 @@
 /* eslint-disable no-constant-condition */
+import { getSecretVarName } from "@catladder/pipeline";
 import { stripIndents } from "common-tags";
 import { difference } from "lodash";
-import Vorpal, { CommandInstance } from "vorpal";
-import { GOOGLE_CLOUD_SQL_PASS_PATH } from "../../../../config/constants";
+import type { CommandInstance } from "vorpal";
+import type Vorpal from "vorpal";
 import {
   getAllComponentsWithAllEnvsHierarchical,
   getEnvironment,
   getEnvVars,
-  getPipelineContextByChoice,
   getProjectComponents,
   parseChoice,
 } from "../../../../config/getProjectConfig";
 import { editAsFile } from "../../../../utils/editAsFile";
 import { upsertAllVariables } from "../../../../utils/gitlab";
-import { hasBitwarden, readPass } from "../../../../utils/passwordstore";
 import { delay } from "../../../../utils/promise";
 import { allEnvsAndAllComponents } from "./utils/autocompletions";
 
@@ -45,6 +44,7 @@ const resolveJson = (v: Vars) =>
       ];
     })
   );
+
 const getEnvVarsToEdit = async (
   instance: CommandInstance,
   env: string,
@@ -54,7 +54,13 @@ const getEnvVarsToEdit = async (
 
   const allEnvVars = await getEnvVars(instance, env, componentName);
   return Object.fromEntries(
-    secretEnvVarKeys.map((key) => [key, allEnvVars[key]])
+    secretEnvVarKeys.map((key) => {
+      const value = allEnvVars[key];
+      // due to some quirky way to resolve these variables, unset variables have the $CL_ prefix, so we remove thouse here
+      const variableIsNotSet =
+        value === "$" + getSecretVarName(env, componentName, key);
+      return [key, variableIsNotSet ? "🚨 FILL ME" : value];
+    })
   );
 };
 const doItFor = async (
@@ -148,32 +154,7 @@ const doItFor = async (
         env,
         componentName
       );
-
-      if (hasBitwarden()) {
-        // add cloud sql secret if needed.
-        // TODO: this is legacy, in the future we want to have one service account per app
-        try {
-          const context = await getPipelineContextByChoice(env, componentName);
-          if (
-            context.componentConfig.deploy &&
-            context.componentConfig.deploy.type === "kubernetes" &&
-            context.componentConfig.deploy.values?.cloudsql?.enabled
-          ) {
-            await upsertAllVariables(
-              instance,
-              {
-                cloudsqlProxyCredentials: await readPass(
-                  GOOGLE_CLOUD_SQL_PASS_PATH
-                ),
-              },
-              env,
-              componentName
-            );
-          }
-        } catch (e) {
-          // ignore atm
-        }
-      }
+      instance.log("");
       instance.log("✅ " + env + ":" + componentName);
     }
   }

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

@@ -1,11 +1,9 @@
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 import { getk8sApi } from "../../../../k8sApi";
+import { getProjectPodNames } from "../../../../kubernetes";
 
 import { logError } from "../../../../utils/log";
-import {
-  getProjectNamespace,
-  getProjectPodNames,
-} from "../../../../utils/projects";
+import { getProjectNamespace } from "../../../../utils/projects";
 import { envAndComponents } from "./utils/autocompletions";
 import ensureCluster from "./utils/ensureCluster";
 

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

@@ -1,4 +1,4 @@
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 import { exec } from "child-process-promise";
 import { getProjectNamespace } from "../../../../utils/projects";
 import { envAndComponents } from "./utils/autocompletions";

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

@@ -1,4 +1,4 @@
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 import { getEnvVars, parseChoice } from "../../../../config/getProjectConfig";
 import { envAndComponents } from "./utils/autocompletions";
 

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

@@ -1,5 +1,5 @@
 import { spawn } from "child-process-promise";
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 
 export default async (vorpal: Vorpal) =>
   vorpal
@@ -8,7 +8,7 @@ export default async (vorpal: Vorpal) =>
       "show the total worktime that you spent on a project"
     )
     .action(async () => {
-      await spawn("sh", ["-c", "curl -L http://bit.ly/10hA8iC | bash"], {
+      await spawn("sh", ["-c", "curl -s -L http://bit.ly/3VQEKNq | bash"], {
         stdio: ["pipe", "inherit", "pipe"],
       });
     });

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

@@ -1,9 +1,7 @@
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
+import { getProjectPodNames } from "../../../../kubernetes";
 import { logError } from "../../../../utils/log";
-import {
-  getProjectNamespace,
-  getProjectPodNames,
-} from "../../../../utils/projects";
+import { getProjectNamespace } from "../../../../utils/projects";
 import { getShell } from "../../../../utils/shell";
 
 import { envAndComponents } from "./utils/autocompletions";

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

@@ -1,7 +1,8 @@
 import { exec } from "child-process-promise";
 import { last } from "lodash";
 import open from "open";
-import Vorpal, { CommandInstance } from "vorpal";
+import type { CommandInstance } from "vorpal";
+import type Vorpal from "vorpal";
 import {
   doGitlabRequest,
   getGitlabToken,

package/src/apps/cli/commands/project/commandInitProject.old.ts

@@ -2,7 +2,7 @@ import { readFile, writeFile } from "fs-extra";
 import { dump } from "js-yaml";
 import { mapKeys, snakeCase, toUpper } from "lodash";
 import path from "path";
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 import { hasGitlabCiFile } from "../../../../utils/projects";
 
 const transformVar = (key: string) => toUpper(snakeCase(key));

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

@@ -1,7 +1,7 @@
 import { dump } from "js-yaml";
 import { pick } from "lodash";
-import Vorpal from "vorpal";
-import { getProjectPods } from "../../../../utils/projects";
+import type Vorpal from "vorpal";
+import { getProjectPods } from "../../../../kubernetes";
 import { envAndComponents } from "./utils/autocompletions";
 import ensureCluster from "./utils/ensureCluster";
 

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

@@ -1,5 +1,5 @@
 import { exec } from "child-process-promise";
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 import {
   getEnvironment,
   parseChoice,
@@ -43,8 +43,9 @@ export default async (vorpal: Vorpal) =>
           // ignore
         }
 
-        const releaseName = (await getEnvironment(env, componentName)).envVars
-          .RELEASE_NAME; // TODO: maybe its own function would be better
+        // we use the app full name as the release name
+        const releaseName = (await getEnvironment(env, componentName)).fullName;
+
         this.log(`helm release name: ${releaseName}`);
         this.log("");
         this.log("migrating now... 😼. This may take a moment");

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

@@ -1,4 +1,4 @@
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 import { getProjectNamespace } from "../../../../utils/projects";
 import { envAndComponents } from "./utils/autocompletions";
 

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

@@ -1,11 +1,11 @@
 import open from "open";
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 import {
   GRAFANA_PROXY_LOCAL_PORT,
   GRAFANA_PROXY_TARGET_PORT,
 } from "../../../../config/constants";
 
-import { startPortForward } from "../../../../utils/portForward";
+import { startKubePortForward } from "../../../../kubernetes/portForward";
 
 import { getProjectNamespace } from "../../../../utils/projects";
 
@@ -22,7 +22,7 @@ export default async (vorpal: Vorpal) =>
       await ensureCluster.call(this, envComponent);
       const namespace = await getProjectNamespace(envComponent);
       const url = `http://localhost:${GRAFANA_PROXY_LOCAL_PORT}/namespace.html?name=${namespace}`;
-      await startPortForward(
+      await startKubePortForward(
         "deployment/kubecost-cost-analyzer",
         GRAFANA_PROXY_LOCAL_PORT,
         GRAFANA_PROXY_TARGET_PORT,

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

@@ -1,48 +1,28 @@
-import Vorpal from "vorpal";
+import { isOfDeployType } from "@catladder/pipeline";
+import type Vorpal from "vorpal";
 import {
   getPipelineContextByChoice,
   parseChoice,
 } from "../../../../config/getProjectConfig";
-import { getGoogleAuthUserNumber } from "../../utils/getGoogleAuthUserNumber";
-import { openGoogleCloudKubernetesDashboard } from "../shared";
+import { openGoogleCloudRunDashboard } from "../../../../gcloud/cloudRun/openCloudRunDashboards";
+import { openGoogleCloudKubernetesDashboard } from "../../../../kubernetes/openKubernetesDashboards";
+
 import { envAndComponents } from "./utils/autocompletions";
+
 export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-open-dashboard <envComponent>",
-      "open kubernetes dashboard on google"
+      "open an apps dashboard (kubernetes or cloudrun)"
     )
     .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       const { env, componentName } = parseChoice(envComponent);
-      const { componentConfig, environment } = await getPipelineContextByChoice(
-        env,
-        componentName
-      );
-
-      if (
-        !componentConfig.deploy ||
-        componentConfig.deploy.type !== "kubernetes"
-      ) {
-        throw new Error(
-          "only kubernetes deployments are supported at the moment"
-        );
+      const context = await getPipelineContextByChoice(env, componentName);
+      if (isOfDeployType(context.componentConfig.deploy, "kubernetes")) {
+        await openGoogleCloudKubernetesDashboard(this, context);
       }
-
-      if (
-        !componentConfig.deploy.cluster ||
-        componentConfig.deploy.cluster.type !== "gcloud"
-      ) {
-        throw new Error("no gcloud custer configured");
+      if (isOfDeployType(context.componentConfig.deploy, "google-cloudrun")) {
+        await openGoogleCloudRunDashboard(this, context);
       }
-      // currently only supports kubernetes
-      const namespace = environment.envVars.KUBE_NAMESPACE;
-
-      const authGoogleNumber = await getGoogleAuthUserNumber.call(this, vorpal);
-
-      openGoogleCloudKubernetesDashboard(
-        componentConfig.deploy.cluster,
-        namespace,
-        authGoogleNumber
-      );
     });

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

@@ -1,5 +1,5 @@
 import open from "open";
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 import {
   getEnvironment,
   parseChoice,

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

@@ -1,5 +1,5 @@
-import Vorpal from "vorpal";
-import { $ } from "zx";
+import type Vorpal from "vorpal";
+import { exec } from "child-process-promise";
 
 export default async (vorpal: Vorpal) =>
   vorpal
@@ -8,5 +8,5 @@ export default async (vorpal: Vorpal) =>
       "open the repo on gitlab / github in your browser"
     )
     .action(async () => {
-      await $`npx git-open`;
+      await exec("npx git-open");
     });

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

@@ -1,6 +1,6 @@
 import open from "open";
-import { startPortForward } from "../../../../utils/portForward";
-import Vorpal from "vorpal";
+import { startKubePortForward } from "../../../../kubernetes/portForward";
+import type Vorpal from "vorpal";
 import {
   GRAFANA_PROXY_LOCAL_PORT,
   GRAFANA_PROXY_TARGET_PORT,
@@ -21,7 +21,7 @@ export default async (vorpal: Vorpal) =>
       await ensureCluster.call(this, envComponent);
       const namespace = await getProjectNamespace(envComponent);
       const url = `http://localhost:${GRAFANA_PROXY_LOCAL_PORT}/grafana/d/at-cost-analysis-namespace2/namespace-utilization-metrics?var-namespace=${namespace}`;
-      await startPortForward(
+      await startKubePortForward(
         "deployment/kubecost-cost-analyzer",
         GRAFANA_PROXY_LOCAL_PORT,
         GRAFANA_PROXY_TARGET_PORT,

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

@@ -1,15 +1,13 @@
 import open from "open";
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 import {
   GRAFANA_PROXY_LOCAL_PORT,
   GRAFANA_PROXY_TARGET_PORT,
 } from "../../../../config/constants";
+import { getProjectPodNames } from "../../../../kubernetes";
 import { logError } from "../../../../utils/log";
-import { startPortForward } from "../../../../utils/portForward";
-import {
-  getProjectNamespace,
-  getProjectPodNames,
-} from "../../../../utils/projects";
+import { startKubePortForward } from "../../../../kubernetes/portForward";
+import { getProjectNamespace } from "../../../../utils/projects";
 import { envAndComponents } from "./utils/autocompletions";
 import ensureCluster from "./utils/ensureCluster";
 
@@ -35,7 +33,7 @@ export default async (vorpal: Vorpal) =>
       });
       const namespace = await getProjectNamespace(envComponent);
       const url = `http://localhost:${GRAFANA_PROXY_LOCAL_PORT}/grafana/d/at-cost-analysis-pod/pod-cost-and-utilization-metrics?var-namespace=${namespace}&var-pod=${podName}`;
-      await startPortForward(
+      await startKubePortForward(
         "deployment/kubecost-cost-analyzer",
         GRAFANA_PROXY_LOCAL_PORT,
         GRAFANA_PROXY_TARGET_PORT,

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

@@ -1,14 +1,10 @@
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 import {
   getPipelineContextByChoice,
   parseChoice,
 } from "../../../../config/getProjectConfig";
-import { getCurrentConnectedClusterName } from "../../../../utils/cluster";
-import { getProjectNamespace } from "../../../../utils/projects";
-import { getGoogleAuthUserNumber } from "../../utils/getGoogleAuthUserNumber";
-import { openGoogleCloudLogs } from "../shared";
+import { openGoogleCloudLogs } from "../../../../kubernetes/openKubernetesDashboards";
 import { envAndComponents } from "./utils/autocompletions";
-import ensureCluster from "./utils/ensureCluster";
 
 export default async (vorpal: Vorpal) =>
   vorpal
@@ -19,34 +15,7 @@ export default async (vorpal: Vorpal) =>
     .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       const { env, componentName } = parseChoice(envComponent);
-      const { componentConfig, environment } = await getPipelineContextByChoice(
-        env,
-        componentName
-      );
+      const context = await getPipelineContextByChoice(env, componentName);
 
-      if (
-        !componentConfig.deploy ||
-        componentConfig.deploy.type !== "kubernetes"
-      ) {
-        throw new Error(
-          "only kubernetes deployments are supported at the moment"
-        );
-      }
-
-      if (
-        !componentConfig.deploy.cluster ||
-        componentConfig.deploy.cluster.type !== "gcloud"
-      ) {
-        throw new Error("no gcloud custer configured");
-      }
-      // currently only supports kubernetes
-      const namespace = environment.envVars.KUBE_NAMESPACE;
-
-      const authGoogleNumber = await getGoogleAuthUserNumber.call(this, vorpal);
-
-      await openGoogleCloudLogs(
-        componentConfig.deploy.cluster,
-        namespace,
-        authGoogleNumber
-      );
+      await openGoogleCloudLogs(this, context);
     });

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

@@ -1,4 +1,4 @@
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 import { exec } from "child-process-promise";
 import { getProjectNamespace } from "../../../../utils/projects";
 import { envAndComponents } from "./utils/autocompletions";