openk8s 1.0.1 → 1.0.3

package/README.md

@@ -12,7 +12,7 @@ openk8s is a keyboard-driven TUI for browsing and managing Kubernetes clusters,
 
 | Tool | Required | Notes |
 |------|----------|-------|
-| [kubectl](https://kubernetes.io/docs/tasks/tools/) | yes | Must be configured with a valid kubeconfig |
+| [kubectl](https://kubernetes.io/docs/tasks/tools/) | yes | >= 1.36.1, must be configured with a valid kubeconfig |
 | [helm](https://helm.sh/) | no | Enables HelmRelease management |
 | [bun](https://bun.sh/) | yes | Required at runtime to execute the app |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openk8s",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A terminal UI for Kubernetes",
   "license": "MIT",
   "type": "module",
@@ -32,7 +32,9 @@
   ],
   "scripts": {
     "dev": "bun run --watch src/index.tsx",
-    "prepare": "husky || exit 0"
+    "prepare": "husky || exit 0",
+    "test": "bun test",
+    "test:watch": "bun test --watch"
   },
   "release": {
     "branches": [
@@ -43,6 +45,7 @@
     "@commitlint/cli": "^21.0.1",
     "@commitlint/config-conventional": "^21.0.1",
     "@types/bun": "latest",
+    "@types/node": "^25.8.0",
     "@types/react": "^19.2.14",
     "husky": "^9.1.7",
     "semantic-release": "^25.0.3",

package/src/app/__tests__/app-state.test.ts

@@ -0,0 +1,376 @@
+import { describe, expect, test } from "bun:test";
+import { reducer, initialState, DEFAULT_NAMESPACE } from "../app-state";
+import type { AppAction } from "../app-actions";
+import type { AppState, ResourceListItem, ActivePortForward, Notification } from "../../lib/k8s/types";
+
+function reduce(action: AppAction, state?: Partial<AppState>): AppState {
+  return reducer({ ...initialState, ...state }, action);
+}
+
+describe("reducer", () => {
+  test("initial state is well-formed", () => {
+    expect(initialState.activePane).toBe("resources");
+    expect(initialState.overlay).toBeUndefined();
+    expect(initialState.activeNamespace).toBe(DEFAULT_NAMESPACE);
+    expect(initialState.selectedKind).toBe("pods");
+    expect(initialState.kubectlAvailable).toBe(true);
+  });
+
+  // ── Pane management ──────────────────────────────────────────────────────
+
+  describe("setActivePane", () => {
+    test("changes active pane", () => {
+      const state = reduce({ type: "setActivePane", pane: "inspector" });
+      expect(state.activePane).toBe("inspector");
+    });
+  });
+
+  describe("cyclePane", () => {
+    test("cycles forward", () => {
+      const state = reduce({ type: "cyclePane", direction: 1 });
+      expect(state.activePane).toBe("inspector");
+    });
+
+    test("cycles backward", () => {
+      const state = reduce({ type: "cyclePane", direction: -1 });
+      expect(state.activePane).toBe("clusters");
+    });
+
+    test("wraps around forward", () => {
+      const s1 = reduce({ type: "cyclePane", direction: 1 });
+      const s2 = reducer(s1, { type: "cyclePane", direction: 1 });
+      const s3 = reducer(s2, { type: "cyclePane", direction: 1 });
+      expect(s3.activePane).toBe("resources");
+    });
+  });
+
+  // ── Overlays ─────────────────────────────────────────────────────────────
+
+  describe("setOverlay", () => {
+    test("sets overlay", () => {
+      const state = reduce({ type: "setOverlay", overlay: "logs" });
+      expect(state.overlay).toBe("logs");
+    });
+
+    test("clears overlay", () => {
+      const state = reduce({ type: "setOverlay", overlay: undefined }, { overlay: "logs" as const });
+      expect(state.overlay).toBeUndefined();
+    });
+  });
+
+  // ── Contexts ─────────────────────────────────────────────────────────────
+
+  describe("setContexts", () => {
+    test("sets contexts and active context", () => {
+      const contexts = [{ name: "prod", isCurrent: true }];
+      const state = reduce({ type: "setContexts", contexts, activeContext: "prod" });
+      expect(state.contexts).toEqual(contexts);
+      expect(state.activeContext).toBe("prod");
+    });
+  });
+
+  describe("setActiveContext", () => {
+    test("changes active context", () => {
+      const state = reduce({ type: "setActiveContext", activeContext: "staging" });
+      expect(state.activeContext).toBe("staging");
+    });
+  });
+
+  // ── Namespaces ───────────────────────────────────────────────────────────
+
+  describe("setNamespaces", () => {
+    test("sets namespaces and active namespace", () => {
+      const namespaces = [{ name: "kube-system" }, { name: "default" }];
+      const state = reduce({ type: "setNamespaces", namespaces, activeNamespace: "kube-system" });
+      expect(state.namespaces).toEqual(namespaces);
+      expect(state.activeNamespace).toBe("kube-system");
+    });
+  });
+
+  describe("setActiveNamespace", () => {
+    test("changes namespace", () => {
+      const state = reduce({ type: "setActiveNamespace", namespace: "production" });
+      expect(state.activeNamespace).toBe("production");
+    });
+  });
+
+  // ── Resource kinds ───────────────────────────────────────────────────────
+
+  describe("setResourceKinds", () => {
+    test("sets kinds and selected kind", () => {
+      const kinds = [{ name: "pods", namespaced: true, shortNames: ["po"] }];
+      const state = reduce({ type: "setResourceKinds", resourceKinds: kinds, selectedKind: "pods" });
+      expect(state.resourceKinds).toEqual(kinds);
+      expect(state.selectedKind).toBe("pods");
+    });
+  });
+
+  describe("setSelectedKind", () => {
+    test("changes selected kind and clears filter", () => {
+      const state = reduce({ type: "setSelectedKind", kind: "services" }, { resourceFilter: "nginx" });
+      expect(state.selectedKind).toBe("services");
+      expect(state.resourceFilter).toBe("");
+    });
+  });
+
+  // ── Resources ────────────────────────────────────────────────────────────
+
+  describe("setResources", () => {
+    test("sets resources and selected name", () => {
+      const resources: ResourceListItem[] = [
+        { ref: { kind: "Pod", name: "nginx-1" }, status: "Running", age: "5m", summary: "nginx" },
+        { ref: { kind: "Pod", name: "nginx-2" }, status: "Running", age: "2m", summary: "nginx" },
+      ];
+      const state = reduce({ type: "setResources", resources, selectedResourceName: "nginx-1" });
+      expect(state.resources).toEqual(resources);
+      expect(state.selectedResourceName).toBe("nginx-1");
+    });
+  });
+
+  describe("toggleSelectedResource", () => {
+    test("adds to selection", () => {
+      const state = reduce({ type: "toggleSelectedResource", name: "pod-1" });
+      expect(state.selectedResourceNames).toEqual(["pod-1"]);
+    });
+
+    test("removes from selection", () => {
+      const state = reduce({ type: "toggleSelectedResource", name: "pod-1" }, { selectedResourceNames: ["pod-1", "pod-2"] });
+      expect(state.selectedResourceNames).toEqual(["pod-2"]);
+    });
+  });
+
+  describe("clearSelectedResources", () => {
+    test("clears all selections", () => {
+      const state = reduce({ type: "clearSelectedResources" }, { selectedResourceNames: ["pod-1", "pod-2"] });
+      expect(state.selectedResourceNames).toEqual([]);
+    });
+  });
+
+  // ── Filter ───────────────────────────────────────────────────────────────
+
+  describe("setResourceFilter", () => {
+    test("sets filter value", () => {
+      const state = reduce({ type: "setResourceFilter", value: "nginx" });
+      expect(state.resourceFilter).toBe("nginx");
+    });
+  });
+
+  // ── Selected resource name ───────────────────────────────────────────────
+
+  describe("setSelectedResourceName", () => {
+    test("sets selected resource name", () => {
+      const state = reduce({ type: "setSelectedResourceName", name: "web-1" });
+      expect(state.selectedResourceName).toBe("web-1");
+    });
+
+    test("clears selected resource name", () => {
+      const state = reduce({ type: "setSelectedResourceName", name: undefined });
+      expect(state.selectedResourceName).toBeUndefined();
+    });
+  });
+
+  // ── Detail ───────────────────────────────────────────────────────────────
+
+  describe("setSelectedResourceDetail", () => {
+    test("sets detail", () => {
+      const detail: any = { ref: { kind: "Pod", name: "test" }, summaryLines: [], summarySections: [], yaml: "" };
+      const state = reduce({ type: "setSelectedResourceDetail", detail });
+      expect(state.selectedResourceDetail).toBe(detail);
+    });
+
+    test("clears detail", () => {
+      const state = reduce({ type: "setSelectedResourceDetail", detail: undefined });
+      expect(state.selectedResourceDetail).toBeUndefined();
+    });
+  });
+
+  // ── Events ───────────────────────────────────────────────────────────────
+
+  describe("setEvents", () => {
+    test("sets events", () => {
+      const events = [{ type: "Normal", reason: "Pulled", message: "Pulled image", age: "1m", source: "kubelet" }];
+      const state = reduce({ type: "setEvents", events });
+      expect(state.events).toEqual(events);
+    });
+  });
+
+  // ── Reveal / Secret ──────────────────────────────────────────────────────
+
+  describe("toggleRevealDetailLine", () => {
+    test("adds id to revealed list", () => {
+      const state = reduce({ type: "toggleRevealDetailLine", id: "line-1" });
+      expect(state.revealedDetailLineIds).toEqual(["line-1"]);
+    });
+
+    test("removes id from revealed list", () => {
+      const state = reduce({ type: "toggleRevealDetailLine", id: "line-1" }, { revealedDetailLineIds: ["line-1"] });
+      expect(state.revealedDetailLineIds).toEqual([]);
+    });
+  });
+
+  describe("setRevealedSecretValue", () => {
+    test("sets revealed secret value", () => {
+      const state = reduce({ type: "setRevealedSecretValue", id: "secret-1", value: "password123" });
+      expect(state.revealedSecretValues["secret-1"]).toBe("password123");
+    });
+  });
+
+  // ── Port forwarding ──────────────────────────────────────────────────────
+
+  describe("addActivePortForward", () => {
+    test("adds a port forward entry", () => {
+      const forward: ActivePortForward = {
+        id: "pf-1", context: "prod", namespace: "default", namespaced: true,
+        ref: { kind: "Pod", name: "web" }, localPort: 8080, remotePort: 80, status: "starting",
+      };
+      const state = reduce({ type: "addActivePortForward", forward });
+      expect(state.activePortForwards).toHaveLength(1);
+      expect(state.activePortForwards[0]?.id).toBe("pf-1");
+    });
+  });
+
+  describe("updateActivePortForward", () => {
+    test("updates an existing forward", () => {
+      const forward: ActivePortForward = {
+        id: "pf-1", context: "prod", namespace: "default", namespaced: true,
+        ref: { kind: "Pod", name: "web" }, localPort: 8080, remotePort: 80, status: "starting",
+      };
+      const state = reduce({ type: "updateActivePortForward", id: "pf-1", patch: { status: "ready" } }, { activePortForwards: [forward] });
+      expect(state.activePortForwards[0]?.status).toBe("ready");
+    });
+  });
+
+  describe("removeActivePortForward", () => {
+    test("removes a port forward", () => {
+      const forward: ActivePortForward = {
+        id: "pf-1", context: "prod", namespace: "default", namespaced: true,
+        ref: { kind: "Pod", name: "web" }, localPort: 8080, remotePort: 80, status: "ready",
+      };
+      const state = reduce({ type: "removeActivePortForward", id: "pf-1" }, { activePortForwards: [forward] });
+      expect(state.activePortForwards).toHaveLength(0);
+    });
+  });
+
+  // ── Notifications ────────────────────────────────────────────────────────
+
+  describe("pushNotification", () => {
+    test("adds a notification", () => {
+      const notification: Notification = { id: "n-1", tone: "info", message: "Hello" };
+      const state = reduce({ type: "pushNotification", notification });
+      expect(state.notifications).toHaveLength(1);
+    });
+  });
+
+  describe("dismissNotification", () => {
+    test("removes a notification", () => {
+      const n1: Notification = { id: "n-1", tone: "info", message: "Hello" };
+      const n2: Notification = { id: "n-2", tone: "success", message: "Done" };
+      const state = reduce({ type: "dismissNotification", id: "n-1" }, { notifications: [n1, n2] });
+      expect(state.notifications).toHaveLength(1);
+      expect(state.notifications[0]?.id).toBe("n-2");
+    });
+  });
+
+  // ── Logs ─────────────────────────────────────────────────────────────────
+
+  describe("setLogsData", () => {
+    test("sets logs data", () => {
+      const state = reduce({ type: "setLogsData", logsTarget: "pod/web", logsText: "line 1", logsStatus: "ready" });
+      expect(state.logsTarget).toBe("pod/web");
+      expect(state.logsText).toBe("line 1");
+      expect(state.logsStatus).toBe("ready");
+    });
+  });
+
+  describe("setLogsContainer", () => {
+    test("sets container", () => {
+      const state = reduce({ type: "setLogsContainer", container: "nginx" });
+      expect(state.logsContainer).toBe("nginx");
+    });
+  });
+
+  describe("setLogsOptions", () => {
+    test("sets log options", () => {
+      const state = reduce({ type: "setLogsOptions", options: { tail: 50, previous: true } });
+      expect(state.logsOptions.tail).toBe(50);
+      expect(state.logsOptions.previous).toBe(true);
+    });
+  });
+
+  // ── Metrics ──────────────────────────────────────────────────────────────
+
+  describe("setPodMetrics", () => {
+    test("sets pod metrics", () => {
+      const metrics = { "pod-1": { cpu: "100m", memory: "256Mi" } };
+      const state = reduce({ type: "setPodMetrics", metrics });
+      expect(state.podMetrics).toEqual(metrics);
+    });
+  });
+
+  describe("setNodeMetrics", () => {
+    test("sets node metrics", () => {
+      const metrics = { "node-1": { cpu: "500m", memory: "1Gi", cpuPct: 25, memPct: 30 } };
+      const state = reduce({ type: "setNodeMetrics", metrics });
+      expect(state.nodeMetrics).toEqual(metrics);
+    });
+  });
+
+  // ── Misc ─────────────────────────────────────────────────────────────────
+
+  describe("setStatusMessage", () => {
+    test("sets status message", () => {
+      const state = reduce({ type: "setStatusMessage", message: "Connected" });
+      expect(state.statusMessage).toBe("Connected");
+    });
+  });
+
+  describe("setKubectlAvailable", () => {
+    test("sets availability", () => {
+      const state = reduce({ type: "setKubectlAvailable", available: false });
+      expect(state.kubectlAvailable).toBe(false);
+    });
+  });
+
+  describe("clearTransientViews", () => {
+    test("clears events, logs, reveals, and selections", () => {
+      const state = reduce(
+        { type: "clearTransientViews" },
+        {
+          events: [{ type: "Normal", reason: "test", message: "", age: "1m", source: "k" }],
+          eventsStatus: "ready",
+          logsTarget: "pod/web",
+          logsText: "output",
+          logsStatus: "ready",
+          logsContainer: "nginx",
+          revealedDetailLineIds: ["line-1"],
+          revealedSecretValues: { "line-1": "value" },
+          selectedResourceNames: ["pod-1"],
+        },
+      );
+      expect(state.events).toHaveLength(0);
+      expect(state.eventsStatus).toBe("idle");
+      expect(state.logsTarget).toBeUndefined();
+      expect(state.logsText).toBe("");
+      expect(state.logsStatus).toBe("idle");
+      expect(state.logsContainer).toBeUndefined();
+      expect(state.revealedDetailLineIds).toHaveLength(0);
+      expect(state.revealedSecretValues).toEqual({});
+      expect(state.selectedResourceNames).toHaveLength(0);
+    });
+  });
+
+  describe("setHelmRollbackRevision", () => {
+    test("sets the revision value", () => {
+      const state = reduce({ type: "setHelmRollbackRevision", value: "42" });
+      expect(state.helmRollbackRevision).toBe("42");
+    });
+  });
+
+  describe("default case", () => {
+    test("returns unchanged state for unknown action", () => {
+      const state = reduce({ type: "setStatusMessage", message: "hi" });
+      const result = reducer(state, { type: "unknown" } as any);
+      expect(result).toEqual(state);
+    });
+  });
+});

package/src/app/__tests__/components/inspector-tokens.test.ts

@@ -0,0 +1,101 @@
+import { describe, expect, test } from "bun:test";
+import { tokenizeYamlLine, tokenizeDescribeLine } from "../../components/inspector-tokens";
+import { YAML_COMMENT, YAML_KEY, TEXT_SUBTLE, YAML_VALUE } from "../../theme";
+
+describe("tokenizeYamlLine", () => {
+  test("empty line", () => {
+    const tokens = tokenizeYamlLine("");
+    expect(tokens[0]?.text).toBe(" ");
+  });
+
+  test("whitespace line", () => {
+    const tokens = tokenizeYamlLine("   ");
+    expect(tokens[0]?.text).toBe("   ");
+  });
+
+  test("comment line", () => {
+    const tokens = tokenizeYamlLine("# this is a comment");
+    expect(tokens).toHaveLength(1);
+    expect(tokens[0]?.fg).toBe(YAML_COMMENT);
+  });
+
+  test("key: value line", () => {
+    const tokens = tokenizeYamlLine("name: nginx");
+    expect(tokens).toHaveLength(4);
+    expect(tokens[0]?.text).toBe("");
+    expect(tokens[1]?.text).toBe("name");
+    expect(tokens[1]?.fg).toBe(YAML_KEY);
+    expect(tokens[3]?.text).toBe("nginx");
+    expect(tokens[3]?.fg).toBe(YAML_VALUE);
+  });
+
+  test("indented key: value", () => {
+    const tokens = tokenizeYamlLine("  name: nginx");
+    expect(tokens[0]?.text).toBe("  ");
+    expect(tokens[1]?.text).toBe("name");
+    expect(tokens[1]?.fg).toBe(YAML_KEY);
+  });
+
+  test("list item with value", () => {
+    const tokens = tokenizeYamlLine("- name: nginx");
+    expect(tokens[0]?.text).toBe("- ");
+    expect(tokens[1]?.text).toBe("name");
+    expect(tokens[1]?.fg).toBe(YAML_KEY);
+  });
+
+  test("bare list marker", () => {
+    const tokens = tokenizeYamlLine("-");
+    expect(tokens).toHaveLength(1);
+    expect(tokens[0]?.fg).toBe(TEXT_SUBTLE);
+  });
+
+  test("key only (ends with colon)", () => {
+    const tokens = tokenizeYamlLine("metadata:");
+    expect(tokens).toHaveLength(3);
+    expect(tokens[1]?.text).toBe("metadata");
+    expect(tokens[1]?.fg).toBe(YAML_KEY);
+    expect(tokens[2]?.text).toBe(":");
+  });
+
+  test("plain text fallthrough", () => {
+    const tokens = tokenizeYamlLine("some random text");
+    expect(tokens).toHaveLength(1);
+    expect(tokens[0]?.fg).toBe(TEXT_SUBTLE);
+  });
+});
+
+describe("tokenizeDescribeLine", () => {
+  test("empty line", () => {
+    const tokens = tokenizeDescribeLine("");
+    expect(tokens[0]?.text).toBe(" ");
+  });
+
+  test("section header", () => {
+    const tokens = tokenizeDescribeLine("Name: test-pod");
+    expect(tokens).toHaveLength(3);
+    expect(tokens[0]?.text).toBe("Name");
+    expect(tokens[0]?.fg).toBe(YAML_KEY);
+    expect(tokens[2]?.fg).toBe(YAML_VALUE);
+  });
+
+  test("indented key:  value (double space after colon)", () => {
+    const tokens = tokenizeDescribeLine("  Namespace:  default");
+    expect(tokens).toHaveLength(2);
+    expect(tokens[0]?.fg).toBe(TEXT_SUBTLE);
+    expect(tokens[1]?.fg).toBe(YAML_VALUE);
+  });
+
+  test("key: single value", () => {
+    const tokens = tokenizeDescribeLine("key:value");
+    expect(tokens).toHaveLength(3);
+    expect(tokens[0]?.fg).toBe(TEXT_SUBTLE);
+    expect(tokens[1]?.text).toBe(":");
+    expect(tokens[2]?.text).toBe("value");
+  });
+
+  test("plain text", () => {
+    const tokens = tokenizeDescribeLine("Some plain description text");
+    expect(tokens).toHaveLength(1);
+    expect(tokens[0]?.fg).toBe(TEXT_SUBTLE);
+  });
+});