@catladder/cli 3.48.0 → 4.0.1

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

@@ -1,194 +0,0 @@
-import type { ComponentContext } from "@catladder/pipeline";
-import {
-  createKubernetesCloudsqlBaseValues,
-  getDeployConfigType,
-  isOfDeployType,
-} from "@catladder/pipeline";
-import type Vorpal from "vorpal";
-import type { CommandInstance } from "vorpal";
-import clipboard from "clipboardy";
-import {
-  getEnvVarsResolved,
-  getPipelineContextByChoice,
-  parseChoice,
-} from "../../../../config/getProjectConfig";
-import { envAndComponents } from "./utils/autocompletions";
-import {
-  ERROR_NOT_INSTALLED,
-  startCloudSqlProxyInCurrentShell,
-} from "../../../../gcloud/cloudSql/startProxy";
-import { logError, logLines, logWarning } from "../../../../utils/log";
-
-type ProxyInfo = {
-  instanceName: string;
-  DB_NAME: string;
-  DB_PASSWORD: string;
-  DB_USER: string;
-};
-
-const getProxyInfo = (context: ComponentContext) => {
-  if (isOfDeployType(context.deploy?.config, "kubernetes")) {
-    return getProxyInfoForKubernetes(this, context);
-  } else if (isOfDeployType(context.deploy?.config, "google-cloudrun")) {
-    return getProxyInfoForCloudRun(this, context);
-  }
-  throw new Error(`unsupported environment: ${context.deploy?.config?.type}`);
-};
-
-const getProxyInfoForKubernetes = async (
-  vorpal: CommandInstance,
-  context: ComponentContext,
-): Promise<ProxyInfo> => {
-  if (!isOfDeployType(context.deploy?.config, "kubernetes")) {
-    throw new Error("unsupported");
-  }
-
-  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);
-
-  const DB_PASSWORD = (
-    envVars?.DB_PASSWORD || envVars?.POSTGRESQL_PASSWORD
-  )?.toString();
-
-  const DB_NAME = cloudSqlValues.cloudsql.fullDbName.toString();
-
-  const instanceName = cloudSqlValues.cloudsql.instanceConnectionName;
-
-  return {
-    instanceName,
-    DB_PASSWORD,
-    DB_NAME,
-    DB_USER: "postgres",
-  };
-};
-
-const getProxyInfoForCloudRun = async (
-  vorpal: CommandInstance,
-  context: ComponentContext,
-): Promise<ProxyInfo> => {
-  if (
-    !isOfDeployType(context.deploy?.config, "google-cloudrun") ||
-    !context.deploy?.config.cloudSql
-  ) {
-    const deployType = getDeployConfigType(context.deploy?.config);
-    const errorMessage =
-      deployType === "google-cloudrun"
-        ? `DeployConfig is missing the cloudSql property`
-        : `Unsupported DeployConfig type: ${deployType}`;
-    logError(vorpal, errorMessage);
-    throw new Error(errorMessage);
-  }
-  const envVars = await getEnvVarsResolved(vorpal, context.env, context.name);
-  return {
-    instanceName: context.deploy?.config.cloudSql.instanceConnectionName,
-    DB_PASSWORD: envVars?.DB_PASSWORD?.toString(),
-    DB_NAME: context.environment.envVars.DB_NAME.toString(),
-    DB_USER: envVars?.DB_USER?.toString(),
-  };
-};
-
-const getDbUrl = (
-  { DB_PASSWORD, DB_NAME, DB_USER }: ProxyInfo,
-  localPort: string,
-  additional: string = "",
-) =>
-  `DATABASE_URL="postgresql://${DB_USER}:${DB_PASSWORD}@localhost:${localPort}/${DB_NAME}${additional}"`;
-
-const getJdbcUrl = (
-  { DB_PASSWORD, DB_NAME, DB_USER }: ProxyInfo,
-  localPort: string,
-) =>
-  `DATABASE_JDBC_URL="jdbc:postgresql://localhost:${localPort}/${DB_NAME}?schema=public&user=${DB_USER}&password=${DB_PASSWORD}"`;
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command("project-cloud-sql-proxy <envComponent>", "proxy to cloud sql db")
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      const { env, componentName } = parseChoice(envComponent);
-      if (!componentName) {
-        logWarning(this, "need componentName");
-        return;
-      }
-
-      const context = await getPipelineContextByChoice(env, componentName);
-
-      if (env === "review") {
-        logWarning(
-          this,
-          "connection string does not include mr information on review environments",
-        );
-      }
-
-      const { localPort } = await this.prompt({
-        type: "number",
-        name: "localPort",
-        default: "54320",
-        message: "Local port: ",
-      });
-
-      const proxyInfo = await getProxyInfo(context);
-
-      /**
-       * Env variables for libpq (e.g. psql client)
-       * https://www.postgresql.org/docs/current/libpq-envars.html#LIBPQ-ENVARS
-       */
-      const psqlEnvVars = {
-        PGPASSWORD: proxyInfo.DB_PASSWORD,
-        PGUSER: proxyInfo.DB_USER,
-        PGDATABASE: proxyInfo.DB_NAME,
-        PGHOST: "localhost",
-        PGPORT: localPort,
-      };
-      const lipbqEnvVarDeclarations = Object.entries(psqlEnvVars).map(
-        ([key, value]) => `${key}="${value}"`,
-      );
-      const dbUrl = getDbUrl(proxyInfo, localPort);
-      const jdbcUrl = getJdbcUrl(proxyInfo, localPort);
-
-      clipboard.writeSync(
-        [
-          "",
-          "## CloudSQL proxy connection .env variables",
-          dbUrl,
-          jdbcUrl,
-          "## DATABASE_URL with schema=public parameter (e. g. Prisma requires this):",
-          `# ${getDbUrl(proxyInfo, localPort, `?schema=public`)}`,
-          "## Env variables for libpq (e.g. psql client https://www.postgresql.org/docs/current/libpq-envars.html#LIBPQ-ENVARS)",
-          ...lipbqEnvVarDeclarations,
-          "",
-        ].join("\n"),
-      );
-
-      logLines(
-        this,
-        null,
-        "Connection strings env variables DATABASE_URL and those for the 'psql' client (copied to your clipboard for .env file):",
-        dbUrl,
-        jdbcUrl,
-        ...lipbqEnvVarDeclarations,
-        null,
-        "DATABASE_URL with schema=public parameter (e. g. Prisma requires this):",
-        getDbUrl(proxyInfo, localPort, `?schema=public`),
-        null,
-      );
-
-      try {
-        await startCloudSqlProxyInCurrentShell({
-          instanceName: proxyInfo.instanceName,
-          localPort,
-        });
-      } catch (error) {
-        if (!(error instanceof Error)) throw error;
-        if (error.message !== ERROR_NOT_INSTALLED) throw error;
-        logError(
-          this,
-          error.message,
-          null,
-          "Please install the Cloud SQL Auth Proxy from:",
-          `https://cloud.google.com/sql/docs/postgres/connect-auth-proxy#install`,
-          null,
-        );
-      }
-    });

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

@@ -1,48 +0,0 @@
-import type Vorpal from "vorpal";
-import { getk8sApi } from "../../../../k8sApi";
-import { getProjectPodNames } from "../../../../kubernetes";
-
-import { logError } from "../../../../utils/log";
-import { getProjectNamespace } from "../../../../utils/projects";
-import { envAndComponents } from "./utils/autocompletions";
-import ensureCluster from "./utils/ensureCluster";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command("project-delete-pods <envComponent>", "delete / restart pods")
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      await ensureCluster.call(this, envComponent);
-      const namespace = await getProjectNamespace(envComponent);
-      const podNames = await getProjectPodNames(envComponent);
-      if (podNames.length === 0) {
-        logError(this, "sorry, no pods found");
-        return;
-      }
-      const { selectedPodNames } = await this.prompt({
-        type: "checkbox",
-        name: "selectedPodNames",
-        choices: podNames,
-        message: "Which pods to delete / restart ? 🤔  ",
-      });
-
-      this.log(
-        "the following pods will be DELETED 🙀 (and therefore restarted 😸)",
-      );
-      this.log("");
-      selectedPodNames.forEach((n: string) => this.log(n));
-      this.log("");
-      const { shouldContinue } = await this.prompt({
-        type: "confirm",
-        name: "shouldContinue",
-        message: "Continue ? 🤔  ",
-      });
-      this.log("");
-      const k8sApi = getk8sApi();
-      if (shouldContinue) {
-        for (const podName of selectedPodNames) {
-          await k8sApi.deleteNamespacedPod(podName, namespace, "true");
-          this.log(`deleted pod '${podName}'`);
-        }
-      }
-    });

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

@@ -1,33 +0,0 @@
-import type Vorpal from "vorpal";
-import { exec } from "child-process-promise";
-import { getProjectNamespace } from "../../../../utils/projects";
-import { envAndComponents } from "./utils/autocompletions";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command(
-      "project-delete <envComponent>",
-      "deletes a environment of a project (it deletes the namespace)",
-    )
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      const namespace = await getProjectNamespace(envComponent);
-      const { shouldContinue } = await this.prompt({
-        type: "confirm",
-        name: "shouldContinue",
-        message: `This will delete the ${namespace}. You have to reinitialize it if you need it in the future. All data will be lost. Continue? 🤔 `,
-      });
-
-      if (!shouldContinue) {
-        return;
-      }
-
-      const fullCommand = `kubectl delete namespace ${namespace}`;
-      const { stdout } = await exec(fullCommand, {
-        env: {
-          ...process.env,
-          DEBUG: "",
-        },
-      });
-      this.log(stdout);
-    });

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

@@ -1,18 +0,0 @@
-import type Vorpal from "vorpal";
-import {
-  getEnvVarsResolved,
-  parseChoice,
-} from "../../../../config/getProjectConfig";
-import { envAndComponents } from "./utils/autocompletions";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command("project-env-vars <envComponent>", "list env vars")
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      const { env, componentName } = parseChoice(envComponent);
-      const envvars = await getEnvVarsResolved(this, env, componentName);
-      Object.keys(envvars).forEach((key) =>
-        this.log(`${key}: ${envvars[key]}`),
-      );
-    });

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

@@ -1,14 +0,0 @@
-import { spawn } from "child-process-promise";
-import type Vorpal from "vorpal";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command(
-      "project-get-my-total-worktime",
-      "show the total worktime that you spent on a project",
-    )
-    .action(async () => {
-      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,36 +0,0 @@
-import type Vorpal from "vorpal";
-import { getProjectPods } from "../../../../kubernetes";
-import { logError } from "../../../../utils/log";
-import { getProjectNamespace } from "../../../../utils/projects";
-import { getShell } from "../../../../utils/shell";
-
-import { envAndComponents } from "./utils/autocompletions";
-import ensureCluster from "./utils/ensureCluster";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command(
-      "project-get-shell <envComponent>",
-      "get a shell to a pod in the environment",
-    )
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      await ensureCluster.call(this, envComponent);
-      const namespace = await getProjectNamespace(envComponent);
-      const pods = await getProjectPods(envComponent);
-      const runningPodNames = pods
-        .filter((p) => p.status.phase == "Running")
-        .map((r) => r.metadata.name);
-      if (runningPodNames.length === 0) {
-        logError(this, "sorry, no running pods found");
-        return;
-      }
-      const { podName } = await this.prompt({
-        type: "list",
-        name: "podName",
-        choices: runningPodNames,
-        message: "Which pod? 🤔",
-      });
-
-      return getShell(namespace, podName);
-    });

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

@@ -1,115 +0,0 @@
-import { exec } from "child-process-promise";
-import { last } from "lodash";
-import open from "open";
-import type { CommandInstance } from "vorpal";
-import type Vorpal from "vorpal";
-import {
-  doGitlabRequest,
-  getGitlabToken,
-  getProjectInfo,
-} from "../../../../utils/gitlab";
-
-const statusEmojiMap: any = {
-  failed: "🙀",
-  warning: "😿",
-  pending: "🍺",
-  running: "🏃‍",
-  manual: "🤚",
-  scheduled: "🍺",
-  canceled: "😽",
-  success: "😻",
-  skipped: "🤭",
-  created: "🍺",
-};
-
-const statusTxt = (status: any) =>
-  statusEmojiMap[status] ? `${statusEmojiMap[status]} ${status}` : status;
-
-const getCurrentCommit = async () => {
-  const result = await exec("git rev-parse HEAD");
-  return result.stdout && result.stdout.replace(/\n$/, "");
-};
-
-const delay = async (ms: any) =>
-  new Promise((resolve) => setTimeout(resolve, ms));
-
-const promptJob = async (vorpal: CommandInstance, projectId: any, ctx: any) => {
-  const jobs = await doGitlabRequest(vorpal, `projects/${projectId}/jobs`);
-
-  const commitId = await getCurrentCommit();
-
-  const jobsToName = (jo: any[]) =>
-    jo.map(
-      (j: any) => `${j.ref}-${j.name}-${j.user.username}-${j.status}-${j.id}`,
-    );
-
-  const preferredJobs = jobs.filter((j: any) => j.commit.id === commitId);
-  const moreJobs = jobs.filter((j: any) => !preferredJobs.includes(j.ref));
-  const sortedJobs =
-    preferredJobs.length > 1
-      ? [
-          ...jobsToName(preferredJobs),
-          "========================================================",
-          ...jobsToName(moreJobs),
-        ]
-      : jobsToName([...preferredJobs, ...moreJobs]);
-
-  const { jobName } = await ctx.prompt({
-    type: "list",
-    name: "jobName",
-    choices: sortedJobs,
-    message: "Which job? 🤔",
-  });
-
-  const jobId = Number(last(jobName.split("-")));
-  return jobs.find((j: any) => j.id === jobId);
-};
-
-export default async (vorpal: Vorpal) => {
-  vorpal.command("project-ci-job-open", "Open a Job").action(async function () {
-    const { id: projectId } = await getProjectInfo(this);
-
-    const job = await promptJob(this, projectId, this);
-    open(job.web_url);
-  });
-
-  vorpal
-    .command("project-ci-job-log", "Show a job's log")
-    .action(async function () {
-      const { id: projectId } = await getProjectInfo(this);
-
-      const { id } = await promptJob(this, projectId, this);
-
-      let finished = false;
-      while (!finished) {
-        const trace = await exec(
-          `curl -s --header "PRIVATE-TOKEN: ${await getGitlabToken(
-            this,
-          )}" "https://git.panter.ch/api/v4/projects/${projectId}/jobs/${id}/trace"`,
-        );
-
-        const job = await doGitlabRequest(
-          this,
-          `projects/${projectId}/jobs/${id}`,
-        );
-
-        if (trace.stdout) {
-          vorpal.ui.redraw(`${trace.stdout}`);
-        } else {
-          vorpal.ui.redraw(`
-
-          ${statusTxt(job.status)}
-          ${job.web_url}
-
-          `);
-        }
-
-        finished = !!job.finished_at;
-        if (!finished) {
-          await delay(5000);
-        } else {
-          vorpal.ui.redraw.done();
-        }
-      }
-    });
-};

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

@@ -1,20 +0,0 @@
-import { stringify } from "yaml";
-import { pick } from "lodash";
-import type Vorpal from "vorpal";
-import { getProjectPods } from "../../../../kubernetes";
-import { envAndComponents } from "./utils/autocompletions";
-import ensureCluster from "./utils/ensureCluster";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command("project-list-pods <envComponent>", "list pods of local project")
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      await ensureCluster.call(this, envComponent);
-      const pods = await getProjectPods(envComponent);
-      this.log(
-        stringify(
-          pods.map((p) => pick(p, ["metadata.name", "status.startTime"])),
-        ),
-      );
-    });

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

@@ -1,14 +0,0 @@
-import type Vorpal from "vorpal";
-import { getProjectNamespace } from "../../../../utils/projects";
-import { envAndComponents } from "./utils/autocompletions";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command(
-      "project-namespace <envComponent>",
-      "show namespace of local project",
-    )
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      this.log(await getProjectNamespace(envComponent));
-    });

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

@@ -1,22 +0,0 @@
-import open from "open";
-import type Vorpal from "vorpal";
-import {
-  getEnvironment,
-  parseChoice,
-} from "../../../../config/getProjectConfig";
-
-import { envAndComponents } from "./utils/autocompletions";
-import ensureCluster from "./utils/ensureCluster";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command("project-open-env <envComponent>", "open the live environment")
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      const { env, componentName } = parseChoice(envComponent);
-      await ensureCluster.call(this, envComponent);
-      const environment = await getEnvironment(env, componentName);
-      const url = environment.envVars.ROOT_URL;
-
-      open(url.toString());
-    });

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

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

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

@@ -1,21 +0,0 @@
-import type Vorpal from "vorpal";
-import {
-  getPipelineContextByChoice,
-  parseChoice,
-} from "../../../../config/getProjectConfig";
-import { openGoogleCloudLogs } from "../../../../kubernetes/openKubernetesDashboards";
-import { envAndComponents } from "./utils/autocompletions";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command(
-      "project-open-logs <envComponent>",
-      "open google cloud logs (stackdriver logs)",
-    )
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      const { env, componentName } = parseChoice(envComponent);
-      const context = await getPipelineContextByChoice(env, componentName);
-
-      await openGoogleCloudLogs(this, context);
-    });

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

@@ -1,33 +0,0 @@
-import type Vorpal from "vorpal";
-import { exec } from "child-process-promise";
-import { getProjectNamespace } from "../../../../utils/projects";
-import { envAndComponents } from "./utils/autocompletions";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command(
-      "project-pause <envComponent>",
-      "halts all running pods (scales to 0)",
-    )
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      const namespace = await getProjectNamespace(envComponent);
-      const { shouldContinue } = await this.prompt({
-        type: "confirm",
-        name: "shouldContinue",
-        message: `This will STOP all running pods in the namespace ${namespace}. You will need to manually scale back up or re-deploy. Continue? 🤔 `,
-      });
-
-      if (!shouldContinue) {
-        return;
-      }
-
-      const fullCommand = `kubectl scale statefulset,deployment --all --replicas=0 --namespace=${namespace}`;
-      const { stdout } = await exec(fullCommand, {
-        env: {
-          ...process.env,
-          DEBUG: "",
-        },
-      });
-      this.log(stdout);
-    });

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

@@ -1,91 +0,0 @@
-import type Vorpal from "vorpal";
-import { getProjectPodNames } from "../../../../kubernetes";
-import { logError } from "../../../../utils/log";
-import { startKubePortForward } from "../../../../kubernetes/portForward";
-import { getProjectNamespace } from "../../../../utils/projects";
-import { envAndComponents } from "./utils/autocompletions";
-import ensureCluster from "./utils/ensureCluster";
-import type { CommandInstance } from "vorpal";
-import { parseChoice } from "../../../../config/parseChoice";
-import { getPipelineContextByChoice } from "../../../../config/getProjectConfig";
-import type { ComponentContext } from "@catladder/pipeline";
-import { isOfDeployType } from "@catladder/pipeline";
-import { startPortForwardCommand } from "../../../../utils/portForwards";
-import open from "open";
-const kubePortForward = async (cmd: CommandInstance, envComponent: string) => {
-  await ensureCluster.call(cmd, envComponent);
-  const namespace = await getProjectNamespace(envComponent);
-  const podNames = await getProjectPodNames(envComponent);
-  if (podNames.length === 0) {
-    logError(cmd, "sorry, no pods found");
-    return;
-  }
-  const { podName } = await cmd.prompt({
-    type: "list",
-    name: "podName",
-    choices: podNames,
-    message: "Which pod? 🤔",
-  });
-
-  const { localPort } = await cmd.prompt({
-    type: "number",
-    name: "localPort",
-
-    message: "Local port: ",
-  });
-
-  const { remotePort } = await cmd.prompt({
-    type: "number",
-    name: "remotePort",
-
-    message: "Remote port: ",
-  });
-
-  return startKubePortForward(podName, localPort, remotePort, namespace);
-};
-
-const cloudRunPortForward = async (
-  cmd: CommandInstance,
-  context: ComponentContext,
-) => {
-  if (!isOfDeployType(context.deploy?.config, "google-cloudrun")) {
-    throw new Error("not cloud run");
-  }
-
-  const { fullName } = context.environment;
-  let serviceName: string = fullName.toString();
-  if (context.environment.envType === "review") {
-    const { mr } = await cmd.prompt({
-      type: "number",
-      name: "mr",
-
-      message: "Which mr 🤔 ",
-    });
-    // poor mans solution
-    serviceName = serviceName
-      .toString()
-      .replace("-review-", "-review-mr" + mr + "-");
-  }
-
-  const { projectId, region } = context.deploy.config;
-
-  const command = `gcloud beta run services proxy ${serviceName} --project ${projectId} --region ${region}`;
-
-  await startPortForwardCommand(`cloudRun/${serviceName}`, command);
-  open("http://localhost:8080");
-};
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command("project-port-forward <envComponent>", "start port-forwarding")
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      const { env, componentName } = parseChoice(envComponent);
-      const context = await getPipelineContextByChoice(env, componentName);
-
-      if (isOfDeployType(context.deploy?.config, "kubernetes")) {
-        await kubePortForward(this, envComponent);
-      }
-      if (isOfDeployType(context.deploy?.config, "google-cloudrun")) {
-        await cloudRunPortForward(this, context);
-      }
-    });