test - auto detect project output directory now

 this better handle project accross all our tests

Author: cderv

tests/smoke/extensions/extension-render-project.test.ts

@@ -4,38 +4,20 @@
  * Copyright (C) 2020-2022 Posit Software, PBC
  */
 
-import { docs } from "../../utils.ts";
+import { docs, projectOutputForInput } from "../../utils.ts";
 
 import { basename, dirname, extname, join, relative } from "../../../src/deno_ral/path.ts";
 import { ensureHtmlElements } from "../../verify.ts";
 import { testQuartoCmd } from "../../test.ts";
 import { noErrors } from "../../verify.ts";
 import { existsSync } from "fs/mod.ts";
 
-const siteOutputForInput = (rootDir: string, input: string) => {
-  const dir = join(rootDir, "_site");
-  const stem = basename(input, extname(input));
-
-  const outputPath = join(
-    dir,
-    dirname(relative(rootDir, input)),
-    `${stem}.html`,
-  );
-  const supportPath = join(dir, `site_libs`);
-
-  return {
-    outputPath,
-    supportPath,
-  };
-};
-
 const testRender = (
-  rootDir: string,
   input: string,
   includeSelectors: string[],
   excludeSelectors: string[],
 ) => {
-  const output = siteOutputForInput(rootDir, input);
+  const output = projectOutputForInput(input);
   const verifySel = ensureHtmlElements(
     output.outputPath,
     includeSelectors,
@@ -63,8 +45,7 @@ const rootDir = docs("extensions/project/");
 
 // Render the home page and verify the output
 // contains the extension shortcodes and filter elements
-const rootInput = join(rootDir, "posts/welcome/index.qmd");
-testRender(rootDir, rootInput, [
+testRender(join(rootDir, "posts/welcome/index.qmd"), [
   "a.lightbox",
   "i.fa-solid.fa-anchor",
   "i.fa-solid.fa-bacteria",
@@ -74,7 +55,7 @@ testRender(rootDir, rootInput, [
 // Render the welcome page (subdirectory) and verify the output
 // contains the extension shortcodes and filter elements
 const subdirInput = join(rootDir, "posts/welcome/index.qmd");
-testRender(rootDir, subdirInput, [
+testRender(join(rootDir, "posts/welcome/index.qmd"), [
   "a.lightbox",
   "i.fa-solid.fa-anchor",
   "i.fa-solid.fa-bacteria",

tests/smoke/jats/render-manuscript.test.ts

@@ -11,15 +11,14 @@ import { ensureMECAValidates, ensureXmlValidatesWithXsd } from "../../verify.ts"
 import { testRender } from "../render/render.ts";
 
 const xsdPath = docs(join("jats", "xsd", "JATS-Archiving-1-2-MathML2-DTD"));
-const projectOutDir = "_manuscript";
 
 const testContext = undefined;
 const args = undefined;
 
 // Test a basic manuscript render (this will include a sub-notebook which should
 // nonetheless validate)
 const input = docs(join("jats", "manuscript", "index.ipynb"));
-const output = outputForInput(input, "jats", projectOutDir);
+const output = outputForInput(input, "jats");
 const mecaOutput = join(dirname(output.outputPath), "index-meca.zip");
 
 // Test the article and ensure that it validates
@@ -29,6 +28,5 @@ testRender(
   false,
   [ensureXmlValidatesWithXsd(output.outputPath, xsdPath), ensureMECAValidates(mecaOutput)],
   testContext,
-  args,
-  projectOutDir,
+  args
 );

tests/smoke/project/common.ts

@@ -21,14 +21,15 @@ export async function cleanWorking() {
 
 export type OutputVerify = (outputDir: string) => Verify[];
 
+// This is similar to testSite.
+// It tests a project render, and allow to verify output directory assertions
 export const testProjectRender = (
   input: string,
   to: string,
-  outputDir: string,
-  outputVerify: OutputVerify
+  outputVerify: OutputVerify = (_outDir: string): Verify[] => [],
 ) => {
 
-  const output = outputForInput(input, to, outputDir);
+  const output = outputForInput(input, to);
   const outDir = dirname(output.outputPath);
   const outVerify = outputVerify(outDir);
 

tests/smoke/render/render-email.test.ts

@@ -38,8 +38,8 @@ testRender(docs("email/email-attach.qmd"), "email", false, [fileExists(previewFi
 // Test an email render that has no subject line, this verifies that `rsc_email_subject` key is present and the value is an empty string
 testRender(docs("email/email-no-subject.qmd"), "email", false, [fileExists(previewFile), validJsonWithFields(jsonFile, {"rsc_email_subject": ""})], cleanupCtx);
 
-// Render in a project with an output directory and confirm that everything ends up in the output directory
-testProjectRender(docs("email/project/email-attach.qmd"), "email", "_out", (outputDir: string) => {
+// Render in a project with an output directory set in _quarto.yml and confirm that everything ends up in the output directory
+testProjectRender(docs("email/project/email-attach.qmd"), "email", (outputDir: string) => {
   const verify: Verify[]= [];
   const json = join(outputDir, ".output_metadata.json");
   const preview = join(outputDir, "email-preview", "index.html");

tests/smoke/render/render.ts

@@ -80,10 +80,11 @@ export function cleanoutput(
   input: string, 
   to: string, 
   projectOutDir?: string,
+  projectRoot?: string,
   // deno-lint-ignore no-explicit-any
   metadata?: Record<string, any>,
 ) {
-  const out = outputForInput(input, to, projectOutDir, metadata);
+  const out = outputForInput(input, to, projectOutDir, projectRoot, metadata);
   if (safeExistsSync(out.outputPath)) {
     safeRemoveSync(out.outputPath);
   }

tests/smoke/site/render-shortcode-navbar.test.ts

@@ -4,7 +4,7 @@
 * Copyright (C) 2020-2022 Posit Software, PBC
 *
 */
-import { docs, siteOutputForInput } from "../../utils.ts";
+import { docs, projectOutputForInput } from "../../utils.ts";
 import { ensureFileRegexMatches } from "../../verify.ts";
 import { testSite } from "./site.ts";
 
@@ -14,7 +14,7 @@ testSite(
   [],
   [],
   ensureFileRegexMatches(
-    siteOutputForInput(docs("websites/issue-3686/index.qmd"))
+    projectOutputForInput(docs("websites/issue-3686/index.qmd"))
       .outputPath,
     [],
     [/\{\{\&lt\;/, /\&gt\;\}\}/],

tests/smoke/site/site.ts

@@ -6,7 +6,7 @@
 import { existsSync } from "fs/mod.ts";
 import { dirname } from "../../../src/deno_ral/path.ts";
 import { testQuartoCmd, Verify } from "../../test.ts";
-import { siteOutputForInput } from "../../utils.ts";
+import { projectOutputForInput } from "../../utils.ts";
 import { ensureHtmlElements, noErrorsOrWarnings } from "../../verify.ts";
 
 export const testSite = (
@@ -16,7 +16,7 @@ export const testSite = (
   excludeSelectors: string[],
   ...verify: Verify[]
 ) => {
-  const output = siteOutputForInput(input);
+  const output = projectOutputForInput(input);
 
   const verifySel = ensureHtmlElements(
     output.outputPath,

tests/smoke/smoke-all.test.ts

@@ -125,8 +125,9 @@ function resolveTestSpecs(
           verifyFns.push(noErrors);
         } else {
           // See if there is a project and grab it's type
-          const projectOutDir = findProjectOutputDir(findSmokeAllProjectDir(input));
-          const outputFile = outputForInput(input, format, projectOutDir, metadata);
+          const projectPath = findSmokeAllProjectDir(input)
+          const projectOutDir = findProjectOutputDir(projectPath);
+          const outputFile = outputForInput(input, format, projectOutDir, projectPath, metadata);
           if (key === "fileExists") {
             for (
               const [path, file] of Object.entries(
@@ -284,7 +285,7 @@ for (const { path: fileName } of files) {
                   return Promise.resolve(true);
                 },
                 teardown: () => {
-                  cleanoutput(input, format, undefined, metadata);
+                  cleanoutput(input, format, undefined, undefined, metadata);
                   testSpecResolve(); // Resolve the promise for the testSpec
                   return Promise.resolve();
                 },

tests/utils.ts

@@ -5,7 +5,7 @@
 *
 */
 
-import { basename, dirname, extname, join } from "../src/deno_ral/path.ts";
+import { basename, dirname, extname, join, relative } from "../src/deno_ral/path.ts";
 import { parseFormatString } from "../src/core/pandoc/pandoc-formats.ts";
 import { kMetadataFormat, kOutputExt } from "../src/config/constants.ts";
 import { safeExistsSync } from "../src/core/path.ts";
@@ -73,11 +73,14 @@ export function outputForInput(
   input: string,
   to: string,
   projectOutDir?: string,
+  projectRoot?: string,
   // deno-lint-ignore no-explicit-any
   metadata?: Record<string, any>,
 ) {
   // TODO: Consider improving this (e.g. for cases like Beamer, or typst)
-  const dir = dirname(input);
+  projectRoot = projectRoot ?? findProjectDir(input);
+  projectOutDir = projectOutDir ?? findProjectOutputDir(projectRoot);
+  const dir = projectRoot ? relative(projectRoot, dirname(input)) : dirname(input);
   let stem = basename(input, extname(input));
   let ext = metadata?.[kMetadataFormat]?.[to]?.[kOutputExt];
 
@@ -139,11 +142,11 @@ export function outputForInput(
     }
   }
 
-  const outputPath = projectOutDir
-    ? join(dir, projectOutDir, `${stem}.${outputExt}`)
-    : join(dir, `${stem}.${outputExt}`);
-  const supportPath = projectOutDir
-    ? join(dir, projectOutDir, `${stem}_files`)
+  const outputPath: string = projectRoot && projectOutDir
+      ? join(projectRoot, projectOutDir, dir, `${stem}.${outputExt}`)
+      : join(dir, `${stem}.${outputExt}`);
+  const supportPath: string = projectRoot && projectOutDir
+    ? join(projectRoot, projectOutDir, dir, `${stem}_files`)
     : join(dir, `${stem}_files`);
 
   return {
@@ -152,8 +155,13 @@ export function outputForInput(
   };
 }
 
-export function siteOutputForInput(input: string) {
-  const dir = join(dirname(input), "_site");
+export function projectOutputForInput(input: string) {
+  const projectDir = findProjectDir(input);
+  const projectOutDir = findProjectOutputDir(projectDir);
+  if (!projectDir) {
+    throw new Error("No project directory found");
+  }
+  const dir = join(projectDir, projectOutDir, relative(projectDir, dirname(input)));
   const stem = basename(input, extname(input));
 
   const outputPath = join(dir, `${stem}.html`);