Tests work better but not perfectly (spinners persist)

src/e2e/endToEnd.test.ts → src/endToEnd.test.ts

@@ -3,9 +3,9 @@ import path, { dirname } from "path";
 import { fileURLToPath } from "url";
 
 import fastGlob from "fast-glob";
-import { executeConfig } from "../engine/executeConfig.js";
-import { resolveConfigFromDirectory } from "../config.js";
-import { LogCollector } from "../utils/logUtils.js";
+import { executeConfig } from "./engine/executeConfig.js";
+import { resolveConfigFromDirectory } from "./config.js";
+import { LogCollector } from "./utils/logUtils.js";
 
 function rmrf(parentDir: string) {
   console.log("rm -rf", parentDir);
@@ -21,16 +21,24 @@ function rmrf(parentDir: string) {
 }
 
 const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-const inputRoot = path.join(__dirname, "docs");
-const outputRoot = path.join(__dirname, "out");
+const e2eDataRoot = path.resolve(
+  path.join(dirname(__filename), "..", "examples", "e2e")
+);
+const inputRoot = path.join(e2eDataRoot);
+const outputRoot = path.join(inputRoot, "out");
 
 beforeEach(() => {
   rmrf(outputRoot);
 });
+
 test("HTML rendering", async () => {
+  console.log("Tests are looking in", inputRoot);
   const config = resolveConfigFromDirectory(inputRoot, true)!;
-  const logCollector = new LogCollector("E2E", { silent: true });
+  expect(config).toBeTruthy();
+  const logCollector = new LogCollector("E2E", {
+    silent: true,
+    shouldStart: false,
+  });
   await executeConfig(config, ["html"], logCollector);
   expect(logCollector.hasWarningsOrErrors).toBeFalsy();
 });

src/plugins/autoTitlePlugin.test.ts

@@ -5,7 +5,7 @@ import { DocSet } from "../engine/docset.js";
 import { getConfigDefaults } from "../config.js";
 import { LogCollector } from "../utils/logUtils.js";
 
-test("Title is set to first heading by default", () => {
+test("Title is set to first heading by default", async () => {
   const doc: DjockeyDoc = {
     docs: {
       content: parse(
@@ -40,12 +40,14 @@ test("Title is set to first heading by default", () => {
     url_root: "URL_ROOT",
   };
   const docSet = new DocSet(config, [new AutoTitlePlugin()], [doc]);
-  docSet.runPasses(new LogCollector("", { shouldStart: false }));
+  await docSet.runPasses(
+    new LogCollector("", { shouldStart: false, silent: true })
+  );
 
   expect(doc.title).toEqual("Heading 1");
 });
 
-test("Title is set to frontMatter.title if present", () => {
+test("Title is set to frontMatter.title if present", async () => {
   const doc: DjockeyDoc = {
     docs: {
       content: parse(
@@ -80,7 +82,9 @@ test("Title is set to frontMatter.title if present", () => {
     url_root: "URL_ROOT",
   };
   const docSet = new DocSet(config, [new AutoTitlePlugin()], [doc]);
-  docSet.runPasses(new LogCollector("", { shouldStart: false }));
+  await docSet.runPasses(
+    new LogCollector("", { shouldStart: false, silent: true })
+  );
 
   expect(doc.title).toEqual("Custom title");
 });

src/plugins/tableOfContentsPlugin.test.ts

@@ -95,10 +95,12 @@ test("Works end-to-end with LinkRewritingPlugin", async () => {
     [new TableOfContentsPlugin(), new LinkRewritingPlugin(config)],
     [doc]
   );
-  await docSet.runPasses(new LogCollector("", { shouldStart: false }));
+  await docSet.runPasses(
+    new LogCollector("", { shouldStart: false, silent: true })
+  );
   const htmlCopy = docSet.makeRenderableCopy(
     new HTMLRenderer({ relativeLinks: true }),
-    new LogCollector("", { shouldStart: false })
+    new LogCollector("", { shouldStart: false, silent: true })
   )[0];
   const html = renderHTML(htmlCopy.docs.toc);
   expect(html).toEqual(`<ul>

src/utils/logUtils.ts

@@ -25,6 +25,7 @@ export class LogCollector {
   private loader?: ReturnType<typeof print.spin>;
   private silent = false;
   private parent?: LogCollector;
+  private children = new Array<LogCollector>();
 
   constructor(
     public label: string,