@catladder/cli 0.0.0-next-95928577 → 0.0.0-next-e7541a00

package/src/apps/catci/commands/security/commands.ts

@@ -1,161 +0,0 @@
-import type Vorpal from "vorpal";
-import {
-  evaluateSecurityAudit,
-  makeSecurityAuditOverview,
-} from "./evaluateSecurityAudit";
-import { Gitlab } from "@gitbeaker/rest";
-import {
-  SECURITY_AUDIT_FILE_NAME,
-  createSecurityAuditMergeRequest,
-} from "./createSecurityAuditMergeRequest";
-import { Err, Ok, type Result } from "ts-results-es";
-
-const GITLAB_HOST = "https://git.panter.ch";
-
-export default function (vorpal: Vorpal) {
-  commandCiJob(vorpal);
-  commandEvaluate(vorpal);
-  commandCreate(vorpal);
-}
-
-type ActionFunc = (args: Vorpal.Args) => Promise<void>;
-
-function resultAsExitCode(
-  func: (args: Vorpal.Args) => Promise<Result<unknown, unknown>>,
-): ActionFunc {
-  return async (args: Vorpal.Args) => {
-    const result = await func(args);
-    process.exitCode = result.isErr() ? 1 : 0;
-  };
-}
-
-async function commandCiJob(vorpal: Vorpal) {
-  vorpal
-    .command(
-      "security-audit-ci-job <path> <token> <mainBranch> <projectId> <userId>",
-      `Evaluates security audit document. If the document can't be evaluated or does not exist, creates a new MR with security audit document template.
-
-<path> root path of a project with security audit document (${SECURITY_AUDIT_FILE_NAME})
-<token> gitlab token with 'api' scopes and permissions to create a new branch
-<main-branch> main branch name
-<project-id> project id to create security audit for
-<user-id> gitlab user id that will be assignee of the audit
-`,
-    )
-    .action(
-      resultAsExitCode(async (args) => {
-        const evaluation = await evaluateSecurityAudit({ path: args.path });
-
-        if (evaluation.isErr()) {
-          console.log("could not evaluate security audit document");
-          console.log(
-            "creating new merge request with security audit template...",
-          );
-
-          const { token, mainBranch, projectId, userId } = args;
-          const api = new Gitlab({
-            host: GITLAB_HOST,
-            token,
-          });
-
-          const mr = await createSecurityAuditMergeRequest({
-            api,
-            mainBranch,
-            projectId,
-            userId: parseInt(userId),
-          });
-
-          if (mr.isErr()) {
-            console.error(
-              `could not create merge request with security audit template: ${mr.error}`,
-            );
-            return mr;
-          }
-
-          console.log("security audit merge request created successfully");
-          console.log(
-            `please finish the MR by updating SECURITY.md document: ${mr.value.web_url}`,
-          );
-          return Err("merge request created" as const);
-        }
-
-        if (evaluation.value.score.answeredTopics === 0) {
-          console.error("audit document has no answered topics");
-          console.error(
-            `please answer security topics in ${SECURITY_AUDIT_FILE_NAME} by adding responsible people and check/cross in the table`,
-          );
-          return Err("audit document has no answered topics" as const);
-        }
-
-        console.log(makeSecurityAuditOverview(evaluation.value));
-        return Ok({});
-      }),
-    );
-}
-
-async function commandEvaluate(vorpal: Vorpal) {
-  vorpal
-    .command(
-      "security-audit-evaluate <path>",
-      "Evaluates security audit document in given <path>",
-    )
-    .action(
-      resultAsExitCode(async (args) => {
-        console.log("evaluating security audit document...");
-
-        const result = await evaluateSecurityAudit({ path: args.path });
-        if (result.isErr()) {
-          console.error(result.error);
-          console.error(
-            `please make sure the security audit document ${SECURITY_AUDIT_FILE_NAME} is in the repository`,
-          );
-        } else {
-          console.log(makeSecurityAuditOverview(result.value));
-        }
-        return result;
-      }),
-    );
-}
-
-async function commandCreate(vorpal: Vorpal) {
-  vorpal
-    .command(
-      "security-audit-create <token> <mainBranch> <projectId> <userId>",
-      `Creates a MR in given project with the latest security audit template document
-
-<token> gitlab token with 'api' scopes and permissions to create a new branch
-<main-branch> main branch name
-<project-id> project id to create security audit for
-<user-id> gitlab user id that will be assignee of the audit
-`,
-    )
-    .action(
-      resultAsExitCode(async (args) => {
-        const { token, mainBranch, projectId, userId } = args;
-
-        const api = new Gitlab({
-          host: GITLAB_HOST,
-          token,
-        });
-
-        const result = await createSecurityAuditMergeRequest({
-          api,
-          mainBranch,
-          projectId,
-          userId: parseInt(userId),
-        });
-
-        if (result.isErr()) {
-          console.error(
-            `could not create security audit merge request: ${result.error}`,
-          );
-        } else {
-          console.log("security audit merge request created successfully");
-          console.log(
-            `please finish the MR by updating SECURITY.md document: ${result.value.web_url}`,
-          );
-        }
-        return result;
-      }),
-    );
-}

package/src/apps/cli/cli.ts

@@ -1,43 +0,0 @@
-import Vorpal from "vorpal";
-// tslint:disable-next-line:no-var-requires
-import packageInfos from "../../packageInfos";
-import { stopAllPortForwards } from "../../utils/portForwards";
-import general from "./commands/general";
-import mongodb from "./commands/mongodb";
-import cloudSQL from "./commands/cloudSQL";
-import project from "./commands/project";
-import theStuffThatReallyMatters from "./commands/theStuffThatReallyMatters";
-
-import { verify } from "./verify";
-import { showProjectBanner } from "./commands/project/utils/showProjectBanner";
-import { boxWithAsci } from "../../utils/boxWithAscii";
-
-export default async () => {
-  const vorpal = new Vorpal();
-
-  const welcomeMessage = boxWithAsci(
-    `catladder 😻 v${packageInfos.version} ✨`,
-  );
-
-  vorpal
-    .delimiter("catladder $") // emoji messes with cursor :-( https://github.com/dthree/vorpal/issues/332
-    .history("catladder")
-    .show()
-    .log("")
-    .log(welcomeMessage)
-    .log("");
-
-  await showProjectBanner(vorpal);
-
-  verify(vorpal);
-
-  general(vorpal);
-  project(vorpal);
-  cloudSQL(vorpal);
-  mongodb(vorpal);
-  theStuffThatReallyMatters(vorpal);
-
-  process.on("exit", () => {
-    stopAllPortForwards();
-  });
-};

package/src/apps/cli/commands/cloudSQL/commandRestoreDb.ts

@@ -1,136 +0,0 @@
-import type Vorpal from "vorpal";
-import { spawnCopyDb } from "../../../../gcloud/cloudSql/copyDb";
-import type { CloudSqlBackgroundProxy } from "../../../../gcloud/cloudSql/startProxy";
-import { startCloudSqlProxyInBackground } from "../../../../gcloud/cloudSql/startProxy";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command(
-      "cloud-sql-restore-db",
-      "restore a db from one source to another target",
-    )
-    .action(async function restoreDb() {
-      const { sourceInstance } = await this.prompt({
-        type: "input",
-        name: "sourceInstance",
-
-        message: "Source instance (connection string or 'local')? 🤔 ",
-      });
-
-      let sourceProxy: CloudSqlBackgroundProxy;
-
-      let targetProxy: CloudSqlBackgroundProxy;
-
-      let sourcePort: number;
-      let targetPort: number;
-
-      if (sourceInstance === "local") {
-        const { sourceLocalPort } = await this.prompt({
-          type: "number",
-          name: "sourceLocalPort",
-          default: 5432,
-
-          message: "Local Port for source? 🤔 ",
-        });
-        sourcePort = sourceLocalPort;
-      } else {
-        sourcePort = 54399;
-        sourceProxy = await startCloudSqlProxyInBackground({
-          instanceName: sourceInstance,
-          localPort: sourcePort,
-        });
-      }
-
-      const { sourceUsername } = await this.prompt({
-        type: "input",
-        name: "sourceUsername",
-        default: "postgres",
-
-        message: "Source Username? 🤔 ",
-      });
-
-      const { sourcePassword } = await this.prompt({
-        type: "input",
-        name: "sourcePassword",
-
-        message: "Source Password? 🤔 ",
-      });
-
-      const { sourceDbName } = await this.prompt({
-        type: "input",
-        name: "sourceDbName",
-
-        message: "Source DB name? 🤔 ",
-      });
-
-      const { targetInstance } = await this.prompt({
-        type: "input",
-        name: "targetInstance",
-
-        message: "Target INSTANCE (connection string or 'local')? 🤔  ",
-      });
-
-      if (targetInstance === "local") {
-        const { targetLocalPort } = await this.prompt({
-          type: "number",
-          name: "targetLocalPort",
-          default: 5432,
-
-          message: "Local Port for target? 🤔 ",
-        });
-        targetPort = targetLocalPort;
-      } else {
-        targetPort = 54499;
-        targetProxy = await startCloudSqlProxyInBackground({
-          instanceName: targetInstance,
-          localPort: targetPort,
-        });
-      }
-
-      const { targetUsername } = await this.prompt({
-        type: "input",
-        name: "targetUsername",
-        default: "postgres",
-
-        message: "Target Username? 🤔 ",
-      });
-      const { targetPassword } = await this.prompt({
-        type: "input",
-        name: "targetPassword",
-
-        message: "Target Password? 🤔 ",
-      });
-
-      const { targetDbName } = await this.prompt({
-        type: "input",
-        name: "targetDbName",
-
-        message: "Target DB name? 🤔 ",
-      });
-
-      const { shouldContinue } = await this.prompt({
-        type: "confirm",
-        name: "shouldContinue",
-        message: `This will drop ${targetInstance}/${targetDbName} and replace it with ${sourceInstance}/${sourceDbName}. Continue? 🤔 `,
-      });
-
-      if (!shouldContinue) {
-        return;
-      }
-
-      try {
-        await spawnCopyDb({
-          targetPassword,
-          targetPort,
-          targetUsername,
-          sourceUsername,
-          sourcePassword,
-          sourcePort,
-          sourceDbName,
-          targetDbName,
-        });
-      } finally {
-        sourceProxy?.stop();
-        targetProxy?.stop();
-      }
-    });

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

@@ -1,7 +0,0 @@
-import type Vorpal from "vorpal";
-
-import commandRestoreDb from "./commandRestoreDb";
-
-export default async (vorpal: Vorpal) => {
-  commandRestoreDb(vorpal);
-};

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

@@ -1,90 +0,0 @@
-import memoizee from "memoizee";
-import type Vorpal from "vorpal";
-import { getk8sApi } from "../../../../k8sApi";
-import { getCurrentContext } from "../../../../utils/cluster";
-import { logError } from "../../../../utils/log";
-import {
-  getAllRunningPortForwards,
-  stopPortForward,
-} from "../../../../utils/portForwards";
-import { getShell } from "../../../../utils/shell";
-import { namespaceAutoCompletion } from "./namespaceAutoCompletion";
-import portForward from "./portForward";
-
-const getAllNamespaces = memoizee(
-  async () => {
-    const k8sApi = getk8sApi();
-    const res = await k8sApi.listNamespace();
-    return res.body.items;
-  },
-  { maxAge: 30000, promise: true },
-);
-
-export const getAllNamespacesNames = async () => {
-  const namespaces = await getAllNamespaces();
-  return namespaces.map((n) => n.metadata.name);
-};
-export default async (vorpal: Vorpal) => {
-  vorpal.command("kube-current-context").action(async function () {
-    this.log(await getCurrentContext());
-  });
-
-  vorpal
-    .command("kube-list-namespaces", "list all namespaces")
-    .action(async function () {
-      const namespaces = await getAllNamespacesNames();
-      this.log(namespaces.join("\n"));
-    });
-
-  vorpal
-    .command("kube-list-secrets <namespace>", "show secrets")
-    .autocomplete(namespaceAutoCompletion)
-    .action(async function ({ namespace }) {
-      const k8sApi = getk8sApi();
-      const res = await k8sApi.listNamespacedSecret(namespace);
-
-      this.log(res.body.items.map((n) => n.metadata.name).join("\n"));
-    });
-
-  vorpal
-    .command("kube-list-pods <namespace>", "list all pods of namespace")
-    .autocomplete(namespaceAutoCompletion)
-    .action(async function ({ namespace }) {
-      const k8sApi = getk8sApi();
-      const res = await k8sApi.listNamespacedPod(namespace);
-      this.log(res.body.items.map((n) => n.metadata.name).join("\n"));
-    });
-
-  vorpal
-    .command("kube-stop-portforward <name>", "stop a running port forward")
-    .autocomplete({ data: async () => getAllRunningPortForwards() })
-    .action(async function ({ name }) {
-      stopPortForward(name.trim());
-    });
-
-  vorpal
-    .command(
-      "kube-get-shell <namespace>",
-      "get a shell to a pod in the environment",
-    )
-    .autocomplete(namespaceAutoCompletion)
-    .action(async function ({ namespace }) {
-      const k8sApi = getk8sApi();
-      const res = await k8sApi.listNamespacedPod(namespace);
-      if (res.body.items.length === 0) {
-        logError(this, "sorry, no pods found");
-        return;
-      }
-      const podNames = res.body.items.map((i) => i.metadata.name);
-      const { podName } = await this.prompt({
-        type: "list",
-        name: "podName",
-        choices: podNames,
-        message: "Which pod? 🤔",
-      });
-
-      await getShell(namespace, podName);
-    });
-
-  portForward(vorpal);
-};

package/src/apps/cli/commands/general/namespaceAutoCompletion.ts

@@ -1,7 +0,0 @@
-import { getAllNamespacesNames } from "./index";
-export const namespaceAutoCompletion = {
-  async data() {
-    const namespaces = await getAllNamespacesNames();
-    return namespaces;
-  },
-};

package/src/apps/cli/commands/general/portForward.ts

@@ -1,48 +0,0 @@
-import type Vorpal from "vorpal";
-import { logError } from "../../../../utils/log";
-
-import { startKubePortForward } from "../../../../kubernetes/portForward";
-
-import { getk8sApi } from "../../../../k8sApi";
-import { namespaceAutoCompletion } from "./namespaceAutoCompletion";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command("kube-port-forward <namespace>", "start port-forwarding")
-    .autocomplete(namespaceAutoCompletion)
-    .action(async function ({ namespace }) {
-      const k8sApi = getk8sApi();
-      const res = await k8sApi.listNamespacedPod(namespace);
-      if (res.body.items.length === 0) {
-        logError(this, "sorry, no pods found");
-        return;
-      }
-      const podNames = res.body.items.map((i) => i.metadata.name);
-
-      if (podNames.length === 0) {
-        logError(this, "sorry, no pods found");
-        return;
-      }
-      const { podName } = await this.prompt({
-        type: "list",
-        name: "podName",
-        choices: podNames,
-        message: "Which pod? 🤔",
-      });
-
-      const { localPort } = await this.prompt({
-        type: "number",
-        name: "localPort",
-
-        message: "Local port: ",
-      });
-
-      const { remotePort } = await this.prompt({
-        type: "number",
-        name: "remotePort",
-
-        message: "Remote port: ",
-      });
-
-      return startKubePortForward(podName, localPort, remotePort, namespace);
-    });

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

@@ -1,10 +0,0 @@
-import type Vorpal from "vorpal";
-import projectMongoDestroyMember from "./projectMongoDestroyMember";
-import projectMongoGetShell from "./projectMongoGetShell";
-import projectMongoPortForward from "./projectMongoPortForward";
-
-export default async (vorpal: Vorpal) => {
-  projectMongoGetShell(vorpal);
-  projectMongoPortForward(vorpal);
-  projectMongoDestroyMember(vorpal);
-};

package/src/apps/cli/commands/mongodb/projectMongoDestroyMember.ts

@@ -1,132 +0,0 @@
-import { exec } from "child-process-promise";
-import type Vorpal from "vorpal";
-import { getProjectPvcs } from "../../../../kubernetes";
-import { logError } from "../../../../utils/log";
-import { getProjectNamespace } from "../../../../utils/projects";
-import { envAndComponents } from "../project/utils/autocompletions";
-import ensureCluster from "../project/utils/ensureCluster";
-import { getMongoDbPodsWithReplInfo } from "./utils";
-
-const removeFinalizer = async (
-  namespace: string,
-  type: "pod" | "pv" | "pvc",
-  name: string,
-) =>
-  exec(
-    `kubectl patch --namespace ${namespace} ${type} ${name} -p '{"metadata":{"finalizers":null}}'`,
-  );
-
-const deleteResource = async (
-  namespace: string,
-  type: "pod" | "pv" | "pvc",
-  name: string,
-) => exec(`kubectl delete --namespace ${namespace} ${type} ${name}`);
-
-const removeFinalizerAndDelete = async (
-  namespace: string,
-  type: "pod" | "pv" | "pvc",
-  name: string,
-) => {
-  return Promise.all([
-    removeFinalizer(namespace, type, name),
-    await deleteResource(namespace, type, name),
-  ]);
-};
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command(
-      "project-mongo-destroy-member <envComponent>",
-      "DESTROY a member of a replicaset in order to reinitialize it",
-    )
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      await ensureCluster.call(this, envComponent);
-      this.log(
-        "this command tries to delete a (secondary) member of the replicaset, it's persistent volume claim (pvc) and the volume",
-      );
-      this.log("");
-      this.log(
-        "this is useful, if you update the stateful set with new volume configuration (different size or storage class)",
-      );
-      this.log("");
-      this.log(
-        "Kubernetes will usually recreate the missing member with the updated config and mongodb will start synchronizing the new member.",
-      );
-      this.log("");
-      this.log(
-        "This works without downtime, but should be done when load on the db is low. Also it has not been tested with large dbs (> 10gi)",
-      );
-      this.log("");
-      this.log(
-        "Deleting the volume and claim often stuck, just wait or cancel and restart.",
-      );
-      this.log("");
-      const { understood } = await this.prompt({
-        default: true,
-        message: "DO YOU UNDERSTAND?",
-        name: "understood",
-        type: "confirm",
-      });
-
-      if (!understood) {
-        throw new Error("abort");
-      }
-
-      const namespace = await getProjectNamespace(envComponent);
-      const mongodbPods = await getMongoDbPodsWithReplInfo(envComponent);
-
-      const pvcs = await getProjectPvcs(envComponent);
-      const secondaries = mongodbPods.filter((pod) => !pod.isMaster);
-
-      if (secondaries.length === 0) {
-        logError(this, "sorry, no pods found");
-        return;
-      }
-
-      const podName = (
-        await this.prompt({
-          type: "list",
-          name: "podName",
-          choices: secondaries.map((p) => ({
-            name: `[ secondary ] ${p.podName}`,
-            value: p.podName,
-          })),
-          message: "Which pod? 🤔",
-        })
-      ).podName;
-
-      const thePvc = pvcs.find(
-        (pvc) => pvc.metadata.name === `datadir-${podName}`,
-      );
-      if (!thePvc) {
-        logError(this, `sorry, no pvc found for ${podName}`);
-        return;
-      }
-      const { shouldContinue } = await this.prompt({
-        default: true,
-        message:
-          "THIS WILL DESTROY THE POD, ITS VOLUME AND ALL ITS DATA 🙀🙀🙀!!! continue? 🤔",
-        name: "shouldContinue",
-        type: "confirm",
-      });
-
-      if (!shouldContinue) {
-        throw new Error("abort");
-      }
-
-      // force delete, see https://github.com/kubernetes/kubernetes/issues/77258#issuecomment-502209800
-      this.log("destroying volume...");
-      try {
-        await removeFinalizerAndDelete(namespace, "pv", thePvc.spec.volumeName);
-      } catch (e) {
-        this.log(e.message);
-      }
-      this.log("destroying volume claim...");
-      try {
-        await removeFinalizerAndDelete(namespace, "pvc", thePvc.metadata.name);
-      } catch (e) {
-        this.log(e.message);
-      }
-      this.log("destroying pod...");
-      await removeFinalizerAndDelete(namespace, "pod", podName);
-    });

package/src/apps/cli/commands/mongodb/projectMongoGetShell.ts

@@ -1,42 +0,0 @@
-import type Vorpal from "vorpal";
-import { logError } from "../../../../utils/log";
-import { getProjectNamespace } from "../../../../utils/projects";
-import { envAndComponents } from "../project/utils/autocompletions";
-import ensureCluster from "../project/utils/ensureCluster";
-import {
-  getMongodbShell,
-  getProjectMongodbAllPodsSortedWithLabel,
-} from "./utils";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command(
-      "project-mongo-get-shell <envComponent>",
-      "get a shell to a mongodb in the environment",
-    )
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      await ensureCluster.call(this, envComponent);
-      const namespace = await getProjectNamespace(envComponent);
-      const podNames =
-        await getProjectMongodbAllPodsSortedWithLabel(envComponent);
-      if (podNames.length === 0) {
-        logError(this, "sorry, no pods found");
-        return;
-      }
-      let podName;
-      if (podNames.length === 1) {
-        podName = podNames[0];
-      } else {
-        podName = (
-          await this.prompt({
-            type: "list",
-            name: "podName",
-            choices: podNames,
-            message: "Which pod? 🤔",
-          })
-        ).podName;
-      }
-
-      return getMongodbShell(namespace, podName);
-    });