kubernetes-fluent-client 1.5.1 → 1.6.1

package/dist/generate.test.js

@@ -0,0 +1,367 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const generate_1 = require("./generate");
+const fs_1 = __importDefault(require("fs"));
+const sampleYaml = `
+# non-crd should be ignored
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+  namespace: default
+data:
+  any: bleh
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: movies.example.com
+spec:
+  group: example.com
+  names:
+    kind: Movie
+    plural: movies
+  scope: Namespaced
+  versions:
+    - name: v1
+      schema:
+        openAPIV3Schema:
+          type: object
+          description: Movie nerd
+          properties:
+            spec:
+              properties:
+                title:
+                  type: string
+                author:
+                  type: string
+              type: object
+---
+# duplicate entries should not break things
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: movies.example.com
+spec:
+  group: example.com
+  names:
+    kind: Movie
+    plural: movies
+  scope: Namespaced
+  versions:
+    - name: v1
+      schema:
+        openAPIV3Schema:
+          type: object
+          description: Movie nerd
+          properties:
+            spec:
+              properties:
+                title:
+                  type: string
+                author:
+                  type: string
+              type: object
+---            
+# should support multiple versions
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: books.example.com
+spec:
+  group: example.com
+  names:
+    kind: Book
+    plural: books
+  scope: Namespaced
+  versions:
+    - name: v1
+      schema:
+        openAPIV3Schema:
+          type: object
+          description: Book nerd
+          properties:
+            spec:
+              properties:
+                title:
+                  type: string
+                author:
+                  type: string
+              type: object
+    - name: v2
+      schema:
+        openAPIV3Schema:
+          type: object
+          description: Book nerd
+          properties:
+            spec:
+              properties:
+                author:
+                  type: string
+              type: object
+      served: true
+      storage: true
+`;
+globals_1.jest.mock("./fetch", () => ({
+    fetch: globals_1.jest.fn(),
+}));
+globals_1.jest.mock("./fluent", () => ({
+    K8s: globals_1.jest.fn(),
+}));
+(0, globals_1.describe)("CRD Generate", () => {
+    const originalReadFileSync = fs_1.default.readFileSync;
+    globals_1.jest.spyOn(fs_1.default, "existsSync").mockReturnValue(true);
+    globals_1.jest.spyOn(fs_1.default, "readFileSync").mockImplementation((...args) => {
+        // Super janky hack due ot source-map-support calling readFileSync internally
+        if (args[0].toString().includes("test-crd.yaml")) {
+            return sampleYaml;
+        }
+        return originalReadFileSync(...args);
+    });
+    const mkdirSyncSpy = globals_1.jest.spyOn(fs_1.default, "mkdirSync").mockReturnValue(undefined);
+    const writeFileSyncSpy = globals_1.jest.spyOn(fs_1.default, "writeFileSync").mockReturnValue(undefined);
+    (0, globals_1.beforeEach)(() => {
+        globals_1.jest.clearAllMocks();
+    });
+    (0, globals_1.test)("converts CRD to TypeScript", async () => {
+        const options = { source: "test-crd.yaml", language: "ts", logFn: globals_1.jest.fn() };
+        const actual = await (0, generate_1.generate)(options);
+        const expectedMovie = [
+            "// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n",
+            'import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n',
+            "/**",
+            " * Movie nerd",
+            " */",
+            "export class Movie extends GenericKind {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+            "RegisterKind(Movie, {",
+            '  group: "example.com",',
+            '  version: "v1",',
+            '  kind: "Movie",',
+            "});",
+        ];
+        const expectedBookV1 = [
+            "// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n",
+            'import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n',
+            "/**",
+            " * Book nerd",
+            " */",
+            "export class Book extends GenericKind {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+            "RegisterKind(Book, {",
+            '  group: "example.com",',
+            '  version: "v1",',
+            '  kind: "Book",',
+            "});",
+        ];
+        const expectedBookV2 = expectedBookV1
+            .filter(line => !line.includes("title?"))
+            .map(line => line.replace("v1", "v2"));
+        (0, globals_1.expect)(actual["movie-v1"]).toEqual(expectedMovie);
+        (0, globals_1.expect)(actual["book-v1"]).toEqual(expectedBookV1);
+        (0, globals_1.expect)(actual["book-v2"]).toEqual(expectedBookV2);
+    });
+    (0, globals_1.test)("converts CRD to TypeScript with plain option", async () => {
+        const options = { source: "test-crd.yaml", language: "ts", plain: true, logFn: globals_1.jest.fn() };
+        const actual = await (0, generate_1.generate)(options);
+        const expectedMovie = [
+            "/**",
+            " * Movie nerd",
+            " */",
+            "export interface Movie {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+        ];
+        const expectedBookV1 = [
+            "/**",
+            " * Book nerd",
+            " */",
+            "export interface Book {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+        ];
+        const expectedBookV2 = expectedBookV1
+            .filter(line => !line.includes("title?"))
+            .map(line => line.replace("v1", "v2"));
+        (0, globals_1.expect)(actual["movie-v1"]).toEqual(expectedMovie);
+        (0, globals_1.expect)(actual["book-v1"]).toEqual(expectedBookV1);
+        (0, globals_1.expect)(actual["book-v2"]).toEqual(expectedBookV2);
+    });
+    (0, globals_1.test)("converts CRD to TypeScript with other options", async () => {
+        const options = {
+            source: "test-crd.yaml",
+            npmPackage: "test-package",
+            logFn: globals_1.jest.fn(),
+        };
+        const actual = await (0, generate_1.generate)(options);
+        const expectedMovie = [
+            "// This file is auto-generated by test-package, do not edit manually\n",
+            'import { GenericKind, RegisterKind } from "test-package";\n',
+            "/**",
+            " * Movie nerd",
+            " */",
+            "export class Movie extends GenericKind {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+            "RegisterKind(Movie, {",
+            '  group: "example.com",',
+            '  version: "v1",',
+            '  kind: "Movie",',
+            "});",
+        ];
+        const expectedBookV1 = [
+            "// This file is auto-generated by test-package, do not edit manually\n",
+            'import { GenericKind, RegisterKind } from "test-package";\n',
+            "/**",
+            " * Book nerd",
+            " */",
+            "export class Book extends GenericKind {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+            "RegisterKind(Book, {",
+            '  group: "example.com",',
+            '  version: "v1",',
+            '  kind: "Book",',
+            "});",
+        ];
+        const expectedBookV2 = expectedBookV1
+            .filter(line => !line.includes("title?"))
+            .map(line => line.replace("v1", "v2"));
+        (0, globals_1.expect)(actual["movie-v1"]).toEqual(expectedMovie);
+        (0, globals_1.expect)(actual["book-v1"]).toEqual(expectedBookV1);
+        (0, globals_1.expect)(actual["book-v2"]).toEqual(expectedBookV2);
+    });
+    (0, globals_1.test)("converts CRD to TypeScript and writes to the given directory", async () => {
+        const options = {
+            source: "test-crd.yaml",
+            directory: "test",
+            logFn: globals_1.jest.fn(),
+        };
+        await (0, generate_1.generate)(options);
+        const expectedMovie = [
+            "// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n",
+            'import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n',
+            "/**",
+            " * Movie nerd",
+            " */",
+            "export class Movie extends GenericKind {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+            "RegisterKind(Movie, {",
+            '  group: "example.com",',
+            '  version: "v1",',
+            '  kind: "Movie",',
+            "});",
+        ];
+        const expectedBookV1 = [
+            "// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n",
+            'import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n',
+            "/**",
+            " * Book nerd",
+            " */",
+            "export class Book extends GenericKind {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+            "RegisterKind(Book, {",
+            '  group: "example.com",',
+            '  version: "v1",',
+            '  kind: "Book",',
+            "});",
+        ];
+        const expectedBookV2 = expectedBookV1
+            .filter(line => !line.includes("title?"))
+            .map(line => line.replace("v1", "v2"));
+        (0, globals_1.expect)(mkdirSyncSpy).toHaveBeenCalledWith("test", { recursive: true });
+        (0, globals_1.expect)(writeFileSyncSpy).toHaveBeenCalledWith("test/movie-v1.ts", expectedMovie.join("\n"));
+        (0, globals_1.expect)(writeFileSyncSpy).toHaveBeenCalledWith("test/book-v1.ts", expectedBookV1.join("\n"));
+        (0, globals_1.expect)(writeFileSyncSpy).toHaveBeenCalledWith("test/book-v2.ts", expectedBookV2.join("\n"));
+    });
+    (0, globals_1.test)("converts CRD to Go", async () => {
+        const options = { source: "test-crd.yaml", language: "go", logFn: globals_1.jest.fn() };
+        const actual = await (0, generate_1.generate)(options);
+        const expectedMovie = [
+            "// Movie nerd",
+            "type Movie struct {",
+            '\tSpec *Spec `json:"spec,omitempty"`',
+            "}",
+            "",
+            "type Spec struct {",
+            '\tAuthor *string `json:"author,omitempty"`',
+            '\tTitle  *string `json:"title,omitempty"`',
+            "}",
+            "",
+        ];
+        const expectedBookV1 = [
+            "// Book nerd",
+            "type Book struct {",
+            '\tSpec *Spec `json:"spec,omitempty"`',
+            "}",
+            "",
+            "type Spec struct {",
+            '\tAuthor *string `json:"author,omitempty"`',
+            '\tTitle  *string `json:"title,omitempty"`',
+            "}",
+            "",
+        ];
+        const expectedBookV2 = expectedBookV1
+            .filter(line => !line.includes("Title"))
+            .map(line => line.replace("v1", "v2"));
+        (0, globals_1.expect)(actual["movie-v1"]).toEqual(expectedMovie);
+        (0, globals_1.expect)(actual["book-v1"]).toEqual(expectedBookV1);
+        (0, globals_1.expect)(actual["book-v2"]).toEqual(expectedBookV2);
+    });
+});

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export { fetch } from "./fetch";
 export { StatusCodes as fetchStatus } from "http-status-codes";
 export { K8s } from "./fluent";
 export { RegisterKind, modelToGroupVersionKind } from "./kinds";
+export { GenericKind } from "./types";
 export * from "./types";
 export * as K8sClientNode from "@kubernetes/client-node";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,oGAAoG;AACpG,OAAO,EAAE,IAAI,EAAE,CAAC;AAGhB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAGhC,OAAO,EAAE,WAAW,IAAI,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAG/D,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAG/B,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAEhE,cAAc,SAAS,CAAC;AAExB,OAAO,KAAK,aAAa,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,oGAAoG;AACpG,OAAO,EAAE,IAAI,EAAE,CAAC;AAGhB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAGhC,OAAO,EAAE,WAAW,IAAI,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAG/D,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAG/B,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAGhE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,cAAc,SAAS,CAAC;AAExB,OAAO,KAAK,aAAa,MAAM,yBAAyB,CAAC"}

package/dist/index.js

@@ -28,7 +28,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.K8sClientNode = exports.modelToGroupVersionKind = exports.RegisterKind = exports.K8s = exports.fetchStatus = exports.fetch = exports.kind = void 0;
+exports.K8sClientNode = exports.GenericKind = exports.modelToGroupVersionKind = exports.RegisterKind = exports.K8s = exports.fetchStatus = exports.fetch = exports.kind = void 0;
 // Export kinds as a single object
 const kind = __importStar(require("./upstream"));
 exports.kind = kind;
@@ -45,5 +45,8 @@ Object.defineProperty(exports, "K8s", { enumerable: true, get: function () { ret
 var kinds_1 = require("./kinds");
 Object.defineProperty(exports, "RegisterKind", { enumerable: true, get: function () { return kinds_1.RegisterKind; } });
 Object.defineProperty(exports, "modelToGroupVersionKind", { enumerable: true, get: function () { return kinds_1.modelToGroupVersionKind; } });
+// Export the GenericKind interface for CRD registration
+var types_1 = require("./types");
+Object.defineProperty(exports, "GenericKind", { enumerable: true, get: function () { return types_1.GenericKind; } });
 __exportStar(require("./types"), exports);
 exports.K8sClientNode = __importStar(require("@kubernetes/client-node"));

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "kubernetes-fluent-client",
-  "version": "1.5.1",
+  "version": "1.6.1",
   "description": "A @kubernetes/client-node fluent API wrapper that leverages K8s Server Side Apply",
+  "bin": "./dist/cli.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -39,18 +40,22 @@
     "fast-json-patch": "3.1.1",
     "http-status-codes": "2.3.0",
     "node-fetch": "2.7.0",
-    "type-fest": "4.3.3"
+    "quicktype-core": "23.0.76",
+    "type-fest": "4.4.0",
+    "yargs": "17.7.2"
   },
   "devDependencies": {
     "@commitlint/cli": "17.7.2",
     "@commitlint/config-conventional": "17.7.0",
     "@jest/globals": "29.7.0",
     "@types/byline": "4.2.34",
-    "@typescript-eslint/eslint-plugin": "6.7.4",
-    "@typescript-eslint/parser": "6.7.4",
+    "@types/readable-stream": "4.0.3",
+    "@types/yargs": "17.0.28",
+    "@typescript-eslint/eslint-plugin": "6.7.5",
+    "@typescript-eslint/parser": "6.7.5",
     "eslint-plugin-jsdoc": "46.8.2",
     "jest": "29.7.0",
-    "nock": "13.3.3",
+    "nock": "13.3.4",
     "prettier": "3.0.3",
     "semantic-release": "22.0.5",
     "ts-jest": "29.1.1",

package/src/cli.ts

@@ -0,0 +1,51 @@
+#!/usr/bin/env node
+
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
+
+import { hideBin } from "yargs/helpers";
+import yargs from "yargs/yargs";
+import { GenerateOptions, generate } from "./generate";
+
+void yargs(hideBin(process.argv))
+  .version(false)
+  .command(
+    "crd [source] [directory]",
+    "generate usable types from a K8s CRD",
+    yargs => {
+      return yargs
+        .positional("source", {
+          describe: "the yaml file path, remote url, or K8s CRD name",
+          type: "string",
+        })
+        .positional("directory", {
+          describe: "the directory to output the generated types to",
+          type: "string",
+        })
+        .option("plain", {
+          alias: "p",
+          type: "boolean",
+          description:
+            "generate plain types without binding to the fluent client, automatically enabled when an alternate language is specified",
+        })
+        .option("language", {
+          alias: "l",
+          type: "string",
+          default: "ts",
+          description:
+            "the language to generate types in, see https://github.com/glideapps/quicktype#target-languages for a list of supported languages",
+        })
+        .demandOption(["source", "directory"]);
+    },
+    async argv => {
+      const opts = argv as unknown as GenerateOptions;
+      opts.logFn = console.log;
+
+      try {
+        await generate(opts);
+      } catch (e) {
+        console.log(`\n❌ ${e.message}`);
+      }
+    },
+  )
+  .parse();

package/src/fetch.test.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { expect, test, beforeEach } from "@jest/globals";
 

package/src/fetch.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { StatusCodes } from "http-status-codes";
 import fetchRaw, { FetchError, RequestInfo, RequestInit } from "node-fetch";

package/src/fluent/apply.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 /**
  * Configuration for the apply function.

package/src/fluent/index.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node";
 import { Operation } from "fast-json-patch";

package/src/fluent/types.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node";
 import { Operation } from "fast-json-patch";

package/src/fluent/utils.test.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { beforeEach, describe, expect, it, jest } from "@jest/globals";
 

package/src/fluent/utils.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { KubeConfig, PatchStrategy } from "@kubernetes/client-node";
 

package/src/fluent/watch.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import byline from "byline";
 import fetch from "node-fetch";