@catladder/cli 0.0.0-test7 → 0.0.0-update-meteor-53480fed

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/k8sApi/index.ts

@@ -5,13 +5,29 @@ import {
   BatchV1beta1Api,
 } from "@kubernetes/client-node";
 
-const kc = new KubeConfig();
+const getKubeConfig = () => {
+  const kc = new KubeConfig();
+  kc.loadFromDefault();
+  return kc;
+};
+/**
+ * get kubernetes client. avoid reusing the instance when context get changed
+ * @returns kuberenetes client
+ */
+export const getk8sApi = () => {
+  const kc = getKubeConfig();
 
-kc.loadFromDefault();
+  return kc.makeApiClient(CoreV1Api);
+};
 
-const k8sApi = kc.makeApiClient(CoreV1Api);
+export const getk8sApiBatch = () => {
+  const kc = getKubeConfig();
 
-export const k8sApiBatch = kc.makeApiClient(BatchV1Api);
-export const k8sApiBatchBeta = kc.makeApiClient(BatchV1beta1Api);
+  return kc.makeApiClient(BatchV1Api);
+};
 
-export default k8sApi;
+export const getk8sApiBatchBeta = () => {
+  const kc = getKubeConfig();
+
+  return kc.makeApiClient(BatchV1beta1Api);
+};

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,37 @@
-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 | string;
+    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;
+      kill: () => void;
+    };
+  };
+}

package/src/types/types.ts

@@ -1,5 +1,3 @@
-export type Env = "dev-local" | "prod" | "dev" | "stage" | "review";
-
 export type KubernetesSecretName = string;
 export interface ISecrets {
   [key: string]: KubernetesSecretName;

package/src/utils/cluster.ts

@@ -1,21 +1,12 @@
 import { exec } from "child-process-promise";
-import { findKey } from "lodash";
-import clusters from "../config/clusters";
+
 export const getCurrentContext = async () =>
-  (await exec("kubectl config current-context")).stdout.trim();
+  (await exec(`kubectl config current-context`)).stdout.trim();
 
 export const getCurrentConnectedClusterName = async () => {
-  const currentContext = await getCurrentContext();
-  return findKey(clusters, { fullName: currentContext });
-};
-
-export const getClusterByName = (name: string) => {
-  return clusters[name];
+  return await getCurrentContext();
 };
 
-export const getAllClusterNames = () => Object.keys(clusters);
-
-export const connectToCluster = async (clusterName: string) => {
-  const { connect } = getClusterByName(clusterName);
-  await connect();
+export const connectToCluster = async (fullname: string) => {
+  await exec(`kubectl config use-context ${fullname}`);
 };

package/src/utils/editAsFile.ts

@@ -0,0 +1,31 @@
+import { withFile } from "tmp-promise";
+import { dump, load } from "js-yaml";
+
+import { readFile, writeFile } from "fs-extra";
+import getEditor from "./getEditor";
+
+export const editAsFile = async <T>(
+  inObject: T,
+  preamble?: string
+): Promise<T> => {
+  const fullPreamble = preamble
+    ? `#
+# ${preamble.split("\n").join("\n# ")}
+#
+
+`
+    : "\n";
+  const asString = fullPreamble + dump(inObject, { noRefs: true });
+  let newContent: T;
+
+  await withFile(
+    async ({ path: tmpFilePath }) => {
+      await writeFile(tmpFilePath, asString);
+      await (await getEditor()).open(tmpFilePath);
+      newContent = load((await readFile(tmpFilePath)).toString("utf-8")) as T;
+    },
+    { postfix: ".yml" }
+  );
+
+  return newContent;
+};

package/src/utils/files.ts

@@ -13,6 +13,10 @@ export const readFileOrError = async (filePath: string) => {
   }
 };
 
-export const readYaml = async (filename: string) => {
-  return yaml.load(await readFile(filename));
+export const readYaml = async <T = Record<string, any>>(filename: string) => {
+  try {
+    return yaml.load(await readFile(filename)) as T;
+  } catch (e) {
+    return null;
+  }
 };