@skyramp/skyramp 0.5.1 → 0.5.3

package/lib/dev-darwin-amd64.h

@@ -54,6 +54,11 @@ struct response_wrapper {
 	    char *error;
 	};
 
+	struct tester_generate_info {
+	    char *generated_files;
+	    char *error;
+	};
+
 #line 1 "cgo-generated-wrapper"
 
 
@@ -152,6 +157,7 @@ extern char* writeTestDescriptionWrapper(char* testDescription, char* testName);
 extern char* applyMockDescriptionWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* mockDescription, char* mockPath, char* projectPath);
 extern char* buildRequestsWrapper(char* mockDescription);
 extern struct tester_info runTesterStartWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testDescription, GoUint8 generateResult);
+extern struct tester_generate_info runTesterGenerateRestWrapper(char* protocol, char* apiSchemaPath, char* alias, char* endpointPath, char* language, char* tag, char* sampleRequestPath, char* projectPath, GoInt port, GoUint8 generateRobot, GoUint8 functionalScenario, GoUint8 negativeScenario);
 extern struct tester_info runTesterStartWrapperWithGlobalHeaders(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testDescription, char* testFileName, char* testName, char* globalJsonHeaders, GoUint8 generateResult, char* projectPath, char* overrideFile, char* overrideDict);
 extern char* runTesterStatusWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testerId, GoUint8 isFormattingEnabled);
 extern char* getJsonValue(char* jsonString, char* jsonPath);

package/lib/dev-darwin-arm64.h

@@ -54,6 +54,11 @@ struct response_wrapper {
 	    char *error;
 	};
 
+	struct tester_generate_info {
+	    char *generated_files;
+	    char *error;
+	};
+
 #line 1 "cgo-generated-wrapper"
 
 
@@ -152,6 +157,7 @@ extern char* writeTestDescriptionWrapper(char* testDescription, char* testName);
 extern char* applyMockDescriptionWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* mockDescription, char* mockPath, char* projectPath);
 extern char* buildRequestsWrapper(char* mockDescription);
 extern struct tester_info runTesterStartWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testDescription, GoUint8 generateResult);
+extern struct tester_generate_info runTesterGenerateRestWrapper(char* protocol, char* apiSchemaPath, char* alias, char* endpointPath, char* language, char* tag, char* sampleRequestPath, char* projectPath, GoInt port, GoUint8 generateRobot, GoUint8 functionalScenario, GoUint8 negativeScenario);
 extern struct tester_info runTesterStartWrapperWithGlobalHeaders(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testDescription, char* testFileName, char* testName, char* globalJsonHeaders, GoUint8 generateResult, char* projectPath, char* overrideFile, char* overrideDict);
 extern char* runTesterStatusWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testerId, GoUint8 isFormattingEnabled);
 extern char* getJsonValue(char* jsonString, char* jsonPath);

package/lib/dev-linux-386.h

@@ -54,6 +54,11 @@ struct response_wrapper {
 	    char *error;
 	};
 
+	struct tester_generate_info {
+	    char *generated_files;
+	    char *error;
+	};
+
 #line 1 "cgo-generated-wrapper"
 
 
@@ -152,6 +157,7 @@ extern char* writeTestDescriptionWrapper(char* testDescription, char* testName);
 extern char* applyMockDescriptionWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* mockDescription, char* mockPath, char* projectPath);
 extern char* buildRequestsWrapper(char* mockDescription);
 extern struct tester_info runTesterStartWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testDescription, GoUint8 generateResult);
+extern struct tester_generate_info runTesterGenerateRestWrapper(char* protocol, char* apiSchemaPath, char* alias, char* endpointPath, char* language, char* tag, char* sampleRequestPath, char* projectPath, GoInt port, GoUint8 generateRobot, GoUint8 functionalScenario, GoUint8 negativeScenario);
 extern struct tester_info runTesterStartWrapperWithGlobalHeaders(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testDescription, char* testFileName, char* testName, char* globalJsonHeaders, GoUint8 generateResult, char* projectPath, char* overrideFile, char* overrideDict);
 extern char* runTesterStatusWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testerId, GoUint8 isFormattingEnabled);
 extern char* getJsonValue(char* jsonString, char* jsonPath);

package/lib/dev-linux-amd64.h

@@ -54,6 +54,11 @@ struct response_wrapper {
 	    char *error;
 	};
 
+	struct tester_generate_info {
+	    char *generated_files;
+	    char *error;
+	};
+
 #line 1 "cgo-generated-wrapper"
 
 
@@ -152,6 +157,7 @@ extern char* writeTestDescriptionWrapper(char* testDescription, char* testName);
 extern char* applyMockDescriptionWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* mockDescription, char* mockPath, char* projectPath);
 extern char* buildRequestsWrapper(char* mockDescription);
 extern struct tester_info runTesterStartWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testDescription, GoUint8 generateResult);
+extern struct tester_generate_info runTesterGenerateRestWrapper(char* protocol, char* apiSchemaPath, char* alias, char* endpointPath, char* language, char* tag, char* sampleRequestPath, char* projectPath, GoInt port, GoUint8 generateRobot, GoUint8 functionalScenario, GoUint8 negativeScenario);
 extern struct tester_info runTesterStartWrapperWithGlobalHeaders(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testDescription, char* testFileName, char* testName, char* globalJsonHeaders, GoUint8 generateResult, char* projectPath, char* overrideFile, char* overrideDict);
 extern char* runTesterStatusWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testerId, GoUint8 isFormattingEnabled);
 extern char* getJsonValue(char* jsonString, char* jsonPath);

package/lib/dev-windows-amd64.h

@@ -54,6 +54,11 @@ struct response_wrapper {
 	    char *error;
 	};
 
+	struct tester_generate_info {
+	    char *generated_files;
+	    char *error;
+	};
+
 #line 1 "cgo-generated-wrapper"
 
 
@@ -152,6 +157,7 @@ extern __declspec(dllexport) char* writeTestDescriptionWrapper(char* testDescrip
 extern __declspec(dllexport) char* applyMockDescriptionWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* mockDescription, char* mockPath, char* projectPath);
 extern __declspec(dllexport) char* buildRequestsWrapper(char* mockDescription);
 extern __declspec(dllexport) struct tester_info runTesterStartWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testDescription, GoUint8 generateResult);
+extern __declspec(dllexport) struct tester_generate_info runTesterGenerateRestWrapper(char* protocol, char* apiSchemaPath, char* alias, char* endpointPath, char* language, char* tag, char* sampleRequestPath, char* projectPath, GoInt port, GoUint8 generateRobot, GoUint8 functionalScenario, GoUint8 negativeScenario);
 extern __declspec(dllexport) struct tester_info runTesterStartWrapperWithGlobalHeaders(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testDescription, char* testFileName, char* testName, char* globalJsonHeaders, GoUint8 generateResult, char* projectPath, char* overrideFile, char* overrideDict);
 extern __declspec(dllexport) char* runTesterStatusWrapper(char* namespace, char* kubePath, char* kubeContext, char* clusterName, char* address, char* testerId, GoUint8 isFormattingEnabled);
 extern __declspec(dllexport) char* getJsonValue(char* jsonString, char* jsonPath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyramp/skyramp",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "module for leveraging skyramp cli functionality",
   "scripts": {
     "lint": "eslint 'src/**/*.js' 'src/**/*.ts' --fix",

package/src/classes/Protocol.d.ts

@@ -1,8 +1,5 @@
-declare const Protocol: {
-  readonly REST: 'rest';
-  readonly GRAPHQL: 'graphql';
-  readonly GRPC: 'grpc';
-};
-
-export default Protocol;
-
+export enum Protocol {
+  REST = 'rest',
+  GRAPHQL = 'graphql',
+  GRPC = 'grpc'
+}

package/src/classes/SkyrampClient.d.ts

@@ -2,7 +2,13 @@ import { ResponseValue } from '..';
 import { Endpoint } from './Endpoint';
 import { Scenario } from './Scenario';
 import {TrafficConfig} from './TrafficConfig';
+import { Protocol } from './Protocol';
 import {oauthResponseType} from './SkyrampClient';
+
+export enum Language {
+  PYTHON = 'python'
+}
+
 interface testerStartV1Options {
   namespace?: string;
   kubePath?: string;
@@ -85,5 +91,20 @@ export declare class SkyrampClient {
   getOAuthURL(provider: string, port: number): string;
   runOAuthLoopback(provider: string, port: number): Promise<oauthResponseType>;
   registerUser(provider: string, email: string, oauthToken: string): Promise<string>;
+
+  testerGenerate(
+    protocol: Protocol,
+    apiSchemaPath: string,
+    alias: string,
+    endpointPath: string,
+    language: Language,
+    tag: string,
+    sampleRequestPath: string,
+    port: int,
+    generateRobot: boolean,
+    functionalScenario: boolean,
+    negativeScenario: boolean): Promise<string[]>; 
+
   sendRequest(options: SendRequestV2Options): Promise<void>;
+  deployDashboard(network: string): Promise<void>;
 }

package/src/classes/SkyrampClient.js

@@ -27,6 +27,11 @@ const testerInfoType = koffi.struct({
   error: 'char*',
 });
 
+const testerGenerateType = koffi.struct({
+  generated_files: 'char*',
+  error: 'char*',
+});
+
 const contractResponseType = koffi.struct({
   response: 'char*',
   error: 'char*',
@@ -57,6 +62,7 @@ const applyMockDescriptionWrapper = lib.func('applyMockDescriptionWrapper', 'str
 const initTargetWrapper = lib.func('initTargetWrapper', 'string', ['string']);
 const deployTargetWrapper = lib.func('deployTargetWrapper', 'string', ['string', 'string', 'string', 'string', 'string', 'string', 'bool']);
 const deleteTargetWrapper = lib.func('deleteTargetWrapper', 'string', ['string', 'string', 'string', 'string', 'string']);
+const runTesterGenerateRestWrapper = lib.func('runTesterGenerateRestWrapper', testerGenerateType, ['string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'int', 'bool', 'bool', 'bool']);
 
 // credential / oauth related
 const readCredentialWrapper = lib.func('readCredentialWrapper', credResponseType, []);
@@ -68,6 +74,11 @@ const runOAuthLoopback = lib.func('runOAuthLoopback', oauthResponseType, ['strin
 // contract test
 // func sendRequestWrapper(address, namespace, kubePath, kubeContext, clusterName, request *C.char) *C.char {
 const sendRequestWrapper = lib.func('sendRequestWrapper', contractResponseType, ['string', 'string', 'string', 'string', 'string', 'string']);
+
+// dashboard
+const deployDockerDashboardWrapper = lib.func('deployDockerDashboardWrapper', 'string', ['string']);
+const deployK8sDashboardWrapper = lib.func('deployK8sDashboardWrapper', 'string', ['string', 'string']);
+
 /**
  * The `SkyrampClient` class is the main client that provides methods for interacting with the Skyramp service.
  * It allows users to manage Kubernetes clusters, deploy and delete workers and targets, apply mock descriptions, and start tests.
@@ -88,8 +99,9 @@ class SkyrampClient {
    * @param {string} [clusterName] - The name of the cluster (when using individual parameters)
    * @param {string} [context] - The context of the cluster (when using individual parameters)
    * @param {string} [userToken] - The user token for authentication (when using individual parameters)
+   * @param {string} [directory=process.cwd()] - The working directory of the client.
    */
-  constructor(kubeconfigPathOrOptions, clusterName, context, userToken) {
+  constructor(kubeconfigPathOrOptions, clusterName, context, userToken, directory = process.cwd()) {
     if (typeof kubeconfigPathOrOptions === 'object') {
       const options = kubeconfigPathOrOptions;
       if (options.kubeconfigPath || options.clusterName || options.context) {
@@ -104,10 +116,11 @@ class SkyrampClient {
     } else {
       if (kubeconfigPathOrOptions || clusterName || context) {
         this.addKubeconfig(clusterName, context, kubeconfigPathOrOptions);
+      }
+      this.workerNamespaces = [];
+      this.userToken = userToken;
+      this.projectPath = directory;
     }
-    this.workerNamespaces = [];
-    this.userToken = userToken;
-  }
   }
 
   setUserToken(userToken) {
@@ -623,6 +636,41 @@ class SkyrampClient {
 
     return mockDescription;
   }
+  
+  /**
+   * Generates test scenarios based on the provided parameters.
+   * 
+   * @param {Protocol} protocol - The protocol to be used.
+   * @param {string} apiSchemaPath - The path to the API schema.
+   * @param {string} alias - The alias for the generated tests.
+   * @param {string} endpointPath - Endpoint REST path to filter for.
+   * @param {Language} language - The programming language for the generated tests.
+   * @param {string} tag - Tag to filter OpenAPI endpoint paths for.
+   * @param {string} sampleRequestPath - The path to the sample request.
+   * @param {int} port - The port number.
+   * @param {boolean} generateRobot - Whether to generate robot tests.
+   * @param {boolean} functionalScenario - Whether to generate functional scenarios.
+   * @param {boolean} negativeScenario - Whether to generate negative scenarios.
+   * @returns {Promise<string[]>} A promise that resolves with a list of generated test file paths.
+   */
+  async testerGenerate(protocol, apiSchemaPath, alias, endpointPath, language, tag, sampleRequestPath, port, generateRobot, functionalScenario, negativeScenario) {
+    return new Promise((resolve, reject) => {
+      runTesterGenerateRestWrapper.async(protocol, apiSchemaPath, alias, endpointPath, language, tag, sampleRequestPath, this.projectPath, port, generateRobot, functionalScenario, negativeScenario, (err, res) => {
+        if (err) {
+          console.error(`Error generating tests: ${err.name} - ${err.message}`);
+          reject(err);
+        } else if (res.error) {
+          console.error(`Error generating tests: ${res.error}`);
+          reject(new Error(res.error));
+        } else {
+          console.log(`Test generation completed successfully. Generated files: ${res.generated_files}`);
+
+          const generatedTestNames = res.generated_files.split(',');
+          resolve(generatedTestNames);
+        }
+      });
+    });
+  }
 
   /**
    * Sends a request to a Skyramp worker using the V2 API
@@ -635,7 +683,6 @@ class SkyrampClient {
    * @returns {Promise<string>} A promise that resolves with the response from the worker
    */
   async sendRequest(options) {
-    // FIXME: should be sendRequest
     const req = new RequestV2(options);
     return new Promise((resolve, reject) => {
       const jsonRequest = req.toJson();
@@ -650,6 +697,31 @@ class SkyrampClient {
       });
     });
   }
+
+  async deployDashboard(network) {
+    if (network === undefined || network === null || network === "") {
+      network = "dashboard"
+    }
+    return new Promise((resolve, reject) => {
+      if (this.kubeConfigPath === null || this.kubeConfigPath === undefined) {
+        deployDockerDashboardWrapper.async(network, (err, res) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve(res);
+          }
+        });
+      } else {
+        deployK8sDashboardWrapper.async(network, (err, res) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve(res);
+          }
+        });
+      }
+    });
+  }
 }
 
 module.exports = SkyrampClient;