(feature) Add testing product (#6)

backend/package.json

@@ -19,6 +19,7 @@
   "dependencies": {
     "@aws-sdk/client-ec2": "^3.142.0",
     "@aws-sdk/client-pricing": "^3.142.0",
+    "@types/newman": "^5.3.0",
     "@types/async-retry": "^1.4.4",
     "async-retry": "^1.3.3",
     "aws-sdk": "^2.1189.0",
@@ -29,6 +30,7 @@
     "express-session": "^1.17.3",
     "js-yaml": "^4.1.0",
     "multer": "^1.4.5-lts.1",
+    "newman": "^5.3.2",
     "node-schedule": "^2.1.0",
     "node-ssh": "^13.0.0",
     "openapi-request-validator": "^12.0.0",

backend/src/api/tests/index.ts

@@ -0,0 +1,12 @@
+import { Request, Response } from "express";
+import ApiResponseHandler from "api-response-handler";
+import { runTest } from "~/services/testing/runTests";
+
+export const runTestHandler = async (
+  req: Request,
+  res: Response
+): Promise<void> => {
+  console.log(req.body);
+  runTest(req.body.test);
+  await ApiResponseHandler.success(res, null);
+};

backend/src/index.ts

@@ -35,6 +35,7 @@ import {
   aws_os_choices,
   setup_connection,
 } from "./api/setup";
+import { runTestHandler } from "./api/tests";
 import {
   get_connection_for_uuid,
   get_ssh_key_for_connection_uuid,
@@ -102,6 +103,8 @@ app.get(
 );
 app.post("/api/v1/update_connection", update_connection);
 
+app.post("/api/v1/test/run", runTestHandler);
+
 const main = async () => {
   try {
     const datasource = await AppDataSource.initialize();

backend/src/models/api-endpoint-test.ts

@@ -0,0 +1,28 @@
+import {
+  BaseEntity,
+  Column,
+  Entity,
+  JoinColumn,
+  ManyToOne,
+  PrimaryGeneratedColumn,
+} from "typeorm";
+import { ApiEndpoint } from "models/api-endpoint";
+
+@Entity()
+export class ApiEndpointTest extends BaseEntity {
+  @PrimaryGeneratedColumn("uuid")
+  uuid: string;
+
+  @Column({ nullable: false })
+  name: string;
+
+  @Column({ type: "jsonb", nullable: true })
+  tags: string[];
+
+  @Column({ type: "jsonb", nullable: true })
+  requests: Request[];
+
+  @ManyToOne(() => ApiEndpoint)
+  @JoinColumn()
+  apiEndpoint: ApiEndpoint;
+}

backend/src/services/get-endpoints/index.ts

@@ -118,6 +118,7 @@ export class GetEndpointsService {
       return {
         ...endpoint,
         traces: [...traces],
+        tests: [],
         firstDetected: firstDetected?.createdAt,
         lastActive: lastActive?.createdAt,
       };

backend/src/services/testing/runTests.ts

@@ -0,0 +1,61 @@
+import newman from "newman";
+import {
+  CollectionDefinition,
+  RequestDefinition,
+  RequestBodyDefinition,
+} from "postman-collection";
+import { RequestBodyType } from "../../../../common/src/testing/enums";
+import { Request } from "../../../../common/src/testing/types";
+import { Test } from "../../../../common/src/testing/types";
+
+const requestToItem = (e: Request, i: number) => {
+  const event = e.tests.trim()
+    ? [
+        {
+          listen: "test",
+          script: {
+            type: "text/javascript",
+            exec: e.tests.split("\n"),
+          },
+        },
+      ]
+    : [];
+  let body: RequestBodyDefinition = { mode: "raw" };
+  if (e.body.type == RequestBodyType.JSON) {
+    body.raw = e.body.data as string;
+  }
+  let url: string = e.url;
+  if (e.params.length > 0) {
+    url = `${url}?${e.params.map((p) => `${p.key}=${p.value}`).join("&")}`;
+  }
+  let item = {
+    name: `Request ${i}`,
+    event: event,
+    request: {
+      url: e.url,
+      method: e.method,
+      header: e.headers,
+      body: body,
+    } as RequestDefinition,
+  };
+  return item;
+};
+
+export const runTest = (e: Test) => {
+  const items = e.requests.map(requestToItem);
+  const collection: CollectionDefinition = {
+    info: {
+      name: "Sample Postman Collection",
+    },
+    item: items,
+  };
+  const res = newman.run(
+    {
+      collection,
+    },
+    (a, b) => {
+      console.log(JSON.stringify(a, null, 4));
+      console.log(JSON.stringify(b, null, 4));
+    }
+  );
+};