@catladder/cli 1.1.0 → 1.3.0

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

@@ -1,5 +1,5 @@
-import { exec } from "child-process-promise";
 import Vorpal from "vorpal";
+import { $ } from "zx";
 
 export default async (vorpal: Vorpal) =>
   vorpal
@@ -8,5 +8,5 @@ export default async (vorpal: Vorpal) =>
       "open the repo on gitlab / github in your browser"
     )
     .action(async () => {
-      await exec("npx git-open");
+      await $`npx git-open`;
     });

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

@@ -1,4 +1,8 @@
 import Vorpal from "vorpal";
+import {
+  getPipelineContextByChoice,
+  parseChoice,
+} from "../../../../config/getProjectConfig";
 import { getCurrentConnectedClusterName } from "../../../../utils/cluster";
 import { getProjectNamespace } from "../../../../utils/projects";
 import { getGoogleAuthUserNumber } from "../../utils/getGoogleAuthUserNumber";
@@ -14,10 +18,35 @@ export default async (vorpal: Vorpal) =>
     )
     .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
-      await ensureCluster.call(this, envComponent);
-      const clustername = await getCurrentConnectedClusterName();
-      const namespace = await getProjectNamespace(envComponent);
+      const { env, componentName } = parseChoice(envComponent);
+      const { componentConfig, environment } = await getPipelineContextByChoice(
+        env,
+        componentName
+      );
+
+      if (
+        !componentConfig.deploy ||
+        componentConfig.deploy.type !== "kubernetes"
+      ) {
+        throw new Error(
+          "only kubernetes deployments are supported at the moment"
+        );
+      }
+
+      if (
+        !componentConfig.deploy.cluster ||
+        componentConfig.deploy.cluster.type !== "gcloud"
+      ) {
+        throw new Error("no gcloud custer configured");
+      }
+      // currently only supports kubernetes
+      const namespace = environment.envVars.KUBE_NAMESPACE;
+
       const authGoogleNumber = await getGoogleAuthUserNumber.call(this, vorpal);
 
-      await openGoogleCloudLogs(authGoogleNumber, clustername, namespace);
+      await openGoogleCloudLogs(
+        componentConfig.deploy.cluster,
+        namespace,
+        authGoogleNumber
+      );
     });

package/src/apps/cli/commands/project/utils/ensureCluster.ts

@@ -1,4 +1,7 @@
-import { isOfDeployType } from "@catladder/pipeline";
+import {
+  isOfDeployType,
+  getFullKubernetesClusterName,
+} from "@catladder/pipeline";
 import {
   getPipelineContextByChoice,
   parseChoice,
@@ -13,7 +16,9 @@ export default async function (envComponent: string) {
   if (!isOfDeployType(context.componentConfig.deploy, "kubernetes")) {
     throw new Error("can't ensure cluster for non-kubernetes deployments");
   }
-  const cluster = context.componentConfig.deploy.cluster || "production";
+  const cluster = getFullKubernetesClusterName(
+    context.componentConfig.deploy.cluster
+  );
   const connectedClusterName = await getCurrentConnectedClusterName();
 
   if (cluster !== connectedClusterName) {

package/src/apps/cli/commands/project/utils/ensureNamespace.ts

@@ -1,31 +1,55 @@
+import { Context, getKubernetesNamespace } from "@catladder/pipeline";
 import { V1Namespace, V1ObjectMeta } from "@kubernetes/client-node";
 import k8sApi from "../../../../../k8sApi";
-import { getProjectNamespace } from "../../../../../utils/projects/index";
 
-export default async function (envComponent: string) {
-  const namespace = await getProjectNamespace(envComponent);
+export default async function (context: Context) {
+  const namespace = getKubernetesNamespace(
+    context.fullConfig,
+    context.environment.shortName
+  );
+  const namespaceBody = new V1Namespace();
+  const metadata: V1ObjectMeta = {
+    name: namespace,
+    labels: {
+      customerName: context.fullConfig.customerName,
+      appName: context.fullConfig.appName,
+      environment: context.environment.shortName,
+      components: Object.keys(context.fullConfig.components).join("_"), // limited chars available...
+      buildTypes: Object.values(context.fullConfig.components)
+        .map((config) => config.build.type)
+        .join("_"), // limited chars available...
+      ...Object.fromEntries(
+        Object.entries(context.fullConfig.components).map(
+          ([componentName, config]) => [
+            "buildType_" + componentName,
+            config.build.type,
+          ]
+        )
+      ),
+      ...(context.fullConfig.meta?.labels ?? {}),
+    },
+  };
+
+  namespaceBody.metadata = metadata;
   try {
     await k8sApi.readNamespace(namespace);
+
+    await k8sApi.patchNamespace(
+      namespace,
+      namespaceBody,
+      undefined,
+      undefined,
+      undefined,
+      undefined,
+      { headers: { "content-type": "application/merge-patch+json" } } // see https://github.com/kubernetes-client/javascript/issues/443
+    ); // update meta data
   } catch (e) {
-    if (e.response.body && e.response.body.reason === "NotFound") {
-      this.log(`namespace '${namespace} does not exist. `);
-      const { shouldContinue } = await this.prompt({
-        type: "confirm",
-        name: "shouldContinue",
-        default: true,
-        message: `Should I create namespace '${namespace}'?`,
-      });
-      if (!shouldContinue) {
-        throw new Error("abort");
-      }
-      const namespaceBody = new V1Namespace();
-      const metadata = {
-        name: namespace,
-      };
-      namespaceBody.metadata = metadata as V1ObjectMeta;
+    if (e.response?.body?.reason === "NotFound") {
       await k8sApi.createNamespace(namespaceBody);
     } else {
+      console.error(e.response?.body);
       throw e;
     }
   }
+  return namespace;
 }

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

@@ -1,31 +1,34 @@
+import { DeployConfigKubernetesCluster } from "@catladder/pipeline";
 import open from "open";
-import { GOOGLE_PROJECT } from "../../../../config/constants";
 
 export const openGoogleCloudLogs = async (
-  googleAuthUserNumber = 0,
-  clustername?: string,
-  namespace?: string
+  cluster?: DeployConfigKubernetesCluster,
+  namespace?: string,
+  googleAuthUserNumber = 0
 ) => {
-  const resource = clustername
-    ? `k8s_container/cluster_name/${clustername}${
-        namespace ? `/namespace_name/${namespace}` : ""
-      }`
-    : null;
+  const resource = `k8s_container/cluster_name/${cluster.name}${
+    namespace ? `/namespace_name/${namespace}` : ""
+  }`;
 
-  const url = `https://console.cloud.google.com/logs/viewer?project=${GOOGLE_PROJECT}${
+  const url = `https://console.cloud.google.com/logs/viewer?project=${
+    cluster.projectId
+  }${
     resource ? `&resource=${encodeURIComponent(resource)}` : ""
   }&authuser=${googleAuthUserNumber}`;
   open(url);
 };
 
 export const openGoogleCloudKubernetesDashboard = async (
-  googleAuthUserNumber = 0,
-  clustername?: string,
-  namespace?: string
+  cluster: DeployConfigKubernetesCluster,
+  namespace: string,
+  googleAuthUserNumber = 0
 ) => {
-  const url = `https://console.cloud.google.com/kubernetes/workload?authuser=${googleAuthUserNumber}&project=${GOOGLE_PROJECT}&pageState=(%22savedViews%22:(%22c%22:%5B%22gke%2Feurope-west1-d%2F${clustername}%22%5D,${
-    namespace ? `%22n%22:%5B%22${namespace}%22%5D` : ""
-  }))`;
+  //gke_skynet-164509_europe-west1-d_production
+
+  const pageState = `pageState=("savedViews":("c":["gke/${cluster.region}/${cluster.name}"],"n":["${namespace}"],"i":"4e42e0b9cd6147f8a4fba7516752ec48"))`;
+  const url = `https://console.cloud.google.com/kubernetes/workload?authuser=${googleAuthUserNumber}&project=${
+    cluster.projectId
+  }&pageState=${encodeURIComponent(pageState)}`;
 
   open(url);
 };

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

@@ -14,26 +14,7 @@ export default async (vorpal: Vorpal) => {
     this.log(text);
     this.log("");
   });
-  vorpal.command("pantobot", "the allknowing oracle").action(async function () {
-    const { message } = await this.prompt({
-      type: "string",
-      name: "message",
 
-      message: "Your question, unworthy?: ",
-    });
-    const result = await fetch(
-      `https://paas.panter.cloud/api/pantobot/${message}`,
-      {
-        headers: {
-          Accept: "text/plain",
-        },
-      }
-    );
-    const text = await result.text();
-    this.log("");
-    this.log(text);
-    this.log("");
-  });
   let starwarsPromise: any;
   vorpal
     .command("starwars", "Long time ago... in a galaxy far far away...")

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

@@ -87,7 +87,6 @@ export const migrateV2 = async (vorpal: Vorpal) => {
     APP_NAME,
     COMPONENT_NAME,
     APP_DIR = ".",
-    CLUSTER_NAME,
     STAGING_ENABLED,
   } = gitlabCi.variables;
 
@@ -147,7 +146,13 @@ export const migrateV2 = async (vorpal: Vorpal) => {
             deploy: {
               type: "kubernetes",
               values: transformValues(baseValues),
-              cluster: CLUSTER_NAME,
+              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) => {

package/src/catenv.ts

@@ -1,3 +1,4 @@
 import catenv from "./apps/catenv/catenv";
-
+import { $ } from "zx";
+$.verbose = false;
 catenv();

package/src/cli.ts

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

package/src/config/constants.ts

@@ -1,5 +1,4 @@
 export const GRAFANA_PROXY_LOCAL_PORT = 9090;
 export const GRAFANA_PROXY_TARGET_PORT = 9090;
 
-export const GOOGLE_PROJECT = "skynet-164509";
 export const GOOGLE_CLOUD_SQL_PASS_PATH = "cloud-sql-proxy-credentials";

package/src/config/getProjectConfig.ts

@@ -72,9 +72,11 @@ export const getAllComponentsWithAllEnvs = async () => {
 
 export const getAllPipelineContexts = async () => {
   return Promise.all(
-    (await getAllComponentsWithAllEnvs()).map(({ env, componentName }) =>
-      getPipelineContextByChoice(env, componentName)
-    )
+    (await getAllComponentsWithAllEnvs())
+      .filter((c) => c.env !== "local")
+      .map(({ env, componentName }) =>
+        getPipelineContextByChoice(env, componentName)
+      )
   );
 };
 

package/src/k8sApi/index.ts

@@ -7,7 +7,11 @@ import {
 
 const kc = new KubeConfig();
 
-kc.loadFromDefault();
+export const reload = () => {
+  kc.loadFromDefault();
+};
+
+reload();
 
 const k8sApi = kc.makeApiClient(CoreV1Api);
 

package/src/utils/cluster.ts

@@ -1,34 +1,14 @@
-import { exec } from "child-process-promise";
-import { findKey } from "lodash";
-import clusters from "../config/clusters";
+import { $ } from "zx";
+import { reload } from "../k8sApi";
+
 export const getCurrentContext = async () =>
-  (await exec("kubectl config current-context")).stdout.trim();
+  (await $`kubectl config current-context`).stdout.trim();
 
 export const getCurrentConnectedClusterName = async () => {
-  const currentContext = await getCurrentContext();
-  return findKey(clusters, { fullName: currentContext });
-};
-
-export const getClusterByFullName = (fullName: string) => {
-  const found = Object.entries(getAllClusters()).find(
-    ([, config]) => config.fullName === fullName
-  );
-  if (found) {
-    return { name: found[0], cluster: found[1] };
-  } else {
-    return null;
-  }
+  return await getCurrentContext();
 };
 
-export const getClusterByName = (name: string) => getAllClusters()[name];
-
-export const getAllClusters = () => {
-  return clusters;
-};
-
-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 $`kubectl config use-context ${fullname}`;
+  reload();
 };

package/src/utils/gitlab.ts

@@ -125,6 +125,9 @@ export const getAllVariables = memoizee(
   { promise: true }
 );
 
+const maskableRegex = new RegExp("^[a-zA-Z0-9_+=/@:.~-]{8,}$"); // SEE https://gitlab.com/gitlab-org/gitlab-foss/-/blob/master/spec/frontend/ci_variable_list/components/ci_variable_modal_spec.js#L20
+const isMaskable = (value: string): boolean => maskableRegex.test(value);
+
 const createVariable = async (
   vorpal: CommandInstance,
   projectId: string,
@@ -134,6 +137,7 @@ const createVariable = async (
   return await doGitlabRequest(vorpal, `projects/${projectId}/variables`, {
     key,
     value,
+    masked: isMaskable(value),
   });
 };
 
@@ -148,6 +152,7 @@ const updateVariable = async (
     `projects/${projectId}/variables/${key}`,
     {
       value,
+      masked: isMaskable(value),
     },
     true
   );

package/src/utils/projects/index.ts

@@ -1,12 +1,11 @@
-import { exec } from "child-process-promise";
-
+import { $ } from "zx";
 import { join } from "path";
 import { getProjectConfig, parseChoice } from "../../config/getProjectConfig";
 import k8sApi from "../../k8sApi";
 import { readFileOrError } from "../files";
 
 export const getGitRoot = async (): Promise<string> => {
-  return (await exec("git rev-parse --show-toplevel")).stdout?.trim();
+  return (await $`git rev-parse --show-toplevel`).stdout.trim();
 };
 
 export const getRootGitlabCiFile = async () => {

package/dist/config/clusters.d.ts

@@ -1,14 +0,0 @@
-export declare type Cluster = {
-    fullName: string;
-    passToken?: string;
-    passCredentials?: {
-        ca_cert: string;
-        token: string;
-    };
-    api_url?: string;
-    connect: () => Promise<any>;
-};
-declare const clusters: {
-    [clustername: string]: Cluster;
-};
-export default clusters;

package/dist/config/clusters.js

@@ -1,72 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-exports.__esModule = true;
-var child_process_promise_1 = require("child-process-promise");
-var clusters = {
-    demo: {
-        fullName: "gke_skynet-164509_europe-west1-d_demo",
-        connect: function () { return __awaiter(void 0, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, (0, child_process_promise_1.exec)("gcloud container clusters get-credentials demo --zone europe-west1-d --project skynet-164509")];
-            });
-        }); }
-    },
-    production: {
-        fullName: "gke_skynet-164509_europe-west1-d_production",
-        passCredentials: {
-            token: "syknet/clusters/production/token",
-            ca_cert: "syknet/clusters/production/ca_cert"
-        },
-        api_url: "https://35.189.234.235",
-        connect: function () { return __awaiter(void 0, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, (0, child_process_promise_1.exec)("gcloud container clusters get-credentials production --zone europe-west1-d --project skynet-164509")];
-            });
-        }); }
-    },
-    panterGitlab: {
-        fullName: "gke_skynet-intern_europe-west6-a_swiss-cluster",
-        connect: function () { return __awaiter(void 0, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, (0, child_process_promise_1.exec)("gcloud container clusters get-credentials --project skynet-intern swiss-cluster --region europe-west6-a")];
-            });
-        }); }
-    }
-};
-exports["default"] = clusters;
-//# sourceMappingURL=clusters.js.map

package/dist/config/clusters.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"clusters.js","sourceRoot":"","sources":["../../src/config/clusters.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAA6C;AAa7C,IAAM,QAAQ,GAEV;IACF,IAAI,EAAE;QACJ,QAAQ,EAAE,uCAAuC;QACjD,OAAO,EAAE;;gBACP,sBAAA,IAAA,4BAAI,EACF,8FAA8F,CAC/F,EAAA;;aAAA;KACJ;IACD,UAAU,EAAE;QACV,QAAQ,EAAE,6CAA6C;QACvD,eAAe,EAAE;YACf,KAAK,EAAE,kCAAkC;YACzC,OAAO,EAAE,oCAAoC;SAC9C;QAED,OAAO,EAAE,wBAAwB;QACjC,OAAO,EAAE;;gBACP,sBAAA,IAAA,4BAAI,EACF,oGAAoG,CACrG,EAAA;;aAAA;KACJ;IACD,YAAY,EAAE;QACZ,QAAQ,EAAE,gDAAgD;QAC1D,OAAO,EAAE;;gBACP,sBAAA,IAAA,4BAAI,EACF,yGAAyG,CAC1G,EAAA;;aAAA;KACJ;CACF,CAAC;AACF,qBAAe,QAAQ,CAAC"}

package/src/config/clusters.ts

@@ -1,45 +0,0 @@
-import { exec } from "child-process-promise";
-
-export type Cluster = {
-  fullName: string;
-  passToken?: string;
-  passCredentials?: {
-    ca_cert: string;
-    token: string;
-  };
-  api_url?: string;
-  connect: () => Promise<any>;
-};
-
-const clusters: {
-  [clustername: string]: Cluster;
-} = {
-  demo: {
-    fullName: "gke_skynet-164509_europe-west1-d_demo",
-    connect: async () =>
-      exec(
-        "gcloud container clusters get-credentials demo --zone europe-west1-d --project skynet-164509"
-      ),
-  },
-  production: {
-    fullName: "gke_skynet-164509_europe-west1-d_production",
-    passCredentials: {
-      token: "syknet/clusters/production/token",
-      ca_cert: "syknet/clusters/production/ca_cert",
-    },
-
-    api_url: "https://35.189.234.235",
-    connect: async () =>
-      exec(
-        "gcloud container clusters get-credentials production --zone europe-west1-d --project skynet-164509"
-      ),
-  },
-  panterGitlab: {
-    fullName: "gke_skynet-intern_europe-west6-a_swiss-cluster",
-    connect: async () =>
-      exec(
-        "gcloud container clusters get-credentials --project skynet-intern swiss-cluster --region europe-west6-a"
-      ),
-  },
-};
-export default clusters;