@grafana/openapi-to-k6 0.3.0 → 0.3.2

package/tests/e2e/single/k6Script.ts

@@ -3,8 +3,15 @@ import { check } from 'k6'
 import { ComprehensiveAPIClient } from './sdk.ts'
 /* eslint-enable import/no-unresolved */
 
+const commonRequestParameters = {
+  headers: {
+    'Only-Common-Header': 'test',
+    'Only-Common-Header-2': 'test-2',
+    'X-Correlation-ID': 'only-common-header-value',
+  },
+}
 const baseUrl = 'http://localhost:3000'
-const client = new ComprehensiveAPIClient({ baseUrl })
+const client = new ComprehensiveAPIClient({ baseUrl, commonRequestParameters })
 
 export const options = {
   thresholds: {
@@ -79,4 +86,50 @@ export default function () {
     id: 'test',
   })
   checkResponseStatus(getItemsHeaderResponseData.response, 200)
+
+  const requestParameters = {
+    headers: {
+      'Only-Common-Header-2': 'test-common-header-2-parameter',
+      'X-Correlation-ID': 'test-request-parameter',
+    },
+  }
+  const getItemsNewMandatoryHeadersResponseData =
+    client.getItemsNewMandatoryHeaders(
+      {
+        itemId: 'test',
+      },
+      {
+        'X-Auth-Token': 'test',
+        'X-Correlation-ID': 'test-function-argument',
+      },
+      requestParameters
+    )
+  checkResponseStatus(getItemsNewMandatoryHeadersResponseData.response, 200)
+
+  const requestHeaders =
+    getItemsNewMandatoryHeadersResponseData.response.request.headers
+  console.log('requestHeaders')
+  console.log(requestHeaders)
+
+  // Validate that the header present only in common request parameters is present in the request
+  check(requestHeaders, {
+    'has only-common-header': (r) => r['Only-Common-Header'][0] === 'test',
+  })
+
+  // Validate that the header present only in the request parameters is present in the request
+  check(requestHeaders, {
+    'has X-Auth-Token': (r) => r['X-Auth-Token'][0] === 'test',
+  })
+
+  // Validate that the header present in the requestParameters takes precedence over the value in common request parameters
+  check(requestHeaders, {
+    'has correct value of Only-Common-Header-2 from request parameters': (r) =>
+      r['Only-Common-Header-2'][0] === 'test-common-header-2-parameter',
+  })
+
+  // Validate that the value of the header present in function arguments takes precedence over the value in common request parameters and request parameters
+  check(requestHeaders, {
+    'has correct value X-Correlation-ID from function arguments': (r) =>
+      r['X-Correlation-Id'][0] === 'test-function-argument',
+  })
 }

package/tests/functional-tests/test-generator/fixtures/basic_parameter_in_ref.json

@@ -0,0 +1,59 @@
+{
+  "openapi_schema": {
+    "openapi": "3.0.0",
+    "info": {
+      "title": "Simple API",
+      "version": "1.0.0"
+    },
+    "paths": {
+      "/example": {
+        "get": {
+          "summary": "Retrieve example data",
+          "parameters": [
+            {
+              "$ref": "#/components/parameters/stackId"
+            }
+          ],
+          "responses": {
+            "200": {
+              "description": "Successful response",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "type": "object",
+                    "properties": {
+                      "message": {
+                        "type": "string",
+                        "example": "Hello, World!"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "components": {
+      "parameters": {
+        "stackId": {
+          "in": "header",
+          "name": "X-Stack-Id",
+          "schema": {
+            "type": "integer"
+          },
+          "required": true
+        }
+      }
+    }
+  },
+  "expected_sdk": {
+    "fileName": "simpleAPI.ts",
+    "expectedSubstrings": [
+      "export class SimpleAPIClient",
+      "export type StackIdParameter = number;",
+      "export type GetExampleHeaders = { \"X-Stack-Id\": StackIdParameter; };"
+    ]
+  }
+}

package/tests/functional-tests/test-generator/fixtures/form_data_schema.json

@@ -88,7 +88,7 @@
       "export class FormDataAPIClient",
       "const formData = new FormData(); formData.append(\"file\", postUploadBody.file); if (postUploadBody.description !== undefined) { formData.append(\"description\", postUploadBody.description); } formData.append(\"userId\", postUploadBody.userId);",
       "const url = new URL(this.cleanBaseUrl + `/upload`);",
-      "const response = http.request(\"POST\", url.toString(), formData.body(), { ...mergedRequestParameters, headers: { \"Content-Type\": \"multipart/form-data; boundary=\" + formData.boundary, ...mergedRequestParameters?.headers, }, });"
+      "const response = http.request(\"POST\", url.toString(), formData.body(), { ...mergedRequestParameters, headers: { ...mergedRequestParameters?.headers, \"Content-Type\": \"multipart/form-data; boundary=\" + formData.boundary, }, });"
     ]
   }
 }

package/tests/functional-tests/test-generator/fixtures/form_url_encoded_data_schema.json

@@ -87,7 +87,7 @@
     "expectedSubstrings": [
       "export class FormURLEncodedAPIClient",
       "const url = new URL(this.cleanBaseUrl + `/submit-form`);",
-      "const response = http.request( \"POST\", url.toString(), JSON.stringify(postSubmitFormBody), { ...mergedRequestParameters, headers: { \"Content-Type\": \"application/x-www-form-urlencoded\", ...mergedRequestParameters?.headers, }, }, );"
+      "const response = http.request( \"POST\", url.toString(), JSON.stringify(postSubmitFormBody), { ...mergedRequestParameters, headers: { ...mergedRequestParameters?.headers, \"Content-Type\": \"application/x-www-form-urlencoded\", }, }, );"
     ]
   }
 }

package/tests/functional-tests/test-generator/fixtures/headers_schema.json

@@ -152,9 +152,9 @@
     "expectedSubstrings": [
       "export class HeaderDemoAPIClient",
       "getExampleGet( headers?: GetExampleGetHeaders, requestParameters?: Params, ): { response: Response; data: GetExampleGet200; }",
-      "response = http.request(\"GET\", url.toString(), undefined, { ...mergedRequestParameters, headers: { // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string ...Object.fromEntries( Object.entries(headers || {}).map(([key, value]) => [ key, String(value), ]), ), ...mergedRequestParameters?.headers, }, });",
+      "response = http.request(\"GET\", url.toString(), undefined, { ...mergedRequestParameters, headers: { ...mergedRequestParameters?.headers, // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string ...Object.fromEntries( Object.entries(headers || {}).map(([key, value]) => [ key, String(value), ]), ), }, });",
       "postExamplePost( postExamplePostBody: PostExamplePostBody, headers: PostExamplePostHeaders, requestParameters?: Params, ): { response: Response; data: void; }",
-      "response = http.request( \"POST\", url.toString(), JSON.stringify(postExamplePostBody), { ...mergedRequestParameters, headers: { \"Content-Type\": \"application/json\", // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string ...Object.fromEntries( Object.entries(headers || {}).map(([key, value]) => [ key, String(value), ]), ), ...mergedRequestParameters?.headers, }, }, );",
+      "response = http.request( \"POST\", url.toString(), JSON.stringify(postExamplePostBody), { ...mergedRequestParameters, headers: { ...mergedRequestParameters?.headers, \"Content-Type\": \"application/json\", // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string ...Object.fromEntries( Object.entries(headers || {}).map(([key, value]) => [ key, String(value), ]), ), }, }, );",
       "getExampleResponseHeaders(requestParameters?: Params): { response: Response; data: GetExampleResponseHeaders200; }",
       "response = http.request( \"GET\", url.toString(), undefined, mergedRequestParameters, );"
     ]

package/tests/functional-tests/test-generator/fixtures/simple_post_request_schema.json

@@ -124,7 +124,7 @@
       "const url = new URL(this.cleanBaseUrl + `/example`);",
       "JSON.stringify(createExampleDataBody),",
       "POST",
-      "export type CreateExampleData201 = { age?: number; date?: string; /** The unique ID of the created resource */ id?: string; isActive?: boolean; meta?: CreateExampleData201Meta; name?: string; tags?: string[];"
+      "export type CreateExampleData201 = { /** The unique ID of the created resource */ id?: string; name?: string; age?: number; isActive?: boolean; tags?: string[]; date?: string; meta?: CreateExampleData201Meta; };"
     ]
   }
 }

package/{vite.config.js → vite.config.mjs}

@@ -1,8 +1,12 @@
 import { defineConfig } from 'vite'
+import tsconfigPaths from 'vite-tsconfig-paths'
 
 export default defineConfig({
+  plugins: [tsconfigPaths()],
   test: {
     environment: 'node',
+    globals: true,
+    include: ['tests/**/*.test.ts'],
     coverage: {
       reporter: ['json', 'text', 'lcov'],
       reportsDirectory: 'coverage',