@skyramp/skyramp 1.3.6 → 1.3.8

package/package.json

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

package/src/classes/SkyrampClient.d.ts

@@ -138,6 +138,31 @@ interface GenerateRestTestOptions {
   chainingKey?: string;
 }
 
+interface GenerateRestMockOptions {
+  uri?: string;
+  method?: string;
+  language?: string;
+  framework?: string;
+  output?: string;
+  outputDir?: string;
+  runtime?: string;
+  dockerNetwork?: string;
+  dockerWorkerPort?: string;
+  k8sNamespace?: string;
+  k8sConfig?: string;
+  k8sContext?: string;
+  responseData?: string;
+  responseStatusCode?: string;
+  force?: boolean;
+  deployDashboard?: boolean;
+  formParams?: string;
+  pathParams?: string;
+  queryParams?: string;
+  apiSchema?: string[];
+  traceFilePath?: string;
+  entrypoint?: string;
+}
+
 interface SendScenarioOptions {
   until?: string;
   loadTestConfig?: LoadTestConfig;
@@ -147,6 +172,11 @@ interface SendScenarioOptions {
   skipCertVerification?: boolean;
 }
 
+interface InitAgentOptions {
+  version: string;
+  entryPoint?: string;
+}
+
 export declare class SkyrampClient {
   constructor(
     kubeconfigPath?: string,
@@ -259,6 +289,7 @@ export declare class SkyrampClient {
   deployDashboard(network: string): Promise<void>;
 
   generateRestTest(options: GenerateRestTestOptions): Promise<string>;
+  generateRestMock(options: GenerateRestMockOptions): Promise<string>;
   traceCollect(options: TraceCollectOptions): Promise<string>;
   analyzeOpenapi(options: AnalyzeOpenAPIOptions): Promise<string>;
 
@@ -278,4 +309,13 @@ export declare class SkyrampClient {
   fetchLatestOtp(
     email: string
   ): string;
+
+  /**
+   * 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>;
 }

package/src/classes/SkyrampClient.js

@@ -58,8 +58,10 @@ const deleteTargetWrapper = lib.func('deleteTargetWrapper', 'string', ['string',
 const runTesterGenerateRestWrapper = lib.func('runTesterGenerateRestWrapper', testerGenerateType, ['string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'int', 'bool', 'bool', 'bool']);
 
 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', '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 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']);
 
 // Load test scenario support
 const sendScenarioWrapper = lib.func('sendScenarioWrapper', contractResponseType, ['string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'bool', 'bool']);
@@ -446,13 +448,13 @@ class SkyrampClient {
     if (!Array.isArray(mock)) {
       mock = [mock];
     }
-    
+
     // Convert MockV2 objects to dictionary format
     const mockList = mock.map(m => m.toDict());
-    
+
     // Convert to JSON string
     const mockJson = JSON.stringify(mockList);
-    
+
     return new Promise((resolve, reject) => {
       applyMockObjectWrapper.async(
         this.address || '',
@@ -887,6 +889,42 @@ class SkyrampClient {
     });
   }
 
+  async generateRestMock(options) {
+    return new Promise((resolve, reject) => {
+      generateRestMockWrapper.async(
+        options.uri || "",
+        options.method || "",
+        options.language || "",
+        options.framework || "",
+        options.output || "",
+        options.outputDir || "",
+        options.runtime || "",
+        options.dockerNetwork || "",
+        options.dockerWorkerPort || "0",
+        options.k8sNamespace || "",
+        options.k8sConfig || "",
+        options.k8sContext || "",
+        options.responseData || "",
+        options.responseStatusCode || "",
+        options.force || false,
+        options.deployDashboard || false,
+        options.formParams || "",
+        options.pathParams || "",
+        options.queryParams || "",
+        JSON.stringify(options.apiSchema || []),
+        options.traceFilePath || "",
+        options.entrypoint || "",
+        (err, res) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve(res);
+          }
+        }
+      );
+    });
+  }
+
   /**
    * Sends a scenario for load testing using the V2 API
    * @param {Object|Array} scenario - The scenario object or array of scenarios to run
@@ -909,10 +947,10 @@ class SkyrampClient {
       skipCertVerification = false
     } = options;
 
-    if (debug) { /* add to api for future use */}
+    if (debug) { /* add to api for future use */ }
     let configJson = "";
     if (loadTestConfig) {
-        configJson = loadTestConfig.toJson();
+      configJson = loadTestConfig.toJson();
     }
 
     // Ensure scenario is an array
@@ -923,13 +961,13 @@ class SkyrampClient {
       // If scenario has toJson method, use it for proper formatting
       if (typeof _scenario.toJson === 'function') {
         const scenarioJson = _scenario.toJson();
-        
+
         return {
           ...scenarioJson,
           until: until || scenarioJson.until
         };
       }
-      
+
       // Fallback for scenarios without toJson method
       return {
         name: _scenario.name,
@@ -982,22 +1020,22 @@ class SkyrampClient {
     let timestamp = this.timestamp;
 
     if (!email.includes("@otp.skyramp.dev")) {
-        throw new Error("non-Skyramp email is not supported")
+      throw new Error("non-Skyramp email is not supported")
     }
 
     const username = email.replace("@otp.skyramp.dev", "")
 
-    for (let i = 0; i < 10; i ++) {
+    for (let i = 0; i < 10; i++) {
       // Execute Request
       latestGetResponse = await this.sendRequest({
-          url: "https://tokenize.skyramp.dev",
-          path: `/msg/${username}/latest`,
-          method: "GET"
+        url: "https://tokenize.skyramp.dev",
+        path: `/msg/${username}/latest`,
+        method: "GET"
       });
 
       if (latestGetResponse.statusCode != 200) {
-          await new Promise(resolve => setTimeout(resolve, 1000));
-          continue
+        await new Promise(resolve => setTimeout(resolve, 1000));
+        continue
       }
 
       let codeTime = new Date(utils.getResponseValue(latestGetResponse, "timestamp"));
@@ -1007,6 +1045,29 @@ class SkyrampClient {
       await new Promise(resolve => setTimeout(resolve, 1000));
     }
   }
+
+  /**
+   * 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) {
+    return new Promise((resolve, reject) => {
+      initAgentWrapper.async(
+        options.version || "",
+        options.entryPoint || "vscode",
+        (err, res) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve(res);
+          }
+        }
+      );
+    });
+  }
 }
 
 module.exports = SkyrampClient;

package/src/lib.js

@@ -8,6 +8,8 @@ let libPath = '';
 if (platform === 'linux') {
   if (arch === 'x64') {
     libPath = 'skyramp-linux-amd64.so';
+  } else if (arch === 'arm64') {
+    libPath = 'skyramp-linux-arm64.so';
   } else if (arch === 'ia32') {
     libPath = 'skyramp-linux-386.so';
   }