@grafana/openapi-to-k6 0.2.5 → 0.3.0

package/tests/functional-tests/test-sample-k6-scripts/fixtures/schema_with_examples.json

@@ -0,0 +1,416 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Comprehensive API",
+    "version": "1.0.0",
+    "description": "API supporting various HTTP methods with query, path parameters, and headers"
+  },
+  "paths": {
+    "/items/{id}": {
+      "get": {
+        "tags": ["Items"],
+        "summary": "Get an item by ID",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "ID of the item to retrieve",
+            "schema": {
+              "type": "string",
+              "example": "12345-getItemById"
+            }
+          },
+          {
+            "name": "detail",
+            "in": "query",
+            "required": false,
+            "description": "Whether to return detailed information",
+            "schema": {
+              "type": "boolean",
+              "default": false,
+              "example": true
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        }
+      },
+      "post": {
+        "tags": ["Items"],
+        "summary": "Create an item by ID",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "ID of the item to create",
+            "schema": {
+              "type": "string",
+              "example": "123450-createItemById"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "example": "Sample Item"
+                  },
+                  "description": {
+                    "type": "string",
+                    "example": "This is a sample description for the item."
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Item created successfully"
+          }
+        }
+      },
+      "put": {
+        "tags": ["Items"],
+        "summary": "Update an item by ID",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "ID of the item to update",
+            "schema": {
+              "type": "string",
+              "example": "123450-updateItemById"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "example": "Updated Item Name"
+                  },
+                  "description": {
+                    "type": "string",
+                    "example": "Updated description for the item."
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Item updated successfully"
+          }
+        }
+      },
+      "patch": {
+        "tags": ["Items"],
+        "summary": "Partially update an item by ID",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "ID of the item to partially update",
+            "schema": {
+              "type": "string",
+              "example": "123450-patchItemById"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "example": "Partially Updated Item Name"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Item partially updated"
+          }
+        }
+      },
+      "delete": {
+        "tags": ["Items"],
+        "summary": "Delete an item by ID",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "ID of the item to delete",
+            "schema": {
+              "type": "string",
+              "example": "123450-deleteItemById"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Item deleted successfully"
+          }
+        }
+      },
+      "head": {
+        "tags": ["Items"],
+        "summary": "Check if item exists",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "ID of the item to check",
+            "schema": {
+              "type": "string",
+              "example": "123450-checkItemById"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Item exists"
+          },
+          "404": {
+            "description": "Item not found"
+          }
+        }
+      }
+    },
+    "/items-form-url-encoded": {
+      "post": {
+        "tags": ["ItemsForm", "Items"],
+        "summary": "Create an item using form-urlencoded data",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "example": "Form Encoded Item"
+                  },
+                  "description": {
+                    "type": "string",
+                    "example": "Description for form-urlencoded item."
+                  }
+                },
+                "required": ["name"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Item created successfully"
+          }
+        }
+      }
+    },
+    "/items-form-data": {
+      "post": {
+        "tags": ["ItemsForm", "Items"],
+        "summary": "Create an item using form-data",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "example": "Form Data Item"
+                  }
+                },
+                "required": ["file", "name"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Item created with file upload"
+          }
+        }
+      }
+    },
+    "/items-header": {
+      "get": {
+        "tags": ["ItemsHeader"],
+        "summary": "Get an item with custom headers",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "query",
+            "required": true,
+            "description": "ID of the item to retrieve",
+            "schema": {
+              "type": "string",
+              "example": "123450-getItemByIdWithHeader"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Item retrieved successfully"
+          }
+        },
+        "requestBody": {
+          "required": false
+        },
+        "headers": [
+          {
+            "name": "X-Client-ID",
+            "in": "header",
+            "description": "Client ID for the request",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "client-123"
+            }
+          },
+          {
+            "name": "X-Request-ID",
+            "in": "header",
+            "description": "Unique request identifier",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "example": "req-56789"
+            }
+          }
+        ]
+      }
+    },
+    "/users/{userId}/posts/{postId}": {
+      "get": {
+        "operationId": "getUserPost",
+        "tags": ["UsersPosts"],
+        "parameters": [
+          {
+            "name": "userId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "postId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "title": {
+                      "type": "string"
+                    },
+                    "content": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/items-new-mandatory-headers": {
+      "get": {
+        "tags": ["ItemsHeader"],
+        "summary": "Retrieve a new item with mandatory headers",
+        "parameters": [
+          {
+            "name": "itemId",
+            "in": "query",
+            "required": true,
+            "description": "ID of the item to retrieve",
+            "schema": {
+              "type": "string",
+              "example": "67890"
+            }
+          },
+          {
+            "name": "X-Auth-Token",
+            "in": "header",
+            "description": "Authentication token",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "Bearer abcdef12345"
+            }
+          },
+          {
+            "name": "X-Correlation-ID",
+            "in": "header",
+            "description": "Correlation ID for tracking requests",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "correlation-12345"
+            }
+          },
+          {
+            "name": "X-Optional-Header",
+            "in": "header",
+            "description": "Optional header",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "example": "optional-header-value"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "New item retrieved successfully"
+          },
+          "400": {
+            "description": "Invalid request"
+          }
+        }
+      }
+    }
+  }
+}

package/tests/functional-tests/test-sample-k6-scripts/fixtures/schema_with_no_variables.json

@@ -0,0 +1,32 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Simple API",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/example": {
+      "get": {
+        "summary": "Retrieve example data",
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string",
+                      "example": "Hello, World!"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/tests/functional-tests/test-sample-k6-scripts/sampleK6Scripts.test.ts

@@ -0,0 +1,248 @@
+import fs from 'fs'
+import os from 'os'
+import path from 'path'
+import { afterAll, beforeAll, describe, expect, it } from 'vitest'
+import { Mode } from '../../../src/constants'
+import generator from '../../../src/generator'
+import {
+  loadFixture,
+  mkdtemp,
+  readFile,
+  replaceSpacesAndNewLineToSingleSpace,
+  rmdir,
+  writeFile,
+} from '../helper'
+
+describe('validate sample k6 script', async () => {
+  const schemaNameToAssertionsMap = {
+    'schema_with_no_variables.json': {
+      common: {
+        expected_string: [],
+        unexpected_string: [],
+      },
+      [Mode.TAGS]: {
+        expected_number_of_files: 3,
+        expected_string: [],
+        unexpected_string: [],
+      },
+      [Mode.SINGLE]: {
+        expected_number_of_files: 2,
+        expected_string: [],
+        unexpected_string: [],
+      },
+      [Mode.SPLIT]: {
+        expected_number_of_files: 3,
+        expected_string: [],
+        unexpected_string: [],
+      },
+    },
+    'schema_with_examples.json': {
+      common: {
+        expected_string: [
+          `let id, postItemsIdBody, putItemsIdBody, patchItemsIdBody, postItemsFormUrlEncodedBody, postItemsFormDataBody, params, userId, postId, headers;`,
+          `id = "12345-getItemById";`,
+          `id = "123450-createItemById";`,
+          `id = "123450-updateItemById";`,
+          `id = "123450-patchItemById";`,
+          `id = "123450-deleteItemById";`,
+          `id = "123450-checkItemById";`,
+          `userId = "`, // This is generated as random word using faker hence to validating the value
+          `postId = "`, // This is generated as random word using faker hence to validating the value
+          `postItemsIdBody = { name: "Sample Item", description: "This is a sample description for the item.", };`,
+          `putItemsIdBody = { name: "Updated Item Name", description: "Updated description for the item.", };`,
+          `patchItemsIdBody = { name: "Partially Updated Item Name", };`,
+          `postItemsFormUrlEncodedBody = { name: "Form Encoded Item", description: "Description for form-urlencoded item.", };`,
+          `postItemsFormDataBody = { name: "Form Data Item", };`,
+          `params = { id: "123450-getItemByIdWithHeader", };`,
+          `params = { itemId: "67890", };`,
+          `headers = { "X-Auth-Token": "Bearer abcdef12345", "X-Correlation-ID": "correlation-12345", };`,
+        ],
+        unexpected_string: [],
+      },
+      [Mode.TAGS]: {
+        expected_number_of_files: 6,
+        expected_string: [
+          `import { ItemsClient } from "./items.ts";`,
+          `import { ItemsFormClient } from "./items-form.ts";`,
+          `import { ItemsHeaderClient } from "./items-header.ts";`,
+          `import { UsersPostsClient } from "./users-posts.ts";`,
+          `const itemsClient = new ItemsClient({ baseUrl });`,
+          `const itemsFormClient = new ItemsFormClient({ baseUrl });`,
+          `const itemsHeaderClient = new ItemsHeaderClient({ baseUrl });`,
+          `const usersPostsClient = new UsersPostsClient({ baseUrl });`,
+        ],
+        unexpected_string: [
+          `import { DefaultClient } from "./default.ts";`,
+          `const defaultClient = new DefaultClient({ baseUrl });`,
+        ],
+      },
+      [Mode.SINGLE]: {
+        expected_number_of_files: 2,
+        expected_string: [
+          `const comprehensiveAPIClient = new ComprehensiveAPIClient({ baseUrl });`,
+        ],
+        unexpected_string: [
+          `import { ItemsClient } from "./items.ts";`,
+          `import { ItemsFormClient } from "./items-form.ts";`,
+          `import { ItemsHeaderClient } from "./items-header.ts";`,
+          `import { UsersPostsClient } from "./users-posts.ts";`,
+          `const itemsClient = new ItemsClient({ baseUrl });`,
+          `const itemsFormClient = new ItemsFormClient({ baseUrl });`,
+          `const itemsHeaderClient = new ItemsHeaderClient({ baseUrl });`,
+          `const usersPostsClient = new UsersPostsClient({ baseUrl });`,
+        ],
+      },
+      [Mode.SPLIT]: {
+        expected_number_of_files: 3,
+        expected_string: [
+          `const comprehensiveAPIClient = new ComprehensiveAPIClient({ baseUrl });`,
+        ],
+        unexpected_string: [
+          `import { ItemsClient } from "./items.ts";`,
+          `import { ItemsFormClient } from "./items-form.ts";`,
+          `import { ItemsHeaderClient } from "./items-header.ts";`,
+          `import { UsersPostsClient } from "./users-posts.ts";`,
+          `const itemsClient = new ItemsClient({ baseUrl });`,
+          `const itemsFormClient = new ItemsFormClient({ baseUrl });`,
+          `const itemsHeaderClient = new ItemsHeaderClient({ baseUrl });`,
+          `const usersPostsClient = new UsersPostsClient({ baseUrl });`,
+        ],
+      },
+    },
+    'schema_using_ref_models.json': {
+      expected_number_of_files: 3,
+      common: {
+        expected_string: [
+          `let id, itemBase, updatedItem, patchItem, formUrlEncodedItem, formDataItem, params, headers, userId, postId;`,
+          `id = "12345-getItemById";`,
+          `userId = "`, // This is generated as random word using faker hence to validating the value
+          `postId = "`, // This is generated as random word using faker hence to validating the value
+          `itemBase = { name: "Sample Item", description: "This is a sample description for the item.", };`,
+          `updatedItem = { name: "Updated Item Name", description: "Updated description for the item.", };`,
+          `patchItem = { name: "Partially Updated Item Name", };`,
+          `formUrlEncodedItem = { name: "Form Encoded Item", description: "Description for form-urlencoded item.", };`,
+          `formDataItem = { name: "Form Data Item", };`,
+          `params = { id: "123450-getItemByIdWithHeader", };`,
+          `headers = { "X-Client-ID": "client-123", };`,
+          `params = { itemId: "67890", };`,
+          `headers = { "X-Auth-Token": "Bearer abcdef12345", "X-Correlation-ID": "correlation-12345", };`,
+        ],
+        unexpected_string: [],
+      },
+      [Mode.TAGS]: {
+        expected_number_of_files: 6,
+        expected_string: [
+          `import { ItemsClient } from "./items.ts";`,
+          `import { ItemsFormClient } from "./items-form.ts";`,
+          `import { ItemsHeaderClient } from "./items-header.ts";`,
+          `import { DefaultClient } from "./default.ts";`,
+          `const itemsClient = new ItemsClient({ baseUrl });`,
+          `const itemsFormClient = new ItemsFormClient({ baseUrl });`,
+          `const itemsHeaderClient = new ItemsHeaderClient({ baseUrl });`,
+          `const defaultClient = new DefaultClient({ baseUrl });`,
+        ],
+        unexpected_string: [
+          `import { UsersPostsClient } from "./users-posts.ts";`,
+          `const usersPostsClient = new UsersPostsClient({ baseUrl });`,
+        ],
+      },
+      [Mode.SINGLE]: {
+        expected_number_of_files: 2,
+        expected_string: [],
+        unexpected_string: [
+          `import { ItemsClient } from "./items.ts";`,
+          `import { ItemsFormClient } from "./items-form.ts";`,
+          `import { ItemsHeaderClient } from "./items-header.ts";`,
+          `import { DefaultClient } from "./default.ts";`,
+          `const itemsClient = new ItemsClient({ baseUrl });`,
+          `const itemsFormClient = new ItemsFormClient({ baseUrl });`,
+          `const itemsHeaderClient = new ItemsHeaderClient({ baseUrl });`,
+          `const defaultClient = new DefaultClient({ baseUrl });`,
+        ],
+      },
+      [Mode.SPLIT]: {
+        expected_number_of_files: 3,
+        expected_string: [],
+        unexpected_string: [],
+      },
+    },
+  }
+
+  for (const [schemaName, assertions] of Object.entries(
+    schemaNameToAssertionsMap
+  )) {
+    describe(`test ${schemaName} schema`, () => {
+      let tempDir: string, openapiSchemaPath: string
+
+      beforeAll(async () => {
+        tempDir = await mkdtemp(
+          path.join(os.tmpdir(), `example-k6-script-test-${schemaName}`)
+        )
+        openapiSchemaPath = path.join(tempDir, 'openapi-schema.json')
+        await writeFile(
+          openapiSchemaPath,
+          JSON.stringify(
+            loadFixture(path.join(__dirname, 'fixtures', schemaName))
+          )
+        )
+      })
+
+      afterAll(async () => {
+        await rmdir(tempDir, { recursive: true })
+      })
+
+      for (const mode of Object.values(Mode)) {
+        it(`should generate sample k6 script with correct example values in ${mode} mode for ${schemaName}`, async () => {
+          const generatedClientPath = path.join(
+            tempDir,
+            mode,
+            `generated-client`
+          )
+
+          await generator({
+            openApiPath: openapiSchemaPath,
+            outputDir: generatedClientPath,
+            mode,
+            shouldGenerateSampleK6Script: true,
+          })
+
+          const generatedFiles = fs.readdirSync(generatedClientPath)
+          expect(generatedFiles.length).toBe(
+            assertions[mode].expected_number_of_files
+          )
+
+          // Get the k6 script file
+          const k6ScriptFile = generatedFiles.find((file) =>
+            file.includes('k6-script.sample.ts')
+          )
+          expect(k6ScriptFile).toBeDefined()
+
+          const k6ScriptFilePath = path.join(generatedClientPath, k6ScriptFile!)
+          const k6ScriptContent = await readFile(k6ScriptFilePath, 'utf-8')
+
+          const allExpectedStrings = [
+            ...assertions.common.expected_string,
+            ...assertions[mode].expected_string,
+          ]
+
+          for (const expectedString of allExpectedStrings) {
+            expect(
+              replaceSpacesAndNewLineToSingleSpace(k6ScriptContent)
+            ).toContain(expectedString)
+          }
+
+          const allUnexpectedStrings = [
+            ...assertions.common.unexpected_string,
+            ...assertions[mode].unexpected_string,
+          ]
+
+          for (const unexpectedString of allUnexpectedStrings) {
+            expect(
+              replaceSpacesAndNewLineToSingleSpace(k6ScriptContent)
+            ).not.toContain(unexpectedString)
+          }
+        })
+      }
+    })
+  }
+})