Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix missing specs router #358

Merged
merged 3 commits into from
Feb 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .azure-pipelines/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,5 @@ jobs:
- script: npm run check-format
displayName: Check formatting

- script: |
npm link
autorest-testserver validate-spec-coverage --maxErrorCount=596
- script: npm run validate-spec-coverage
displayName: Validate OpenAPI specs mock API coverage
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@
"prepack": "npm run build",
"format": "npm run -s prettier -- --write",
"check-format": "npm run -s prettier -- --check",
"prettier": "prettier --config ./.prettierrc.yml **/*.{ts,js,cjs,mjs,json,yml,yaml,md}"
"prettier": "prettier --config ./.prettierrc.yml **/*.{ts,js,cjs,mjs,json,yml,yaml,md}",
"validate-spec-coverage": "node ./dist/cli/cli.js validate-spec-coverage --maxErrorCount=164"
},
"engines": {
"node": ">=10"
Expand Down
20 changes: 14 additions & 6 deletions src/cli/commands/validate-spec-coverage-command.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import { registerLegacyRoutes } from "../../legacy";
import { logger } from "../../logger";
import { getPathsFromSpecs, SpecPath } from "../../services";
import { findFilesFromPattern } from "../../utils";
import { CliConfig } from "../cli-config";

interface Layer {
route: { path: string; methods: Record<HttpMethod, boolean> };
Expand Down Expand Up @@ -73,7 +72,6 @@ const findSpecCoverageErrors = (paths: SpecPath[], registeredPaths: Layer[]): Sp
*/
const validateRouteDefined = (path: SpecPath, registeredPaths: Layer[]): HttpMethod[] => {
const methodFound: Partial<Record<HttpMethod, boolean>> = {};

for (const registeredPath of registeredPaths) {
if (registeredPath.regexp.test(path.path)) {
for (const [method, defined] of Object.entries(registeredPath.route.methods)) {
Expand All @@ -84,7 +82,7 @@ const validateRouteDefined = (path: SpecPath, registeredPaths: Layer[]): HttpMet
}
}

return path.methods.filter((x) => !methodFound[x]);
return path.methods.filter((x) => !methodFound[x]).filter((x) => !x.startsWith("x-"));
};

const loadRegisteredRoutes = async (): Promise<Layer[]> => {
Expand All @@ -99,14 +97,24 @@ const loadRegisteredRoutes = async (): Promise<Layer[]> => {

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const findRoutesFromMiddleware = (middleware: any): Layer[] => {
let routes: Layer[] = [];
const routes: Layer[] = [];
if (middleware.route) {
routes.push(middleware);
routes.push({ route: middleware.route, regexp: middleware.regexp });
} else if (middleware.name === "router") {
for (const nested of middleware.handle.stack) {
routes = routes.concat(findRoutesFromMiddleware(nested));
if (nested.route) {
routes.push({ route: nested.route, regexp: concatRegexp(middleware.regexp, nested.regexp) });
}
}
}

return routes;
};

/**
* Combine the router regex with the child regex.
*/
function concatRegexp(router: RegExp, child: RegExp) {
const reg = router.source.replace("\\/?(?=\\/|$)", child.source.slice(1));
return new RegExp(reg, child.flags);
}
60 changes: 0 additions & 60 deletions swagger/azure-report.json

This file was deleted.