@catladder/cli 0.0.0-main-5f142cf2 → 0.0.0-main-825347d8

package/src/apps/{shell → cli}/commands/project/commandGitlabCi.ts

@@ -64,7 +64,7 @@ const promptJob = async (vorpal: CommandInstance, projectId: any, ctx: any) => {
   return jobs.find((j: any) => j.id === jobId);
 };
 
-export default (vorpal: Vorpal) => {
+export default async (vorpal: Vorpal) => {
   vorpal.command("project-ci-job-open", "Open a Job").action(async function () {
     const { id: projectId } = await getProjectInfo(this);
 

package/src/apps/{shell → cli}/commands/project/commandInitGitlab.ts

@@ -7,10 +7,10 @@ import {
   getClusterByName,
 } from "../../../../utils/cluster";
 import { doGitlabRequest, getProjectInfo } from "../../../../utils/gitlab";
-import { readPass } from "../../../../utils/passwordstore/";
+import { readPass } from "../../../../utils/passwordstore";
 import { getProjectNamespace } from "../../../../utils/projects";
 
-export default (vorpal: Vorpal) =>
+export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-init-gitlab",
@@ -50,7 +50,7 @@ export default (vorpal: Vorpal) =>
       this.log("");
       this.log("your project specifies the following clusters:");
       this.log("");
-      const allContext = getAllPipelineContexts();
+      const allContext = await getAllPipelineContexts();
       const allDeployments = allContext.map((c) => c.componentConfig.deploy);
 
       const configuredClusterNames = allDeployments.reduce<string[]>(

package/src/apps/{shell → cli}/commands/project/commandInitProject.ts

@@ -29,7 +29,7 @@ const DEFAULT_VARIABLES = {
   clusterName: "production",
 };
 // TODO: we should find a way how to fetch the variables of the inclues directly from gitlab
-const DEFAULT_NODE_APPLICATION = {};
+const DEFAULT_NODE_asdfAPPLICATION = {};
 
 const DEFAULT_FILES_TO_CREATE: FileToCreate[] = [
   {
@@ -187,7 +187,7 @@ const PLATFORMS: { [platformName: string]: PlatformDefinition } = {
 */
 
 const PLATFORMS: any = {};
-export default (vorpal: Vorpal) =>
+export default async (vorpal: Vorpal) =>
   vorpal
     .command("project-init", "Inits a new project")
     .action(async function () {

package/src/apps/{shell → cli}/commands/project/commandListPods.ts

@@ -2,13 +2,13 @@ import yaml from "js-yaml";
 import { pick } from "lodash";
 import Vorpal from "vorpal";
 import { getProjectPods } from "../../../../utils/projects";
-import { envAutocompletion } from "./utils/autocompletions";
+import { envAndComponents } from "./utils/autocompletions";
 import ensureCluster from "./utils/ensureCluster";
 
-export default (vorpal: Vorpal) =>
+export default async (vorpal: Vorpal) =>
   vorpal
     .command("project-list-pods <envComponent>", "list pods of local project")
-    .autocomplete(envAutocompletion)
+    .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       await ensureCluster.call(this, envComponent);
       const pods = await getProjectPods(envComponent);

package/src/apps/{shell → cli}/commands/project/commandMigrateHelm3.ts

@@ -1,25 +1,31 @@
 import { exec } from "child-process-promise";
 import Vorpal from "vorpal";
-import { getEnvironmentByChoice } from "../../../../config/getProjectConfig";
+import {
+  getEnvironment,
+  parseChoice,
+} from "../../../../config/getProjectConfig";
 import { logError } from "../../../../utils/log";
 
-import { envAutocompletion } from "./utils/autocompletions";
+import { envAndComponents } from "./utils/autocompletions";
 
 /**
  * Error: rendered manifests contain a resource that already exists.
  * Unable to continue with install: ConfigMap "web-app-env" in namespace "pvl-bike2school-dev" exists and cannot be imported into the current release: invalid ownership metadata; label validation error: missing key "app.kubernetes.io/managed-by": must be set to "Helm"; annotation validation error: missing key "meta.helm.sh/release-name": must be set to "pvl-bike2school-dev-web"; annotation validation error: missing key "meta.helm.sh/release-namespace": must be set to "pvl-bike2school-dev"
  */
-export default (vorpal: Vorpal) =>
+export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-migrate-helm3 <envComponent>",
       "Do manual step for helm2 to helm3 migration"
     )
     .autocomplete(
-      envAutocompletion.filter((e) => e !== "dev-local" && e !== "review")
+      (await envAndComponents()).filter(
+        (e) => !e.startsWith("local") && !e.startsWith("review")
+      )
     )
     .action(async function ({ envComponent }) {
       try {
+        const { env, componentName } = parseChoice(envComponent);
         const result = await exec("helm version --short");
         const version = result.stdout as string;
         this.log(`your helm version: ${version}`);
@@ -37,7 +43,7 @@ export default (vorpal: Vorpal) =>
           // ignore
         }
 
-        const releaseName = await getEnvironmentByChoice(envComponent).envVars
+        const releaseName = (await getEnvironment(env, componentName)).envVars
           .RELEASE_NAME; // TODO: maybe its own function would be better
         this.log(`helm release name: ${releaseName}`);
         this.log("");

package/src/apps/{shell → cli}/commands/project/commandNamespace.ts

@@ -1,14 +1,14 @@
 import Vorpal from "vorpal";
 import { getProjectNamespace } from "../../../../utils/projects";
-import { envAutocompletion } from "./utils/autocompletions";
+import { envAndComponents } from "./utils/autocompletions";
 
-export default (vorpal: Vorpal) =>
+export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-namespace <envComponent>",
       "show namespace of local project"
     )
-    .autocomplete(envAutocompletion)
+    .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       this.log(await getProjectNamespace(envComponent));
     });

package/src/apps/{shell → cli}/commands/project/commandOpenCostDashboard.ts

@@ -9,15 +9,15 @@ import { startPortForward } from "../../../../utils/portForward";
 
 import { getProjectNamespace } from "../../../../utils/projects";
 
-import { envAutocompletion } from "./utils/autocompletions";
+import { envAndComponents } from "./utils/autocompletions";
 import ensureCluster from "./utils/ensureCluster";
-export default (vorpal: Vorpal) =>
+export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-check-costs <envComponent>",
       "Shows you how much you're spending"
     )
-    .autocomplete(envAutocompletion)
+    .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       await ensureCluster.call(this, envComponent);
       const namespace = await getProjectNamespace(envComponent);

package/src/apps/{shell → cli}/commands/project/commandOpenDashboard.ts

@@ -1,20 +1,26 @@
 import Vorpal from "vorpal";
-import { getPipelineContextByChoice } from "../../../../config/getProjectConfig";
+import {
+  getPipelineContextByChoice,
+  parseChoice,
+} from "../../../../config/getProjectConfig";
 import { getCurrentConnectedClusterName } from "../../../../utils/cluster";
 import { getGoogleAuthUserNumber } from "../../utils/getGoogleAuthUserNumber";
 import { openGoogleCloudKubernetesDashboard } from "../shared";
-import { envAutocompletion } from "./utils/autocompletions";
+import { envAndComponents } from "./utils/autocompletions";
 import ensureCluster from "./utils/ensureCluster";
-export default (vorpal: Vorpal) =>
+export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-open-dashboard <envComponent>",
       "open kubernetes dashboard on google"
     )
-    .autocomplete(envAutocompletion)
+    .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
-      const { componentConfig, environment } =
-        getPipelineContextByChoice(envComponent);
+      const { env, componentName } = parseChoice(envComponent);
+      const { componentConfig, environment } = await getPipelineContextByChoice(
+        env,
+        componentName
+      );
 
       if (
         !componentConfig.deploy ||

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

@@ -0,0 +1,22 @@
+import open from "open";
+import Vorpal from "vorpal";
+import {
+  getEnvironment,
+  parseChoice,
+} from "../../../../config/getProjectConfig";
+
+import { envAndComponents } from "./utils/autocompletions";
+import ensureCluster from "./utils/ensureCluster";
+
+export default async (vorpal: Vorpal) =>
+  vorpal
+    .command("project-open-env <envComponent>", "open the live environment")
+    .autocomplete(await envAndComponents())
+    .action(async function ({ envComponent }) {
+      const { env, componentName } = parseChoice(envComponent);
+      await ensureCluster.call(this, envComponent);
+      const environment = await getEnvironment(env, componentName);
+      const url = environment.url;
+
+      open(url);
+    });

package/src/apps/{shell → cli}/commands/project/commandOpenGit.ts

@@ -1,7 +1,7 @@
 import { exec } from "child-process-promise";
 import Vorpal from "vorpal";
 
-export default (vorpal: Vorpal) =>
+export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-open-git",

package/src/apps/{shell → cli}/commands/project/commandOpenGrafana.ts

@@ -8,15 +8,15 @@ import {
 
 import { getProjectNamespace } from "../../../../utils/projects";
 
-import { envAutocompletion } from "./utils/autocompletions";
+import { envAndComponents } from "./utils/autocompletions";
 import ensureCluster from "./utils/ensureCluster";
-export default (vorpal: Vorpal) =>
+export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-open-grafana <envComponent>",
       "open Grafana dashboard for your namespace"
     )
-    .autocomplete(envAutocompletion)
+    .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       await ensureCluster.call(this, envComponent);
       const namespace = await getProjectNamespace(envComponent);

package/src/apps/{shell → cli}/commands/project/commandOpenGrafanaPod.ts

@@ -6,21 +6,20 @@ import {
 } from "../../../../config/constants";
 import { logError } from "../../../../utils/log";
 import { startPortForward } from "../../../../utils/portForward";
-
 import {
   getProjectNamespace,
   getProjectPodNames,
 } from "../../../../utils/projects";
-
-import { envAutocompletion } from "./utils/autocompletions";
+import { envAndComponents } from "./utils/autocompletions";
 import ensureCluster from "./utils/ensureCluster";
-export default (vorpal: Vorpal) =>
+
+export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-open-grafana-pod <envComponent>",
       "open Grafana dashboard for a specific pod"
     )
-    .autocomplete(envAutocompletion)
+    .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       await ensureCluster.call(this, envComponent);
       const podNames = await getProjectPodNames(envComponent);

package/src/apps/{shell → cli}/commands/project/commandOpenLogs.ts

@@ -3,16 +3,16 @@ import { getCurrentConnectedClusterName } from "../../../../utils/cluster";
 import { getProjectNamespace } from "../../../../utils/projects";
 import { getGoogleAuthUserNumber } from "../../utils/getGoogleAuthUserNumber";
 import { openGoogleCloudLogs } from "../shared";
-import { envAutocompletion } from "./utils/autocompletions";
+import { envAndComponents } from "./utils/autocompletions";
 import ensureCluster from "./utils/ensureCluster";
 
-export default (vorpal: Vorpal) =>
+export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-open-logs <envComponent>",
       "open google cloud logs (stackdriver logs)"
     )
-    .autocomplete(envAutocompletion)
+    .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       await ensureCluster.call(this, envComponent);
       const clustername = await getCurrentConnectedClusterName();

package/src/apps/{shell → cli}/commands/project/commandPauseProject.ts

@@ -1,15 +1,15 @@
 import Vorpal from "vorpal";
 import { exec } from "child-process-promise";
 import { getProjectNamespace } from "../../../../utils/projects";
-import { envAutocompletion } from "./utils/autocompletions";
+import { envAndComponents } from "./utils/autocompletions";
 
-export default (vorpal: Vorpal) =>
+export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-pause <envComponent>",
       "halts all running pods (scales to 0)"
     )
-    .autocomplete(envAutocompletion)
+    .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       const namespace = await getProjectNamespace(envComponent);
       const { shouldContinue } = await this.prompt({

package/src/apps/{shell → cli}/commands/project/commandPortForward.ts

@@ -5,13 +5,13 @@ import {
   getProjectNamespace,
   getProjectPodNames,
 } from "../../../../utils/projects";
-import { envAutocompletion } from "./utils/autocompletions";
+import { envAndComponents } from "./utils/autocompletions";
 import ensureCluster from "./utils/ensureCluster";
 
-export default (vorpal: Vorpal) =>
+export default async (vorpal: Vorpal) =>
   vorpal
     .command("project-port-forward <envComponent>", "start port-forwarding")
-    .autocomplete(envAutocompletion)
+    .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       await ensureCluster.call(this, envComponent);
       const namespace = await getProjectNamespace(envComponent);

package/src/apps/{shell → cli}/commands/project/commandTriggerCronjob.ts

@@ -6,7 +6,7 @@ import { logError } from "../../../../utils/log";
 import { namespaceAutoCompletion } from "../general/namespaceAutoCompletion";
 
 import { getProjectNamespace } from "../../../../utils/projects";
-import { envAutocompletion } from "./utils/autocompletions";
+import { envAndComponents } from "./utils/autocompletions";
 import ensureCluster from "./utils/ensureCluster";
 
 async function triggerCronjob(namespace: string) {
@@ -43,7 +43,7 @@ async function triggerCronjob(namespace: string) {
     logError(this, "command failed", e.body);
   }
 }
-export default (vorpal: Vorpal) => {
+export default async (vorpal: Vorpal) => {
   vorpal
     .command("trigger-cronjob <namespace>", "trigger cronjob")
     .autocomplete(namespaceAutoCompletion)
@@ -52,7 +52,7 @@ export default (vorpal: Vorpal) => {
     });
   vorpal
     .command("project-trigger-cronjob <envComponent>", "trigger cronjob")
-    .autocomplete(envAutocompletion)
+    .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       await ensureCluster.call(this, envComponent);
       const namespace = await getProjectNamespace(envComponent);

package/src/apps/{shell → cli}/commands/project/index.ts

@@ -25,7 +25,7 @@ import commandTriggerCronjob from "./commandTriggerCronjob";
 
 import commandOpenGrafanaPod from "./commandOpenGrafanaPod";
 
-export default (vorpal: Vorpal) => {
+export default async (vorpal: Vorpal) => {
   commandInitProject(vorpal);
   commandInitGitlab(vorpal);
   commandEnvVars(vorpal);

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

@@ -0,0 +1,26 @@
+import { getAllEnvs, getAllEnvsInAllComponents } from "@catladder/pipeline";
+import {
+  getAllComponentsWithAllEnvs,
+  getProjectConfig,
+} from "../../../../../config/getProjectConfig";
+
+export const allEnvs = async () => {
+  const config = await getProjectConfig();
+  if (!config) {
+    return [];
+  }
+  return getAllEnvsInAllComponents(config);
+};
+
+export const envAndComponents = async () => {
+  const allEnvAndcomponents = await getAllComponentsWithAllEnvs();
+
+  return allEnvAndcomponents.reduce<string[]>(
+    (acc, { env, componentName }) => [...acc, env + ":" + componentName],
+    []
+  );
+};
+
+export const allEnvsAndAllComponents = async () => {
+  return [...(await allEnvs()), ...(await envAndComponents())];
+};

package/src/apps/{shell → cli}/commands/project/utils/ensureCluster.ts

@@ -1,11 +1,15 @@
 import { isOfDeployType } from "@catladder/pipeline";
-import { getPipelineContextByChoice } from "../../../../../config/getProjectConfig";
+import {
+  getPipelineContextByChoice,
+  parseChoice,
+} from "../../../../../config/getProjectConfig";
 import {
   connectToCluster,
   getCurrentConnectedClusterName,
 } from "../../../../../utils/cluster";
 export default async function (envComponent: string) {
-  const context = getPipelineContextByChoice(envComponent);
+  const { env, componentName } = parseChoice(envComponent);
+  const context = await getPipelineContextByChoice(env, componentName);
   if (!isOfDeployType(context.componentConfig.deploy, "kubernetes")) {
     throw new Error("can't ensure cluster for non-kubernetes deployments");
   }

package/src/apps/{shell → cli}/commands/theStuffThatReallyMatters/index.ts

@@ -2,31 +2,31 @@ import { spawn } from "child-process-promise";
 import fetch from "node-fetch";
 import Vorpal from "vorpal";
 
-export default (vorpal: Vorpal) => {
-  vorpal.command("dadjoke", "something for jonas.").action(async function() {
+export default async (vorpal: Vorpal) => {
+  vorpal.command("dadjoke", "something for jonas.").action(async function () {
     const result = await fetch("https://icanhazdadjoke.com/", {
       headers: {
-        Accept: "text/plain"
-      }
+        Accept: "text/plain",
+      },
     });
     const text = await result.text();
     this.log("");
     this.log(text);
     this.log("");
   });
-  vorpal.command("pantobot", "the allknowing oracle").action(async function() {
+  vorpal.command("pantobot", "the allknowing oracle").action(async function () {
     const { message } = await this.prompt({
       type: "string",
       name: "message",
 
-      message: "Your question, unworthy?: "
+      message: "Your question, unworthy?: ",
     });
     const result = await fetch(
       `https://paas.panter.cloud/api/pantobot/${message}`,
       {
         headers: {
-          Accept: "text/plain"
-        }
+          Accept: "text/plain",
+        },
       }
     );
     const text = await result.text();
@@ -37,15 +37,15 @@ export default (vorpal: Vorpal) => {
   let starwarsPromise: any;
   vorpal
     .command("starwars", "Long time ago... in a galaxy far far away...")
-    .action(async function() {
+    .action(async function () {
       starwarsPromise = spawn("telnet", ["towel.blinkenlights.nl"], {
-        stdio: ["pipe", "inherit", "pipe"]
+        stdio: ["pipe", "inherit", "pipe"],
       });
       await starwarsPromise;
     })
     // we need to close it properly, because telnet towel.blinkenlights.nl has no way to cancel and stop itself
     // this is also why we need to only inherit the stdout and not the stdin
-    .cancel(async function() {
+    .cancel(async function () {
       starwarsPromise.childProcess.kill();
     });
 };

package/src/catenv.ts

@@ -0,0 +1,3 @@
+import catenv from "./apps/catenv/catenv";
+
+catenv();

package/src/cli.ts

@@ -0,0 +1,8 @@
+import updateNotifier from "update-notifier";
+import cli from "./apps/cli/cli";
+import packageInfos from "./packageInfos";
+
+updateNotifier({
+  pkg: packageInfos,
+}).notify();
+cli();

package/src/config/getProjectConfig.ts

@@ -7,67 +7,78 @@ import {
 
 import { CommandInstance } from "vorpal";
 import { getAllVariables } from "../utils/gitlab";
-
+import memoizee from "memoizee";
+import { getGitRoot } from "../utils/projects";
 // currently cant change
-const projectConfig = readConfigSync();
 
-export const getProjectConfig = () => {
-  return projectConfig;
-};
+export const getProjectConfig = memoizee(
+  async () => {
+    try {
+      const gitRoot = await getGitRoot();
+      return readConfigSync(gitRoot);
+    } catch (e) {
+      // ignore
+    }
+  },
+  { promise: true }
+);
 
-export const getProjectComponents = () => {
-  const config = getProjectConfig();
+export const getProjectComponents = async () => {
+  const config = await getProjectConfig();
+  if (!config) return [];
   return Object.keys(config.components);
 };
 
-export const getEnvComponentChoices = () => {
-  const config = getProjectConfig();
-  return Object.keys(config.components).reduce<string[]>(
-    (acc, componentName) => [
-      ...acc,
-      ...getAllEnvs(config, componentName).map((e) => e + ":" + componentName),
-    ],
-    []
-  );
-};
-
 export const parseChoice = (envComponent: string) => {
   const [env, componentName] = envComponent.split(":");
   return { env, componentName };
 };
 
-export const getPipelineContextByChoice = (envComponent: string) => {
-  const { env, componentName } = parseChoice(envComponent);
-  const config = getProjectConfig();
+export const getPipelineContextByChoice = async (
+  env: string,
+  componentName: string
+) => {
+  const config = await getProjectConfig();
   return createContext(config, componentName, env);
 };
+export const getAllComponentsWithAllEnvs = async () => {
+  const config = await getProjectConfig();
+  if (!config) {
+    return [];
+  }
+  return Promise.all(
+    Object.keys(config.components).flatMap((componentName) =>
+      getAllEnvs(config, componentName).map((env) => ({ env, componentName }))
+    )
+  );
+};
 
-export const getAllPipelineContexts = () => {
-  const envComponents = getEnvComponentChoices();
-  return envComponents.map(getPipelineContextByChoice);
+export const getAllPipelineContexts = async () => {
+  return Promise.all(
+    (await getAllComponentsWithAllEnvs()).map(({ env, componentName }) =>
+      getPipelineContextByChoice(env, componentName)
+    )
+  );
 };
 
-export const getEnvironmentByChoice = (envComponent: string) => {
-  const { env, componentName } = parseChoice(envComponent);
-  const config = getProjectConfig();
+export const getEnvironment = async (env: string, componentName: string) => {
+  const config = await getProjectConfig();
   return _getEnvironment(config, componentName, env);
 };
 
 const resolveSecrets = async (
   vorpal: CommandInstance,
-  allEnvVars: Record<string, string>,
-  secretEnvVarKeys: string[]
+  allEnvVars: Record<string, string>
 ) => {
   const allVariablesInGitlab = await getAllVariables(vorpal);
-  console.log("resolveSecrets", { allVariablesInGitlab, allEnvVars });
+
   return Object.fromEntries(
     Object.entries(allEnvVars).map(([key, value]) => {
-      const isSecret = secretEnvVarKeys.includes(key);
-      console.log({ key, value, isSecret, allVariablesInGitlab });
+      const isSecret = value?.startsWith("$CL_");
       if (isSecret) {
         // secrets have CL_XXXX structure
         const found = allVariablesInGitlab.find((v) => "$" + v.key === value);
-        console.log({ found });
+
         if (found) {
           return [key, found.value];
         } else {
@@ -81,12 +92,9 @@ const resolveSecrets = async (
 
 export const getEnvVars = async (
   vorpal: CommandInstance,
-  envComponent: string
+  env: string,
+  componentName: string
 ) => {
-  const envionment = getEnvironmentByChoice(envComponent);
-  return resolveSecrets(
-    vorpal,
-    envionment.envVars,
-    envionment.secretEnvVarKeys
-  );
+  const envionment = await getEnvironment(env, componentName);
+  return resolveSecrets(vorpal, envionment.envVars);
 };

package/src/utils/editAsFile.ts

@@ -4,8 +4,18 @@ import yaml from "js-yaml";
 import { readFile, writeFile } from "fs-extra";
 import getEditor from "./getEditor";
 
-export const editAsFile = async <T>(inObject: T): Promise<T> => {
-  const asString = yaml.safeDump(inObject);
+export const editAsFile = async <T>(
+  inObject: T,
+  preamble?: string
+): Promise<T> => {
+  const fullPreamble = preamble
+    ? `#
+# ${preamble.split("\n").join("\n# ")}
+#
+
+`
+    : "\n";
+  const asString = fullPreamble + yaml.safeDump(inObject, { noRefs: true });
   let newContent;
 
   await withFile(