pepr 0.52.3-nightly.0 → 0.52.3-nightly.2

package/src/cli/build/build.helpers.ts

@@ -113,15 +113,9 @@ export function checkIronBankImage(registry: string, image: string, peprVersion:
  * @param imagePullSecret
  * @returns boolean
  */
-export function validImagePullSecret(imagePullSecretName: string): void {
-  if (imagePullSecretName) {
-    const error = "Invalid imagePullSecret. Please provide a valid name as defined in RFC 1123.";
-    if (sanitizeResourceName(imagePullSecretName) !== imagePullSecretName) {
-      // https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names
-      console.error(error);
-      process.exit(1);
-    }
-  }
+export function validImagePullSecret(imagePullSecretName: string): boolean {
+  // https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names
+  return sanitizeResourceName(imagePullSecretName) === imagePullSecretName;
 }
 
 /**

package/src/cli/build/buildModule.ts

@@ -11,7 +11,7 @@ import { PeprConfig, Reloader } from "../types";
 import { BuildContext } from "esbuild";
 import { loadModule } from "./loadModule";
 
-type BuildModuleReturn = {
+export type BuildModuleReturn = {
   ctx: BuildContext<BuildOptions>;
   path: string;
   cfg: PeprConfig;

package/src/cli/build/index.ts

@@ -15,6 +15,7 @@ import {
   generateYamlAndWriteToDisk,
 } from "./build.helpers";
 import { buildModule } from "./buildModule";
+import Log from "../../lib/telemetry/logger";
 
 export default function (program: Command): void {
   program
@@ -53,7 +54,7 @@ export default function (program: Command): void {
     .option("-o, --output <directory>", "Set output directory.", "dist")
     .addOption(
       new Option(
-        "-r, --registry <GitHub|Iron Bank>",
+        "-r, --registry <registry>",
         "Container registry: Choose container registry for deployment manifests. Conflicts with --custom-image and --registry-info.",
       )
         .conflicts(["customImage", "registryInfo"])
@@ -99,7 +100,7 @@ export default function (program: Command): void {
       }
 
       if (opts.registryInfo !== undefined) {
-        console.info(`Including ${cfg.pepr.includedFiles.length} files in controller image.`);
+        Log.info(`Including ${cfg.pepr.includedFiles.length} files in controller image.`);
         // for journey test to make sure the image is built
 
         // only actually build/push if there are files to include
@@ -113,7 +114,7 @@ export default function (program: Command): void {
 
       // If building without embedding, exit after building
       if (!opts.embed) {
-        console.info(`Module built successfully at ${path}`);
+        Log.info(`Module built successfully at ${path}`);
         return;
       }
 
@@ -136,7 +137,11 @@ export default function (program: Command): void {
       if (image !== "") assets.image = image;
 
       // Ensure imagePullSecret is valid
-      validImagePullSecret(opts.withPullSecret);
+      if (!validImagePullSecret(opts.withPullSecret)) {
+        throw new Error(
+          "Invalid imagePullSecret. Please provide a valid name as defined in RFC 1123.",
+        );
+      }
 
       handleValidCapabilityNames(assets.capabilities);
       await generateYamlAndWriteToDisk({

package/src/cli/deploy/buildAndDeploy.ts

@@ -0,0 +1,48 @@
+import { Assets } from "../../lib/assets/assets";
+import { deployWebhook } from "../../lib/assets/deploy";
+import { loadCapabilities } from "../../lib/assets/loader";
+import { namespaceDeploymentsReady } from "../../lib/deploymentChecks";
+import { namespaceComplianceValidator, validateCapabilityNames } from "../../lib/helpers";
+import { CapabilityExport } from "../../lib/types";
+import { buildModule } from "../build/buildModule";
+
+export async function buildAndDeployModule(image: string, force: boolean): Promise<void> {
+  const builtModule = await buildModule("dist");
+  if (!builtModule) {
+    return;
+  }
+
+  // Generate a secret for the module
+  const webhook = new Assets(
+    { ...builtModule.cfg.pepr, description: builtModule.cfg.description },
+    builtModule.path,
+    [],
+  );
+  webhook.image = image ?? webhook.image;
+  const capabilities = await loadCapabilities(webhook.path);
+  for (const capability of capabilities) {
+    validateNamespaces(capability, webhook);
+  }
+  try {
+    await webhook.deploy(deployWebhook, force, builtModule.cfg.pepr.webhookTimeout ?? 10);
+
+    // wait for capabilities to be loaded and test names
+    validateCapabilityNames(webhook.capabilities);
+
+    // Wait for the pepr-system resources to be fully up
+    await namespaceDeploymentsReady();
+    console.info(`Module deployed successfully`);
+  } catch (e) {
+    console.error(`Error deploying module:`, e);
+    process.exit(1);
+  }
+}
+export function validateNamespaces(capability: CapabilityExport, webhook: Assets): void {
+  namespaceComplianceValidator(capability, webhook.alwaysIgnore?.namespaces);
+  namespaceComplianceValidator(
+    capability,
+    webhook.config.admission?.alwaysIgnore?.namespaces,
+    false,
+  );
+  namespaceComplianceValidator(capability, webhook.config.watch?.alwaysIgnore?.namespaces, true);
+}

package/src/cli/deploy/imagePullSecret.ts

@@ -0,0 +1,68 @@
+import { ImagePullSecret } from "../../lib/types";
+import { sanitizeName } from "../init/utils";
+
+export interface ImagePullSecretDetails {
+  pullSecret?: string;
+  dockerServer?: string;
+  dockerUsername?: string;
+  dockerEmail?: string;
+  dockerPassword?: string;
+}
+
+export function validateImagePullSecretDetails(details: ImagePullSecretDetails): {
+  valid: boolean;
+  error?: string;
+} {
+  if (!details.pullSecret) {
+    return { valid: true };
+  }
+
+  // https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names
+  if (details.pullSecret !== sanitizeName(details.pullSecret)) {
+    return {
+      valid: false,
+      error: `Invalid --pullSecret. Must be valid name as defined in RFC 1123.`,
+    };
+  }
+
+  const missing: string[] = [];
+  if (!details.dockerEmail) {
+    missing.push("--docker-email");
+  }
+  if (!details.dockerServer) {
+    missing.push("--docker-server");
+  }
+  if (!details.dockerUsername) {
+    missing.push("--docker-username");
+  }
+  if (!details.dockerPassword) {
+    missing.push("--docker-password");
+  }
+
+  if (missing.length > 0) {
+    return {
+      valid: false,
+      error: `Error: Must provide ${missing.join(", ")} when providing --pull-secret`,
+    };
+  }
+
+  return { valid: true };
+}
+
+type ValidatedImagePullSecretDetails = Required<ImagePullSecretDetails>;
+
+export function generateImagePullSecret(details: ValidatedImagePullSecretDetails): ImagePullSecret {
+  const auth = Buffer.from(`${details.dockerUsername}:${details.dockerPassword}`).toString(
+    "base64",
+  );
+  return {
+    auths: {
+      [details.dockerServer]: {
+        username: details.dockerUsername,
+        password: details.dockerPassword,
+        email: details.dockerEmail,
+        auth,
+      },
+    },
+  };
+}

package/src/cli/deploy/index.ts

@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+
+import { Command } from "commander";
+import { deployImagePullSecret } from "../../lib/assets/deploy";
+import { validateImagePullSecretDetails, generateImagePullSecret } from "./imagePullSecret";
+import { getUserConfirmation } from "./userConfirmation";
+import { buildAndDeployModule } from "./buildAndDeploy";
+
+export default function (program: Command): void {
+  program
+    .command("deploy")
+    .description("Deploy a Pepr Module")
+    .option("-E, --docker-email <email>", "Email for Docker registry.")
+    .option("-P, --docker-password <password>", "Password for Docker registry.")
+    .option("-S, --docker-server <server>", "Docker server address.")
+    .option("-U, --docker-username <username>", "Docker registry username.")
+    .option("-f, --force", "Force deploy the module, override manager field.")
+    .option("-i, --image <image>", "Override the image tag.")
+    .option("-p, --pull-secret <name>", "Deploy imagePullSecret for Controller private registry.")
+    .option("-y, --yes", "Skip confirmation prompts.")
+    .action(async opts => {
+      const valResp = validateImagePullSecretDetails(opts);
+      if (!valResp.valid) {
+        console.error(valResp.error);
+        process.exit(1);
+      }
+
+      if (opts.pullSecret) {
+        await deployImagePullSecret(generateImagePullSecret(opts), opts.pullSecret);
+        return;
+      }
+
+      if (!(await getUserConfirmation(opts))) {
+        process.exit(0);
+      }
+
+      await buildAndDeployModule(opts.image, opts.force);
+    });
+}

package/src/cli/deploy/userConfirmation.ts

@@ -0,0 +1,16 @@
+import prompt from "prompts";
+
+export async function getUserConfirmation(opts: { yes: boolean }): Promise<boolean> {
+  if (opts.yes) {
+    return true;
+  }
+
+  // Prompt the user to confirm
+  const confirmation = await prompt({
+    type: "confirm",
+    name: "yes",
+    message: "This will remove and redeploy the module. Continue?",
+  });
+
+  return confirmation.yes ? true : false;
+}

package/dist/cli/deploy.d.ts

@@ -1,21 +0,0 @@
-import { CapabilityExport } from "../lib/types";
-import { Assets } from "../lib/assets/assets";
-import { Command } from "commander";
-interface ImagePullSecretDetails {
-    pullSecret?: string;
-    dockerServer?: string;
-    dockerUsername?: string;
-    dockerEmail?: string;
-    dockerPassword?: string;
-}
-export declare function validateImagePullSecretDetails(details: ImagePullSecretDetails): {
-    valid: boolean;
-    error?: string;
-};
-export declare function getUserConfirmation(opts: {
-    yes: boolean;
-}): Promise<boolean>;
-export default function (program: Command): void;
-export declare function validateNamespaces(capability: CapabilityExport, webhook: Assets): void;
-export {};
-//# sourceMappingURL=deploy.d.ts.map

package/dist/cli/deploy.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/cli/deploy.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAE9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AASpC,UAAU,sBAAsB;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,wBAAgB,8BAA8B,CAAC,OAAO,EAAE,sBAAsB,GAAG;IAC/E,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAmCA;AAoBD,wBAAsB,mBAAmB,CAAC,IAAI,EAAE;IAAE,GAAG,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAalF;AAkCD,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,OAAO,GAAG,IAAI,CA8B/C;AAED,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAQtF"}

package/src/cli/deploy.ts

@@ -1,170 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
-
-import prompt from "prompts";
-import { CapabilityExport } from "../lib/types";
-import { Assets } from "../lib/assets/assets";
-import { ImagePullSecret } from "../lib/types";
-import { Command } from "commander";
-import { buildModule } from "./build/buildModule";
-import { deployImagePullSecret, deployWebhook } from "../lib/assets/deploy";
-import { namespaceDeploymentsReady } from "../lib/deploymentChecks";
-import { sanitizeName } from "./init/utils";
-import { validateCapabilityNames } from "../lib/helpers";
-import { namespaceComplianceValidator } from "../lib/helpers";
-import { loadCapabilities } from "../lib/assets/loader";
-
-interface ImagePullSecretDetails {
-  pullSecret?: string;
-  dockerServer?: string;
-  dockerUsername?: string;
-  dockerEmail?: string;
-  dockerPassword?: string;
-}
-
-export function validateImagePullSecretDetails(details: ImagePullSecretDetails): {
-  valid: boolean;
-  error?: string;
-} {
-  if (!details.pullSecret) {
-    return { valid: true };
-  }
-
-  // https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names
-  if (details.pullSecret !== sanitizeName(details.pullSecret)) {
-    return {
-      valid: false,
-      error: `Invalid --pullSecret. Must be valid name as defined in RFC 1123.`,
-    };
-  }
-
-  const missing: string[] = [];
-  if (!details.dockerEmail) {
-    missing.push("--docker-email");
-  }
-  if (!details.dockerServer) {
-    missing.push("--docker-server");
-  }
-  if (!details.dockerUsername) {
-    missing.push("--docker-username");
-  }
-  if (!details.dockerPassword) {
-    missing.push("--docker-password");
-  }
-
-  if (missing.length > 0) {
-    return {
-      valid: false,
-      error: `Error: Must provide ${missing.join(", ")} when providing --pull-secret`,
-    };
-  }
-
-  return { valid: true };
-}
-
-type ValidatedImagePullSecretDetails = Required<ImagePullSecretDetails>;
-
-function generateImagePullSecret(details: ValidatedImagePullSecretDetails): ImagePullSecret {
-  const auth = Buffer.from(`${details.dockerUsername}:${details.dockerPassword}`).toString(
-    "base64",
-  );
-  return {
-    auths: {
-      [details.dockerServer]: {
-        username: details.dockerUsername,
-        password: details.dockerPassword,
-        email: details.dockerEmail,
-        auth,
-      },
-    },
-  };
-}
-
-export async function getUserConfirmation(opts: { yes: boolean }): Promise<boolean> {
-  if (opts.yes) {
-    return true;
-  }
-
-  // Prompt the user to confirm
-  const confirmation = await prompt({
-    type: "confirm",
-    name: "yes",
-    message: "This will remove and redeploy the module. Continue?",
-  });
-
-  return confirmation.yes ? true : false;
-}
-
-async function buildAndDeployModule(image: string, force: boolean): Promise<void> {
-  const builtModule = await buildModule("dist");
-  if (!builtModule) {
-    return;
-  }
-
-  // Generate a secret for the module
-  const webhook = new Assets(
-    { ...builtModule.cfg.pepr, description: builtModule.cfg.description },
-    builtModule.path,
-    [],
-  );
-  webhook.image = image ?? webhook.image;
-  const capabilities = await loadCapabilities(webhook.path);
-  for (const capability of capabilities) {
-    validateNamespaces(capability, webhook);
-  }
-  try {
-    await webhook.deploy(deployWebhook, force, builtModule.cfg.pepr.webhookTimeout ?? 10);
-
-    // wait for capabilities to be loaded and test names
-    validateCapabilityNames(webhook.capabilities);
-
-    // Wait for the pepr-system resources to be fully up
-    await namespaceDeploymentsReady();
-    console.info(`✅ Module deployed successfully`);
-  } catch (e) {
-    console.error(`Error deploying module:`, e);
-    process.exit(1);
-  }
-}
-
-export default function (program: Command): void {
-  program
-    .command("deploy")
-    .description("Deploy a Pepr Module")
-    .option("-E, --docker-email <email>", "Email for Docker registry.")
-    .option("-P, --docker-password <password>", "Password for Docker registry.")
-    .option("-S, --docker-server <server>", "Docker server address.")
-    .option("-U, --docker-username <username>", "Docker registry username.")
-    .option("-f, --force", "Force deploy the module, override manager field.")
-    .option("-i, --image <image>", "Override the image tag.")
-    .option("-p, --pull-secret <name>", "Deploy imagePullSecret for Controller private registry.")
-    .option("-y, --yes", "Skip confirmation prompts.")
-    .action(async opts => {
-      const valResp = validateImagePullSecretDetails(opts);
-      if (!valResp.valid) {
-        console.error(valResp.error);
-        process.exit(1);
-      }
-
-      if (opts.pullSecret) {
-        await deployImagePullSecret(generateImagePullSecret(opts), opts.pullSecret);
-        return;
-      }
-
-      if (!(await getUserConfirmation(opts))) {
-        process.exit(0);
-      }
-
-      await buildAndDeployModule(opts.image, opts.force);
-    });
-}
-
-export function validateNamespaces(capability: CapabilityExport, webhook: Assets): void {
-  namespaceComplianceValidator(capability, webhook.alwaysIgnore?.namespaces);
-  namespaceComplianceValidator(
-    capability,
-    webhook.config.admission?.alwaysIgnore?.namespaces,
-    false,
-  );
-  namespaceComplianceValidator(capability, webhook.config.watch?.alwaysIgnore?.namespaces, true);
-}