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

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

@@ -1,31 +0,0 @@
-import open from "open";
-import { startKubePortForward } from "../../../../kubernetes/portForward";
-import type Vorpal from "vorpal";
-import {
-  GRAFANA_PROXY_LOCAL_PORT,
-  GRAFANA_PROXY_TARGET_PORT,
-} from "../../../../config/constants";
-
-import { getProjectNamespace } from "../../../../utils/projects";
-
-import { envAndComponents } from "./utils/autocompletions";
-import ensureCluster from "./utils/ensureCluster";
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command(
-      "project-open-grafana <envComponent>",
-      "open Grafana dashboard for your namespace"
-    )
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      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 startKubePortForward(
-        "deployment/kubecost-cost-analyzer",
-        GRAFANA_PROXY_LOCAL_PORT,
-        GRAFANA_PROXY_TARGET_PORT,
-        "kubecost"
-      );
-      open(url);
-    });

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

@@ -1,43 +0,0 @@
-import open from "open";
-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 { startKubePortForward } from "../../../../kubernetes/portForward";
-import { getProjectNamespace } from "../../../../utils/projects";
-import { envAndComponents } from "./utils/autocompletions";
-import ensureCluster from "./utils/ensureCluster";
-
-export default async (vorpal: Vorpal) =>
-  vorpal
-    .command(
-      "project-open-grafana-pod <envComponent>",
-      "open Grafana dashboard for a specific pod"
-    )
-    .autocomplete(await envAndComponents())
-    .action(async function ({ envComponent }) {
-      await ensureCluster.call(this, envComponent);
-      const podNames = await getProjectPodNames(envComponent);
-      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 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 startKubePortForward(
-        "deployment/kubecost-cost-analyzer",
-        GRAFANA_PROXY_LOCAL_PORT,
-        GRAFANA_PROXY_TARGET_PORT,
-        "kubecost"
-      );
-      open(url);
-    });

package/src/apps/cli/config/writeConfig.ts

@@ -1,71 +0,0 @@
-import type { Config } from "@catladder/pipeline";
-import { spawn, exec } from "child-process-promise";
-import { writeFile } from "fs-extra";
-import { dump } from "js-yaml";
-import { format } from "prettier";
-import type { CommandInstance } from "vorpal";
-import { getGitRoot } from "../../../utils/projects";
-
-export const writeConfig = async (
-  vorpal: CommandInstance,
-  config: Config,
-  options?: {
-    endComment?: string;
-  }
-) => {
-  const gitRoot = await getGitRoot();
-  const TS = "typescript (recommended)";
-  const { configType } = await vorpal.prompt({
-    type: "list",
-    name: "configType",
-    choices: [TS, "yaml"],
-    message: "In which format do you want the config? 🤔",
-  });
-  vorpal.log("");
-  if (configType === TS) {
-    const file = gitRoot + "/catladder.ts";
-    const content = format(
-      `
-      import type { Config } from "@catladder/pipeline";
-      
-      const config: Config = ${JSON.stringify(config)};
-
-      export default config;
-
-     
-      ${options?.endComment ? `/*${options.endComment}*/` : ""}
-      
-      `,
-      {
-        parser: "babel",
-      }
-    );
-
-    await writeFile(file, content, {
-      encoding: "utf-8",
-    });
-    vorpal.log("adding type @catladder/pipeline....");
-    await spawn("yarn add --non-interactive @catladder/pipeline -DW", {
-      shell: true,
-    });
-    await exec("git add " + file);
-  } else {
-    const file = gitRoot + "/catladder.yml";
-    const content = dump(config);
-
-    await writeFile(
-      file,
-      content +
-        "\n\n" +
-        (options.endComment
-          ? "# " + options.endComment.split("\n").join("\n# ")
-          : ""),
-      {
-        encoding: "utf-8",
-      }
-    );
-    await exec("git add " + file);
-  }
-  vorpal.log("done!");
-  vorpal.log("");
-};

package/src/apps/cli/verify/migration/fromv2.ts

@@ -1,262 +0,0 @@
-import type {
-  BuildConfig,
-  ComponentConfig,
-  Config,
-  DeployConfigKubernetes,
-  Env,
-} from "@catladder/pipeline";
-import {
-  existsSync,
-  lstatSync,
-  readdirSync,
-  readFile,
-  writeFile,
-} from "fs-extra";
-import { isEmpty } from "lodash";
-import { join } from "path";
-import type Vorpal from "vorpal";
-import {
-  getGitlabCi,
-  getGitlabCiFilePath,
-} from "../../../../config/getProjectConfig";
-import { readYaml } from "../../../../utils/files";
-import { syncBitwarden } from "../../../../utils/passwordstore";
-import { getGitRoot } from "../../../../utils/projects";
-import { writeConfig } from "../../config/writeConfig";
-import { migrateSecrets } from "./migrateSecrets";
-import type { OldGitlabCiFile } from "./oldGitlabCi";
-import { detectBuildConfig, isOldInclude } from "./oldGitlabCi";
-export const LEGACY_ENVS = [
-  "dev-local",
-  "dev",
-  "review",
-  "stage",
-  "prod",
-] as const;
-
-const arrayToRecord = (arr: { name: string }[]): Record<string, any> => {
-  if (!arr) return undefined;
-  if (!Array.isArray(arr)) return arr;
-  return Object.fromEntries(arr.map(({ name, ...rest }) => [name, rest]));
-};
-
-const transformVars = (rawVars: {
-  public: Record<string, any>;
-  secret: Record<string, any>;
-  fromCommponents: any;
-}) => {
-  if (rawVars.fromCommponents) {
-    console.warn("cant transform legacy fromCommponents");
-  }
-
-  return {
-    public: rawVars.public,
-    secret: rawVars.secret ? Object.keys(rawVars.secret) : undefined,
-  };
-};
-
-const getLegacyMonorepoSubCiFiles = (dir: string) => {
-  return readdirSync(dir)
-    .filter((file) => lstatSync(file).isDirectory())
-    .map((dir) => ({
-      dir,
-      ci: join(dir, ".gitlab-ci.yml"),
-    }))
-    .filter(({ ci }) => existsSync(ci));
-};
-
-const transformValues = (
-  valuesIn: Record<string, any>
-): DeployConfigKubernetes["values"] => {
-  if (isEmpty(valuesIn)) {
-    return undefined;
-  }
-  delete valuesIn?.application?.host;
-  delete valuesIn?.application?.command;
-
-  return {
-    ...valuesIn,
-    jobs: arrayToRecord(valuesIn?.jobs),
-    cronjobs: arrayToRecord(valuesIn?.cronjobs),
-  };
-};
-
-export const isV2 = async () => {
-  const gitlabCi = await getGitlabCi<OldGitlabCiFile>();
-  return isOldInclude(gitlabCi);
-};
-export const migrateV2 = async (vorpal: Vorpal) => {
-  const gitlabCi = await getGitlabCi<OldGitlabCiFile>();
-  const gitRoot = await getGitRoot();
-
-  const {
-    CUSTOMER_NAME,
-    APP_NAME,
-    COMPONENT_NAME = "web",
-    APP_DIR = ".",
-    STAGING_ENABLED,
-  } = gitlabCi.variables;
-
-  vorpal
-    .command("migrate")
-
-    .action(async function () {
-      this.log("");
-      this.log("⚠️ this project uses legacy catladder (v2)");
-      this.log("");
-      this.log(
-        "😼 I can migrate the project for you. This contains the following steps:"
-      );
-      this.log("");
-      this.log(
-        " - migrate the config from values-*.yml to catladder config file"
-      );
-      this.log(
-        " - migrate the secrets from bitwarden to gitlab (this will trash the entries in bitwarden)"
-      );
-      this.log("");
-      this.log(
-        "☝ make sure that you checked in your current state in case something goes wrong."
-      );
-      this.log(
-        "☝ secrets in bitwarden are deleted, but can be restored within 30 days."
-      );
-      this.log("");
-      const { shouldContinue } = await this.prompt({
-        default: true,
-        message: "Migrate project now? 🤔",
-        name: "shouldContinue",
-        type: "confirm",
-      });
-
-      if (shouldContinue) {
-        vorpal.log("");
-        vorpal.log("");
-        vorpal.log("💪😼 ok, let's go...");
-        vorpal.log("");
-        vorpal.log("");
-
-        const createComponent = async (
-          dir: string,
-          ciFile: OldGitlabCiFile
-        ): Promise<ComponentConfig> => {
-          const { env, ...baseValues } =
-            (await readYaml(dir + "/values.yml")) ?? {};
-
-          const startCommand = Array.isArray(baseValues?.application?.command)
-            ? baseValues?.application?.command.join(" ")
-            : baseValues?.application?.command;
-          return {
-            vars: env ? transformVars(env) : undefined,
-            dir: dir,
-            build: {
-              type: detectBuildConfig(ciFile),
-              startCommand: startCommand,
-            } as BuildConfig,
-            deploy: {
-              type: "kubernetes",
-              values: transformValues(baseValues),
-              cluster: {
-                type: "gcloud",
-                name: "ch-production",
-                projectId: "skynet-swiss",
-                region: "europe-west6-a",
-                domainCanonical: "panter.swiss",
-              },
-            },
-            env: await LEGACY_ENVS.reduce<Promise<Env>>(
-              async (acc, envName) => {
-                if (envName === "stage" && !STAGING_ENABLED) {
-                  return {
-                    ...(await acc),
-                    [envName]: false,
-                  };
-                }
-                const newEnvName = envName === "dev-local" ? "local" : envName;
-
-                const envValues =
-                  (await readYaml(dir + `/values-${envName}.yml`)) ?? {};
-                const { env, ...rest } = envValues;
-                const host = rest?.application?.host;
-                const values = transformValues(rest);
-                return {
-                  ...(await acc),
-                  [newEnvName]: {
-                    host: host,
-                    vars: env ? transformVars(env) : undefined,
-                    deploy: values
-                      ? {
-                          values: values,
-                        }
-                      : undefined,
-                  },
-                };
-              },
-              Promise.resolve({})
-            ),
-          };
-        };
-        let components: Record<string, ComponentConfig>;
-        if (detectBuildConfig(gitlabCi) === "monorepo") {
-          components = await getLegacyMonorepoSubCiFiles(gitRoot).reduce<
-            Promise<Record<string, ComponentConfig>>
-          >(async (acc, el) => {
-            return {
-              ...(await acc),
-              [el.dir]: await createComponent(el.dir, await readYaml(el.ci)),
-            };
-          }, Promise.resolve({}));
-        } else {
-          components = {
-            [COMPONENT_NAME]: await createComponent(APP_DIR, gitlabCi),
-          };
-        }
-        // we only have one component
-        const config: Config = {
-          customerName: CUSTOMER_NAME,
-          appName: APP_NAME,
-          components,
-        };
-
-        const comment =
-          "Old migrated config:\n\n" +
-          (await readFile(await getGitlabCiFilePath(), {
-            encoding: "utf-8",
-          }));
-
-        this.log("-------------------");
-        this.log("migrate config");
-        await writeConfig(this, config, {
-          endComment: comment,
-        });
-        this.log("write gitlab-ci.yml");
-        await writeFile(
-          await getGitlabCiFilePath(),
-          "include: https://git.panter.ch/api/v4/projects/catladder%2Fcatladder/packages/generic/ci-includes/main/gitlab-ci.yml",
-          { encoding: "utf-8" }
-        );
-
-        this.log("-------------------");
-        this.log("migrate secrets");
-        await syncBitwarden();
-        for (const env of LEGACY_ENVS) {
-          if (env === "stage" && !STAGING_ENABLED) return;
-          await migrateSecrets(this, config, env);
-        }
-
-        this.log("-------------------");
-
-        this.log("done!");
-        this.log("");
-        this.log("You can remove the values*.yml files now.");
-
-        this.log("-------------------");
-      } else {
-        this.log(
-          "☝ if you want to use catladder in legacy mode, install @panter/catladder globally and invoke catladder-legacy"
-        );
-      }
-    });
-
-  vorpal.exec("migrate");
-};

package/src/apps/cli/verify/migration/migrateSecrets.ts

@@ -1,47 +0,0 @@
-import type { Config } from "@catladder/pipeline";
-import { getEnvironment } from "@catladder/pipeline";
-import { load } from "js-yaml";
-import { pick } from "lodash";
-import type { CommandInstance } from "vorpal";
-import { upsertAllVariables } from "../../../../utils/gitlab";
-import { readPass, trashItem } from "../../../../utils/passwordstore";
-import type { LEGACY_ENVS } from "./fromv2";
-
-const getPassPath = (newConfig: Config, env: string) => {
-  return `${newConfig.customerName}/${newConfig.appName}/${env}/secrets.yml`;
-};
-
-export const migrateSecrets = async (
-  vorpal: CommandInstance,
-  newConfig: Config,
-  oldEnv: typeof LEGACY_ENVS[number]
-) => {
-  const newEnv = oldEnv === "dev-local" ? "local" : oldEnv;
-  const path = getPassPath(newConfig, oldEnv);
-  try {
-    const yamlstring = await readPass(path);
-    const secrets = load(yamlstring);
-
-    Object.keys(newConfig.components).forEach(async (componentName) => {
-      const environment = await getEnvironment(
-        newConfig,
-        componentName,
-        newEnv
-      );
-      await upsertAllVariables(
-        vorpal,
-        pick(
-          secrets,
-          environment.secretEnvVarKeys
-            .filter((k) => !k.hidden)
-            .map((k) => k.key)
-        ),
-        newEnv,
-        componentName
-      );
-    });
-    await trashItem(path);
-  } catch (e) {
-    console.warn(`could not migrate secrets for env '${oldEnv}': ${e}`);
-  }
-};

package/src/apps/cli/verify/migration/oldGitlabCi.ts

@@ -1,48 +0,0 @@
-import type { BuildConfig } from "@catladder/pipeline";
-
-export type OldGitlabCiFile = {
-  variables: {
-    CUSTOMER_NAME: string;
-    APP_NAME: string;
-    COMPONENT_NAME?: string;
-    APP_DIR?: string;
-    CLUSTER_NAME?: string;
-    STAGING_ENABLED?: string;
-  };
-  include: {
-    project: string;
-    ref: string;
-    file: string;
-  }[];
-};
-
-export const isOldInclude = (gitlabCi: OldGitlabCiFile) => {
-  return gitlabCi.include[0]?.project === "catladder/gitlab-ci";
-};
-
-export const detectBuildConfig = (
-  gitlabCi: OldGitlabCiFile
-): BuildConfig["type"] | "monorepo" => {
-  if (!isOldInclude(gitlabCi)) {
-    throw new Error("unsupported gitlab-ci file");
-  }
-
-  const firstInclude = gitlabCi.include[0];
-
-  if (firstInclude.file === "monorepo.yml") return "monorepo";
-
-  if (firstInclude.file === "node-kubernetes.yml") {
-    return "node";
-  }
-
-  if (firstInclude.file === "static-js-kubernetes.yml") {
-    return "node-static";
-  }
-  if (firstInclude.file === "meteor-kubernetes.yml") {
-    return "meteor";
-  }
-
-  if (firstInclude.file === "rails-kubernetes.yml") {
-    return "rails";
-  }
-};

package/src/config/constants.ts

@@ -1,2 +0,0 @@
-export const GRAFANA_PROXY_LOCAL_PORT = 9090;
-export const GRAFANA_PROXY_TARGET_PORT = 9090;

package/src/config/parseChoiceArgument.ts

@@ -1,50 +0,0 @@
-import type { Config, EnvType } from '@catladder/pipeline';
-import { ENV_TYPES, isKnowEnvType } from '@catladder/pipeline';
-import type { Choice } from '../apps/catenv/types';
-
-const envTypes = Object.keys(ENV_TYPES);
-
-export const getEnvComponentArgument = (): {
-  env: EnvType;
-  componentName?: string | undefined;
-} => {
-  const componentMatch = `([a-zA-Z0-9_-]+)`;
-  const argRegexp = new RegExp(
-    `^((${envTypes.join('|')}):${componentMatch}|${componentMatch})$`
-  );
-  const envComponent = process.argv[2] ?? '';
-  const [, , env = 'local', componentNameWithEnv, onlyComponentName] =
-    argRegexp.exec(envComponent);
-  if (!isKnowEnvType(env)) {
-    throw new Error(
-      `invalid env type! ${env}.\nEnv must be one of: ${envTypes.join(', ')}`
-    );
-  }
-  if (componentNameWithEnv?.length) {
-    return { env, componentName: componentNameWithEnv };
-  }
-  if (onlyComponentName?.length) {
-    return { env, componentName: onlyComponentName };
-  }
-  return { env };
-};
-
-/**
- * Parses the environment component argument and returns a Choice object.
- * @param envComponent - The environment component argument to parse.
- * @returns The parsed Choice object.
- * @throws Error if the env type is invalid.
- */
-export const parseChoiceArgument = ({ components }: Config): Choice => {
-  const { env, componentName } = getEnvComponentArgument();
-  const componentNames = Object.keys(components);
-  if (componentName?.length && !componentNames.includes(componentName)) {
-    throw new Error(
-      `invalid component name! Component must be one of: ${componentNames.join(', ')}`
-    );
-  }
-  if (componentName?.length) {
-    return { env, componentName };
-  }
-  return { env };
-};