refactor(programmatic-interface): extract logic to run script against a provided list of repositories

for #219

Author: travi

lib/run-script-against-repositories.js

@@ -2,6 +2,7 @@ import enquirer from "enquirer";
 import chalk from "chalk";
 
 import { resolveRepositories } from "./resolve-repositories.js";
+import { runScriptAgainstRepositories as runScriptAgainstResolvedRepositories } from "./run-script-against-resolved-repositories.js";
 
 export async function runScriptAgainstRepositories(state, octoherdRepos = []) {
   if (!state.octoherdReposPassedAsFlag) {
@@ -51,22 +52,7 @@ export async function runScriptAgainstRepositories(state, octoherdRepos = []) {
     state.octokit.log.info("Loading repositories ...");
     const repositories = await resolveRepositories(state, octoherdRepos);
 
-    for (const repository of repositories) {
-      state.octokit.log.info(
-        { octoherd: true },
-        "Running on %s ...",
-        repository.full_name
-      );
-
-      try {
-        const { id, owner, name } = repository;
-        state.octokit.log.setContext({ repository: { id, owner, name } });
-        await state.script(state.octokit, repository, state.userOptions);
-      } catch (error) {
-        if (!error.cancel) throw error;
-        state.octokit.log.debug(error.message);
-      }
-    }
+    await runScriptAgainstResolvedRepositories(state.octokit, repositories, state.script, state.userOptions);
   } catch (error) {
     state.octokit.log.error(error);
     process.exitCode = 1;

lib/run-script-against-resolved-repositories.js

@@ -0,0 +1,21 @@
+export async function runScriptAgainstRepositories(octokit, repositories, script, options) {
+  for (const repository of repositories) {
+    octokit.log.info(
+      { octoherd: true },
+      "Running on %s ...",
+      repository.full_name
+    );
+
+    try {
+      if (octokit.log.setContext) {
+        const {id, owner, name} = repository;
+        octokit.log.setContext({repository: {id, owner, name}});
+      }
+
+      script(octokit, repository, options);
+    } catch (error) {
+      if (!error.cancel) throw error;
+      octokit.log.debug(error.message);
+    }
+  }
+}

tests/run-script-against-resolved-repositories.test.js

@@ -0,0 +1,69 @@
+import { suite } from "uvu";
+import { equal } from "uvu/assert";
+import simple from "simple-mock";
+
+import { runScriptAgainstRepositories } from "../lib/run-script-against-resolved-repositories.js";
+
+const runAgainstRepos = suite('run script against repositories');
+
+const userOptions = {};
+const octoherdCliRepository = {id: 123, owner: {login: 'octoherd'}, name: 'cli', full_name: 'octoherd/cli'};
+
+runAgainstRepos('run the script against the provided repositories', async () => {
+  const octokitInfoLogger = simple.spy(() => undefined);
+  const octokit = {log: {info: octokitInfoLogger}};
+  const octokitCoreRepository = {id: 456, owner: {login: 'octokit'}, name: 'core.js', full_name: 'octokit/core.js'};
+  const repositories = [octoherdCliRepository, octokitCoreRepository];
+  const script = simple.spy(() => undefined);
+
+  await runScriptAgainstRepositories(octokit, repositories, script, userOptions);
+
+  repositories.forEach((repository, index) => {
+    equal(script.calls[index].args, [octokit, repository, userOptions]);
+    equal(octokitInfoLogger.calls[index].args, [{octoherd: true}, "Running on %s ...", repository.full_name]);
+  });
+});
+
+runAgainstRepos('set logger context when available', async () => {
+  const octokitLoggerContextSetter = simple.spy(() => undefined);
+  const octokit = {log: {info: () => undefined, setContext: octokitLoggerContextSetter}};
+  const octokitCoreRepository = {id: 456, owner: {login: 'octokit'}, name: 'core.js', full_name: 'octokit/core.js'};
+  const repositories = [octoherdCliRepository, octokitCoreRepository];
+  const script = simple.spy(() => undefined);
+
+  await runScriptAgainstRepositories(octokit, repositories, script, userOptions);
+
+  repositories.forEach((repository, index) => equal(
+    octokitLoggerContextSetter.calls[index].args,
+    [{repository: {id: repository.id, owner: repository.owner, name: repository.name}}]
+  ));
+});
+
+runAgainstRepos('log cancelled routes at debug level', async () => {
+  const repositories = [octoherdCliRepository];
+  const errorMessage = 'error message';
+  const cancelledRouteError = new Error(errorMessage);
+  cancelledRouteError.cancel = true;
+  const octokitDebugLogger = simple.spy(() => undefined);
+  const octokit = {log: {info: () => undefined, debug: octokitDebugLogger}};
+  const script = simple.spy(() => undefined).throwWith(cancelledRouteError);
+
+  await runScriptAgainstRepositories(octokit, repositories, script, userOptions);
+
+  equal(octokitDebugLogger.calls[0].args, [errorMessage]);
+});
+
+runAgainstRepos('throw other errors', async () => {
+  const repositories = [octoherdCliRepository];
+  const error = new Error();
+  const octokit = {log: {info: () => undefined}};
+  const script = simple.spy(() => undefined).throwWith(error);
+
+  try {
+    await runScriptAgainstRepositories(octokit, repositories, script, userOptions);
+  } catch (err) {
+    equal(err, error);
+  }
+});
+
+runAgainstRepos.run();