@grafana/openapi-to-k6 0.1.0

package/src/type.d.ts

@@ -0,0 +1,34 @@
+export interface PackageDetails {
+  name: string
+  commandName: string
+  description: string
+  version: string
+}
+
+export interface SchemaDetails {
+  title: string
+}
+
+export interface AnalyticsData {
+  generatedRequestsCount: {
+    post: number
+    put: number
+    get: number
+    delete: number
+    patch: number
+    head: number
+  }
+  openApiSpecVersion: string
+  toolVersion: string
+  anonymousUserId: string
+  osPlatform?: string
+  osArch?: string
+  osType?: string
+}
+
+export interface GenerateK6SDKOptions {
+  openApiPath: string
+  outputDir: string
+  shouldGenerateSampleK6Script?: boolean
+  analyticsData?: AnalyticsData
+}

package/tests/e2e/k6Script.ts

@@ -0,0 +1,77 @@
+/* eslint-disable import/no-unresolved */
+import { check } from 'k6'
+import { createComprehensiveAPI } from './sdk.ts'
+/* eslint-enable import/no-unresolved */
+
+const baseUrl = 'http://localhost:3000'
+const client = createComprehensiveAPI({ baseUrl })
+
+export const options = {
+  thresholds: {
+    // the rate of successful checks should be higher than 90%
+    checks: ['rate>=1'],
+  },
+}
+
+function checkResponseStatus(response, expectedStatus) {
+  const result = check(response, {
+    [`status is ${expectedStatus}`]: (r) => r.status === expectedStatus,
+  })
+
+  if (!result) {
+    console.error(
+      `Check failed! Expected status ${expectedStatus} but got ${response.status}. Following is the response:`
+    )
+    console.log(JSON.stringify(response, null, 2))
+  }
+}
+
+export default function () {
+  const getResponseData = client.getItemsId('1')
+  checkResponseStatus(getResponseData.response, 200)
+
+  const postResponseData = client.postItemsId('1', {
+    name: 'string',
+  })
+  checkResponseStatus(postResponseData.response, 201)
+
+  const putResponseData = client.putItemsId('1', {
+    description: 'string',
+  })
+  checkResponseStatus(putResponseData.response, 200)
+
+  const deleteResponseData = client.deleteItemsId('1')
+  checkResponseStatus(deleteResponseData.response, 204)
+
+  const patchResponseData = client.patchItemsId('1', {
+    name: 'string',
+  })
+  checkResponseStatus(patchResponseData.response, 200)
+
+  const headResponseData = client.headItemsId('1')
+  checkResponseStatus(headResponseData.response, 200)
+
+  const postFormUrlEncodedResponseData = client.postItemsFormUrlEncoded({
+    name: 'string',
+  })
+  checkResponseStatus(postFormUrlEncodedResponseData.response, 201)
+  // Should add x-www-form-urlencoded content type header in request
+  check(postFormUrlEncodedResponseData.response, {
+    'has x-www-form-urlencoded content type header': (r) =>
+      r.request.headers['Content-Type'][0] ===
+      'application/x-www-form-urlencoded',
+  })
+
+  const postFormDataResponseData = client.postItemsFormData({
+    name: 'string',
+  })
+  checkResponseStatus(postFormDataResponseData.response, 201)
+
+  // Should add multipart/form-data content type header in request with boundary
+  check(postFormDataResponseData.response, {
+    'has multipart/form-data content type header with bounday': (r) =>
+      r.request.headers['Content-Type'][0].includes(
+        'multipart/form-data; boundary=---'
+      ),
+  })
+}

package/tests/e2e/schema.json

@@ -0,0 +1,289 @@
+{
+  "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": {
+        "summary": "Get an item by ID",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "ID of the item to retrieve",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "detail",
+            "in": "query",
+            "required": false,
+            "description": "Whether to return detailed information",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        }
+      },
+      "post": {
+        "summary": "Create an item by ID",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "ID of the item to create",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "description": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Item created successfully"
+          }
+        }
+      },
+      "put": {
+        "summary": "Update an item by ID",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "ID of the item to update",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "description": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Item updated successfully"
+          }
+        }
+      },
+      "patch": {
+        "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"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Item partially updated"
+          }
+        }
+      },
+      "delete": {
+        "summary": "Delete an item by ID",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "ID of the item to delete",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Item deleted successfully"
+          }
+        }
+      },
+      "head": {
+        "summary": "Check if item exists",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "ID of the item to check",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Item exists"
+          },
+          "404": {
+            "description": "Item not found"
+          }
+        }
+      }
+    },
+    "/items-form-url-encoded": {
+      "post": {
+        "summary": "Create an item using form-urlencoded data",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "description": {
+                    "type": "string"
+                  }
+                },
+                "required": ["name"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Item created successfully"
+          }
+        }
+      }
+    },
+    "/items-form-data": {
+      "post": {
+        "summary": "Create an item using form-data",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  }
+                },
+                "required": ["file", "name"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Item created with file upload"
+          }
+        }
+      }
+    },
+    "/items-header": {
+      "get": {
+        "summary": "Get an item with custom headers",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "query",
+            "required": true,
+            "description": "ID of the item to retrieve",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "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"
+            }
+          },
+          {
+            "name": "X-Request-ID",
+            "in": "header",
+            "description": "Unique request identifier",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ]
+      }
+    }
+  }
+}

package/tests/functional-tests/fixtures/schemas/basic_schema.json

@@ -0,0 +1,41 @@
+{
+  "openapi_schema": {
+    "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!"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "expected_sdk": {
+    "fileName": "simpleAPI.ts",
+    "expectedSubstrings": [
+      "export const createSimpleAPI =",
+      "return { getExample };"
+    ]
+  }
+}

package/tests/functional-tests/fixtures/schemas/form_data_schema.json

@@ -0,0 +1,94 @@
+{
+  "openapi_schema": {
+    "openapi": "3.0.0",
+    "info": {
+      "title": "Form Data API",
+      "version": "1.0.0"
+    },
+    "paths": {
+      "/upload": {
+        "post": {
+          "summary": "Upload files and data",
+          "description": "This endpoint accepts form data and file uploads.",
+          "requestBody": {
+            "required": true,
+            "content": {
+              "multipart/form-data": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "file": {
+                      "type": "string",
+                      "format": "binary",
+                      "description": "File to upload"
+                    },
+                    "description": {
+                      "type": "string",
+                      "description": "Description of the file"
+                    },
+                    "userId": {
+                      "type": "string",
+                      "description": "User ID associated with the upload"
+                    }
+                  },
+                  "required": ["file", "userId"]
+                }
+              }
+            }
+          },
+          "responses": {
+            "200": {
+              "description": "File uploaded successfully",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "type": "object",
+                    "properties": {
+                      "success": {
+                        "type": "boolean",
+                        "example": true
+                      },
+                      "message": {
+                        "type": "string",
+                        "example": "File uploaded successfully"
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            "400": {
+              "description": "Bad Request",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "type": "object",
+                    "properties": {
+                      "success": {
+                        "type": "boolean",
+                        "example": false
+                      },
+                      "error": {
+                        "type": "string",
+                        "example": "Invalid file or data"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "expected_sdk": {
+    "fileName": "formDataAPI.ts",
+    "expectedSubstrings": [
+      "export const createFormDataAPI = (clientOptions: CreateFormDataAPIOptions) => {",
+      "const formData = new FormData();\n    formData.append(\"file\", postUploadBody.file);\n    if (postUploadBody.description !== undefined) {\n      formData.append(\"description\", postUploadBody.description);\n    }\n    formData.append(\"userId\", postUploadBody.userId);",
+      "const url = new URL(cleanBaseUrl + `/upload`);",
+      "const response = http.request(\"POST\", url.toString(), formData.body(), {\n      ...mergedRequestParameters,\n      headers: {\n        \"Content-Type\": \"multipart/form-data; boundary=\" + formData.boundary,\n        ...mergedRequestParameters?.headers,\n      },\n    });"
+    ]
+  }
+}

package/tests/functional-tests/fixtures/schemas/form_url_encoded_data_schema.json

@@ -0,0 +1,93 @@
+{
+  "openapi_schema": {
+    "openapi": "3.0.0",
+    "info": {
+      "title": "Form URL Encoded API",
+      "version": "1.0.0"
+    },
+    "paths": {
+      "/submit-form": {
+        "post": {
+          "summary": "Submit form data",
+          "description": "This endpoint accepts form URL-encoded data.",
+          "requestBody": {
+            "required": true,
+            "content": {
+              "application/x-www-form-urlencoded": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "description": "Name of the user"
+                    },
+                    "age": {
+                      "type": "integer",
+                      "description": "Age of the user"
+                    },
+                    "email": {
+                      "type": "string",
+                      "format": "email",
+                      "description": "Email address of the user"
+                    }
+                  },
+                  "required": ["name", "email"]
+                }
+              }
+            }
+          },
+          "responses": {
+            "200": {
+              "description": "Form submitted successfully",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "type": "object",
+                    "properties": {
+                      "success": {
+                        "type": "boolean",
+                        "example": true
+                      },
+                      "message": {
+                        "type": "string",
+                        "example": "Form submitted successfully"
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            "400": {
+              "description": "Bad Request",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "type": "object",
+                    "properties": {
+                      "success": {
+                        "type": "boolean",
+                        "example": false
+                      },
+                      "error": {
+                        "type": "string",
+                        "example": "Invalid input data"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "expected_sdk": {
+    "fileName": "formURLEncodedAPI.ts",
+    "expectedSubstrings": [
+      "export const createFormURLEncodedAPI = (\n  clientOptions: CreateFormURLEncodedAPIOptions,\n) => {",
+      "const url = new URL(cleanBaseUrl + `/submit-form`);",
+      "const response = http.request(\n      \"POST\",\n      url.toString(),\n      JSON.stringify(postSubmitFormBody),\n      {\n        ...mergedRequestParameters,\n        headers: {\n          \"Content-Type\": \"application/x-www-form-urlencoded\",\n          ...mergedRequestParameters?.headers,\n        },\n      },\n    );"
+    ]
+  }
+}