pepr 0.3.0-rc0 → 0.3.0

package/docs/cli.md

@@ -1,58 +0,0 @@
-# Pepr CLI
-
-## `pepr init`
-
-Initialize a new Pepr Module.
-
-**Options:**
-
-- `-l, --log-level [level]` - Log level: debug, info, warn, error (default: "info")
-- `--skip-post-init` - Skip npm install, git init and VSCode launch
-
----
-
-## `pepr update`
-
-Update the current Pepr Module to the latest SDK version and update the global Pepr CLI to the same version.
-
-**Options:**
-
-- `-l, --log-level [level]` - Log level: debug, info, warn, error (default: "info")
-- `--skip-template-update` - Skip updating the template files
-
----
-
-## `pepr dev`
-
-Connect a local cluster to a local version of the Pepr Controller to do real-time debugging of your module. Note
-the `pepr dev` assumes a K3d cluster is running by default. If you are working with Kind or another docker-based
-K8s distro, you will need to pass the `--host host.docker.internal` option to `pepr dev`. If working with a remote
-cluster you will have to give Pepr a host path to your machine that is reachable from the K8s cluster.
-
-**Options:**
-
-- `-l, --log-level [level]` - Log level: debug, info, warn, error (default: "info")
-- `-h, --host [host]` - Host to listen on (default: "host.k3d.internal")
-- `--confirm` - Skip confirmation prompt
-
----
-
-## `pepr deploy`
-
-Deploy the current module into a Kubernetes cluster, useful for CI systems. Not recommended for production use.
-
-**Options:**
-
-- `-l, --log-level [level]` - Log level: debug, info, warn, error (default: "info")
-- `-i, --image [image]` - Override the image tag
-- `--confirm` - Skip confirmation prompt
-
----
-
-## `pepr build`
-
-Create a [zarf.yaml](https://zarf.dev) and K8s manifest for the current module. This includes everything needed to deploy Pepr and the current module into production environments.
-
-**Options:**
-
-- `-l, --log-level [level]` - Log level: debug, info, warn, error (default: "info")

package/docs/module.md

@@ -1,90 +0,0 @@
-# Pepr Module
-
-Each Pepr Module is it's own Typescript project, produced by [`pepr init`](./cli.md#pepr-init). Typically a module is maintained by a unique group or system. For example, a module for internal [Zarf](https://zarf.dev/) mutations would be different from a module for [Big Bang](https://p1.dso.mil/products/big-bang). An important idea with modules is that they are _wholly independent of one another_. This means that 2 different modules can be on completely different versions of Pepr and any other dependencies; their only interaction is through the standard K8s interfaces like any other webhook or controller.
-
-## Module development lifecycle
-
-1. **Create the module**:
-
-   Use [`pepr init`](./cli.md#pepr-init) to generate a new module.
-
-1. **Quickly validate system setup**:
-
-   Every new module includes a sample Pepr Capability called `HelloPepr`. By default,
-   this capability is deployed and monitoring the `pepr-demo` namespace. There is a sample
-   yaml also included you can use to see Pepr in your cluster. Here's the quick steps to do
-   that after `pepr init`:
-
-   ```bash
-   # cd to the newly-created Pepr module folder
-   cd my-module-name
-
-   # If you don't already have a local K8s cluster, you can set one up with k3d
-   npm run k3d-setup
-
-   # Launch pepr dev mode (npm start or pepr dev)
-   # If using another local K8s distro instead of k3d, use `pepr dev --host host.docker.internal`
-   pepr dev
-
-   # From another terminal, apply the sample yaml
-   kubectl apply -f capabilities/hello-pepr.samples.yaml
-
-   # Verify the configmaps were transformed using kubectl, k9s or another tool
-   ```
-
-1. **Create your custom Pepr Capabilities**
-
-   Now that you have confirmed Pepr is working, you can now create new [capabilities](./capabilities.md). You'll also want to disable the `HelloPepr` capability in your module (`pepr.ts`) before pushing to production. You can disable by commenting out or deleting the `HelloPepr` variable below:
-
-   ```typescript
-   new PeprModule(cfg, [
-     // Remove or comment the line below to disable the HelloPepr capability
-     HelloPepr,
-
-     // Your additional capabilities go here
-   ]);
-   ```
-
-   _Note: if you also delete the `capabilities/hello-pepr.ts` file, it will be added again on the next [`pepr update`](./cli.md#pepr-update) so you have the latest examples usages from the Pepr SDK. Therefore, it is sufficient to remove the entry from your `pepr.ts` module
-   config._
-
-1. **Build and deploy the Pepr Module**
-
-   Most of the time, you'll likely be iterating on a module with `perp dev` for real-time feedback and validation Once you are ready to move beyond the local dev environment, Pepr provides deployment and build tools you can use.
-
-   `pepr deploy` - you can use this command to build your module and deploy it into any K8s cluster your current `kubecontext` has access to. This setup is ideal for CI systems during testing, but is not recommended for production use. See [`pepr deploy`](./cli.md#pepr-deploy) for more info.
-
-## Advanced Module Configuration
-
-By default, when you run `pepr init`, the module is not configured with any additional options. Currently, there are 3 options you can configure:
-
-- `deferStart` - if set to `true`, the module will not start automatically. You will need to call `start()` manually. This is useful if you want to do some additional setup before the module controller starts. You can also use this to change the default port that the controller listens on.
-
-- `beforeHook` - an optional callback that will be called before every request is processed. This is useful if you want to do some additional logging or validation before the request is processed.
-
-- `afterHook` - an optional callback that will be called after every request is processed. This is useful if you want to do some additional logging or validation after the request is processed.
-
-You can configure each of these by modifying the `pepr.ts` file in your module. Here's an example of how you would configure each of these options:
-
-```typescript
-const module = new PeprModule(
-  cfg,
-  [
-    // Your capabilities go here
-  ],
-  {
-    deferStart: true,
-
-    beforeHook: req => {
-      // Any actions you want to perform before the request is processed, including modifying the request.
-    },
-
-    afterHook: res => {
-      // Any actions you want to perform after the request is processed, including modifying the response.
-    },
-  }
-);
-
-// Do any additional setup before starting the controller
-module.start();
-```

package/osv-scanner.toml

@@ -1,4 +0,0 @@
-# One entry for each vulnerability group
-[[IgnoredVulns]]
-id = "GHSA-p8p7-x288-28g6"
-reason = "Library only used client-side and not affected by this vulnerability."

package/src/lib/fetch.test.ts

@@ -1,115 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
-// fetch.test.ts
-
-import test from "ava";
-import { StatusCodes } from "http-status-codes";
-import nock from "nock";
-import { RequestInit } from "node-fetch";
-import { fetch } from "./fetch";
-
-test.beforeEach(() => {
-  nock("https://jsonplaceholder.typicode.com")
-    .get("/todos/1")
-    .reply(200, {
-      userId: 1,
-      id: 1,
-      title: "Example title",
-      completed: false,
-    })
-    .post("/todos", {
-      title: "test todo",
-      userId: 1,
-      completed: false,
-    })
-    .reply(200, (uri, requestBody) => requestBody)
-    .get("/todos/empty-null")
-    .reply(200, undefined)
-    .get("/todos/empty-string")
-    .reply(200, "")
-    .get("/todos/empty-object")
-    .reply(200, {})
-    .get("/todos/invalid")
-    .replyWithError("Something bad happened");
-});
-
-test("fetch: should return without type data", async t => {
-  const url = "https://jsonplaceholder.typicode.com/todos/1";
-  const { data, ok } = await fetch<{ title: string }>(url);
-  t.is(ok, true);
-  t.is(data["title"], "Example title");
-});
-
-test("fetch: should return parsed JSON response as a specific type", async t => {
-  interface Todo {
-    userId: number;
-    id: number;
-    title: string;
-    completed: boolean;
-  }
-
-  const url = "https://jsonplaceholder.typicode.com/todos/1";
-  const { data, ok } = await fetch<Todo>(url);
-  t.is(ok, true);
-  t.is(data.id, 1);
-  t.is(typeof data.title, "string");
-  t.is(typeof data.completed, "boolean");
-});
-
-test("fetch: should handle additional request options", async t => {
-  const url = "https://jsonplaceholder.typicode.com/todos";
-  const requestOptions: RequestInit = {
-    method: "POST",
-    body: JSON.stringify({
-      title: "test todo",
-      userId: 1,
-      completed: false,
-    }),
-    headers: {
-      "Content-type": "application/json; charset=UTF-8",
-    },
-  };
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const { data, ok } = await fetch<any>(url, requestOptions);
-  t.is(ok, true);
-  t.is(data["title"], "test todo");
-  t.is(data["userId"], 1);
-  t.is(data["completed"], false);
-});
-
-test("fetch: should handle empty (null) responses", async t => {
-  const url = "https://jsonplaceholder.typicode.com/todos/empty-null";
-  const resp = await fetch(url);
-
-  t.is(resp.data, "");
-  t.is(resp.ok, true);
-  t.is(resp.status, StatusCodes.OK);
-});
-
-test("fetch: should handle empty (string) responses", async t => {
-  const url = "https://jsonplaceholder.typicode.com/todos/empty-string";
-  const resp = await fetch(url);
-
-  t.is(resp.data, "");
-  t.is(resp.ok, true);
-  t.is(resp.status, StatusCodes.OK);
-});
-
-test("fetch: should handle empty (object) responses", async t => {
-  const url = "https://jsonplaceholder.typicode.com/todos/empty-object";
-  const resp = await fetch(url);
-
-  t.deepEqual(resp.data, {});
-  t.is(resp.ok, true);
-  t.is(resp.status, StatusCodes.OK);
-});
-
-test("fetch: should handle failed requests without throwing an error", async t => {
-  const url = "https://jsonplaceholder.typicode.com/todos/invalid";
-  const resp = await fetch(url);
-
-  t.is(resp.data, undefined);
-  t.is(resp.ok, false);
-  t.is(resp.status, StatusCodes.BAD_REQUEST);
-});

package/src/lib/filter.test.ts

@@ -1,231 +0,0 @@
-import test from "ava";
-import { POD1 } from "../../fixtures/loader";
-import { shouldSkipRequest } from "./filter";
-import { gvkMap } from "./k8s";
-
-const callback = () => undefined;
-
-test("should reject when name does not match", t => {
-  const binding = {
-    kind: gvkMap.V1Pod,
-    filters: {
-      name: "bleh",
-      namespaces: [],
-      labels: {},
-      annotations: {},
-    },
-    callback,
-  };
-  const pod = POD1();
-
-  t.true(shouldSkipRequest(binding, pod));
-});
-
-test("should reject when kind does not match", t => {
-  const binding = {
-    kind: gvkMap.V1ConfigMap,
-    filters: {
-      name: "",
-      namespaces: [],
-      labels: {},
-      annotations: {},
-    },
-    callback,
-  };
-  const pod = POD1();
-
-  t.true(shouldSkipRequest(binding, pod));
-});
-
-test("should reject when group does not match", t => {
-  const binding = {
-    kind: gvkMap.V1CronJob,
-    filters: {
-      name: "",
-      namespaces: [],
-      labels: {},
-      annotations: {},
-    },
-    callback,
-  };
-  const pod = POD1();
-
-  t.true(shouldSkipRequest(binding, pod));
-});
-
-test("should reject when version does not match", t => {
-  const binding = {
-    kind: {
-      group: "",
-      version: "v2",
-      kind: "Pod",
-    },
-    filters: {
-      name: "",
-      namespaces: [],
-      labels: {},
-      annotations: {},
-    },
-    callback,
-  };
-  const pod = POD1();
-
-  t.true(shouldSkipRequest(binding, pod));
-});
-
-test("should allow when group, version, and kind match", t => {
-  const binding = {
-    kind: gvkMap.V1Pod,
-    filters: {
-      name: "",
-      namespaces: [],
-      labels: {},
-      annotations: {},
-    },
-    callback,
-  };
-  const pod = POD1();
-
-  t.false(shouldSkipRequest(binding, pod));
-});
-
-test("should allow when kind match and others are empty", t => {
-  const binding = {
-    kind: {
-      group: "",
-      version: "",
-      kind: "Pod",
-    },
-    filters: {
-      name: "",
-      namespaces: [],
-      labels: {},
-      annotations: {},
-    },
-    callback,
-  };
-  const pod = POD1();
-
-  t.false(shouldSkipRequest(binding, pod));
-});
-
-test("should reject when namespace does not match", t => {
-  const binding = {
-    kind: gvkMap.V1Pod,
-    filters: {
-      name: "",
-      namespaces: ["bleh"],
-      labels: {},
-      annotations: {},
-    },
-    callback,
-  };
-  const pod = POD1();
-
-  t.true(shouldSkipRequest(binding, pod));
-});
-
-test("should allow when namespace is match", t => {
-  const binding = {
-    kind: gvkMap.V1Pod,
-    filters: {
-      name: "",
-      namespaces: ["default", "unicorn", "things"],
-      labels: {},
-      annotations: {},
-    },
-    callback,
-  };
-  const pod = POD1();
-
-  t.false(shouldSkipRequest(binding, pod));
-});
-
-test("should reject when label does not match", t => {
-  const binding = {
-    kind: gvkMap.V1Pod,
-    filters: {
-      name: "",
-      namespaces: [],
-      labels: {
-        foo: "bar",
-      },
-      annotations: {},
-    },
-    callback,
-  };
-  const pod = POD1();
-
-  t.true(shouldSkipRequest(binding, pod));
-});
-
-test("should allow when label is match", t => {
-  const binding = {
-    kind: gvkMap.V1Pod,
-    filters: {
-      name: "",
-
-      namespaces: [],
-      labels: {
-        foo: "bar",
-        test: "test1",
-      },
-      annotations: {},
-    },
-    callback,
-  };
-
-  const pod = POD1();
-  pod.object.metadata = pod.object.metadata || {};
-  pod.object.metadata.labels = {
-    foo: "bar",
-    test: "test1",
-    test2: "test2",
-  };
-
-  t.false(shouldSkipRequest(binding, pod));
-});
-
-test("should reject when annotation does not match", t => {
-  const binding = {
-    kind: gvkMap.V1Pod,
-    filters: {
-      name: "",
-      namespaces: [],
-      labels: {},
-      annotations: {
-        foo: "bar",
-      },
-    },
-    callback,
-  };
-  const pod = POD1();
-
-  t.true(shouldSkipRequest(binding, pod));
-});
-
-test("should allow when annotation is match", t => {
-  const binding = {
-    kind: gvkMap.V1Pod,
-    filters: {
-      name: "",
-      namespaces: [],
-      labels: {},
-      annotations: {
-        foo: "bar",
-        test: "test1",
-      },
-    },
-    callback,
-  };
-
-  const pod = POD1();
-  pod.object.metadata = pod.object.metadata || {};
-  pod.object.metadata.annotations = {
-    foo: "bar",
-    test: "test1",
-    test2: "test2",
-  };
-
-  t.false(shouldSkipRequest(binding, pod));
-});