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

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,7 +1,10 @@
 import catenv from "./apps/catenv/catenv";
-import { $ } from "zx";
-$.verbose = false;
-catenv().then(() => {
+
+import { parseChoice } from "./config/parseChoice";
+
+const choice = process.argv[2] ? parseChoice(process.argv[2]) : null;
+
+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,19 +1,21 @@
+import type { Config } 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";
 
+export { parseChoice } from "./parseChoice";
+
 let currentConfig: Config = null;
 
 // reload the config on change
@@ -59,17 +61,12 @@ export const getProjectComponents = async () => {
   return Object.keys(config.components);
 };
 
-export const parseChoice = (envComponent: string) => {
-  const [env, componentName] = envComponent.split(":");
-  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 }>
@@ -153,8 +150,13 @@ export const getEnvVars = async (
   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);
+    // 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);
+  } 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, 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/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);
+};

package/src/kubernetes/openKubernetesDashboards.ts

@@ -0,0 +1,52 @@
+import type { Context } from "@catladder/pipeline";
+import { isOfDeployType } from "@catladder/pipeline";
+import type { CommandInstance } from "vorpal";
+import { openGoogleCloudDashboard } from "../gcloud/openDashboard";
+
+export const openGoogleCloudLogs = async (
+  instance: CommandInstance,
+  context: Context
+) => {
+  const deployConfig = context.componentConfig.deploy;
+  if (!isOfDeployType(deployConfig, "kubernetes")) {
+    throw new Error("context is not of type kubernetes");
+  }
+
+  if (!deployConfig.cluster || deployConfig.cluster.type !== "gcloud") {
+    throw new Error("no gcloud custer configured");
+  }
+
+  const namespace = context.environment.envVars.KUBE_NAMESPACE;
+  const cluster = deployConfig.cluster;
+
+  const resource = `k8s_container/cluster_name/${cluster.name}${
+    namespace ? `/namespace_name/${namespace}` : ""
+  }`;
+
+  await openGoogleCloudDashboard(instance, "logs/viewer", {
+    project: cluster.projectId,
+    resource: resource,
+  });
+};
+
+export const openGoogleCloudKubernetesDashboard = async (
+  instance: CommandInstance,
+  context: Context
+) => {
+  const deployConfig = context.componentConfig.deploy;
+  if (!isOfDeployType(deployConfig, "kubernetes")) {
+    throw new Error("context is not of type kubernetes");
+  }
+
+  if (!deployConfig.cluster || deployConfig.cluster.type !== "gcloud") {
+    throw new Error("no gcloud custer configured");
+  }
+  const namespace = context.environment.envVars.KUBE_NAMESPACE;
+  const cluster = deployConfig.cluster;
+  const pageState = `("savedViews":("c":["gke/${cluster.region}/${cluster.name}"],"n":["${namespace}"],"i":"4e42e0b9cd6147f8a4fba7516752ec48"))`;
+
+  await openGoogleCloudDashboard(instance, "kubernetes/workload", {
+    project: cluster.projectId,
+    pageState: pageState,
+  });
+};

package/src/kubernetes/portForward.ts

@@ -0,0 +1,15 @@
+import { startPortForwardCommand } from "../utils/portForwards";
+
+export const startKubePortForward = async (
+  podname: string,
+  localPort: number,
+  remotePort: number,
+  namespace: string
+) => {
+  const name = `kube/${namespace}/${podname}/${localPort}:${remotePort}`;
+
+  await startPortForwardCommand(
+    name,
+    `kubectl port-forward ${podname} ${localPort}:${remotePort} -n ${namespace}`
+  );
+};

package/src/types/child-process-promise.d.ts

@@ -1 +1,36 @@
-declare module 'child-process-promise'
+import type { ReadStream } from "fs-extra";
+
+declare module "child-process-promise" {
+  function exec(
+    cmd: string,
+    options?: {
+      env?: Record<string, string>;
+    }
+  ): Promise<{
+    stdout: string;
+  }>;
+
+  type Stdio = "inherit" | "pipe";
+  type SpawnOptions = {
+    stdio?: Stdio | Stdio[];
+    shell?: boolean;
+    env?: Record<string, string>;
+  };
+
+  function spawn(
+    cmd: string,
+    options?: SpawnOptions
+  ): Promise<{
+    stdout: string;
+  }>;
+
+  function spawn(
+    cmd: string,
+    args: string[],
+    options?: SpawnOptions
+  ): Promise<unknown> & {
+    childProcess: {
+      stdout: ReadStream;
+    };
+  };
+}

package/src/utils/cluster.ts

@@ -1,12 +1,12 @@
-import { $ } from "zx";
+import { exec } from "child-process-promise";
 
 export const getCurrentContext = async () =>
-  (await $`kubectl config current-context`).stdout.trim();
+  (await exec(`kubectl config current-context`)).stdout.trim();
 
 export const getCurrentConnectedClusterName = async () => {
   return await getCurrentContext();
 };
 
 export const connectToCluster = async (fullname: string) => {
-  await $`kubectl config use-context ${fullname}`;
+  await exec(`kubectl config use-context ${fullname}`);
 };