@catladder/cli 0.0.0-waitfor-deploy-31ebcf14 → 0.0.0-yarn-cache-a697966f

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

@@ -1,4 +1,4 @@
-import {
+import type {
   BuildConfig,
   ComponentConfig,
   Config,
@@ -14,7 +14,7 @@ import {
 } from "fs-extra";
 import { isEmpty } from "lodash";
 import { join } from "path";
-import Vorpal from "vorpal";
+import type Vorpal from "vorpal";
 import {
   getGitlabCi,
   getGitlabCiFilePath,
@@ -24,11 +24,8 @@ import { syncBitwarden } from "../../../../utils/passwordstore";
 import { getGitRoot } from "../../../../utils/projects";
 import { writeConfig } from "../../config/writeConfig";
 import { migrateSecrets } from "./migrateSecrets";
-import {
-  detectBuildConfig,
-  isOldInclude,
-  OldGitlabCiFile,
-} from "./oldGitlabCi";
+import type { OldGitlabCiFile } from "./oldGitlabCi";
+import { detectBuildConfig, isOldInclude } from "./oldGitlabCi";
 export const LEGACY_ENVS = [
   "dev-local",
   "dev",
@@ -39,6 +36,7 @@ export const LEGACY_ENVS = [
 
 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]));
 };
 

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

@@ -1,10 +1,11 @@
-import { Config, getEnvironment } from "@catladder/pipeline";
+import type { Config } from "@catladder/pipeline";
+import { getEnvironment } from "@catladder/pipeline";
 import { load } from "js-yaml";
 import { pick } from "lodash";
-import { CommandInstance } from "vorpal";
+import type { CommandInstance } from "vorpal";
 import { upsertAllVariables } from "../../../../utils/gitlab";
 import { readPass, trashItem } from "../../../../utils/passwordstore";
-import { LEGACY_ENVS } from "./fromv2";
+import type { LEGACY_ENVS } from "./fromv2";
 
 const getPassPath = (newConfig: Config, env: string) => {
   return `${newConfig.customerName}/${newConfig.appName}/${env}/secrets.yml`;
@@ -22,10 +23,19 @@ export const migrateSecrets = async (
     const secrets = load(yamlstring);
 
     Object.keys(newConfig.components).forEach(async (componentName) => {
-      const environment = getEnvironment(newConfig, componentName, newEnv);
+      const environment = await getEnvironment(
+        newConfig,
+        componentName,
+        newEnv
+      );
       await upsertAllVariables(
         vorpal,
-        pick(secrets, environment.secretEnvVarKeys),
+        pick(
+          secrets,
+          environment.secretEnvVarKeys
+            .filter((k) => !k.hidden)
+            .map((k) => k.key)
+        ),
         newEnv,
         componentName
       );

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

@@ -1,4 +1,4 @@
-import { BuildConfig } from "@catladder/pipeline";
+import type { BuildConfig } from "@catladder/pipeline";
 
 export type OldGitlabCiFile = {
   variables: {
@@ -43,6 +43,6 @@ export const detectBuildConfig = (
   }
 
   if (firstInclude.file === "rails-kubernetes.yml") {
-    throw new Error("rails is not yet implemented");
+    return "rails";
   }
 };

package/src/catenv.ts

@@ -1,10 +1,9 @@
 import catenv from "./apps/catenv/catenv";
-import { $, argv } from "zx";
-import { parseChoice } from "./config/getProjectConfig";
 
-const choice = argv._[0] ? parseChoice(argv._[0]) : null;
+import { parseChoice } from "./config/parseChoice";
+
+const choice = process.argv[2] ? parseChoice(process.argv[2]) : null;
 
-$.verbose = false;
 catenv(choice).then(() => {
   // we have to exit manually, because we have some file watches
   process.exit();

package/src/cli.ts

@@ -1,9 +1,3 @@
-import updateNotifier from "update-notifier";
 import cli from "./apps/cli/cli";
-import packageInfos from "./packageInfos";
-import { $ } from "zx";
-$.verbose = false;
-updateNotifier({
-  pkg: packageInfos,
-}).notify();
+
 cli();

package/src/config/constants.ts

@@ -1,4 +1,2 @@
 export const GRAFANA_PROXY_LOCAL_PORT = 9090;
 export const GRAFANA_PROXY_TARGET_PORT = 9090;
-
-export const GOOGLE_CLOUD_SQL_PASS_PATH = "cloud-sql-proxy-credentials";

package/src/config/getProjectConfig.ts

@@ -1,20 +1,22 @@
+import type { Config, EnvironmentEnvVars } from "@catladder/pipeline";
 import {
   readConfigSync,
   getAllEnvs,
   getEnvironment as _getEnvironment,
   createContext,
   getSecretVarName,
-  Config,
 } from "@catladder/pipeline";
 
-import { CommandInstance } from "vorpal";
+import type { CommandInstance } from "vorpal";
 import { getAllVariables, getVariableValueByRawName } from "../utils/gitlab";
 
 import { getGitRoot } from "../utils/projects";
 import { readYaml } from "../utils/files";
 import { watch } from "fs";
 
-let currentConfig: Config = null;
+export { parseChoice } from "./parseChoice";
+
+let currentConfig: Config | null = null;
 
 // reload the config on change
 const reloadConfigAndObserve = async () => {
@@ -37,7 +39,7 @@ export const getProjectConfig = async () => {
     // initially
     await reloadConfigAndObserve();
   }
-  return currentConfig;
+  return currentConfig as Config;
 };
 
 export const getGitlabCiFilePath = async () => {
@@ -59,17 +61,12 @@ export const getProjectComponents = async () => {
   return Object.keys(config.components);
 };
 
-export const parseChoice = (envComponent: string) => {
-  const [env, componentName] = envComponent.split(":").map((x) => x || null);
-  return { env, componentName };
-};
-
 export const getPipelineContextByChoice = async (
   env: string,
   componentName: string
 ) => {
   const config = await getProjectConfig();
-  return createContext(config, componentName, env);
+  return await createContext(config, componentName, env);
 };
 export const getAllComponentsWithAllEnvsFlat = async (): Promise<
   Array<{ env: string; componentName: string }>
@@ -126,35 +123,78 @@ export const getGitlabVar = async (
 };
 
 const resolveSecrets = async (
-  vorpal: CommandInstance,
-  allEnvVars: Record<string, string>
-) => {
+  vorpal: CommandInstance | null,
+  varSets: EnvironmentEnvVars[]
+): Promise<Record<string, string>> => {
   const allVariablesInGitlab = await getAllVariables(vorpal);
 
   return Object.fromEntries(
-    Object.entries(allEnvVars).map(([key, value]) => {
-      const containsSecret = String(value)?.includes?.("$CL_");
-      if (containsSecret) {
-        for (const variable of allVariablesInGitlab) {
-          value = value.replace(
-            new RegExp("\\$" + variable.key, "g"),
-            variable.value
-          );
-        }
-        return [key, value];
-      }
-      return [key, value];
-    })
+    varSets.flatMap((set) =>
+      Object.entries(set.envVars)
+        .map(([key, value]) => {
+          const secretKey = set.secretEnvVarKeys.find((k) => k.key === key);
+
+          if (secretKey) {
+            if (secretKey.hidden) {
+              return null;
+            }
+            for (const variable of allVariablesInGitlab) {
+              value = value.replace(
+                new RegExp("\\$" + variable.key, "g"),
+                variable.value
+              );
+            }
+            return [key, value];
+          }
+          return [key, value];
+        })
+        .filter(Boolean)
+    )
   );
 };
 
-export const getEnvVars = async (
+export const getEnvVarsResolved = async (
+  vorpal: CommandInstance | null,
+  env: string,
+  componentName: string | null
+) => {
+  if (!componentName) {
+    return {};
+  }
+  try {
+    const envionment = await getEnvironment(env, componentName);
+
+    // in the pipeline the secrets alreadyy exists  and bash will expand them
+    // but here we need to manually load them
+    return resolveSecrets(vorpal, [
+      {
+        envVars: envionment.envVars,
+        secretEnvVarKeys: envionment.secretEnvVarKeys,
+      },
+    ]);
+  } catch (e) {
+    // env is disabled
+    return {};
+  }
+};
+
+/**
+ *
+ * is used to get job only vars that should also be editable locally with catladder.
+ */
+export const getJobOnlyEnvVarsResolved = async (
   vorpal: CommandInstance,
   env: string,
   componentName: string
 ) => {
-  const envionment = await getEnvironment(env, componentName);
-  // in the pipeline the secrets alreadyy exists  and bash will expand them
-  // but here we need to manually load them
-  return resolveSecrets(vorpal, envionment.envVars);
+  try {
+    const envionment = await getEnvironment(env, componentName);
+    return resolveSecrets(vorpal, [
+      envionment.jobOnlyVars.build,
+      envionment.jobOnlyVars.deploy,
+    ]);
+  } catch (e) {
+    // env is disabled
+    return {};
+  }
 };

package/src/config/parseChoice.ts

@@ -0,0 +1,4 @@
+export const parseChoice = (envComponent: string) => {
+  const [env, componentName] = envComponent.split(":").map((x) => x || null);
+  return { env: env as string, componentName };
+};

package/src/gcloud/artifactsRegistry.ts

@@ -0,0 +1,16 @@
+import type { Gcloudregion } from "@catladder/pipeline";
+import { exec } from "child-process-promise";
+
+export const upsertGcloudArtifactsRegistry = async (config: {
+  projectId: string;
+  region: Gcloudregion;
+}) => {
+  try {
+    await exec(
+      `gcloud artifacts repositories create catladder-deploy --project="${config.projectId}" --repository-format=docker --location=${config.region}`
+    );
+  } catch (e) {
+    // probably already exists
+    //
+  }
+};

package/src/gcloud/cloudRun/getCloudRunDomainSuffix.ts

@@ -0,0 +1,35 @@
+import type { DeployConfigCloudRun } from "@catladder/pipeline";
+import { exec } from "child-process-promise";
+
+const getSuffixFromService = (service: any) => {
+  const fullUrl = service.status.url;
+  const name = service.metadata.name;
+
+  return fullUrl.replace("https://" + name + "-", "");
+};
+export const getCloudRunDomainSuffix = async (config: DeployConfigCloudRun) => {
+  /* google cloud run domains are partially predictable, they have a fixed suffix that depends on the region and project, but we don't know it beforehand
+
+  So what we do is either:
+   - get one service and extract its suffix
+   - create a dummy project, extract the suffix and save that as a gitlab variable
+  
+  
+  */
+
+  const dummyServiceName = "cl-dummy-service-delete-me";
+
+  const existingServices = await exec(
+    `gcloud run services list --format=json  --project="${config.projectId}"  --region=${config.region} --limit=1`
+  ).then((r) => JSON.parse(r.stdout));
+
+  if (existingServices.length > 0) {
+    return getSuffixFromService(existingServices[0]);
+  }
+
+  const result = await exec(
+    `gcloud run deploy ${dummyServiceName} --region=${config.region} --allow-unauthenticated --project ${config.projectId} --image=us-docker.pkg.dev/cloudrun/container/hello --format=json`
+  ).then((r) => JSON.parse(r.stdout));
+
+  return await getSuffixFromService(result);
+};

package/src/gcloud/cloudRun/openCloudRunDashboards.ts

@@ -0,0 +1,22 @@
+import type { Context } from "@catladder/pipeline";
+import { isOfDeployType } from "@catladder/pipeline";
+import type { CommandInstance } from "vorpal";
+import { openGoogleCloudDashboard } from "../openDashboard";
+
+export const openGoogleCloudRunDashboard = async (
+  instance: CommandInstance,
+  context: Context
+) => {
+  if (!isOfDeployType(context.componentConfig.deploy, "google-cloudrun")) {
+    throw new Error("deploy type is not google-cloudrun ");
+  }
+  const { fullName } = context.environment;
+  const { region, projectId } = context.componentConfig.deploy;
+  await openGoogleCloudDashboard(
+    instance,
+    `run/detail/${region}/${fullName}/metrics`,
+    {
+      project: projectId,
+    }
+  );
+};

package/src/gcloud/cloudSql/copyDb.ts

@@ -0,0 +1,57 @@
+import { spawn } from "child-process-promise";
+type Opts = {
+  targetPassword: string;
+  targetPort: number;
+  targetUsername: string;
+  sourceUsername: string;
+  sourcePassword: string;
+  sourcePort: number;
+  sourceDbName: string;
+  targetDbName: string;
+};
+export const spawnCopyDb = async (opts: Opts) => {
+  const script = createCopyDbScript(opts);
+
+  return await spawn(script, [], {
+    shell: "bash",
+    stdio: "inherit",
+  });
+};
+const createCopyDbScript = ({
+  targetPassword,
+  targetPort,
+  targetUsername,
+  sourceUsername,
+  sourcePassword,
+  sourcePort,
+  sourceDbName,
+  targetDbName,
+}: Opts) => {
+  const targetPSQL = (command: string) =>
+    `PGPASSWORD=${targetPassword} psql -p ${targetPort} --host=localhost --user=${targetUsername} -q ${command}`;
+
+  const copyDBScript = `
+      set -e
+     
+    
+
+      dumptmp=$(mktemp /tmp/dump.XXXXXX)
+
+      echo "Dumping file to $dumptmp"
+      pg_dump --dbname=postgres://${sourceUsername}:${sourcePassword}@localhost:${sourcePort}/${sourceDbName} --no-owner --no-privileges > $dumptmp
+      echo "dump done"
+      ${targetPSQL(
+        `-c 'drop database "${targetDbName}" WITH (FORCE)' 1> /dev/null || true`
+      )}
+      ${targetPSQL(`-c 'create database "${targetDbName}"' 1> /dev/null`)}
+          echo "Restoring dump..."
+      ${targetPSQL(`"${targetDbName}" < $dumptmp 1> /dev/null`)}
+  
+
+      echo "Clean up..."
+      set +e
+      rm $dumptmp
+      echo "\n🐱 Done!"
+      `;
+  return copyDBScript;
+};

package/src/gcloud/cloudSql/startProxy.ts

@@ -0,0 +1,74 @@
+import { spawn } from "child-process-promise";
+import commandExists from "command-exists-promise";
+
+export const ERROR_NOT_INSTALLED = "cloud-sql-proxy not installed";
+
+export type CloudSqlBackgroundProxy = {
+  stop: () => void;
+};
+
+export type CloudSqlProxyOptions = {
+  instanceName: string;
+  localPort: number;
+};
+
+const getProxyCommandSpawnArgs = async ({
+  localPort,
+  instanceName,
+}: CloudSqlProxyOptions) => {
+  const commandString = (await commandExists("cloud-sql-proxy"))
+    ? `cloud-sql-proxy --port ${localPort} ${instanceName}`
+    : (await commandExists(
+        "cloud_sql_proxy" // v1
+      ))
+    ? `cloud_sql_proxy -instances ${instanceName}=tcp:${localPort}`
+    : null;
+  if (!commandString) {
+    throw new Error(ERROR_NOT_INSTALLED);
+  }
+
+  const [cmd, ...args] = commandString.split(" ");
+  return { cmd, args };
+};
+
+export const startCloudSqlProxyInCurrentShell = async (
+  opts: CloudSqlProxyOptions
+) => {
+  const { cmd, args } = await getProxyCommandSpawnArgs(opts);
+
+  await spawn(cmd, args, {
+    stdio: "inherit",
+    shell: true,
+  });
+};
+
+export const startCloudSqlProxyInBackground = async (
+  opts: CloudSqlProxyOptions
+): Promise<CloudSqlBackgroundProxy> => {
+  const { cmd, args } = await getProxyCommandSpawnArgs(opts);
+
+  const proxyPromise = spawn(cmd, args, { shell: "bash" });
+
+  // wait until it starts
+  await spawn(
+    `echo -n "Waiting for proxy"
+      until echo > /dev/tcp/localhost/${opts.localPort}; do
+        sleep 0.2
+        echo -n "."
+      done 2>/dev/null`,
+    [],
+    { shell: "bash" }
+  );
+  const stop = () => {
+    proxyPromise.catch(() => {
+      // ignore
+    });
+    proxyPromise.childProcess.kill();
+  };
+  // stop if catladder i stopped
+  process.on("beforeExit", stop);
+
+  return {
+    stop,
+  };
+};

package/src/gcloud/enableServices.ts

@@ -0,0 +1,14 @@
+import { exec } from "child-process-promise";
+
+export const enableGCloudServices = async (
+  services: string[],
+  config: {
+    projectId: string;
+  }
+) => {
+  for (const service of services) {
+    await exec(
+      `gcloud services enable ${service} --project=${config.projectId}`
+    );
+  }
+};

package/src/gcloud/openDashboard.ts

@@ -0,0 +1,19 @@
+import type { CommandInstance } from "vorpal";
+import { getGoogleAuthUserNumber } from "../apps/cli/utils/getGoogleAuthUserNumber";
+import open from "open";
+export const openGoogleCloudDashboard = async (
+  instance: CommandInstance,
+  path: string,
+  params: Record<string, string>
+) => {
+  const url = new URL("https://console.cloud.google.com/");
+  url.pathname = path;
+  for (const [key, value] of Object.entries(params)) {
+    url.searchParams.set(key, value);
+  }
+
+  const googleAuthUserNumber = await getGoogleAuthUserNumber.call(instance);
+  url.searchParams.set("authuser", googleAuthUserNumber);
+
+  open(url.toString());
+};

package/src/gcloud/serviceAccounts.ts

@@ -0,0 +1,101 @@
+import type { Context } from "@catladder/pipeline";
+
+import { exec } from "child-process-promise";
+import { createHmac } from "crypto";
+import type { CommandInstance } from "vorpal";
+import { upsertAllVariables } from "../utils/gitlab";
+
+export const accountExists = async (fullIdentifier: string) => {
+  try {
+    await exec(`gcloud iam service-accounts describe ${fullIdentifier}`);
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+type ServiceAccount = {
+  projectId: string;
+  name: string;
+  displayName: string;
+  roles: string[];
+  description: string;
+};
+const upsertGcloudServiceAccount = async (
+  context: Context,
+  account: ServiceAccount
+): Promise<string> => {
+  const { projectId, name, displayName, roles, description } = account;
+
+  // name has limit of 30
+  const namePrefix = `${name}-`;
+  const nameSuffix = `-${context.environment.shortName}-${context.componentName}`;
+  const nameMiddleLength = 30 - namePrefix.length - nameSuffix.length;
+  const nameMiddle = `${context.fullConfig.customerName}-${context.fullConfig.appName}`;
+
+  const middle = hashIfNessecary(nameMiddle, nameMiddleLength);
+
+  const fullName = `${namePrefix}${middle}${nameSuffix}`;
+
+  const fullDisplayName = `${context.fullConfig.customerName}-${context.fullConfig.appName} ${context.environment.shortName}:${context.componentName} | ${displayName}`;
+
+  const fullIdentifier = `${fullName}@${projectId}.iam.gserviceaccount.com`;
+
+  const existing = await accountExists(fullIdentifier);
+
+  if (!existing) {
+    await exec(
+      `gcloud iam service-accounts create ${fullName} --display-name="${fullDisplayName}" --project="${projectId}"  --description="${description}"`
+    );
+  }
+  const memberName = `serviceAccount:${fullIdentifier}`;
+  for (const role of roles) {
+    await exec(
+      `gcloud projects add-iam-policy-binding ${projectId} --member=${memberName} --role=${role} `
+    );
+  }
+
+  // create key
+
+  // delete first all keys
+  const keys = await exec(
+    `gcloud iam service-accounts keys list --iam-account=${fullIdentifier} --managed-by=user --format=json`
+  ).then((o) => JSON.parse(o.stdout));
+
+  for (const key of keys) {
+    await exec(
+      `gcloud iam service-accounts keys delete ${key.name} --quiet --iam-account=${fullIdentifier}`
+    );
+  }
+
+  return await exec(
+    `gcloud iam service-accounts keys create /dev/stdout --iam-account=${fullIdentifier}`
+  ).then((o) => o.stdout);
+};
+
+export const upsertGcloudServiceAccountAndSaveSecret = async (
+  instance: CommandInstance,
+  context: Context,
+  account: ServiceAccount,
+  secretName: string
+): Promise<void> => {
+  instance.log("upserting service account " + account.name + "...");
+  const key = await upsertGcloudServiceAccount(context, account);
+
+  await upsertAllVariables(
+    instance,
+    {
+      [secretName]: key,
+    },
+    context.environment.shortName,
+    context.componentName
+  );
+  instance.log("done!");
+};
+
+const hashIfNessecary = (str: string, maxLength: number) =>
+  str.length > maxLength ? hash(str, maxLength) : str;
+
+const hash = (str: string, length: number) => {
+  return createHmac("sha256", str).digest("hex").substring(0, length);
+};

package/src/kubernetes/index.ts

@@ -0,0 +1,27 @@
+import { parseChoice } from "../config/parseChoice";
+import { getk8sApi } from "../k8sApi";
+import { getProjectNamespace } from "../utils/projects";
+
+export const getProjectPods = async (envComponent: string) => {
+  const namespace = await getProjectNamespace(envComponent);
+  const k8sApi = getk8sApi();
+  const res = await k8sApi.listNamespacedPod(namespace);
+
+  const { componentName } = parseChoice(envComponent);
+  return res.body.items.filter((item) =>
+    componentName ? item.metadata?.name?.includes(componentName + "-") : true
+  );
+};
+
+export const getProjectPvcs = async (envComponent: string) => {
+  const namespace = await getProjectNamespace(envComponent);
+  const k8sApi = getk8sApi();
+  const res = await k8sApi.listNamespacedPersistentVolumeClaim(namespace);
+
+  return res.body.items;
+};
+
+export const getProjectPodNames = async (envComponent: string) => {
+  const pods = await getProjectPods(envComponent);
+  return pods.map((n) => n.metadata.name);
+};