@backstage/repo-tools 0.3.5 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @backstage/repo-tools
 
+## 0.4.0
+
+### Minor Changes
+
+- 4e36abef14: Remove support for the deprecated `--experimental-type-build` option for `package build`.
+- 6694b369a3: Adds a new command `schema openapi test` that performs runtime validation of your OpenAPI specs using your test data. Under the hood, we're using Optic to perform this check, really cool work by them!
+
+  To use this new command, you will have to run `yarn add @useoptic/optic` in the root of your repo.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/cli-node@0.2.0
+  - @backstage/catalog-model@1.4.3
+  - @backstage/cli-common@0.1.13
+  - @backstage/errors@1.2.3
+
+## 0.4.0-next.0
+
+### Minor Changes
+
+- 4e36abef14: Remove support for the deprecated `--experimental-type-build` option for `package build`.
+- 6694b369a3: Adds a new command `schema openapi test` that performs runtime validation of your OpenAPI specs using your test data. Under the hood, we're using Optic to perform this check, really cool work by them!
+
+  To use this new command, you will have to run `yarn add @useoptic/optic` in the root of your repo.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/cli-node@0.2.0-next.0
+  - @backstage/catalog-model@1.4.3
+  - @backstage/cli-common@0.1.13
+  - @backstage/errors@1.2.3
+
 ## 0.3.5
 
 ### Patch Changes

package/dist/cjs/{api-reports-2bcd4682.cjs.js → api-reports-2b0ee2bf.cjs.js}

@@ -219,16 +219,13 @@ function logApiReportInstructions() {
 async function findPackageEntryPoints(packageDirs) {
   return Promise.all(
     packageDirs.map(async (packageDir) => {
-      var _a, _b, _c, _d;
+      var _a, _b;
       const pkg = await fs__default["default"].readJson(
         paths.paths.resolveTargetRoot(packageDir, "package.json")
       );
-      return (_d = (_a = entryPoints.getPackageExportNames(pkg)) == null ? void 0 : _a.map((name) => ({ packageDir, name }))) != null ? _d : {
+      return (_b = (_a = entryPoints.getPackageExportNames(pkg)) == null ? void 0 : _a.map((name) => ({ packageDir, name }))) != null ? _b : {
         packageDir,
-        name: "index",
-        usesExperimentalTypeBuild: (_c = (_b = pkg.scripts) == null ? void 0 : _b.build) == null ? void 0 : _c.includes(
-          "--experimental-type-build"
-        )
+        name: "index"
       };
     })
   ).then((results) => results.flat());
@@ -258,11 +255,7 @@ async function runApiExtraction({
     };
   }
   const warnings = new Array();
-  for (const {
-    packageDir,
-    name,
-    usesExperimentalTypeBuild
-  } of packageEntryPoints) {
+  for (const { packageDir, name } of packageEntryPoints) {
     console.log(`## Processing ${packageDir}`);
     const noBail = Array.isArray(allowWarnings) ? allowWarnings.some((aw) => aw === packageDir || minimatch__default["default"](packageDir, aw)) : allowWarnings;
     const projectFolder = paths.paths.resolveTargetRoot(packageDir);
@@ -368,7 +361,7 @@ async function runApiExtraction({
       },
       compilerState
     });
-    if (validateReleaseTags && !usesExperimentalTypeBuild && fs__default["default"].pathExistsSync(extractorConfig.reportFilePath)) {
+    if (validateReleaseTags && fs__default["default"].pathExistsSync(extractorConfig.reportFilePath)) {
       if (["index", "alpha", "beta"].includes(name)) {
         const report = await fs__default["default"].readFile(
           extractorConfig.reportFilePath,
@@ -1157,4 +1150,4 @@ function parseArrayOption(value) {
 }
 
 exports.buildApiReports = buildApiReports;
-//# sourceMappingURL=api-reports-2bcd4682.cjs.js.map
+//# sourceMappingURL=api-reports-2b0ee2bf.cjs.js.map

package/dist/cjs/{constants-2eebdd79.cjs.js → constants-f7b16ffc.cjs.js}

@@ -3,21 +3,35 @@
 var paths = require('./paths-9ab9b8a8.cjs.js');
 var pLimit = require('p-limit');
 var path = require('path');
+var portFinder = require('portfinder');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var pLimit__default = /*#__PURE__*/_interopDefaultLegacy(pLimit);
+var portFinder__default = /*#__PURE__*/_interopDefaultLegacy(portFinder);
 
-async function runner(paths$1, command) {
+async function runner(paths$1, command, options) {
+  var _a;
   const packages = await paths.resolvePackagePaths({ paths: paths$1 });
-  const limit = pLimit__default["default"](5);
+  const limit = pLimit__default["default"]((_a = options == null ? void 0 : options.concurrencyLimit) != null ? _a : 5);
+  let port = (options == null ? void 0 : options.startingPort) && await portFinder__default["default"].getPortPromise({
+    // Prevent collisions with optic which runs 8000->8999
+    port: options.startingPort,
+    stopPort: options.startingPort + 1e3
+  });
   const resultsList = await Promise.all(
     packages.map(
       (pkg) => limit(async () => {
         let resultText = "";
         try {
+          if (port)
+            port = (options == null ? void 0 : options.startingPort) && await portFinder__default["default"].getPortPromise({
+              // Prevent collisions with optic which runs 8000->8999
+              port: port + 1,
+              stopPort: options.startingPort + 1e3
+            });
           console.log(`## Processing ${pkg}`);
-          await command(pkg);
+          await command(pkg, port ? { port } : void 0);
         } catch (err) {
           resultText = err.message;
         }
@@ -39,4 +53,4 @@ exports.TS_MODULE = TS_MODULE;
 exports.TS_SCHEMA_PATH = TS_SCHEMA_PATH;
 exports.YAML_SCHEMA_PATH = YAML_SCHEMA_PATH;
 exports.runner = runner;
-//# sourceMappingURL=constants-2eebdd79.cjs.js.map
+//# sourceMappingURL=constants-f7b16ffc.cjs.js.map

package/dist/cjs/exec-7bf444eb.cjs.js

@@ -0,0 +1,18 @@
+'use strict';
+
+var util = require('util');
+var child_process = require('child_process');
+
+const execPromise = util.promisify(child_process.exec);
+const exec = (command, options = [], execOptions) => {
+  return execPromise(
+    [
+      command,
+      ...options.filter((e) => e).map((e) => e.startsWith("-") ? e : `"${e}"`)
+    ].join(" "),
+    execOptions
+  );
+};
+
+exports.exec = exec;
+//# sourceMappingURL=exec-7bf444eb.cjs.js.map

package/dist/cjs/{generate-242d2277.cjs.js → generate-f300e17f.cjs.js}

@@ -5,13 +5,14 @@ var YAML = require('js-yaml');
 var chalk = require('chalk');
 var path = require('path');
 var paths = require('./paths-9ab9b8a8.cjs.js');
-var constants = require('./constants-2eebdd79.cjs.js');
+var constants = require('./constants-f7b16ffc.cjs.js');
 var util = require('util');
 var child_process = require('child_process');
 require('@backstage/cli-common');
 require('@backstage/cli-node');
 require('minimatch');
 require('p-limit');
+require('portfinder');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -76,4 +77,4 @@ async function bulkCommand(paths = []) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=generate-242d2277.cjs.js.map
+//# sourceMappingURL=generate-f300e17f.cjs.js.map

package/dist/cjs/index-80206881.cjs.js

@@ -0,0 +1,95 @@
+'use strict';
+
+var fs = require('fs-extra');
+var path = require('path');
+var chalk = require('chalk');
+var constants = require('./constants-f7b16ffc.cjs.js');
+var paths = require('./paths-9ab9b8a8.cjs.js');
+var exec = require('./exec-7bf444eb.cjs.js');
+require('p-limit');
+require('portfinder');
+require('@backstage/cli-common');
+require('@backstage/cli-node');
+require('minimatch');
+require('util');
+require('child_process');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
+
+async function test(directoryPath, { port }, options) {
+  const openapiPath = path.join(directoryPath, constants.YAML_SCHEMA_PATH);
+  if (!await fs__default["default"].pathExists(openapiPath)) {
+    return;
+  }
+  const opticConfigFilePath = path.join(directoryPath, "optic.yml");
+  if (!await fs__default["default"].pathExists(opticConfigFilePath)) {
+    return;
+  }
+  let opticLocation = "";
+  try {
+    opticLocation = (await exec.exec(`yarn bin optic`, [], { cwd: paths.paths.ownRoot })).stdout;
+  } catch (err) {
+    throw new Error(
+      `Failed to find an Optic CLI installation, ensure that you have @useoptic/optic installed in the root of your repo. If not, run yarn add @useoptic/optic from the root of your repo.`
+    );
+  }
+  try {
+    await exec.exec(
+      `${opticLocation.trim()} capture`,
+      [
+        constants.YAML_SCHEMA_PATH,
+        "--server-override",
+        `http://localhost:${port}`,
+        (options == null ? void 0 : options.update) ? "--update" : ""
+      ],
+      {
+        cwd: directoryPath,
+        env: {
+          ...process.env,
+          PORT: `${port}`
+        }
+      }
+    );
+  } catch (err) {
+    err.message = err.stderr + err.stdout;
+    err.message = err.message.split("\n").map((e) => e.replace(/.{1} Sending requests to server/, "")).filter((e) => !e.includes("PASS")).filter((e) => e.trim()).join("\n");
+    throw err;
+  }
+  if (await paths.paths.resolveTargetRoot("node_modules/.bin/prettier") && (options == null ? void 0 : options.update)) {
+    await exec.exec(`yarn prettier`, ["--write", openapiPath]);
+  }
+}
+async function bulkCommand(paths = [], options) {
+  const resultsList = await constants.runner(
+    paths,
+    (dir, runnerOptions) => test(dir, runnerOptions, options),
+    {
+      concurrencyLimit: 1,
+      startingPort: 9e3
+    }
+  );
+  let failed = false;
+  for (const { relativeDir, resultText } of resultsList) {
+    if (resultText) {
+      console.log();
+      console.log(
+        chalk__default["default"].red(
+          `OpenAPI runtime validation against tests failed in ${relativeDir}:`
+        )
+      );
+      console.log(resultText.trimStart());
+      failed = true;
+    }
+  }
+  if (failed) {
+    process.exit(1);
+  } else {
+    console.log(chalk__default["default"].green("Verified all specifications against test data."));
+  }
+}
+
+exports.bulkCommand = bulkCommand;
+//# sourceMappingURL=index-80206881.cjs.js.map

package/dist/cjs/init-1a47015e.cjs.js

@@ -0,0 +1,85 @@
+'use strict';
+
+var fs = require('fs-extra');
+var path = require('path');
+var constants = require('./constants-f7b16ffc.cjs.js');
+var paths = require('./paths-9ab9b8a8.cjs.js');
+var chalk = require('chalk');
+var exec = require('./exec-7bf444eb.cjs.js');
+require('p-limit');
+require('portfinder');
+require('@backstage/cli-common');
+require('@backstage/cli-node');
+require('minimatch');
+require('util');
+require('child_process');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
+
+const ROUTER_TEST_PATHS = [
+  "src/service/router.test.ts",
+  "src/service/createRouter.test.ts"
+];
+async function init(directoryPath) {
+  const openapiPath = path.join(directoryPath, constants.YAML_SCHEMA_PATH);
+  if (!await fs__default["default"].pathExists(openapiPath)) {
+    throw new Error(
+      `You do not have an OpenAPI YAML file at ${openapiPath}. Please create one and retry this command. If you already have existing test cases for your router, see 'backstage-repo-tools schema openapi test --update'`
+    );
+  }
+  const opticConfigFilePath = path.join(directoryPath, "optic.yml");
+  if (!await fs__default["default"].pathExists(opticConfigFilePath)) {
+    throw new Error(`This directory already has an optic.yml file. Exiting.`);
+  }
+  await fs__default["default"].writeFile(
+    opticConfigFilePath,
+    `ruleset:
+    - breaking-changes
+capture:
+    ${constants.YAML_SCHEMA_PATH}:
+        # \u{1F527} Runnable example with simple get requests.
+        # Run with "PORT=3000 optic capture ${constants.YAML_SCHEMA_PATH} --update interactive" in '${directoryPath}'
+        # You can change the server and the 'requests' section to experiment
+        server:
+            # This will not be used by 'backstage-repo-tools schema openapi test', but may be useful for interactive updates.
+            url: http://localhost:3000
+        requests:
+            # \u2139\uFE0F Requests should be sent to the Optic proxy, the address of which is injected into 'run.command's env as OPTIC_PROXY (or the value of 'run.proxy_variable').
+            run:
+                # \u{1F527} Specify a command that will generate traffic
+                command: yarn backstage-cli package test --no-watch ${ROUTER_TEST_PATHS.map(
+      (e) => `"${e}"`
+    ).join(",")} 
+  `
+  );
+  if (await paths.paths.resolveTargetRoot("node_modules/.bin/prettier")) {
+    await exec.exec(`yarn prettier`, ["--write", opticConfigFilePath]);
+  }
+}
+async function initCommand(paths = []) {
+  const resultsList = await constants.runner(paths, (dir) => init(dir), {
+    concurrencyLimit: 5
+  });
+  let failed = false;
+  for (const { relativeDir, resultText } of resultsList) {
+    if (resultText) {
+      console.log();
+      console.log(
+        chalk__default["default"].red(`Failed to initialize ${relativeDir} for OpenAPI commands.`)
+      );
+      console.log(resultText.trimStart());
+      failed = true;
+    }
+  }
+  if (failed) {
+    process.exit(1);
+  } else {
+    console.log(chalk__default["default"].green(`All directories have already been configured.`));
+  }
+}
+
+exports["default"] = initCommand;
+//# sourceMappingURL=init-1a47015e.cjs.js.map

package/dist/cjs/{lint-d126add4.cjs.js → lint-fa452310.cjs.js}

@@ -6,7 +6,7 @@ var ruleset = require('@apisyouwonthate/style-guide');
 var fs = require('fs-extra');
 var chalk = require('chalk');
 var path = require('path');
-var constants = require('./constants-2eebdd79.cjs.js');
+var constants = require('./constants-f7b16ffc.cjs.js');
 var spectralRulesets = require('@stoplight/spectral-rulesets');
 var types = require('@stoplight/types');
 var spectralFormatters = require('@stoplight/spectral-formatters');
@@ -15,6 +15,7 @@ require('@backstage/cli-common');
 require('@backstage/cli-node');
 require('minimatch');
 require('p-limit');
+require('portfinder');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -91,4 +92,4 @@ async function bulkCommand(paths = [], options) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=lint-d126add4.cjs.js.map
+//# sourceMappingURL=lint-fa452310.cjs.js.map

package/dist/cjs/{verify-8fe63985.cjs.js → verify-7bbbd05f.cjs.js}

@@ -6,9 +6,10 @@ var lodash = require('lodash');
 var path = require('path');
 var chalk = require('chalk');
 var Parser = require('@apidevtools/swagger-parser');
-var constants = require('./constants-2eebdd79.cjs.js');
+var constants = require('./constants-f7b16ffc.cjs.js');
 var paths = require('./paths-9ab9b8a8.cjs.js');
 require('p-limit');
+require('portfinder');
 require('@backstage/cli-common');
 require('@backstage/cli-node');
 require('minimatch');
@@ -79,4 +80,4 @@ async function bulkCommand(paths = []) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=verify-8fe63985.cjs.js.map
+//# sourceMappingURL=verify-7bbbd05f.cjs.js.map

package/dist/index.cjs.js

@@ -49,14 +49,16 @@ function registerSchemaCommand(program) {
   const openApiCommand = command.command("openapi [command]").description("Tooling for OpenApi schema");
   openApiCommand.command("verify [paths...]").description(
     "Verify that all OpenAPI schemas are valid and have a matching `schemas/openapi.generated.ts` file."
-  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/verify-8fe63985.cjs.js'); }).then((m) => m.bulkCommand)));
+  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/verify-7bbbd05f.cjs.js'); }).then((m) => m.bulkCommand)));
   openApiCommand.command("generate [paths...]").description(
     "Generates a Typescript file from an OpenAPI yaml spec. For use with the `@backstage/backend-openapi-utils` ApiRouter type."
-  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/generate-242d2277.cjs.js'); }).then((m) => m.bulkCommand)));
+  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/generate-f300e17f.cjs.js'); }).then((m) => m.bulkCommand)));
   openApiCommand.command("lint [paths...]").description("Lint OpenAPI schemas.").option(
     "--strict",
     "Fail on any linting severity messages, not just errors."
-  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/lint-d126add4.cjs.js'); }).then((m) => m.bulkCommand)));
+  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/lint-fa452310.cjs.js'); }).then((m) => m.bulkCommand)));
+  openApiCommand.command("test [paths...]").description("Test OpenAPI schemas against written tests").option("--update", "Update the spec on failure.").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/index-80206881.cjs.js'); }).then((m) => m.bulkCommand)));
+  openApiCommand.command("init <paths...>").description("Creates any config needed for the test command.").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/init-1a47015e.cjs.js'); }).then((m) => m.default)));
 }
 function registerCommands(program) {
   program.command("api-reports [paths...]").option("--ci", "CI run checks that there is no changes on API reports").option("--tsc", "executes the tsc compilation before extracting the APIs").option("--docs", "generates the api documentation").option(
@@ -82,7 +84,7 @@ function registerCommands(program) {
     "Turn on release tag validation for the public, beta, and alpha APIs"
   ).description("Generate an API report for selected packages").action(
     lazy(
-      () => Promise.resolve().then(function () { return require('./cjs/api-reports-2bcd4682.cjs.js'); }).then((m) => m.buildApiReports)
+      () => Promise.resolve().then(function () { return require('./cjs/api-reports-2b0ee2bf.cjs.js'); }).then((m) => m.buildApiReports)
     )
   );
   program.command("type-deps").description("Find inconsistencies in types of all packages and plugins").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/type-deps-5eacd931.cjs.js'); }).then((m) => m.default)));
@@ -114,7 +116,7 @@ function lazy(getActionFunc) {
   };
 }
 
-var version = "0.3.5";
+var version = "0.4.0";
 
 const main = (argv) => {
   commander.program.name("backstage-repo-tools").version(version);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/repo-tools",
   "description": "CLI for Backstage repo tooling ",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "publishConfig": {
     "access": "public"
   },
@@ -34,7 +34,7 @@
     "@apisyouwonthate/style-guide": "^1.4.0",
     "@backstage/catalog-model": "^1.4.3",
     "@backstage/cli-common": "^0.1.13",
-    "@backstage/cli-node": "^0.1.5",
+    "@backstage/cli-node": "^0.2.0",
     "@backstage/errors": "^1.2.3",
     "@manypkg/get-packages": "^1.1.3",
     "@microsoft/api-documenter": "^7.22.33",
@@ -43,7 +43,7 @@
     "@stoplight/spectral-formatters": "^1.1.0",
     "@stoplight/spectral-functions": "^1.7.2",
     "@stoplight/spectral-parsers": "^1.0.2",
-    "@stoplight/spectral-rulesets": "^1.16.0",
+    "@stoplight/spectral-rulesets": "^1.18.0",
     "@stoplight/spectral-runtime": "^1.1.2",
     "@stoplight/types": "^13.14.0",
     "chalk": "^4.0.0",
@@ -56,21 +56,24 @@
     "lodash": "^4.17.21",
     "minimatch": "^5.1.1",
     "p-limit": "^3.0.2",
+    "portfinder": "^1.0.32",
     "ts-node": "^10.0.0",
     "yaml-diff-patch": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.23.0",
+    "@backstage/cli": "^0.24.0",
     "@backstage/types": "^1.1.1",
     "@types/is-glob": "^4.0.2",
     "@types/mock-fs": "^4.13.0",
     "@types/node": "^18.17.8",
+    "@types/prettier": "^2.0.0",
     "mock-fs": "^5.2.0"
   },
   "peerDependencies": {
     "@microsoft/api-extractor-model": "*",
     "@microsoft/tsdoc": "*",
     "@microsoft/tsdoc-config": "*",
+    "@useoptic/optic": "^0.50.7",
     "prettier": "^2.8.1",
     "typescript": "> 3.0.0"
   },