mirror of
https://github.com/spacebarchat/server.git
synced 2024-09-21 10:11:34 +02:00
✨ route middleware test option
This commit is contained in:
parent
a7bf295591
commit
a3484e64e4
@ -2,6 +2,7 @@ import { traverseDirectory } from "lambert-server";
|
||||
import path from "path";
|
||||
import express from "express";
|
||||
import * as RouteUtility from "../dist/util/route";
|
||||
import { RouteOptions } from "../dist/util/route";
|
||||
const Router = express.Router;
|
||||
|
||||
const routes = new Map<string, RouteUtility.RouteOptions>();
|
||||
@ -12,9 +13,10 @@ const methods = ["get", "post", "put", "delete", "patch"];
|
||||
function registerPath(file, method, prefix, path, ...args) {
|
||||
const urlPath = prefix + path;
|
||||
const sourceFile = file.replace("/dist/", "/src/").replace(".js", ".ts");
|
||||
const opts = args.find((x) => typeof x === "object");
|
||||
const opts: RouteOptions = args.find((x) => typeof x === "object");
|
||||
if (opts) {
|
||||
routes.set(urlPath + "|" + method, opts);
|
||||
routes.set(urlPath + "|" + method, opts); // @ts-ignore
|
||||
opts.file = sourceFile;
|
||||
// console.log(method, urlPath, opts);
|
||||
} else {
|
||||
console.log(`${sourceFile}\nrouter.${method}("${path}") is missing the "route()" description middleware\n`, args);
|
||||
|
@ -11,7 +11,7 @@ export interface UserProfileResponse {
|
||||
premium_since?: Date;
|
||||
}
|
||||
|
||||
router.get("/", route({ response: { body: "UserProfileResponse" } }), async (req: Request, res: Response) => {
|
||||
router.get("/", route({ test: { response: { body: "UserProfileResponse" } } }), async (req: Request, res: Response) => {
|
||||
if (req.params.id === "@me") req.params.id = req.user_id;
|
||||
const user = await User.getPublicUser(req.params.id, { relations: ["connected_accounts"] });
|
||||
|
||||
|
@ -33,11 +33,11 @@ export type RouteResponse = { status?: number; body?: `${string}Response`; heade
|
||||
export interface RouteOptions {
|
||||
permission?: PermissionResolvable;
|
||||
body?: `${string}Schema`; // typescript interface name
|
||||
response?: RouteResponse;
|
||||
example?: {
|
||||
test?: {
|
||||
response?: RouteResponse;
|
||||
body?: any;
|
||||
path?: string;
|
||||
event?: EventData;
|
||||
event?: EventData | EventData[];
|
||||
headers?: Record<string, string>;
|
||||
};
|
||||
}
|
||||
|
@ -3,13 +3,13 @@
|
||||
|
||||
import getRouteDescriptions from "../jest/getRouteDescriptions";
|
||||
import supertest, { Response } from "supertest";
|
||||
import path from "path";
|
||||
import { join } from "path";
|
||||
import fs from "fs";
|
||||
import Ajv from "ajv";
|
||||
import addFormats from "ajv-formats";
|
||||
const request = supertest("http://localhost:3001/api");
|
||||
|
||||
const SchemaPath = path.join(__dirname, "..", "assets", "responses.json");
|
||||
const SchemaPath = join(__dirname, "..", "assets", "responses.json");
|
||||
const schemas = JSON.parse(fs.readFileSync(SchemaPath, { encoding: "utf8" }));
|
||||
export const ajv = new Ajv({
|
||||
allErrors: true,
|
||||
@ -27,13 +27,10 @@ describe("Automatic unit tests with route description middleware", () => {
|
||||
|
||||
routes.forEach((route, pathAndMethod) => {
|
||||
const [path, method] = pathAndMethod.split("|");
|
||||
|
||||
test(path, (done) => {
|
||||
if (!route.example) {
|
||||
console.log(`Route ${path} is missing the example property`);
|
||||
return done();
|
||||
}
|
||||
if (!route.response) {
|
||||
console.log(`Route ${path} is missing the response property`);
|
||||
console.log(`${(route as any).file}\nrouter.${method} is missing the test property`);
|
||||
return done();
|
||||
}
|
||||
const urlPath = path || route.example?.path;
|
||||
|
Loading…
Reference in New Issue
Block a user