kubernetes-fluent-client 3.0.3 → 3.0.5

package/dist/fluent/watch.spec.js

@@ -1,261 +0,0 @@
-"use strict";
-/* eslint-disable @typescript-eslint/no-explicit-any */
-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 nock_1 = __importDefault(require("nock"));
-const readable_stream_1 = require("readable-stream");
-const _1 = require(".");
-const __1 = require("..");
-const types_1 = require("./types");
-(0, globals_1.describe)("Watcher", () => {
-    const evtMock = globals_1.jest.fn();
-    const errMock = globals_1.jest.fn();
-    const setupAndStartWatcher = (eventType, handler) => {
-        watcher.events.on(eventType, handler);
-        watcher.start().catch(errMock);
-    };
-    let watcher;
-    (0, globals_1.beforeEach)(() => {
-        globals_1.jest.resetAllMocks();
-        (0, nock_1.default)("http://jest-test:8080")
-            .get("/api/v1/pods")
-            .reply(200, {
-            kind: "PodList",
-            apiVersion: "v1",
-            metadata: {
-                resourceVersion: "10",
-            },
-            items: [createMockPod(`pod-0`, `1`)],
-        });
-        (0, nock_1.default)("http://jest-test:8080")
-            .get("/api/v1/pods")
-            .query({ watch: "true", resourceVersion: "10" })
-            .reply(200, () => {
-            const stream = new readable_stream_1.PassThrough();
-            const resources = [
-                { type: "ADDED", object: createMockPod(`pod-0`, `1`) },
-                { type: "MODIFIED", object: createMockPod(`pod-0`, `2`) },
-            ];
-            resources.forEach(resource => {
-                stream.write(JSON.stringify(resource) + "\n");
-            });
-            stream.end();
-            return stream;
-        });
-    });
-    (0, globals_1.afterEach)(() => {
-        watcher.close();
-    });
-    (0, globals_1.it)("should watch named resources", done => {
-        nock_1.default.cleanAll();
-        (0, nock_1.default)("http://jest-test:8080")
-            .get("/api/v1/namespaces/tester/pods")
-            .query({ fieldSelector: "metadata.name=demo" })
-            .reply(200, createMockPod(`demo`, `15`));
-        (0, nock_1.default)("http://jest-test:8080")
-            .get("/api/v1/namespaces/tester/pods")
-            .query({
-            watch: "true",
-            fieldSelector: "metadata.name=demo",
-            resourceVersion: "15",
-        })
-            .reply(200);
-        watcher = (0, _1.K8s)(__1.kind.Pod, { name: "demo" }).InNamespace("tester").Watch(evtMock);
-        setupAndStartWatcher(__1.WatchEvent.CONNECT, () => {
-            done();
-        });
-    });
-    (0, globals_1.it)("should handle resource version is too old", done => {
-        nock_1.default.cleanAll();
-        (0, nock_1.default)("http://jest-test:8080")
-            .get("/api/v1/pods")
-            .reply(200, {
-            kind: "PodList",
-            apiVersion: "v1",
-            metadata: {
-                resourceVersion: "25",
-            },
-            items: [createMockPod(`pod-0`, `1`)],
-        });
-        (0, nock_1.default)("http://jest-test:8080")
-            .get("/api/v1/pods")
-            .query({ watch: "true", resourceVersion: "25" })
-            .reply(200, () => {
-            const stream = new readable_stream_1.PassThrough();
-            stream.write(JSON.stringify({
-                type: "ERROR",
-                object: {
-                    kind: "Status",
-                    apiVersion: "v1",
-                    metadata: {},
-                    status: "Failure",
-                    message: "too old resource version: 123 (391079)",
-                    reason: "Gone",
-                    code: 410,
-                },
-            }) + "\n");
-            stream.end();
-            return stream;
-        });
-        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock);
-        setupAndStartWatcher(__1.WatchEvent.OLD_RESOURCE_VERSION, res => {
-            (0, globals_1.expect)(res).toEqual("25");
-            done();
-        });
-    });
-    (0, globals_1.it)("should call the event handler for each event", done => {
-        watcher = (0, _1.K8s)(__1.kind.Pod).Watch((evt, phase) => {
-            (0, globals_1.expect)(evt.metadata?.name).toEqual(`pod-0`);
-            (0, globals_1.expect)(phase).toEqual(types_1.WatchPhase.Added);
-            done();
-        });
-        watcher.start().catch(errMock);
-    });
-    (0, globals_1.it)("should return the cache id", () => {
-        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
-            resyncDelaySec: 1,
-        });
-        (0, globals_1.expect)(watcher.getCacheID()).toEqual("d69b75a611");
-    });
-    (0, globals_1.it)("should handle the CONNECT event", done => {
-        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
-            resyncDelaySec: 1,
-        });
-        setupAndStartWatcher(__1.WatchEvent.CONNECT, () => {
-            done();
-        });
-    });
-    (0, globals_1.it)("should handle the DATA event", done => {
-        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
-            resyncDelaySec: 1,
-        });
-        setupAndStartWatcher(__1.WatchEvent.DATA, (pod, phase) => {
-            (0, globals_1.expect)(pod.metadata?.name).toEqual(`pod-0`);
-            (0, globals_1.expect)(phase).toEqual(types_1.WatchPhase.Added);
-            done();
-        });
-    });
-    (0, globals_1.it)("should handle the NETWORK_ERROR event", done => {
-        nock_1.default.cleanAll();
-        (0, nock_1.default)("http://jest-test:8080")
-            .get("/api/v1/pods")
-            .reply(200, {
-            kind: "PodList",
-            apiVersion: "v1",
-            metadata: {
-                resourceVersion: "45",
-            },
-            items: [createMockPod(`pod-0`, `1`)],
-        });
-        (0, nock_1.default)("http://jest-test:8080")
-            .get("/api/v1/pods")
-            .query({ watch: "true", resourceVersion: "45" })
-            .replyWithError("Something bad happened");
-        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
-            resyncDelaySec: 1,
-        });
-        setupAndStartWatcher(__1.WatchEvent.NETWORK_ERROR, error => {
-            (0, globals_1.expect)(error.message).toEqual("request to http://jest-test:8080/api/v1/pods?watch=true&resourceVersion=45 failed, reason: Something bad happened");
-            done();
-        });
-    });
-    (0, globals_1.it)("should handle the RECONNECT event on an error", done => {
-        nock_1.default.cleanAll();
-        (0, nock_1.default)("http://jest-test:8080")
-            .get("/api/v1/pods")
-            .reply(200, {
-            kind: "PodList",
-            apiVersion: "v1",
-            metadata: {
-                resourceVersion: "65",
-            },
-            items: [createMockPod(`pod-0`, `1`)],
-        });
-        (0, nock_1.default)("http://jest-test:8080")
-            .get("/api/v1/pods")
-            .query({ watch: "true", resourceVersion: "65" })
-            .replyWithError("Something bad happened");
-        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
-            resyncDelaySec: 0.01,
-        });
-        setupAndStartWatcher(__1.WatchEvent.RECONNECT, count => {
-            (0, globals_1.expect)(count).toEqual(1);
-            done();
-        });
-    });
-    (0, globals_1.it)("should perform a resync after the resync interval", done => {
-        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
-            resyncDelaySec: 0.01,
-            lastSeenLimitSeconds: 0.01,
-        });
-        setupAndStartWatcher(__1.WatchEvent.RECONNECT, count => {
-            (0, globals_1.expect)(count).toEqual(1);
-            done();
-        });
-    });
-    (0, globals_1.it)("should handle the GIVE_UP event", done => {
-        nock_1.default.cleanAll();
-        (0, nock_1.default)("http://jest-test:8080")
-            .get("/api/v1/pods")
-            .reply(200, {
-            kind: "PodList",
-            apiVersion: "v1",
-            metadata: {
-                resourceVersion: "75",
-            },
-            items: [createMockPod(`pod-0`, `1`)],
-        });
-        (0, nock_1.default)("http://jest-test:8080")
-            .get("/api/v1/pods")
-            .query({ watch: "true", resourceVersion: "75" })
-            .replyWithError("Something bad happened");
-        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
-            resyncFailureMax: 1,
-            resyncDelaySec: 0.01,
-            lastSeenLimitSeconds: 1,
-        });
-        setupAndStartWatcher(__1.WatchEvent.GIVE_UP, error => {
-            (0, globals_1.expect)(error.message).toContain("Retry limit (1) exceeded, giving up");
-            done();
-        });
-    });
-});
-/**
- * Creates a mock pod object
- *
- * @param name The name of the pod
- * @param resourceVersion The resource version of the pod
- * @returns A mock pod object
- */
-function createMockPod(name, resourceVersion) {
-    return {
-        kind: "Pod",
-        apiVersion: "v1",
-        metadata: {
-            name: name,
-            resourceVersion: resourceVersion,
-            uid: Math.random().toString(36).substring(7),
-            // ... other metadata fields
-        },
-        spec: {
-            containers: [
-                {
-                    name: "nginx",
-                    image: "nginx:1.14.2",
-                    ports: [
-                        {
-                            containerPort: 80,
-                            protocol: "TCP",
-                        },
-                    ],
-                },
-            ],
-        },
-        status: {
-        // ... pod status
-        },
-    };
-}

package/dist/generate.d.ts

@@ -1,24 +0,0 @@
-import { TargetLanguage } from "quicktype-core";
-import { LogFn } from "./types";
-export interface GenerateOptions {
-    /** The source URL, yaml file path or K8s CRD name */
-    source: string;
-    /** The output directory path */
-    directory?: string;
-    /** Disable kubernetes-fluent-client wrapping */
-    plain?: boolean;
-    /** The language to generate types in */
-    language?: string | TargetLanguage;
-    /** Override the NPM package to import when generating formatted Typescript */
-    npmPackage?: string;
-    /** Log function callback */
-    logFn: LogFn;
-}
-/**
- * Generate TypeScript types from a K8s CRD
- *
- * @param opts The options to use when generating
- * @returns A promise that resolves when the TypeScript types have been generated
- */
-export declare function generate(opts: GenerateOptions): Promise<Record<string, string[]>>;
-//# sourceMappingURL=generate.d.ts.map

package/dist/generate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAMA,OAAO,EAIL,cAAc,EAEf,MAAM,gBAAgB,CAAC;AAKxB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,MAAM,WAAW,eAAe;IAC9B,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gDAAgD;IAChD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;IACnC,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,KAAK,EAAE,KAAK,CAAC;CACd;AA0KD;;;;;GAKG;AACH,wBAAsB,QAAQ,CAAC,IAAI,EAAE,eAAe,qCA4BnD"}

package/dist/generate.js

@@ -1,195 +0,0 @@
-"use strict";
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = generate;
-const client_node_1 = require("@kubernetes/client-node");
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-const quicktype_core_1 = require("quicktype-core");
-const fetch_1 = require("./fetch");
-const fluent_1 = require("./fluent");
-const upstream_1 = require("./upstream");
-/**
- * Converts a CustomResourceDefinition to TypeScript types
- *
- * @param crd The CustomResourceDefinition to convert
- * @param opts The options to use when converting
- * @returns A promise that resolves when the CustomResourceDefinition has been converted
- */
-async function convertCRDtoTS(crd, opts) {
-    // Get the name of the kind
-    const name = crd.spec.names.kind;
-    const results = {};
-    for (const match of crd.spec.versions) {
-        const version = match.name;
-        // Get the schema from the matched version
-        const schema = JSON.stringify(match?.schema?.openAPIV3Schema);
-        // Create a new JSONSchemaInput
-        const schemaInput = new quicktype_core_1.JSONSchemaInput(new quicktype_core_1.FetchingJSONSchemaStore());
-        opts.logFn(`- Generating ${crd.spec.group}/${version} types for ${name}`);
-        // Add the schema to the input
-        await schemaInput.addSource({ name, schema });
-        // Create a new InputData object
-        const inputData = new quicktype_core_1.InputData();
-        inputData.addInput(schemaInput);
-        // If the language is not specified, default to TypeScript
-        if (!opts.language) {
-            opts.language = "ts";
-        }
-        // Generate the types
-        const out = await (0, quicktype_core_1.quicktype)({
-            inputData,
-            lang: opts.language,
-            rendererOptions: { "just-types": "true" },
-        });
-        let processedLines = out.lines;
-        // If using typescript, remove the line containing `[property: string]: any;`
-        if (opts.language === "ts" || opts.language === "typescript") {
-            processedLines = out.lines.filter(line => !line.includes("[property: string]: any;"));
-        }
-        // If the language is TypeScript and plain is not specified, wire up the fluent client
-        if (opts.language === "ts" && !opts.plain) {
-            if (!opts.npmPackage) {
-                opts.npmPackage = "kubernetes-fluent-client";
-            }
-            processedLines.unshift(
-            // Add warning that the file is auto-generated
-            `// This file is auto-generated by ${opts.npmPackage}, do not edit manually\n`, 
-            // Add the imports before any other lines
-            `import { GenericKind, RegisterKind } from "${opts.npmPackage}";\n`);
-            // Replace the interface with a named class that extends GenericKind
-            const entryIdx = processedLines.findIndex(line => line.includes(`export interface ${name} {`));
-            // Replace the interface with a named class that extends GenericKind
-            processedLines[entryIdx] = `export class ${name} extends GenericKind {`;
-            // Add the RegisterKind call
-            processedLines.push(`RegisterKind(${name}, {`);
-            processedLines.push(`  group: "${crd.spec.group}",`);
-            processedLines.push(`  version: "${version}",`);
-            processedLines.push(`  kind: "${name}",`);
-            processedLines.push(`  plural: "${crd.spec.names.plural}",`);
-            processedLines.push(`});`);
-        }
-        const finalContents = processedLines.join("\n");
-        const fileName = `${name.toLowerCase()}-${version.toLowerCase()}`;
-        // If an output file is specified, write the output to the file
-        if (opts.directory) {
-            // Create the directory if it doesn't exist
-            fs.mkdirSync(opts.directory, { recursive: true });
-            // Write the file
-            const filePath = path.join(opts.directory, `${fileName}.${opts.language}`);
-            fs.writeFileSync(filePath, finalContents);
-        }
-        // Add the results to the array
-        results[fileName] = processedLines;
-    }
-    return results;
-}
-/**
- * Reads a CustomResourceDefinition from a file, the cluster or the internet
- *
- * @param opts The options to use when reading
- * @returns A promise that resolves when the CustomResourceDefinition has been read
- */
-async function readOrFetchCrd(opts) {
-    const { source, logFn } = opts;
-    let filePath;
-    if (source[0] === "/") {
-        // If source is an absolute path
-        filePath = source;
-    }
-    else {
-        // If source is a relative path
-        filePath = path.join(process.cwd(), source);
-    }
-    // First try to read the source as a file
-    try {
-        if (fs.existsSync(filePath)) {
-            logFn(`Attempting to load ${source} as a local file`);
-            const payload = fs.readFileSync(filePath, "utf8");
-            return (0, client_node_1.loadAllYaml)(payload);
-        }
-    }
-    catch {
-        // Ignore errors
-    }
-    // Next try to parse the source as a URL
-    try {
-        const url = new URL(source);
-        // If the source is a URL, fetch it
-        if (url.protocol === "http:" || url.protocol === "https:") {
-            logFn(`Attempting to load ${source} as a URL`);
-            const { ok, data } = await (0, fetch_1.fetch)(source);
-            // If the request failed, throw an error
-            if (!ok) {
-                throw new Error(`Failed to fetch ${source}: ${data}`);
-            }
-            return (0, client_node_1.loadAllYaml)(data);
-        }
-    }
-    catch (e) {
-        // If invalid, ignore the error
-        if (e.code !== "ERR_INVALID_URL") {
-            throw new Error(`Error parsing URL ${source}`);
-        }
-    }
-    // Finally, if the source is not a file or URL, try to read it as a CustomResourceDefinition from the cluster
-    try {
-        logFn(`Attempting to read ${source} from the current Kubernetes context`);
-        return [await (0, fluent_1.K8s)(upstream_1.CustomResourceDefinition).Get(source)];
-    }
-    catch (e) {
-        throw new Error(`Failed to read ${source} as a file, url or K8s CRD: ${e.data?.message || "Cluster not available"}`);
-    }
-}
-/**
- * Generate TypeScript types from a K8s CRD
- *
- * @param opts The options to use when generating
- * @returns A promise that resolves when the TypeScript types have been generated
- */
-async function generate(opts) {
-    const crds = (await readOrFetchCrd(opts)).filter(crd => !!crd);
-    const results = {};
-    opts.logFn("");
-    for (const crd of crds) {
-        if (crd.kind !== "CustomResourceDefinition" || !crd.spec?.versions?.length) {
-            opts.logFn(`Skipping ${crd?.metadata?.name}, it does not appear to be a CRD`);
-            // Ignore empty and non-CRD objects
-            continue;
-        }
-        // Add the results to the record
-        const out = await convertCRDtoTS(crd, opts);
-        for (const key of Object.keys(out)) {
-            results[key] = out[key];
-        }
-    }
-    if (opts.directory) {
-        // Notify the user that the files have been generated
-        opts.logFn(`\n✅ Generated ${Object.keys(results).length} files in the ${opts.directory} directory`);
-    }
-    return results;
-}

package/dist/generate.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=generate.test.d.ts.map

package/dist/generate.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate.test.d.ts","sourceRoot":"","sources":["../src/generate.test.ts"],"names":[],"mappings":""}