@skyramp/skyramp 1.3.10 → 1.3.12

package/src/classes/MockV2.js

@@ -5,24 +5,52 @@
 class MockV2 {
   /**
    * Represents a mock object configuration for API endpoint mocking.
-   * @param {string} URL - The URL of the service to mock
-   * @param {string} endpoint - The endpoint path to mock (e.g., "/api/v1/products")
-   * @param {number} port - The port number of the service
-   * @param {string} method - The HTTP method (GET, POST, PUT, DELETE, etc.)
-   * @param {number} responseStatusCode - The HTTP status code to return
-   * @param {string} responseBody - The response body to return
+   * Supports both positional arguments and options object patterns.
+   *
+   * @example
+   * // Positional arguments
+   * new MockV2("http://localhost:8080", "/api/v1/products", 8080, "POST", 201, "{}")
+   *
+   * @example
+   * // Options object (preferred)
+   * new MockV2({
+   *   url: "http://localhost:8080",
+   *   path: "/api/v1/products",
+   *   method: "POST",
+   *   responseStatusCode: 201
+   * })
+   *
+   * @param {string|Object} URLOrOptions - URL string or options object
+   * @param {string} [path] - The endpoint path (positional only)
+   * @param {string} [method] - The HTTP method (positional only)
+   * @param {number} [statusCode] - The status code (positional only)
+   * @param {string} [responseBody] - The response body (positional only)
    * @param {string} [requestBody] - Optional request body to match
    * @param {Object} [dataOverride] - Optional data override object
    */
-  constructor(URL, endpoint, port, method, responseStatusCode, responseBody, requestBody = null, dataOverride = null) {
-    this.URL = URL;
-    this.endpoint = endpoint;
-    this.port = port;
-    this.method = method;
-    this.responseStatusCode = responseStatusCode;
-    this.responseBody = responseBody;
-    this.requestBody = requestBody;
-    this.dataOverride = dataOverride;
+  constructor(URLOrOptions, path, method, statusCode, responseBody, requestBody = null, dataOverride = null) {
+    // Handle options object pattern
+    if (typeof URLOrOptions === 'object' && URLOrOptions !== null) {
+      const options = URLOrOptions;
+      this.url = options.url || '';
+      this.path = options.path || '';
+      this.method = options.method || '';
+      this.statusCode = options.statusCode || 201;
+      this.responseBody = (options.body !== undefined ? options.body : options.responseBody) || '';
+      this.requestBody = options.requestBody || null;
+      this.dataOverride = options.dataOverride || null;
+      this.clientID = options.clientID || null;
+    } else {
+      // Handle positional arguments pattern
+      this.url = URLOrOptions;
+      this.path = path;
+      this.method = method;
+      this.statusCode = statusCode;
+      this.responseBody = responseBody;
+      this.requestBody = requestBody;
+      this.dataOverride = dataOverride;
+      this.clientID = null;
+    }
   }
 
   /**
@@ -31,11 +59,10 @@ class MockV2 {
    */
   toDict() {
     const result = {
-      url: this.URL,
-      endpoint: this.endpoint,
-      port: this.port,
+      url: this.url,
+      path: this.path,
       method: this.method,
-      status_code: this.responseStatusCode,
+      status_code: this.statusCode,
       response_body: this.responseBody
     };
 
@@ -47,6 +74,10 @@ class MockV2 {
       result.data_override = this.dataOverride;
     }
 
+    if (this.clientID !== null) {
+      result.client_id = this.clientID;
+    }
+
     return result;
   }
 
@@ -59,4 +90,4 @@ class MockV2 {
   }
 }
 
-module.exports = MockV2;
+module.exports = MockV2;

package/src/classes/SkyrampClient.d.ts

@@ -138,6 +138,13 @@ interface GenerateRestTestOptions {
   unblock?: boolean;
   entrypoint?: string;
   chainingKey?: string;
+  parentRequestData?: Record<string, string> | string;
+  parentStatusCode?: Record<string, string> | string;
+  requestAware?: boolean;
+  providerMode?: boolean;
+  consumerMode?: boolean;
+  providerOutput?: string;
+  consumerOutput?: string;
 }
 
 interface GenerateRestMockOptions {
@@ -157,6 +164,7 @@ interface GenerateRestMockOptions {
   responseStatusCode?: string;
   force?: boolean;
   deployDashboard?: boolean;
+  requestAware?: boolean;
   formParams?: string;
   pathParams?: string;
   queryParams?: string;
@@ -174,11 +182,6 @@ interface SendScenarioOptions {
   skipCertVerification?: boolean;
 }
 
-interface InitAgentOptions {
-  version: string;
-  entryPoint?: string;
-}
-
 export declare class SkyrampClient {
   constructor(
     kubeconfigPath?: string,
@@ -250,6 +253,7 @@ export declare class SkyrampClient {
     mockYamlContent: string
   ): Promise<void>;
   applyMock(mock: MockV2 | MockV2[]): Promise<void>;
+  removeAllMocks(): Promise<void>;
   testerStart(
     namespace: string,
     kubePath: string,
@@ -314,10 +318,7 @@ export declare class SkyrampClient {
 
   /**
    * Initializes the agent by checking and pulling required Docker images (executor and worker).
-   * @param {InitAgentOptions} options - The options for initializing the agent.
-   * @param {string} options.version - The version of the agent to initialize.
-   * @param {string} [options.entryPoint='vscode'] - The entry point identifier (e.g., 'vscode').
    * @returns {Promise<string>} A promise that resolves with the initialization output message.
    */
-  initAgent(options: InitAgentOptions): Promise<string>;
+  initAgent(): Promise<string>;
 }

package/src/classes/SkyrampClient.js

@@ -1,3 +1,4 @@
+const { promisify } = require('util');
 const lib = require('../lib');
 const koffi = require('koffi');
 const TrafficConfig = require('./TrafficConfig');
@@ -46,16 +47,98 @@ const runTesterStartWrapper = lib.func('runTesterStartWrapper', testerInfoType,
 const runTesterStartWrapperv1 = lib.func('runTesterStartWrapperWithGlobalHeaders', testerInfoType, ['string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'bool', 'string', 'string', 'string']);
 const applyMockDescriptionWrapper = lib.func('applyMockDescriptionWrapper', 'string', ['string', 'string', 'string', 'string', 'string', 'string', 'string', 'string']);
 const applyMockObjectWrapper = lib.func('applyMockObjectWrapper', 'string', ['string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool']);
+const removeMocksObjectWrapper = lib.func('removeMocksObjectWrapper', 'string', []);
 // NPM only: for VS code extension use
 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 generateRestTestWrapper = lib.func('generateRestTestWrapper', 'string', ['string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'bool', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'string', 'bool', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'string', 'string']);
-const generateRestMockWrapper = lib.func('generateRestMockWrapper', 'string', ['string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'bool', 'string', 'string', 'string', 'string', 'string', 'string']);
+const generateRestTestWrapper = lib.func('generateRestTestWrapper', 'string', [
+    'string',       // test
+    'string',       // uri
+    'string',       // methodX
+    'string',       // language
+    'string',       // framework
+    'string',       // output
+    'string',       // outputDir
+    'string',       // runtime
+    'string',       // dockerNetwork
+    'string',       // dockerWorkerPort
+    'string',       // k8sNamespace
+    'string',       // k8sConfig
+    'string',       // k8sContxt
+    'string',       // authHeader
+    'string',       // authType
+    'string',       // requestData
+    'string',       // responseData
+    'string',       // responseStatusCode
+    'bool',         // force
+    'bool',         // deployDashboard
+    'string',       // formParams
+    'string',       // pathParams
+    'string',       // queryParams
+    'string',       // apiSchema
+    'string',       // trafeFilePath
+    'string',       // generateInclude
+    'string',       // generateExclude
+    'string',       // generateNoProxy
+    'bool',         // generateInsecure
+    'string',       // assertOption
+    'bool',         // playwright
+    'string',       // playwrightOutput
+    'string',       // playwrightInput
+    'string',       // playwrightViewportSize
+    'string',       // playwrightStoragePath
+    'string',       // playwrightSaveStoragePath
+    'string',       // browser
+    'string',       // device
+    'string',       // loadCount
+    'string',       // loadDuration
+    'string',       // loadNumThreads
+    'string',       // loadRampupDuration
+    'string',       // loadRampupInterval
+    'string',       // loadTargetRPS
+    'string',       // rawTrace
+    'bool',         // unblock
+    'string',       // entrypoint
+    'string',       // chainingKey
+    'string',       // parentRequestData
+    'string',       // parentStatusCode
+    'bool',         // requestAware
+    'bool',         // providerMode
+    'bool',         // consumerMode
+    'string',       // providerOutput (contract test)
+    'string',        // consumerOutput (contract test)
+    'bool'          // skipProvisionParents
+]);
+const generateRestMockWrapper = lib.func('generateRestMockWrapper', 'string', [
+    'string',       // uri
+    'string',       // methodX
+    'string',       // language
+    'string',       // framework
+    'string',       // output
+    'string',       // outputDir
+    'string',       // runtime
+    'string',       // dockerNetwork
+    'string',       // dockerWorkerPort
+    'string',       // k8sNamespace
+    'string',       // k8sConfig
+    'string',       // k8sContext
+    'string',       // responseData
+    'string',       // responseStatusCode
+    'bool',         // force
+    'bool',         // deployDashboard
+    'bool',         // requestAware
+    'string',       // formParams
+    'string',       // pathParams
+    'string',       // queryParams
+    'string',       // apiSchema
+    'string',       // traceFilePath
+    'string'        // entryPoint
+]);
 const traceCollectWrapper = lib.func('traceCollectWrapper', 'string', ['string', 'string', 'bool', 'string', 'string']);
 const analyzeOpenapiWrapper = lib.func('analyzeOpenapiWrapper', 'string', ['string', 'string']);
-const initAgentWrapper = lib.func('initAgent', 'string', ['string', 'string']);
+const initAgentWrapper = lib.func('initAgent', 'string', []);
 
 // Load test scenario support
 const sendScenarioWrapper = lib.func('sendScenarioWrapper', contractResponseType, ['string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'bool', 'bool']);
@@ -471,6 +554,24 @@ class SkyrampClient {
     });
   }
 
+  /**
+   * Removes all mock configurations from the worker.
+   * @returns {Promise} A promise that resolves when all mocks are removed successfully
+   */
+  async removeAllMocks() {
+    return new Promise((resolve, reject) => {
+      removeMocksObjectWrapper.async((err, res) => {
+        if (err) {
+          reject(err);
+        } else if (res) {
+          reject(new Error(res));
+        } else {
+          resolve();
+        }
+      });
+    });
+  }
+
   async testerStart(namespace, kubePath, kubeContext, clusterName, address, scenario) {
     const preparedScenario = scenario.prepareTestDescription();
     const testDescription = createTestDescriptionFromScenario({ scenario: preparedScenario });
@@ -788,6 +889,13 @@ class SkyrampClient {
 
   async generateRestTest(options) {
     return new Promise((resolve, reject) => {
+      const parentRequestData = typeof options.parentRequestData === 'string'
+        ? options.parentRequestData
+        : JSON.stringify(options.parentRequestData || {});
+      const parentStatusCode = typeof options.parentStatusCode === 'string'
+        ? options.parentStatusCode
+        : JSON.stringify(options.parentStatusCode || {});
+
       generateRestTestWrapper.async(
         options.testType || "",
         options.uri || "",
@@ -837,6 +945,14 @@ class SkyrampClient {
         options.unblock || false,
         options.entrypoint || "",
         options.chainingKey || "",
+        parentRequestData || "",
+        parentStatusCode || "",
+        options.requestAware || false,
+        options.providerMode || true,
+        options.consumerMode || false,
+        options.providerOutput || "",
+        options.consumerOutput || "",
+        options.skipProvisionParents || true,
         (err, res) => {
           if (err) {
             reject(err);
@@ -867,6 +983,7 @@ class SkyrampClient {
         options.responseStatusCode || "",
         options.force || false,
         options.deployDashboard || false,
+        options.requestAware || false,
         options.formParams || "",
         options.pathParams || "",
         options.queryParams || "",
@@ -1007,26 +1124,11 @@ class SkyrampClient {
 
   /**
    * Initializes the agent by checking and pulling required Docker images (executor and worker).
-   * @param {Object} options - The options for initializing the agent.
-   * @param {string} options.version - The version of the agent to initialize.
-   * @param {string} [options.entryPoint='vscode'] - The entry point identifier (e.g., 'vscode').
    * @returns {Promise<string>} A promise that resolves with the initialization output message.
    */
-  async initAgent(options) {
+  async initAgent() {
     await checkForUpdate("npm");
-    return new Promise((resolve, reject) => {
-      initAgentWrapper.async(
-        options.version || "",
-        options.entryPoint || "vscode",
-        (err, res) => {
-          if (err) {
-            reject(err);
-          } else {
-            resolve(res);
-          }
-        }
-      );
-    });
+    return promisify(initAgentWrapper.async)();
   }
 }