pepr 0.36.0 → 0.37.1

package/package.json

@@ -13,7 +13,7 @@
     "/dist",
     "/src"
   ],
-  "version": "0.36.0",
+  "version": "0.37.1",
   "main": "dist/lib.js",
   "types": "dist/lib.d.ts",
   "scripts": {
@@ -21,28 +21,28 @@
     "gen-data-json": "node hack/build-template-data.js",
     "prebuild": "rm -fr dist/* && npm run gen-data-json",
     "version": "node scripts/set-version.js",
-    "build": "tsc && node build.mjs",
-    "build:image": "npm run build && docker buildx build --tag pepr:dev .",
+    "build": "tsc && node build.mjs && npm pack",
+    "build:image": "npm run build && docker buildx build --output type=docker --tag pepr:dev .",
     "test": "npm run test:unit && npm run test:journey",
     "test:unit": "npm run gen-data-json && jest src --coverage --detectOpenHandles --coverageDirectory=./coverage",
-    "test:journey": "npm run test:journey:k3d && npm run test:journey:build && npm run test:journey:image && npm run test:journey:run",
+    "test:journey": "npm run test:journey:k3d && npm run build && npm run test:journey:image && npm run test:journey:run",
     "test:journey:prep": "if [ ! -d ./pepr-upgrade-test ]; then git clone https://github.com/defenseunicorns/pepr-upgrade-test.git ; fi",
-    "test:journey-wasm": "npm run test:journey:k3d && npm run test:journey:build && npm run test:journey:image && npm run test:journey:run-wasm",
+    "test:journey-wasm": "npm run test:journey:k3d && npm run build && npm run test:journey:image && npm run test:journey:run-wasm",
     "test:journey:k3d": "k3d cluster delete pepr-dev && k3d cluster create pepr-dev --k3s-arg '--debug@server:0' --wait && kubectl rollout status deployment -n kube-system",
-    "test:journey:build": "npm run build && npm pack",
-    "test:journey:image": "docker buildx build --tag pepr:dev . && k3d image import pepr:dev -c pepr-dev",
+    "test:journey:image": "docker buildx build --output type=docker --tag pepr:dev . && k3d image import pepr:dev -c pepr-dev",
     "test:journey:run": "jest --detectOpenHandles journey/entrypoint.test.ts && npm run test:journey:prep && npm run test:journey:upgrade",
     "test:journey:run-wasm": "jest --detectOpenHandles journey/entrypoint-wasm.test.ts",
     "test:journey:upgrade": "npm run test:journey:k3d && npm run test:journey:image && jest --detectOpenHandles journey/pepr-upgrade.test.ts",
     "format:check": "eslint src && prettier src --check",
-    "format:fix": "eslint src --fix && prettier src --write"
+    "format:fix": "eslint src --fix && prettier src --write",
+    "prepare": "if [ \"$NODE_ENV\" != 'production' ]; then husky; fi"
   },
   "dependencies": {
     "@types/ramda": "0.30.2",
     "express": "4.21.0",
     "fast-json-patch": "3.1.1",
     "json-pointer": "^0.6.2",
-    "kubernetes-fluent-client": "3.0.3",
+    "kubernetes-fluent-client": "3.0.4",
     "pino": "9.4.0",
     "pino-pretty": "11.2.2",
     "prom-client": "15.1.3",
@@ -54,17 +54,17 @@
     "@fast-check/jest": "^2.0.1",
     "@jest/globals": "29.7.0",
     "@types/eslint": "9.6.1",
-    "@types/express": "4.17.21",
+    "@types/express": "5.0.0",
     "@types/json-pointer": "^1.0.34",
     "@types/node": "22.x.x",
     "@types/node-forge": "1.3.11",
-    "@types/prompts": "2.4.9",
     "@types/uuid": "10.0.0",
     "fast-check": "^3.19.0",
     "jest": "29.7.0",
     "js-yaml": "^4.1.0",
     "nock": "^13.5.4",
-    "ts-jest": "29.2.5"
+    "ts-jest": "29.2.5",
+    "husky": "^9.1.6"
   },
   "peerDependencies": {
     "@typescript-eslint/eslint-plugin": "7.18.0",
@@ -74,6 +74,7 @@
     "eslint": "8.57.0",
     "node-forge": "1.3.1",
     "prettier": "3.3.3",
+    "@types/prompts": "2.4.9",
     "prompts": "2.4.2",
     "typescript": "5.3.3",
     "uuid": "10.0.0"

package/src/cli/build.ts

@@ -139,7 +139,7 @@ export default function (program: RootCmd) {
 
       // If registry is set to Iron Bank, use Iron Bank image
       if (opts?.registry == "Iron Bank") {
-        console.warn(
+        console.info(
           `\n\tThis command assumes the latest release. Pepr's Iron Bank image release cycle is dictated by renovate and is typically released a few days after the GitHub release.\n\tAs an alternative you may consider custom --custom-image to target a specific image and version.`,
         );
         image = `registry1.dso.mil/ironbank/opensource/defenseunicorns/pepr/controller:v${cfg.pepr.peprVersion}`;
@@ -348,7 +348,7 @@ export async function buildModule(reloader?: Reloader, entryPoint = peprTS, embe
 
         // If the regex didn't match, leave a generic error
         if (conflicts.length < 1) {
-          console.warn(
+          console.info(
             `\n\tOne or more imported Pepr Capabilities seem to be using an incompatible version of Pepr.\n\tTry updating your Pepr Capabilities to their latest versions.`,
             "Version Conflict",
           );
@@ -356,7 +356,7 @@ export async function buildModule(reloader?: Reloader, entryPoint = peprTS, embe
 
         // Otherwise, loop through each conflicting package and print an error
         conflicts.forEach(match => {
-          console.warn(
+          console.info(
             `\n\tPackage '${match[1]}' seems to be incompatible with your current version of Pepr.\n\tTry updating to the latest version.`,
             "Version Conflict",
           );

package/src/cli/init/index.ts

@@ -20,29 +20,38 @@ import {
   tsConfig,
 } from "./templates";
 import { createDir, sanitizeName, write } from "./utils";
-import { confirm, walkthrough } from "./walkthrough";
+import { confirm, PromptOptions, walkthrough } from "./walkthrough";
+import { ErrorList, Errors } from "../../lib/errors";
 
 export default function (program: RootCmd) {
+  let response = {} as PromptOptions;
+  let pkgOverride = "";
   program
     .command("init")
     .description("Initialize a new Pepr Module")
-    // skip auto npm install and git init
-    .option("--skip-post-init", "Skip npm install, git init and VSCode launch")
-    .action(async opts => {
-      let pkgOverride = "";
-
-      // Overrides for testing. @todo: don't be so gross with Node CLI testing
+    .option("--confirm", "Skip verification prompt when creating a new module.")
+    .option("--description <string>", "Explain the purpose of the new module.")
+    .option("--name <string>", "Set the name of the new module.")
+    .option("--skip-post-init", "Skip npm install, git init, and VSCode launch.")
+    .option(`--errorBehavior <${ErrorList.join("|")}>`, "Set a errorBehavior.", Errors.reject)
+    .hook("preAction", async thisCommand => {
+      // TODO: Overrides for testing. Don't be so gross with Node CLI testing
+      // TODO: See pepr/#1140
       if (process.env.TEST_MODE === "true") {
         prompts.inject(["pepr-test-module", "A test module for Pepr", "ignore", "y"]);
         pkgOverride = "file:../pepr-0.0.0-development.tgz";
+        response = await walkthrough();
+      } else {
+        response = await walkthrough(thisCommand.opts());
+        Object.entries(response).map(([key, value]) => thisCommand.setOptionValue(key, value));
       }
-
-      const response = await walkthrough();
+    })
+    .action(async opts => {
       const dirName = sanitizeName(response.name);
       const packageJSON = genPkgJSON(response, pkgOverride);
       const peprTS = genPeprTS();
 
-      const confirmed = await confirm(dirName, packageJSON, peprTS.path);
+      const confirmed = await confirm(dirName, packageJSON, peprTS.path, opts.confirm);
 
       if (confirmed) {
         console.log("Creating new Pepr module...");
@@ -72,7 +81,7 @@ export default function (program: RootCmd) {
             });
 
             // setup git
-            execSync("git init", {
+            execSync("git init --initial-branch=main", {
               stdio: "inherit",
             });
 

package/src/cli/init/templates.ts

@@ -13,7 +13,7 @@ import peprSnippetsJSON from "../../templates/pepr.code-snippets.json";
 import settingsJSON from "../../templates/settings.json";
 import tsConfigJSON from "../../templates/tsconfig.module.json";
 import { sanitizeName } from "./utils";
-import { InitOptions } from "./walkthrough";
+import { InitOptions } from "../types";
 
 export const { dependencies, devDependencies, peerDependencies, scripts, version } = packageJSON;
 

package/src/cli/init/utils.test.ts

@@ -1,28 +1,19 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Pepr Authors
 
-import { expect, test } from "@jest/globals";
+import { expect, it } from "@jest/globals";
 
 import { sanitizeName } from "./utils";
 
-test("sanitizeName() sanitizes names correctly", () => {
-  const cases = [
-    {
-      input: "My Test Module",
-      expected: "my-test-module",
-    },
-    {
-      input: "!! 123 @@ Module",
-      expected: "123-module",
-    },
-    {
-      input: "---Test-Module---",
-      expected: "test-module",
-    },
-  ];
+it.each([
+  //Test sanitizeName() with ["$BAD_INPUT", "$SANITIZED_INPUT"]
+  ["My Test Module", "my-test-module"],
+  ["!! 123 @@ Module", "123-module"],
+  ["---Test-Module---", "test-module"],
+])("sanitizeName() sanitizes '%s' correctly", (input: string, expected: string) => {
+  expect(sanitizeName(input)).toBe(expected);
+});
 
-  for (const { input, expected } of cases) {
-    const result = sanitizeName(input);
-    expect(result).toBe(expected);
-  }
+it("sanitizeName() should throw TypeError when given a non-string", () => {
+  expect(() => sanitizeName({ input: 0 } as unknown as string)).toThrow(TypeError);
 });

package/src/cli/init/utils.ts

@@ -10,6 +10,11 @@ import { promises as fs } from "fs";
  * @returns the sanitized name
  */
 export function sanitizeName(name: string) {
+  if (typeof name !== "string") {
+    throw TypeError(
+      `sanitizeName() was called with a non-string value. The value is: ${name} of type ${typeof name}`,
+    );
+  }
   // Replace any characters outside of [^a-z0-9-] with "-"
   let sanitized = name.toLowerCase().replace(/[^a-z0-9-]+/gi, "-");
 

package/src/cli/init/walkthrough.test.ts

@@ -1,21 +1,102 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Pepr Authors
 
-import { expect, test } from "@jest/globals";
+import { describe, expect, it } from "@jest/globals";
 import prompts from "prompts";
+import {
+  walkthrough,
+  confirm,
+  PromptOptions,
+  PartialPromptOptions,
+  setName,
+  setErrorBehavior,
+} from "./walkthrough";
 
-import { walkthrough } from "./walkthrough";
+describe("when processing input", () => {
+  describe("walkthough() returns expected results", () => {
+    it.each([
+      //Test flag combinations with [["$FLAG", ...]]
+      [["description", "errorBehavior"]],
+      [["description"]],
+      [["errorBehavior"]],
+      [["name", "description", "errorBehavior"]],
+      [["name", "description"]],
+      [["name", "errorBehavior"]],
+      [["name"]],
+      [undefined],
+    ])(`when the set flags are: %s`, async (flagInput: string[] | undefined) => {
+      const expected: PromptOptions = {
+        name: "My Test Module",
+        description: "A test module for Pepr",
+        errorBehavior: "reject",
+      };
 
-test("walkthrough() returns expected results", async () => {
-  // Inject predefined answers for the prompts
-  prompts.inject(["My Test Module", "A test module for Pepr", 0]);
+      // Set values for the flag(s) under test by making a subset of (expected)
+      type SupportedFlagNames = keyof typeof expected;
+      type PartialTestInput = { [key in SupportedFlagNames]?: string };
+      const setFlags =
+        flagInput?.reduce((acc: PartialTestInput, key: string) => {
+          if (key in expected) {
+            acc[key as SupportedFlagNames] = expected[key as SupportedFlagNames];
+          }
+          return acc;
+        }, {} as PartialTestInput) || {};
 
-  const result = await walkthrough();
+      // Simulate user-input for unset flags by making a subset of (expected - setFlags)
+      const promptInput = flagInput
+        ? Object.entries(expected)
+            .filter(([key]) => !flagInput.includes(key))
+            .map(([, value]) => value)
+        : Object.values(expected);
+      prompts.inject(Object.values(promptInput));
 
-  // Check the returned object
-  expect(result).toEqual({
-    name: "My Test Module",
-    description: "A test module for Pepr",
-    errorBehavior: 0,
+      const result = await walkthrough(setFlags as PartialPromptOptions);
+
+      expect(result).toEqual(expected);
+    });
+
+    it("should prompt for input when given invalid input", async () => {
+      const expected = { name: "aaa" };
+      prompts.inject(["aaa"]);
+      const result = await setName("aa");
+      expect(result).toStrictEqual(expected);
+    });
+
+    it("should prompt for errorBehavior when given invalid input", async () => {
+      const expected = { errorBehavior: "audit" };
+      prompts.inject(["audit"]);
+      const result = await setErrorBehavior("not-valid" as "reject"); // Type-Coercion forces invalid input
+      expect(result).toStrictEqual(expected);
+    });
+  });
+
+  describe("confirm() handles input", () => {
+    it.each([
+      ["n", false],
+      ["no", false],
+      ["y", true],
+      ["yes", true],
+    ])("when prompt input is '%s'", async (userInput: string, expected: boolean) => {
+      prompts.inject([userInput]);
+      const result = await confirm(
+        "some string",
+        { path: "some path", print: "some print" },
+        "some Pepr TS path",
+      );
+      expect(result).toBe(expected);
+    });
+
+    it.each([[true], [false]])(
+      "when flag '--confirm' is %s",
+      async (confirmFlag: boolean | undefined) => {
+        const result = await confirm(
+          "some string",
+          { path: "some path", print: "some print" },
+          "some Pepr TS path",
+          confirmFlag,
+        );
+        expect(result).toBe(confirmFlag);
+      },
+    );
   });
 });

package/src/cli/init/walkthrough.ts

@@ -4,19 +4,34 @@
 import { promises as fs } from "fs";
 import prompt, { Answers, PromptObject } from "prompts";
 
-import { Errors } from "../../lib/errors";
+import { ErrorList, Errors } from "../../lib/errors";
 import { eslint, gitignore, prettier, readme, tsConfig } from "./templates";
 import { sanitizeName } from "./utils";
 
-export type InitOptions = Answers<"name" | "description" | "errorBehavior">;
+export type PromptOptions = {
+  name: string;
+  description: string;
+  errorBehavior: "audit" | "ignore" | "reject";
+};
 
-export function walkthrough(): Promise<InitOptions> {
+export type PartialPromptOptions = Partial<PromptOptions>;
+
+export async function walkthrough(opts?: PartialPromptOptions): Promise<PromptOptions> {
+  const result = {
+    ...(await setName(opts?.name)),
+    ...(await setDescription(opts?.description)),
+    ...(await setErrorBehavior(opts?.errorBehavior)),
+  };
+  return result as PromptOptions;
+}
+
+export async function setName(name?: string): Promise<Answers<string>> {
   const askName: PromptObject = {
     type: "text",
     name: "name",
     message:
       "Enter a name for the new Pepr module. This will create a new directory based on the name.\n",
-    validate: async val => {
+    validate: async (val: string) => {
       try {
         const name = sanitizeName(val);
         await fs.access(name, fs.constants.F_OK);
@@ -28,12 +43,36 @@ export function walkthrough(): Promise<InitOptions> {
     },
   };
 
+  if (name !== undefined) {
+    if (name.length < 3) {
+      console.error(`Module name must be at least 3 characters long. Received '${name}'`);
+      const response = prompt([askName]);
+      return response;
+    } else {
+      return { name };
+    }
+  }
+
+  return prompt([askName]);
+}
+
+async function setDescription(description?: string): Promise<Answers<string>> {
   const askDescription: PromptObject = {
     type: "text",
     name: "description",
     message: "(Recommended) Enter a description for the new Pepr module.\n",
   };
 
+  if (description !== undefined) {
+    return { description };
+  }
+
+  return prompt([askDescription]);
+}
+
+export async function setErrorBehavior(
+  errorBehavior?: "audit" | "ignore" | "reject",
+): Promise<Answers<string>> {
   const askErrorBehavior: PromptObject = {
     type: "select",
     name: "errorBehavior",
@@ -61,16 +100,28 @@ export function walkthrough(): Promise<InitOptions> {
     ],
   };
 
-  return prompt([askName, askDescription, askErrorBehavior]) as Promise<InitOptions>;
+  if (errorBehavior !== undefined) {
+    if (!ErrorList.includes(errorBehavior)) {
+      return prompt([askErrorBehavior]);
+    }
+    return { errorBehavior };
+  }
+
+  return prompt([askErrorBehavior]);
 }
 
 export async function confirm(
   dirName: string,
   packageJSON: { path: string; print: string },
   peprTSPath: string,
-) {
-  console.log(`
-  To be generated:
+  skipPrompt?: boolean,
+): Promise<boolean> {
+  const confirmationPrompt: PromptObject = {
+    type: "confirm",
+    name: "confirm",
+    message: "Create the new Pepr module?",
+  };
+  const confirmationMessage = `To be generated:
 
     \x1b[1m${dirName}\x1b[0m
     ├── \x1b[1m${eslint.path}\x1b[0m
@@ -84,13 +135,17 @@ ${packageJSON.print.replace(/^/gm, "    │   ")}
     ├── \x1b[1m${peprTSPath}\x1b[0m
     ├── \x1b[1m${readme.path}\x1b[0m
     └── \x1b[1m${tsConfig.path}\x1b[0m
-      `);
-
-  const confirm = await prompt({
-    type: "confirm",
-    name: "confirm",
-    message: "Create the new Pepr module?",
-  });
+  `;
 
-  return confirm.confirm;
+  if (skipPrompt !== undefined) {
+    return skipPrompt;
+  } else {
+    console.log(confirmationMessage);
+    const confirm = await prompt([confirmationPrompt]);
+    const shouldCreateModule =
+      confirm.confirm === "y" || confirm.confirm === "yes" || confirm.confirm === true
+        ? true
+        : false;
+    return shouldCreateModule;
+  }
 }

package/src/cli/monitor.ts

@@ -84,7 +84,7 @@ export default function (program: RootCmd) {
                 }
               }
             } catch {
-              console.warn(`\nIGNORED - Unable to parse line: ${line}.`);
+              // Do nothing
             }
           }
         }

package/src/cli/types.ts

@@ -0,0 +1,3 @@
+import { Answers } from "prompts";
+
+export type InitOptions = Answers<"name" | "description" | "errorBehavior">;

package/src/cli.ts

@@ -17,11 +17,13 @@ import update from "./cli/update";
 import kfc from "./cli/kfc";
 
 if (process.env.npm_lifecycle_event !== "npx") {
-  console.warn("Pepr should be run via `npx pepr <command>` instead of `pepr <command>`.");
+  console.info("Pepr should be run via `npx pepr <command>` instead of `pepr <command>`.");
 }
 
 const program = new RootCmd();
-
+if (!process.env.PEPR_NODE_WARNINGS) {
+  process.removeAllListeners("warning");
+}
 program
   .version(version)
   .description(`Pepr (v${version}) - Type safe K8s middleware for humans`)

package/src/fixtures/data/create-pod.json

@@ -13,7 +13,7 @@
   "subResource": "",
   "name": "podinfo",
   "namespace": "default",
-  "operation": "Create",
+  "operation": "CREATE",
   "userInfo": {
     "username": "system:serviceaccount:kube-system:replicaset-controller",
     "uid": "95c8f0ca-d31a-4d3f-9f27-9a2a2661ab3c",

package/src/fixtures/data/delete-pod.json

@@ -13,7 +13,7 @@
   "subResource": "",
   "name": "podinfo",
   "namespace": "default",
-  "operation": "Delete",
+  "operation": "DELETE",
   "userInfo": {
     "username": "system:serviceaccount:kube-system:replicaset-controller",
     "uid": "95c8f0ca-d31a-4d3f-9f27-9a2a2661ab3c",