k6ctl 0.1.0

package/README.md

@@ -0,0 +1,45 @@
+# k6ctl
+
+A CLI tool to simplify running k6 tests on Kubernetes using the k6-operator.
+
+## Overview
+
+`k6ctl` eliminates the need to manually run `kubectl` commands to create ConfigMaps, apply TestRun manifests, and manage k6 tests in Kubernetes. Instead, you configure your test settings once and run tests with a simple command.
+
+## Installation
+
+```bash
+npm install -g k6ctl
+```
+
+Or use it directly with npx:
+
+```bash
+npx k6ctl run path/to/test.js
+```
+
+## Configuration
+
+Create a `k6ctl.config.js` file in the root of your k6 scripts project:
+
+## Usage
+
+Run a k6 test:
+
+```bash
+k6ctl run large-test-1.js
+```
+
+### Options
+
+### Additional Commands
+
+## Requirements
+
+- Node.js >= 18.0.0
+- kubectl configured with access to your Kubernetes cluster
+- k6-operator installed in your cluster
+
+## License
+
+MIT

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

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

package/dist/cli.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const run_1 = require("./commands/run");
+const program = new commander_1.Command();
+program
+    .name('k6ctl')
+    .description('CLI tool to run k6 tests on Kubernetes using k6-operator')
+    .version('0.1.0');
+program
+    .command('run <script>')
+    .description('Run a k6 test script')
+    .option('-c, --config <path>', 'Path to config file', 'k6ctl.config.js')
+    .option('-n, --namespace <namespace>', 'Kubernetes namespace')
+    .option('-p, --parallelism <number>', 'Number of parallel test pods')
+    .action(run_1.runTest);
+program.parse();
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;AAEA,yCAAoC;AACpC,wCAAyC;AAEzC,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,OAAO,CAAC;KACb,WAAW,CAAC,0DAA0D,CAAC;KACvE,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB,OAAO;KACJ,OAAO,CAAC,cAAc,CAAC;KACvB,WAAW,CAAC,sBAAsB,CAAC;KACnC,MAAM,CAAC,qBAAqB,EAAE,qBAAqB,EAAE,iBAAiB,CAAC;KACvE,MAAM,CAAC,6BAA6B,EAAE,sBAAsB,CAAC;KAC7D,MAAM,CAAC,4BAA4B,EAAE,8BAA8B,CAAC;KACpE,MAAM,CAAC,aAAO,CAAC,CAAC;AAEnB,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/dist/commands/run.d.ts

@@ -0,0 +1,8 @@
+interface RunOptions {
+    config: string;
+    namespace?: string;
+    parallelism?: number;
+}
+export declare function runTest(scriptPath: string, options: RunOptions): Promise<void>;
+export {};
+//# sourceMappingURL=run.d.ts.map

package/dist/commands/run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/commands/run.ts"],"names":[],"mappings":"AAAA,UAAU,UAAU;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,wBAAsB,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,iBAGpE"}

package/dist/commands/run.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runTest = runTest;
+async function runTest(scriptPath, options) {
+    console.log(`Running k6 test: ${scriptPath}`);
+    console.log(`Using config: ${JSON.stringify(options.config, null, 2)}`);
+}
+//# sourceMappingURL=run.js.map

package/dist/commands/run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../src/commands/run.ts"],"names":[],"mappings":";;AAMA,0BAGC;AAHM,KAAK,UAAU,OAAO,CAAC,UAAkB,EAAE,OAAmB;IACnE,OAAO,CAAC,GAAG,CAAC,oBAAoB,UAAU,EAAE,CAAC,CAAC;IAC9C,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAC1E,CAAC"}

package/dist/types/config.types.d.ts

@@ -0,0 +1,30 @@
+export interface K6Config {
+    namespace?: string;
+    parallelism?: number;
+    arguments?: string[];
+    cleanup?: boolean;
+    quiet?: boolean;
+    separate?: boolean;
+    runner: {
+        image?: string;
+        resources?: {
+            limits: {
+                cpu: string;
+                memory: string;
+            };
+            requests: {
+                cpu: string;
+                memory: string;
+            };
+        };
+        env?: Array<{
+            name: string;
+            value: string;
+        }>;
+    };
+    prometheus?: {
+        serverUrl: string;
+        trendStats?: string[];
+    };
+}
+//# sourceMappingURL=config.types.d.ts.map

package/dist/types/config.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.types.d.ts","sourceRoot":"","sources":["../../src/types/config.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAQ;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE;QACN,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,CAAC,EAAE;YACV,MAAM,EAAE;gBACN,GAAG,EAAE,MAAM,CAAC;gBACZ,MAAM,EAAE,MAAM,CAAC;aAChB,CAAC;YACF,QAAQ,EAAE;gBACR,GAAG,EAAE,MAAM,CAAC;gBACZ,MAAM,EAAE,MAAM,CAAC;aAChB,CAAC;SACH,CAAC;QACF,GAAG,CAAC,EAAE,KAAK,CAAC;YACV,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;SACf,CAAC,CAAC;KACJ,CAAA;IACD,UAAU,CAAC,EAAE;QACX,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;KACvB,CAAA;CACF"}

package/dist/types/config.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=config.types.js.map

package/dist/types/config.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.types.js","sourceRoot":"","sources":["../../src/types/config.types.ts"],"names":[],"mappings":""}

package/dist/types/testRunManifest.types.d.ts

@@ -0,0 +1,43 @@
+export interface TestRunManifest {
+    apiVersion: string;
+    kind: string;
+    metadata: {
+        name: string;
+        namespace: string;
+    };
+    spec: {
+        parallelism?: number;
+        arguments?: string;
+        quiet?: boolean;
+        cleanup?: boolean;
+        separate?: boolean;
+        runner?: {
+            image?: string;
+            env?: Array<{
+                name: string;
+                value: string;
+            }>;
+            resources?: {
+                limits: {
+                    cpu: string;
+                    memory: string;
+                };
+                requests: {
+                    cpu: string;
+                    memory: string;
+                };
+            };
+        };
+        script: {
+            configMap?: {
+                name: string;
+                file: string;
+            };
+            volumeClaim?: {
+                name: string;
+                file: string;
+            };
+        };
+    };
+}
+//# sourceMappingURL=testRunManifest.types.d.ts.map

package/dist/types/testRunManifest.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testRunManifest.types.d.ts","sourceRoot":"","sources":["../../src/types/testRunManifest.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,IAAI,EAAE;QACJ,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,MAAM,CAAC,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,GAAG,CAAC,EAAE,KAAK,CAAC;gBACV,IAAI,EAAE,MAAM,CAAC;gBACb,KAAK,EAAE,MAAM,CAAC;aACf,CAAC,CAAC;YACH,SAAS,CAAC,EAAE;gBACV,MAAM,EAAE;oBACN,GAAG,EAAE,MAAM,CAAA;oBACX,MAAM,EAAE,MAAM,CAAA;iBACf,CAAA;gBACD,QAAQ,EAAE;oBACR,GAAG,EAAE,MAAM,CAAA;oBACX,MAAM,EAAE,MAAM,CAAA;iBACf,CAAA;aACF,CAAA;SACF,CAAC;QACF,MAAM,EAAE;YACN,SAAS,CAAC,EAAE;gBACV,IAAI,EAAE,MAAM,CAAC;gBACb,IAAI,EAAE,MAAM,CAAC;aACd,CAAC;YACF,WAAW,CAAC,EAAE;gBACZ,IAAI,EAAE,MAAM,CAAC;gBACb,IAAI,EAAE,MAAM,CAAC;aACd,CAAA;SACF,CAAC;KACH,CAAC;CACH"}

package/dist/types/testRunManifest.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=testRunManifest.types.js.map

package/dist/types/testRunManifest.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testRunManifest.types.js","sourceRoot":"","sources":["../../src/types/testRunManifest.types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "k6ctl",
+  "version": "0.1.0",
+  "description": "CLI tool to run k6 tests on Kubernetes using k6-operator",
+  "main": "dist/index.js",
+  "bin": {
+    "k6ctl": "dist/cli.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "k6",
+    "kubernetes",
+    "k6-operator",
+    "load-testing",
+    "performance-testing",
+    "cli"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@kubernetes/client-node": "^1.4.0",
+    "commander": "^14.0.3",
+    "js-yaml": "^4.1.1"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^25.2.3",
+    "typescript": "^5.9.3"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/src/cli.ts

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+
+import { Command } from 'commander';
+import { runTest } from './commands/run';
+
+const program = new Command();
+
+program
+  .name('k6ctl')
+  .description('CLI tool to run k6 tests on Kubernetes using k6-operator')
+  .version('0.1.0');
+
+program
+  .command('run <script>')
+  .description('Run a k6 test script')
+  .option('-c, --config <path>', 'Path to config file', 'k6ctl.config.js')
+  .option('-n, --namespace <namespace>', 'Kubernetes namespace')
+  .option('-p, --parallelism <number>', 'Number of parallel test pods')
+  .action(runTest);
+
+program.parse();

package/src/commands/run.ts

@@ -0,0 +1,10 @@
+interface RunOptions {
+  config: string;
+  namespace?: string;
+  parallelism?: number;
+}
+
+export async function runTest(scriptPath: string, options: RunOptions) {
+  console.log(`Running k6 test: ${scriptPath}`);
+  console.log(`Using config: ${JSON.stringify(options.config, null, 2)}`);
+}

package/src/types/config.types.ts

@@ -0,0 +1,29 @@
+export interface K6Config {
+  namespace?: string;
+  parallelism?: number;
+  arguments?: string[];
+  cleanup?: boolean;
+  quiet?: boolean;
+  separate?: boolean;
+  runner: {
+    image?: string;
+    resources?: {
+      limits: {
+        cpu: string;
+        memory: string;
+      };
+      requests: {
+        cpu: string;
+        memory: string;
+      };
+    };
+    env?: Array<{
+      name: string;
+      value: string;
+    }>;
+  }
+  prometheus?: {
+    serverUrl: string;
+    trendStats?: string[];
+  }
+}

package/src/types/testRunManifest.types.ts

@@ -0,0 +1,42 @@
+export interface TestRunManifest {
+  apiVersion: string;
+  kind: string;
+  metadata: {
+    name: string;
+    namespace: string;
+  };
+  spec: {
+    parallelism?: number;
+    arguments?: string;
+    quiet?: boolean;
+    cleanup?: boolean;
+    separate?: boolean;
+    runner?: {
+      image?: string;
+      env?: Array<{
+        name: string;
+        value: string;
+      }>;
+      resources?: {
+        limits: {
+          cpu: string
+          memory: string
+        }
+        requests: {
+          cpu: string
+          memory: string
+        }
+      }
+    };
+    script: {
+      configMap?: {
+        name: string;
+        file: string;
+      };
+      volumeClaim?: {
+        name: string;
+        file: string;
+      }
+    };
+  };
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "commonjs",
+    "lib": ["ES2022"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}