@backstage/repo-tools 0.7.1 → 0.8.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @backstage/repo-tools
 
+## 0.8.0-next.0
+
+### Minor Changes
+
+- cfdc5e7: Adds two new commands, `repo schema openapi fuzz` and `package schema openapi fuzz` for fuzzing your plugins documented with OpenAPI. This can help find bugs in your application code through the use of auto-generated schema-compliant inputs. For more information on the underlying library this leverages, take a look at [the docs](https://schemathesis.readthedocs.io/en/stable/index.html).
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.21.7-next.0
+  - @backstage/config-loader@1.8.0-next.0
+  - @backstage/catalog-model@1.4.5
+  - @backstage/cli-common@0.1.13
+  - @backstage/cli-node@0.2.4
+  - @backstage/errors@1.2.4
+
+## 0.7.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.21.6
+  - @backstage/catalog-model@1.4.5
+  - @backstage/cli-common@0.1.13
+  - @backstage/cli-node@0.2.4
+  - @backstage/errors@1.2.4
+
 ## 0.7.1
 
 ### Patch Changes

package/dist/cjs/exec-B_ZXslMw.cjs.js

@@ -0,0 +1,39 @@
+'use strict';
+
+var util = require('util');
+var child_process = require('child_process');
+
+const execPromise = util.promisify(child_process.exec);
+const exec = (command, args = [], options) => {
+  return execPromise(
+    [
+      command,
+      ...args.filter((e) => e).map((e) => e.startsWith("-") ? e : `"${e}"`)
+    ].join(" "),
+    options
+  );
+};
+const spawn = (command, args, options) => {
+  return new Promise((resolve, reject) => {
+    var _a;
+    const cp = child_process.spawn(command, args, options != null ? options : {});
+    const error = [];
+    const stdout = [];
+    (_a = cp.stdout) == null ? void 0 : _a.on("data", (data) => {
+      stdout.push(data.toString());
+    });
+    cp.on("error", (e) => {
+      error.push(e.toString());
+    });
+    cp.on("close", (exitCode) => {
+      if (exitCode)
+        reject(error.join(""));
+      else
+        resolve(stdout.join(""));
+    });
+  });
+};
+
+exports.exec = exec;
+exports.spawn = spawn;
+//# sourceMappingURL=exec-B_ZXslMw.cjs.js.map

package/dist/cjs/fuzz-B61zys1g.cjs.js

@@ -0,0 +1,45 @@
+'use strict';
+
+var cliNode = require('@backstage/cli-node');
+var exec = require('./exec-B_ZXslMw.cjs.js');
+var chalk = require('chalk');
+require('util');
+require('child_process');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
+
+async function command(opts) {
+  let packages = await cliNode.PackageGraph.listTargetPackages();
+  if (opts.since) {
+    const graph = cliNode.PackageGraph.fromPackages(packages);
+    const changedPackages = await graph.listChangedPackages({
+      ref: opts.since,
+      analyzeLockfile: true
+    });
+    const withDevDependents = graph.collectPackageNames(
+      changedPackages.map((pkg) => pkg.name),
+      (pkg) => pkg.localDevDependents.keys()
+    );
+    packages = Array.from(withDevDependents).map((name) => graph.get(name));
+  }
+  const fuzzablePackages = packages.filter((e) => {
+    var _a;
+    return (_a = e.packageJson.scripts) == null ? void 0 : _a.fuzz;
+  });
+  try {
+    for (const pkg of fuzzablePackages) {
+      await exec.exec("yarn", ["fuzz"], {
+        cwd: pkg.dir
+      });
+    }
+    console.log(chalk__default.default.green(`Successfully fuzzed.`));
+  } catch (err) {
+    console.error(err.stdout);
+    process.exit(1);
+  }
+}
+
+exports.command = command;
+//# sourceMappingURL=fuzz-B61zys1g.cjs.js.map

package/dist/cjs/fuzz-BQh7xgC3.cjs.js

@@ -0,0 +1,87 @@
+'use strict';
+
+var fs = require('fs-extra');
+var paths = require('./paths-BvbxdT_S.cjs.js');
+var chalk = require('chalk');
+var exec = require('./exec-B_ZXslMw.cjs.js');
+var helpers = require('./helpers-Dd7PBM8s.cjs.js');
+var configLoader = require('@backstage/config-loader');
+var YAML = require('js-yaml');
+var path = require('path');
+var commandExists = require('command-exists');
+require('@backstage/cli-common');
+require('@backstage/cli-node');
+require('minimatch');
+require('util');
+require('child_process');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
+var YAML__default = /*#__PURE__*/_interopDefaultCompat(YAML);
+
+async function fuzz(opts) {
+  const resolvedOpenapiPath = await helpers.getPathToCurrentOpenApiSpec();
+  if (!commandExists.sync("st")) {
+    console.log(
+      chalk__default.default.red(
+        `Please install schemathesis globally with 'python -m pip install schemathesis'. Then run this command again.`
+      )
+    );
+    process.exit(1);
+  }
+  const openapiSpec = YAML__default.default.load(
+    await fs__default.default.readFile(resolvedOpenapiPath, "utf8")
+  );
+  const configSource = configLoader.ConfigSources.default({
+    rootDir: paths.paths.targetRoot
+  });
+  const config = await configLoader.ConfigSources.toConfig(configSource);
+  const pluginId = openapiSpec.info.title;
+  const args = [];
+  if (opts.debug) {
+    args.push(
+      "--cassette-path",
+      paths.paths.resolveTargetRoot(path.join(".cassettes", `${pluginId}.yml`))
+    );
+  }
+  if (opts.limit) {
+    args.push("--hypothesis-max-examples", opts.limit);
+  }
+  args.push("--workers", opts.workers);
+  if (opts.useGuest) {
+    args.push("--header", `Authorization: Basic guest`);
+  } else {
+    args.push("--header", `Authorization: Basic test`);
+  }
+  if (opts.excludeChecks) {
+    args.push("--exclude-checks", opts.excludeChecks);
+  }
+  await exec.spawn(
+    "st",
+    [
+      "run",
+      "--checks",
+      "all",
+      ...args,
+      `${config.getString("backend.baseUrl")}/api/${pluginId}/openapi.json`
+    ],
+    {
+      stdio: ["ignore", "inherit", "ignore"]
+    }
+  );
+}
+async function command(opts) {
+  try {
+    await fuzz(opts);
+    console.log(chalk__default.default.green(`Successfully fuzzed.`));
+  } catch (err) {
+    console.log(chalk__default.default.red(`OpenAPI fuzzing failed.`));
+    console.error(err);
+    process.exit(1);
+  }
+}
+
+exports.command = command;
+//# sourceMappingURL=fuzz-BQh7xgC3.cjs.js.map

package/dist/cjs/{index-CM0bJMpv.cjs.js → index-CWbHgAsr.cjs.js}

@@ -5,7 +5,7 @@ var path = require('path');
 var helpers = require('./helpers-Dd7PBM8s.cjs.js');
 var paths = require('./paths-BvbxdT_S.cjs.js');
 var fs = require('fs-extra');
-var exec$1 = require('./exec-d7-AweRf.cjs.js');
+var exec$1 = require('./exec-B_ZXslMw.cjs.js');
 var backendCommon = require('@backstage/backend-common');
 var YAML = require('js-yaml');
 var util = require('util');
@@ -139,4 +139,4 @@ async function command(opts) {
 }
 
 exports.command = command;
-//# sourceMappingURL=index-CM0bJMpv.cjs.js.map
+//# sourceMappingURL=index-CWbHgAsr.cjs.js.map

package/dist/cjs/{init-q37Rum6N.cjs.js → init-Canxj28t.cjs.js}

@@ -4,7 +4,7 @@ var fs = require('fs-extra');
 var helpers = require('./helpers-Dd7PBM8s.cjs.js');
 var paths = require('./paths-BvbxdT_S.cjs.js');
 var chalk = require('chalk');
-var exec = require('./exec-d7-AweRf.cjs.js');
+var exec = require('./exec-B_ZXslMw.cjs.js');
 require('path');
 require('@backstage/cli-common');
 require('@backstage/cli-node');
@@ -70,4 +70,4 @@ async function singleCommand() {
 }
 
 exports.singleCommand = singleCommand;
-//# sourceMappingURL=init-q37Rum6N.cjs.js.map
+//# sourceMappingURL=init-Canxj28t.cjs.js.map

package/dist/cjs/{test-Bjep-DJ3.cjs.js → test-B-zlD07F.cjs.js}

@@ -6,7 +6,7 @@ var chalk = require('chalk');
 var runner = require('./runner-CRAhuK8A.cjs.js');
 var helpers = require('./helpers-Dd7PBM8s.cjs.js');
 var paths = require('./paths-BvbxdT_S.cjs.js');
-var exec = require('./exec-d7-AweRf.cjs.js');
+var exec = require('./exec-B_ZXslMw.cjs.js');
 require('p-limit');
 require('portfinder');
 require('@backstage/cli-common');
@@ -95,4 +95,4 @@ async function bulkCommand(paths = [], options) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=test-Bjep-DJ3.cjs.js.map
+//# sourceMappingURL=test-B-zlD07F.cjs.js.map

package/dist/index.cjs.js

@@ -54,7 +54,7 @@ function registerPackageCommand(program) {
     "Initialize any required files to use the OpenAPI tooling for this package."
   ).action(
     lazy(
-      () => Promise.resolve().then(function () { return require('./cjs/init-q37Rum6N.cjs.js'); }).then((m) => m.singleCommand)
+      () => Promise.resolve().then(function () { return require('./cjs/init-Canxj28t.cjs.js'); }).then((m) => m.singleCommand)
     )
   );
   openApiCommand.command("generate").option(
@@ -64,9 +64,20 @@ function registerPackageCommand(program) {
     "Command to generate a client and/or a server stub from an OpenAPI spec."
   ).action(
     lazy(
-      () => Promise.resolve().then(function () { return require('./cjs/index-CM0bJMpv.cjs.js'); }).then((m) => m.command)
+      () => Promise.resolve().then(function () { return require('./cjs/index-CWbHgAsr.cjs.js'); }).then((m) => m.command)
     )
   );
+  openApiCommand.command("fuzz").description(
+    "Fuzz an OpenAPI schema by generating random data and sending it to the server."
+  ).option("--limit <limit>", "Maximum number of requests to send.").option("--workers <workers>", "Number of workers to use", "2").option(
+    "--debug",
+    `Enable debug mode, which will save cassettes to '.cassettes/{pluginId}.yml'`
+  ).option(
+    "--exclude-checks <excludeChecks>",
+    "Exclude checks from schemathesis run"
+  ).action(
+    lazy(() => Promise.resolve().then(function () { return require('./cjs/fuzz-BQh7xgC3.cjs.js'); }).then((m) => m.command))
+  );
 }
 function registerRepoCommand(program) {
   const command = program.command("repo [command]").description("Tools for working across your entire repository.");
@@ -86,7 +97,13 @@ function registerRepoCommand(program) {
     lazy(() => Promise.resolve().then(function () { return require('./cjs/lint-BNE-BGv5.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/test-Bjep-DJ3.cjs.js'); }).then((m) => m.bulkCommand))
+    lazy(() => Promise.resolve().then(function () { return require('./cjs/test-B-zlD07F.cjs.js'); }).then((m) => m.bulkCommand))
+  );
+  openApiCommand.command("fuzz").description("Fuzz all packages").option(
+    "--since <ref>",
+    "Only fuzz packages that have changed since the given ref"
+  ).action(
+    lazy(() => Promise.resolve().then(function () { return require('./cjs/fuzz-B61zys1g.cjs.js'); }).then((m) => m.command))
   );
 }
 function registerCommands(program) {
@@ -151,7 +168,7 @@ function lazy(getActionFunc) {
   };
 }
 
-var version = "0.7.1";
+var version = "0.8.0-next.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.7.1",
+  "version": "0.8.0-next.0",
   "publishConfig": {
     "access": "public"
   },
@@ -32,10 +32,11 @@
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@apisyouwonthate/style-guide": "^1.4.0",
-    "@backstage/backend-common": "^0.21.5",
+    "@backstage/backend-common": "^0.21.7-next.0",
     "@backstage/catalog-model": "^1.4.5",
     "@backstage/cli-common": "^0.1.13",
     "@backstage/cli-node": "^0.2.4",
+    "@backstage/config-loader": "^1.8.0-next.0",
     "@backstage/errors": "^1.2.4",
     "@manypkg/get-packages": "^1.1.3",
     "@microsoft/api-documenter": "^7.22.33",
@@ -50,6 +51,7 @@
     "@stoplight/types": "^14.0.0",
     "chalk": "^4.0.0",
     "codeowners-utils": "^1.0.2",
+    "command-exists": "^1.2.9",
     "commander": "^12.0.0",
     "fs-extra": "^11.2.0",
     "glob": "^8.0.3",
@@ -62,8 +64,8 @@
     "yaml-diff-patch": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.3.5",
-    "@backstage/cli": "^0.26.1",
+    "@backstage/backend-test-utils": "^0.3.7-next.0",
+    "@backstage/cli": "^0.26.3-next.0",
     "@backstage/types": "^1.1.1",
     "@types/is-glob": "^4.0.2",
     "@types/node": "^18.17.8",

package/dist/cjs/exec-d7-AweRf.cjs.js

@@ -1,18 +0,0 @@
-'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-d7-AweRf.cjs.js.map