feat: create a library of helper functions that make working with pepr easier

src/lib.ts

@@ -7,6 +7,7 @@ import { PeprModule } from "./lib/module";
 import { PeprMutateRequest } from "./lib/mutate-request";
 import * as PeprUtils from "./lib/utils";
 import { PeprValidateRequest } from "./lib/validate-request";
+import { containers } from "./lib/module-helpers";
 
 export {
   Capability,
@@ -22,4 +23,5 @@ export {
   fetch,
   fetchStatus,
   kind,
+  containers,
 };

src/lib/module-helpers.test.ts

@@ -0,0 +1,51 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+
+import { expect, test } from "@jest/globals";
+import { PeprValidateRequest } from "./validate-request";
+import { a } from "../lib";
+import { containers } from "./module-helpers";
+
+test("should return a list of containers in the pod", async () => {
+  const standardContainers = [
+    {
+      name: "container-1",
+    },
+  ];
+  const initContainers = [
+    {
+      name: "init-container-1",
+    },
+  ];
+  const ephemeralContainers = [
+    {
+      name: "ephemeral-container-1",
+    },
+  ];
+  const allContainers = [...standardContainers, ...initContainers, ...ephemeralContainers];
+  const peprValidationRequest = {
+    Raw: {
+      spec: {
+        containers: standardContainers,
+        initContainers,
+        ephemeralContainers,
+      },
+    },
+  } as PeprValidateRequest<a.Pod>;
+
+  let result = containers(peprValidationRequest);
+  expect(result).toEqual(expect.arrayContaining(allContainers));
+  expect(result).toHaveLength(allContainers.length);
+
+  result = containers(peprValidationRequest, "containers");
+  expect(result).toEqual(expect.arrayContaining(standardContainers));
+  expect(result).toHaveLength(standardContainers.length);
+
+  result = containers(peprValidationRequest, "initContainers");
+  expect(result).toEqual(expect.arrayContaining(initContainers));
+  expect(result).toHaveLength(initContainers.length);
+
+  result = containers(peprValidationRequest, "ephemeralContainers");
+  expect(result).toEqual(expect.arrayContaining(ephemeralContainers));
+  expect(result).toHaveLength(ephemeralContainers.length);
+});

src/lib/module-helpers.ts

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+
+import { PeprValidateRequest } from "./validate-request";
+import { a } from "../lib";
+
+// Returns all containers in the pod
+export function containers(
+  request: PeprValidateRequest<a.Pod>,
+  containerTypes?: "containers" | "initContainers" | "ephemeralContainers",
+) {
+  const containers = request.Raw.spec?.containers || [];
+  const initContainers = request.Raw.spec?.initContainers || [];
+  const ephemeralContainers = request.Raw.spec?.ephemeralContainers || [];
+
+  if (containerTypes === "containers") {
+    return containers;
+  }
+  if (containerTypes === "initContainers") {
+    return initContainers;
+  }
+  if (containerTypes === "ephemeralContainers") {
+    return ephemeralContainers;
+  }
+  return [...containers, ...initContainers, ...ephemeralContainers];
+}