@grafana/openapi-to-k6 0.2.6 → 0.3.0

package/tests/e2e/schema.json

@@ -17,7 +17,8 @@
             "required": true,
             "description": "ID of the item to retrieve",
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "12345"
             }
           },
           {
@@ -27,7 +28,8 @@
             "description": "Whether to return detailed information",
             "schema": {
               "type": "boolean",
-              "default": false
+              "default": false,
+              "example": true
             }
           }
         ],
@@ -47,7 +49,8 @@
             "required": true,
             "description": "ID of the item to create",
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "12345"
             }
           }
         ],
@@ -59,10 +62,12 @@
                 "type": "object",
                 "properties": {
                   "name": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "Sample Item"
                   },
                   "description": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "This is a sample description for the item."
                   }
                 }
               }
@@ -85,7 +90,8 @@
             "required": true,
             "description": "ID of the item to update",
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "12345"
             }
           }
         ],
@@ -97,10 +103,12 @@
                 "type": "object",
                 "properties": {
                   "name": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "Updated Item Name"
                   },
                   "description": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "Updated description for the item."
                   }
                 }
               }
@@ -123,7 +131,8 @@
             "required": true,
             "description": "ID of the item to partially update",
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "12345"
             }
           }
         ],
@@ -135,7 +144,8 @@
                 "type": "object",
                 "properties": {
                   "name": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "Partially Updated Item Name"
                   }
                 }
               }
@@ -158,7 +168,8 @@
             "required": true,
             "description": "ID of the item to delete",
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "12345"
             }
           }
         ],
@@ -178,7 +189,8 @@
             "required": true,
             "description": "ID of the item to check",
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "12345"
             }
           }
         ],
@@ -204,10 +216,12 @@
                 "type": "object",
                 "properties": {
                   "name": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "Form Encoded Item"
                   },
                   "description": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "Description for form-urlencoded item."
                   }
                 },
                 "required": ["name"]
@@ -234,7 +248,8 @@
                 "type": "object",
                 "properties": {
                   "name": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "Form Data Item"
                   }
                 },
                 "required": ["file", "name"]
@@ -260,7 +275,8 @@
             "required": true,
             "description": "ID of the item to retrieve",
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "12345"
             }
           }
         ],
@@ -279,7 +295,8 @@
             "description": "Client ID for the request",
             "required": true,
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "client-123"
             }
           },
           {
@@ -288,11 +305,111 @@
             "description": "Unique request identifier",
             "required": false,
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "req-56789"
             }
           }
         ]
       }
+    },
+    "/users/{userId}/posts/{postId}": {
+      "get": {
+        "operationId": "getUserPost",
+        "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/helper.ts

@@ -0,0 +1,16 @@
+import fs from 'fs'
+import { promisify } from 'util'
+
+export const writeFile = promisify(fs.writeFile)
+export const readFile = promisify(fs.readFile)
+export const mkdtemp = promisify(fs.mkdtemp)
+export const rmdir = promisify(fs.rmdir)
+
+export const loadFixture = (filePath: string) => {
+  const data = fs.readFileSync(filePath, 'utf-8')
+  return JSON.parse(data)
+}
+
+export const replaceSpacesAndNewLineToSingleSpace = (input: string): string => {
+  return input.replace(/\s+/g, ' ')
+}

package/tests/functional-tests/test-generator/generator.test.ts

@@ -0,0 +1,154 @@
+import fs from 'fs'
+import os from 'os'
+import path from 'path'
+import {
+  afterAll,
+  afterEach,
+  beforeAll,
+  beforeEach,
+  describe,
+  expect,
+  it,
+} from 'vitest'
+import { Mode } from '../../../src/constants'
+import generator from '../../../src/generator'
+
+import {
+  loadFixture,
+  mkdtemp,
+  readFile,
+  replaceSpacesAndNewLineToSingleSpace,
+  rmdir,
+  writeFile,
+} from '../helper'
+
+const commonSubstringsForAllSDK = [
+  'Automatically generated by',
+  'Do not edit manually',
+  'Service version',
+  'const mergedRequestParameters = this._mergeRequestParameters( requestParameters || {}, this.commonRequestParameters, );',
+  'try { data = response.json(); } catch { data = response.body; }',
+  'return { response, data, };',
+]
+
+const commonSubstringsForK6SampleScript = [`const baseUrl = "<BASE_URL>";`]
+
+describe('generator', () => {
+  let tempDir: string, schemaDirectory: string
+  const allFixtures = fs.readdirSync(path.join(__dirname, 'fixtures'))
+
+  beforeAll(async () => {
+    tempDir = await mkdtemp(path.join(os.tmpdir(), 'sdk-generator-'))
+  })
+
+  afterAll(async () => {
+    await rmdir(tempDir, { recursive: true })
+  })
+
+  for (const fixtureName of allFixtures) {
+    describe(`test ${fixtureName} OpenAPI schema`, () => {
+      let openApiPath: string, generatedSchemaPath: string
+      const fixture = loadFixture(path.join(__dirname, 'fixtures', fixtureName))
+
+      beforeEach(async () => {
+        schemaDirectory = await mkdtemp(
+          path.join(tempDir, fixtureName.replace('.', '-'))
+        )
+        // Write the OpenAPI schema to a file
+
+        openApiPath = path.join(schemaDirectory, 'openapi-schema.json')
+
+        await writeFile(openApiPath, JSON.stringify(fixture['openapi_schema']))
+
+        generatedSchemaPath = path.join(schemaDirectory, 'generated-schema')
+      })
+
+      afterEach(async () => {
+        await rmdir(schemaDirectory, { recursive: true })
+      })
+
+      it(`should generate SDK client from the OpenAPI schema`, async () => {
+        const expectedGeneratedCode = fixture['expected_sdk']
+
+        await generator({
+          openApiPath,
+          outputDir: generatedSchemaPath,
+          mode: Mode.SINGLE,
+        })
+
+        const generatedFiles = fs.readdirSync(generatedSchemaPath)
+        expect(generatedFiles.length).toBe(1)
+        expect(generatedFiles[0]).toBeDefined()
+        const fileName = path.basename(generatedFiles[0]!)
+        expect(fileName).toBe(expectedGeneratedCode.fileName)
+        const generatedFilePath = path.join(
+          generatedSchemaPath,
+          generatedFiles[0]!
+        )
+        const generatedContent = await readFile(generatedFilePath, 'utf-8')
+
+        for (const expectedString of [
+          ...expectedGeneratedCode['expectedSubstrings'],
+          ...commonSubstringsForAllSDK,
+        ]) {
+          expect(
+            replaceSpacesAndNewLineToSingleSpace(generatedContent)
+          ).toContain(expectedString)
+        }
+      })
+
+      it('should generate a sample K6 script', async () => {
+        await generator({
+          openApiPath,
+          outputDir: generatedSchemaPath,
+          shouldGenerateSampleK6Script: true,
+          mode: Mode.SINGLE,
+        })
+
+        const generatedFiles = fs.readdirSync(generatedSchemaPath)
+        expect(generatedFiles.length).toBe(2)
+        const k6ScriptFile = generatedFiles.find((file) =>
+          file.includes('k6-script')
+        )
+        expect(k6ScriptFile).toBeDefined()
+        expect(k6ScriptFile).toBe('k6-script.sample.ts')
+
+        const generatedFilePath = path.join(generatedSchemaPath, k6ScriptFile!)
+        const generatedContent = await readFile(generatedFilePath, 'utf-8')
+
+        for (const expectedString of [...commonSubstringsForK6SampleScript]) {
+          expect(generatedContent).toContain(expectedString)
+        }
+      })
+
+      it('should not contain types in main file when using split mode', async () => {
+        await generator({
+          openApiPath,
+          outputDir: generatedSchemaPath,
+          shouldGenerateSampleK6Script: true,
+          mode: Mode.SPLIT,
+        })
+        const expectedGeneratedCode = fixture['expected_sdk']
+        const generatedFiles = fs.readdirSync(generatedSchemaPath)
+
+        expect(generatedFiles.length).toBe(3)
+
+        const clientFile = generatedFiles.find((file) =>
+          file.includes(expectedGeneratedCode.fileName)
+        )
+        const schemaFile = generatedFiles.find((file) =>
+          file.includes('.schemas.ts')
+        )
+
+        expect(clientFile).toBeDefined()
+        expect(schemaFile).toBeDefined()
+
+        const generatedFilePath = path.join(generatedSchemaPath, clientFile!)
+        const generatedContent = await readFile(generatedFilePath, 'utf-8')
+
+        expect(generatedContent).not.toContain('export type')
+        expect(generatedContent).not.toContain('export interface')
+      })
+    })
+  }
+})