-
Notifications
You must be signed in to change notification settings - Fork 283
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fixes: #1642 Signed-off-by: micoferdinand98 <ferdinand.m.b.mico@accenture.com>
- Loading branch information
1 parent
ee99c87
commit cb19c9b
Showing
5 changed files
with
709 additions
and
14 deletions.
There are no files selected for viewing
Submodule cactus
added at
008345
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| import fs from "fs-extra"; | ||
| import path from "path"; | ||
| import { fileURLToPath } from "url"; | ||
| import { globby, Options as GlobbyOptions } from "globby"; | ||
| // import * as globby from "globby"; | ||
| import { RuntimeError } from "run-time-error"; | ||
| import { hasProperty } from "./has-property"; | ||
| import { isStdLibRecord } from "./is-std-lib-record"; | ||
| /** | ||
| * Verifies that the openapi.json files in the entire project are conformant to | ||
| * certain boilerplate requirements and conventions that are designed to reduce | ||
| * or completely eliminate certain types of bugs/mistakes that users/developers | ||
| * can make (and frequently do without these checks). | ||
| * | ||
| * @returns An array with the first item being a boolean indicating | ||
| * 1) success (`true`) or 2) failure (`false`) | ||
| */ | ||
| export async function apache2LicenseChecker( | ||
| req: ICheckApacheVersionRequest, | ||
| ): Promise<[boolean, string[]]> { | ||
| const TAG = "[tools/check-apache-version.ts]"; | ||
| const __filename = fileURLToPath(import.meta.url); | ||
| const __dirname = path.dirname(__filename); | ||
| const SCRIPT_DIR = __dirname; | ||
| const PROJECT_DIR = path.join(SCRIPT_DIR, "../../"); | ||
| console.log(`${TAG} SCRIPT_DIR=${SCRIPT_DIR}`); | ||
| console.log(`${TAG} PROJECT_DIR=${PROJECT_DIR}`); | ||
| if (!req) { | ||
| throw new RuntimeError(`req parameter cannot be falsy.`); | ||
| } | ||
| if (!req.argv) { | ||
| throw new RuntimeError(`req.argv cannot be falsy.`); | ||
| } | ||
| if (!req.env) { | ||
| throw new RuntimeError(`req.env cannot be falsy.`); | ||
| } | ||
| const globbyOpts: GlobbyOptions = { | ||
| cwd: PROJECT_DIR, | ||
| ignore: ["node_modules"], | ||
| }; | ||
| const DEFAULT_GLOB = "**/cactus-*/src/main/json/openapi.json"; | ||
| const oasPaths = await globby(DEFAULT_GLOB, globbyOpts); | ||
| console.log(`openapi.json paths: (${oasPaths.length}): `); | ||
| // const oasPaths = oasPathsEntries.map((it) => it.path); | ||
| const errors: string[] = []; | ||
| const checks = oasPaths.map(async (oasPathRel) => { | ||
| const oasPathAbs = path.join(PROJECT_DIR, oasPathRel); | ||
| const oas: unknown = await fs.readJSON(oasPathAbs); | ||
| if (typeof oas !== "object") { | ||
| errors.push(`ERROR: ${oasPathRel} openapi.json cannot be empty.`); | ||
| return; | ||
| } | ||
| if (!oas) { | ||
| errors.push(`ERROR: ${oasPathRel} openapi.json cannot be empty.`); | ||
| return; | ||
| } | ||
| if (!isStdLibRecord(oas)) { | ||
| return; | ||
| } | ||
| if (!hasProperty(oas, "paths")) { | ||
| return; | ||
| } | ||
| const { paths } = oas; | ||
| if (!isStdLibRecord(paths)) { | ||
| errors.push(`ERROR: ${oasPathRel} "paths" must be an object`); | ||
| return; | ||
| } | ||
| Object.entries(paths).forEach(([pathObjKey, pathObjProp]) => { | ||
| if (!isStdLibRecord(pathObjProp)) { | ||
| errors.push( | ||
| `ERROR: ${oasPathRel} "paths"."${pathObjKey}" must be an object`, | ||
| ); | ||
| return; | ||
| } | ||
| Object.entries(pathObjProp).forEach(([verbObjKey, verbObjProp]) => { | ||
| if (!isStdLibRecord(verbObjProp)) { | ||
| errors.push( | ||
| `ERROR: ${oasPathRel} "paths"."${pathObjKey}"."${verbObjKey}" must be an object`, | ||
| ); | ||
| return; | ||
| } | ||
| const oasExtension = verbObjProp["x-hyperledger-cactus"]; | ||
| if (!isStdLibRecord(oasExtension)) { | ||
| const errorMessage = `${oasPathRel} is missing "paths"."${pathObjKey}"."${verbObjKey}"."x-hyperledger-cactus" from the path definition of ${pathObjKey}. Please add it. If you do not know how to, search for existing examples in other openapi.json files within the project for the string "x-hyperledger-cactus"`; | ||
| errors.push(errorMessage); | ||
| return; | ||
| } | ||
| if (!hasProperty(oasExtension, "http")) { | ||
| const errorMessage = `${oasPathRel} is missing "paths"."${pathObjKey}"."${verbObjKey}"."x-hyperledger-cactus"."http" from the path definition of ${pathObjKey}. Please add it. If you do not know how to, search for existing examples in other openapi.json files within the project for the string "x-hyperledger-cactus"`; | ||
| errors.push(errorMessage); | ||
| return; | ||
| } | ||
| const { http } = oasExtension; | ||
| if (!hasProperty(http, "verbLowerCase")) { | ||
| const errorMessage = `${oasPathRel} is missing "paths"."${pathObjKey}"."${verbObjKey}"."x-hyperledger-cactus"."http"."verbLowerCase" from the path definition of ${pathObjKey}. Please add it. If you do not know how to, search for existing examples in other openapi.json files within the project for the string "x-hyperledger-cactus"`; | ||
| errors.push(errorMessage); | ||
| return; | ||
| } | ||
| if (!hasProperty(http, "path")) { | ||
| const errorMessage = `${oasPathRel} is missing "paths"."${pathObjKey}"."${verbObjKey}"."x-hyperledger-cactus"."http"."path" from the path definition object of ${pathObjKey}. Please add it. If you do not know how to, search for existing examples in other openapi.json files within the project for the string "x-hyperledger-cactus"`; | ||
| errors.push(errorMessage); | ||
| return; | ||
| } | ||
| if (http.path !== pathObjKey) { | ||
| const errorMessage = `${oasPathRel} HTTP paths at "paths"."${pathObjKey}"."${verbObjKey}"."x-hyperledger-cactus"."http"."path" must match "${pathObjKey}" but it is currently set to "${http.path}"`; | ||
| errors.push(errorMessage); | ||
| return; | ||
| } | ||
| if (http.verbLowerCase !== verbObjKey) { | ||
| const errorMessage = `${oasPathRel} HTTP verbs at "paths"."${pathObjKey}"."${verbObjKey}"."x-hyperledger-cactus"."http"."verbLowerCase" must match "${verbObjKey}" but it is currently set to "${http.verbLowerCase}"`; | ||
| errors.push(errorMessage); | ||
| return; | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| await Promise.all(checks); | ||
| return [errors.length === 0, errors]; | ||
| } | ||
| export const E_MISSING_OAS_EXTENSION = `missing "x-hyperledger-cactus" from `; | ||
| export interface ICheckApacheVersionRequest { | ||
| readonly argv: string[]; | ||
| readonly env: NodeJS.ProcessEnv; | ||
| } |
Oops, something went wrong.