feat: add generate workflow from swagger or openai

jellydn · Sep 23, 2023 · e8d9537 · e8d9537
1 parent ba0529b
commit e8d9537
Show file tree

Hide file tree

Showing 6 changed files with 147 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,11 @@
-<h1 align="center">StepCI Demo for Fastify API Testing 👋</h1>
+<h1 align="center">StepCI Demo for E2E Testing 👋</h1>
 
 ## Overview
 
-This repository provides a guide to set up continuous integration for a [Fastify API](https://fastify.dev/docs/latest/Reference/TypeScript/) using [Step CI](https://stepci.com/#get-started).
+This repository provides a guide to set up continuous integration for a [Fastify](https://fastify.dev/docs/latest/Reference/TypeScript/) using [Step CI](https://stepci.com/#get-started).
 
 ## Prerequisites
 
-- [Node.js LTS](https://nodejs.org/en/)
 - [Bun](https://bun.sh/)
 
 ## Usage

diff --git a/index.ts b/index.ts
@@ -20,14 +20,14 @@ await server.register(swagger, {
   swagger: {
     info: {
       title: "Test swagger",
-      description: "Testing the Fastify swagger API",
+      description: "This is the documentation of the API",
       version: "0.1.0",
     },
     externalDocs: {
       url: "https://swagger.io",
       description: "Find more info here",
     },
-    host: "localhost",
+    host: "localhost:3000",
     schemes: ["http", "https"],
     consumes: ["application/json"],
     produces: ["application/json"],
@@ -43,6 +43,12 @@ await server.register(swaggerUI, {
   staticCSP: true,
 });
 
+// Health check
+server.get("/", async (_request, _reply) => {
+  return { ok: true };
+});
+
+
 // Declare a route
 server.get<{
   Querystring: { name: string };
@@ -74,10 +80,6 @@ server.get(
   }
 );
 
-server.get("/", async (_request, _reply) => {
-  return { ok: true };
-});
-
 const start = async () => {
   try {
     await server.listen({ port: 3000 });

diff --git a/package.json b/package.json
@@ -7,6 +7,7 @@
     "ci": "run-p --race test:*",
     "test:server": "NODE_DEVELOPMENT=test tsx index.ts",
     "test:e2e": "wait-on -l tcp:3000 && stepci run workflow.yml",
+    "test:generate": "stepci generate ./specs/openapi.yaml ./specs/generated.yaml",
     "start": "tsx index.ts"
   },
   "dependencies": {

diff --git a/specs/generated.yaml b/specs/generated.yaml
@@ -0,0 +1,35 @@
+version: "1.0"
+name: Test swagger
+config:
+  http:
+    baseURL: http://localhost:3000
+tests:
+  default:
+    name: Default
+    steps:
+      - http:
+          url: /
+          method: GET
+          schema:
+            type: object
+            properties:
+              ok: bool
+      - http:
+          url: /hello
+          method: GET
+          check:
+            status: 200
+            schema:
+              type: object
+              description: Successful response with a JSON object
+      - http:
+          url: /ping
+          method: GET
+          check:
+            status: 200
+            schema:
+              type: object
+              properties:
+                pong:
+                  type: string
+components: {}
diff --git a/specs/openapi.yaml b/specs/openapi.yaml
@@ -0,0 +1,40 @@
+openapi: 3.0.1
+info:
+  title: Test swagger
+  description: Testing the Fastify swagger API
+  version: 0.1.0
+externalDocs:
+  description: Find more info here
+  url: https://swagger.io
+servers:
+  - url: http://localhost:3000
+paths:
+  /:
+    get:
+      responses:
+        200:
+          description: Default Response
+          content: {}
+  /hello:
+    get:
+      responses:
+        200:
+          description: Successful response with a JSON object
+          content:
+            application/json:
+              schema:
+                type: string
+                description: Successful response with a JSON object
+  /ping:
+    get:
+      responses:
+        200:
+          description: Default Response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  pong:
+                    type: string
+components: {}
diff --git a/specs/swagger.json b/specs/swagger.json
@@ -0,0 +1,61 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "Test swagger",
+    "description": "Testing the Fastify swagger API",
+    "version": "0.1.0"
+  },
+  "definitions": {},
+  "paths": {
+    "/": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "Default Response"
+          }
+        }
+      }
+    },
+    "/hello": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "Default Response"
+          }
+        }
+      }
+    },
+    "/ping": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "Default Response",
+            "schema": {
+              "type": "object",
+              "properties": {
+                "pong": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "host": "localhost:3000",
+  "schemes": [
+    "http",
+    "https"
+  ],
+  "consumes": [
+    "application/json"
+  ],
+  "produces": [
+    "application/json"
+  ],
+  "externalDocs": {
+    "url": "https://swagger.io",
+    "description": "Find more info here"
+  }
+}