tests: use an explicit project config

I am about to introduce a change to make the project config
non-optional. Let's prepare the tests for it, by adding an explicit
config (rather than detecting a specific commit that is expected to be
present when running the tests).

Signed-off-by: Johannes Schindelin <[email protected]>

Author: dscho

lib/project-options.ts

@@ -1,4 +1,4 @@
-import { commitExists, revParse } from "./git.js";
+import { revParse } from "./git.js";
 import { IConfig, projectInfo } from "./project-config.js";
 
 // For now, only the Git, Cygwin and BusyBox projects are supported
@@ -39,10 +39,6 @@ export class ProjectOptions {
             // BusyBox
             to = "[email protected]";
             midUrlPrefix = "https://www.mail-archive.com/[email protected]&q=";
-        } else if (await commitExists("7ccd18012de2e6c47e5", workDir)) {
-            // We're running in the test suite!
-            to = "[email protected]";
-            midUrlPrefix = "https://dummy.com/?mid=";
         } else {
             throw new Error("Unrecognized project");
         }

tests/ci-helper.test.ts

@@ -5,8 +5,7 @@ import { GitNotes } from "../lib/git-notes.js";
 import { GitHubGlue, IGitHubUser, IPRComment, IPRCommit, IPullRequestInfo } from "../lib/github-glue.js";
 import { IMailMetadata } from "../lib/mail-metadata.js";
 import { testSmtpServer } from "test-smtp-server";
-import { testCreateRepo, TestRepo } from "./test-lib.js";
-import defaultConfig from "../lib/gitgitgadget-config.js";
+import { testCreateRepo, TestRepo, testConfig } from "./test-lib.js";
 
 const sourceFileName = fileURLToPath(import.meta.url);
 
@@ -32,7 +31,7 @@ function testQ(label: string, fn: AsyncFn) {
     });
 }
 
-const config = defaultConfig;
+const config = testConfig;
 
 const eMailOptions = {
     smtpserver: new testSmtpServer(),

tests/gitgitgadget.test.ts

@@ -5,8 +5,7 @@ import { GitNotes } from "../lib/git-notes.js";
 import { GitGitGadget, IGitGitGadgetOptions } from "../lib/gitgitgadget.js";
 import { PatchSeries } from "../lib/patch-series.js";
 import { IPatchSeriesMetadata } from "../lib/patch-series-metadata.js";
-import { testCreateRepo } from "./test-lib.js";
-import defaultConfig from "../lib/gitgitgadget-config.js";
+import { testCreateRepo, testConfig } from "./test-lib.js";
 
 // This test script might take quite a while to run
 jest.setTimeout(60000);
@@ -207,7 +206,7 @@ test("generate tag/notes from a Pull Request", async () => {
     await git(["config", "user.email", "[email protected]"], repo.options);
 
     const patches = await PatchSeries.getFromNotes(
-        defaultConfig,
+        testConfig,
         notes,
         pullRequestURL,
         pullRequestTitle,
@@ -250,7 +249,7 @@ to have included in git.git [https://github.com/git/git].`);
 
     const headCommit2 = await repo.revParse("HEAD");
     const patches2 = await PatchSeries.getFromNotes(
-        defaultConfig,
+        testConfig,
         notes,
         pullRequestURL,
         pullRequestTitle,
@@ -342,7 +341,7 @@ test("allow/disallow", async () => {
     const notes = new GitNotes(remote.workDir);
     await notes.set("", {} as IGitGitGadgetOptions);
 
-    const gitGitGadget = await GitGitGadget.get(defaultConfig, workDir);
+    const gitGitGadget = await GitGitGadget.get(testConfig, workDir);
 
     // pretend that the notes ref had been changed in the meantime
     await notes.set("", { allowedUsers: ["first-one"] } as IGitGitGadgetOptions, true);
@@ -370,7 +369,7 @@ test("allow/disallow with env vars", async () => {
     const notes = new GitNotes(remote.workDir);
     await notes.set("", {} as IGitGitGadgetOptions);
 
-    const gitGitGadget = await GitGitGadget.get(defaultConfig, workDir);
+    const gitGitGadget = await GitGitGadget.get(testConfig, workDir);
 
     // pretend that the notes ref had been changed in the meantime
     await notes.set("", { allowedUsers: ["first-one"] } as IGitGitGadgetOptions, true);

tests/mail-archive-helper.test.ts

@@ -6,8 +6,7 @@ import { GitNotes } from "../lib/git-notes.js";
 import { GitHubGlue } from "../lib/github-glue.js";
 import { MailArchiveGitHelper, IGitMailingListMirrorState } from "../lib/mail-archive-helper.js";
 import { IMailMetadata } from "../lib/mail-metadata.js";
-import { testCreateRepo } from "./test-lib.js";
-import defaultConfig from "../lib/gitgitgadget-config.js";
+import { testCreateRepo, testConfig } from "./test-lib.js";
 import { IConfig } from "../lib/project-config.js";
 
 /* eslint max-classes-per-file: ["error", 2] */
@@ -97,7 +96,7 @@ interface ICommit {
     parents: [{ sha: string; url: string; html_url?: string }];
 }
 
-const config = { ...defaultConfig }; // make a copy
+const config = { ...testConfig }; // make a copy
 config.repo.owner = "test";
 config.repo.name = "test";
 

tests/misc-helper.test.ts

@@ -1,17 +1,16 @@
 import { expect, jest, test } from "@jest/globals";
 import { fileURLToPath } from "url";
 import { git } from "../lib/git.js";
-import { testCreateRepo, TestRepo } from "./test-lib.js";
+import { testCreateRepo, TestRepo, testConfig } from "./test-lib.js";
 import { execFile } from "child_process";
 import * as util from "util";
-import defaultConfig from "../lib/gitgitgadget-config.js";
 
 const execChild = util.promisify(execFile);
 
 jest.setTimeout(180000);
 const sourceFileName = fileURLToPath(import.meta.url);
 
-const config = defaultConfig;
+const config = testConfig;
 
 // Create three repos.
 // worktree is a local copy for doing updates and has the config

tests/patch-series.test.ts

@@ -4,8 +4,7 @@ import { git } from "../lib/git.js";
 import { GitNotes } from "../lib/git-notes.js";
 import { PatchSeries } from "../lib/patch-series.js";
 import { ProjectOptions } from "../lib/project-options.js";
-import { testCreateRepo } from "./test-lib.js";
-import defaultConfig from "../lib/gitgitgadget-config.js";
+import { testCreateRepo, testConfig } from "./test-lib.js";
 
 jest.setTimeout(60000);
 const sourceFileName = fileURLToPath(import.meta.url);
@@ -101,7 +100,7 @@ class PatchSeriesTest extends PatchSeries {
         }
 
         const x = new PatchSeriesTest(
-            defaultConfig,
+            testConfig,
             new GitNotes(),
             {},
             new ProjectOptionsTest(),

tests/project-options.test.ts

@@ -4,8 +4,7 @@ import { isDirectory } from "../lib/fs-util.js";
 import { GitNotes } from "../lib/git-notes.js";
 import { PatchSeries } from "../lib/patch-series.js";
 import { ProjectOptions } from "../lib/project-options.js";
-import { testCreateRepo } from "./test-lib.js";
-import defaultConfig from "../lib/gitgitgadget-config.js";
+import { testCreateRepo, testConfig } from "./test-lib.js";
 
 // This test script might take quite a while to run
 jest.setTimeout(20000);
@@ -24,7 +23,7 @@ test("project options", async () => {
     expect(await repo.commit("C")).not.toEqual("");
 
     const options2 = await ProjectOptions.get(
-        defaultConfig,
+        testConfig,
         repo.workDir,
         "test-project-options",
         ["Nguyễn Thái Ngọc Duy <[email protected]>"],
@@ -44,7 +43,7 @@ test("project options", async () => {
                 headLabel: options2.branchName,
                 iteration: 1,
             };
-            const x = new X(defaultConfig, new GitNotes(repo.workDir), {}, options2, prMeta, undefined, 1);
+            const x = new X(testConfig, new GitNotes(repo.workDir), {}, options2, prMeta, undefined, 1);
             const mbox = await x.generateMBox();
             const needle = "=?UTF-8?Q?Nguy=E1=BB=85n_Th=C3=A1i_Ng=E1=BB=8Dc?= Duy";
             expect(mbox).toEqual(expect.stringContaining(needle));

tests/test-lib.ts

@@ -4,8 +4,20 @@ import * as path from "path";
 import { fileURLToPath } from "url";
 import { isDirectory, isFile } from "../lib/fs-util.js";
 import { git, IGitOptions, revParse } from "../lib/git.js";
+import defaultConfig from "../lib/gitgitgadget-config.js";
 const dirName = path.dirname(fileURLToPath(import.meta.url));
 
+export const testConfig = {
+    ...defaultConfig,
+    // We're running in the test suite!
+    project: {
+        cc: [],
+        ...defaultConfig.project,
+        to: "[email protected]",
+        urlPrefix: "https://dummy.com/?mid=",
+    },
+};
+
 export async function removeRecursively(directory: string): Promise<void> {
     if (!(await isDirectory(directory))) {
         await unlink(directory);