@schwabyio/gta 0.9.0 → 0.11.0

package/dist/gta.js

@@ -20,13 +20,15 @@ import {
   parseMarkdown,
   projectEnvironments,
   readProject,
+  referenceProblems,
   relativePosix,
   require_dist,
   resolveFlags,
+  resultName,
   samePath,
   stepsForTags,
   unattempted
-} from "./chunks/chunk-VRAFYQNE.js";
+} from "./chunks/chunk-OM3ZR56O.js";
 
 // src/args.ts
 var UsageError = class extends Error {
@@ -194,7 +196,7 @@ function tally(target, outcome, durationMs) {
     error: null,
     // Named for the row they ran with, when a data file drove the collection.
     problems: summary2.results.flatMap(
-      (r, i) => r.status === "fail" || r.status === "error" ? [{ ...r, item: { ...r.item, name: iterationName(r.item.name, outcome.steps[i]) } }] : []
+      (r, i) => r.status === "fail" || r.status === "error" ? [{ ...r, item: { ...r.item, name: iterationName(resultName(r), outcome.steps[i]) } }] : []
     )
   };
 }
@@ -491,13 +493,13 @@ ${tests || '<p class="dim">No tests were run.</p>'}
 var statusOf = (r) => r.status === "pass" ? "passed" : r.status === "fail" ? "failed" : r.status === "error" ? "errored" : "skipped";
 function testSection(r, index, ref) {
   const status = statusOf(r);
-  const named = escape(iterationName(r.item.name, ref));
+  const named = escape(iterationName(resultName(r), ref));
   const name = r.use ? `${named} <span class="dim">(${escape(r.use.set)} ${r.use.child + 1}/${r.use.of})</span>` : named;
   if (r.skipped) {
-    return `<details class="acc skipped skipped" data-search="${escape(iterationName(r.item.name, ref).toLowerCase())}">
+    return `<details class="acc skipped skipped" data-search="${escape(iterationName(resultName(r), ref).toLowerCase())}">
 <summary><span>Test ${index + 1}: ${name}</span>${icon("skipped")}</summary>
 <div class="acc-body">
-${card("Skipped", field2("Feature Flag", `<span class="c-skipped">${escape(r.skipped.reason)} \u2014 this test was not run</span>`, "wide"))}
+${card("Skipped", field2("Reason", `<span class="c-skipped">${escape(r.skipped.reason)} \u2014 this test was not run</span>`, "wide"))}
 </div>
 </details>`;
   }
@@ -509,7 +511,7 @@ ${card("Skipped", field2("Feature Flag", `<span class="c-skipped">${escape(r.ski
     r.logs?.length ? consoleCard(r) : ""
   ].filter(Boolean);
   const group = status === "passed" ? "passed" : status === "skipped" ? "skipped" : "failed";
-  const search = iterationName(r.item.name, ref).toLowerCase();
+  const search = iterationName(resultName(r), ref).toLowerCase();
   return `<details class="acc ${group} ${status}" data-search="${escape(search)}"${status === "passed" ? "" : " open"}>
 <summary><span>Test ${index + 1}: ${name}</span>${icon(status)}</summary>
 <div class="acc-body">
@@ -950,7 +952,7 @@ function testcase(classname, name, durationMs, body) {
   if (body.length === 0) return [`${open}/>`];
   return [`${open}>`, ...body.map((line) => `      ${line}`), "    </testcase>"];
 }
-var caseName = (result) => result.use ? `${result.item.name} [${result.use.set} ${result.use.child + 1}/${result.use.of}]` : result.item.name;
+var caseName = (result) => result.use ? `${resultName(result)} [${result.use.set} ${result.use.child + 1}/${result.use.of}]` : result.item.name;
 var summarize = (a) => a.message ? `${a.name}: ${a.message}` : a.name;
 function describe(a) {
   const lines = [summarize(a)];
@@ -1070,6 +1072,7 @@ function jsonListing(options) {
     project: options.project,
     environments: options.environments,
     environmentType: options.environmentType,
+    settings: { values: options.settings.values, sources: options.settings.sources },
     flags: { values: options.flags.values, sources: options.flags.sources },
     tags: options.tags,
     notTags: options.notTags ?? [],
@@ -1086,7 +1089,8 @@ function jsonListing(options) {
       tags: target.collection.doc.tags ?? [],
       broken: target.broken
     })),
-    leftOut: { excluded: options.excluded, untagged: options.untagged }
+    leftOut: { excluded: options.excluded, untagged: options.untagged },
+    problems: options.problems
   };
 }
 var fileOf = (collection) => `collections/${collection.relativePath}`;
@@ -1165,13 +1169,11 @@ var SettingsError = class extends Error {
   name = "SettingsError";
 };
 var envNameOf = (key) => `GTA_${key.replace(/[A-Z]/g, (c) => `_${c}`).toUpperCase()}`;
+var DEFAULT_SOURCE = "default";
 async function loadSettings(options) {
-  const { root, overrides = {}, env = process.env } = options;
-  const file = path.join(root, SETTINGS_FILE);
-  let source;
-  try {
-    source = await fs.readFile(file, "utf8");
-  } catch {
+  const { root, global = null, overrides = {}, env = process.env } = options;
+  const own = await readSettingsFile(path.join(root, SETTINGS_FILE), SETTINGS_FILE);
+  if (own === null) {
     throw new SettingsError(
       `There is no ${SETTINGS_FILE} in ${root}.
 gta runs from a project folder: the one holding collections/ and ${SETTINGS_FILE}.
@@ -1182,23 +1184,20 @@ A minimal ${SETTINGS_FILE}:
 `
     );
   }
-  let fromFile;
-  try {
-    fromFile = (0, import_yaml.parse)(source) ?? {};
-  } catch (cause) {
-    throw new SettingsError(`${SETTINGS_FILE} will not parse: ${cause.message}`);
-  }
-  if (typeof fromFile !== "object" || fromFile === null || Array.isArray(fromFile)) {
-    throw new SettingsError(
-      `${SETTINGS_FILE} must be a map of settings, such as limitConcurrency: 4`
-    );
-  }
+  const sharedLabel = global ? path.posix.join(global.uses, SETTINGS_FILE) : "";
+  const shared = global ? await readSettingsFile(path.join(global.root, SETTINGS_FILE), sharedLabel) : null;
   const origin = /* @__PURE__ */ new Map();
   const merged = {};
-  for (const [key, value] of Object.entries(fromFile)) {
-    checkKey(key, SETTINGS_FILE);
-    merged[key] = value;
-    origin.set(key, SETTINGS_FILE);
+  const files = [
+    [sharedLabel, shared],
+    [SETTINGS_FILE, own]
+  ];
+  for (const [label, fromFile] of files) {
+    for (const [key, value] of Object.entries(fromFile ?? {})) {
+      checkKey(key, label);
+      merged[key] = value;
+      origin.set(key, label);
+    }
   }
   for (const key of KEYS) {
     const value = env[envNameOf(key)];
@@ -1220,7 +1219,29 @@ A minimal ${SETTINGS_FILE}:
     throw new SettingsError(`Settings are not valid:
 ${lines.join("\n")}`);
   }
-  return result.data;
+  const sources = Object.fromEntries(
+    KEYS.map((key) => [key, origin.get(key) ?? DEFAULT_SOURCE])
+  );
+  return { settings: result.data, sources };
+}
+async function readSettingsFile(file, label) {
+  let source;
+  try {
+    source = await fs.readFile(file, "utf8");
+  } catch (cause) {
+    if (cause.code === "ENOENT") return null;
+    throw new SettingsError(`${label} cannot be read: ${cause.message}`);
+  }
+  let fromFile;
+  try {
+    fromFile = (0, import_yaml.parse)(source) ?? {};
+  } catch (cause) {
+    throw new SettingsError(`${label} will not parse: ${cause.message}`);
+  }
+  if (typeof fromFile !== "object" || fromFile === null || Array.isArray(fromFile)) {
+    throw new SettingsError(`${label} must be a map of settings, such as limitConcurrency: 4`);
+  }
+  return fromFile;
 }
 function checkKey(key, where) {
   if (!Object.hasOwn(SETTING_KEYS, key)) {
@@ -1248,7 +1269,7 @@ function coerce(key, value, where) {
 }
 
 // src/main.ts
-var VERSION = true ? "0.9.0" : "0.0.0-dev";
+var VERSION = true ? "0.11.0" : "0.0.0-dev";
 var JUNIT_DIR = "junit";
 var JUNIT_FILE = "junit.xml";
 var HTML_DIR = "html";
@@ -1283,23 +1304,28 @@ async function main(argv, cli) {
     const command = args.command;
     if (command === "g" || command === "get") {
       const selection = selectFor(project, { kind: "all" });
+      const problems = await listingProblems(project, selection);
+      const code = problems.length > 0 || selection.targets.some((target) => target.broken) ? EXIT.failed : EXIT.passed;
       if (emit) {
         emit(
           jsonListing({
             project: { name: project.name, root: project.root },
             environments: project.environments,
             environmentType: project.settings.environmentType,
+            settings: { values: project.settings, sources: project.settingSources },
             flags: project.flags,
             tags: project.settings.tags,
             notTags: project.settings.notTags,
             targets: selection.targets,
             excluded: selection.excluded,
-            untagged: selection.untagged
+            untagged: selection.untagged,
+            problems
           })
         );
-        return EXIT.passed;
+        return code;
       }
-      return list(project, selection, ctx, p);
+      list(project, selection, problems, ctx, p);
+      return code;
     }
     const request = command === "a" || command === "all" ? { kind: "all" } : { kind: "list", selectors: command.split(",").filter((s) => s.trim() !== "") };
     return await run(project, selectFor(project, request), ctx, p, emit);
@@ -1321,14 +1347,19 @@ async function openProject(ctx, overrides, flagArgs = []) {
 gta runs from a project folder: the one holding ${COLLECTIONS_DIR}/ and ${SETTINGS_FILE}.`
     );
   }
-  const settings = await loadSettings({ root, overrides, env: ctx.env });
   const info = await readProject(root);
+  const { settings, sources: settingSources } = await loadSettings({
+    root,
+    global: info.global,
+    overrides,
+    env: ctx.env
+  });
   const layout = await discoverProject(root);
   const collections = await loadProjectCollections(root, layout.files);
   const environments = environmentNames(await projectEnvironments(root, info.global));
   if (settings.environmentType && !environments.includes(settings.environmentType)) {
     throw new ProjectError(
-      `environmentType: there is no environment called "${settings.environmentType}". ` + (environments.length > 0 ? `This project has: ${environments.join(", ")}` : `This project has no environments/.`)
+      `environmentType (from ${settingSources.environmentType}): there is no environment called "${settings.environmentType}". ` + (environments.length > 0 ? `This project has: ${environments.join(", ")}` : `This project has no environments/.`)
     );
   }
   let flags;
@@ -1353,6 +1384,7 @@ gta runs from a project folder: the one holding ${COLLECTIONS_DIR}/ and ${SETTIN
     root,
     name: info.doc?.name ?? path2.basename(root),
     settings,
+    settingSources,
     flags,
     collections,
     environments,
@@ -1368,7 +1400,24 @@ var selectFor = (project, request) => selectCollections(project.collections, req
   tags: project.settings.tags,
   notTags: project.settings.notTags
 });
-function list(project, selection, ctx, p) {
+async function listingProblems(project, selection) {
+  const listed = new Set(selection.targets.map((target) => target.id));
+  const problems = [];
+  for (const collection of project.collections) {
+    const id = idOf(collection);
+    const leftOut = listed.has(id) ? null : collection.doc.exclude === true ? "excluded" : "tags";
+    if (collection.problems.length > 0) {
+      const message = collection.problems.map((problem) => problem.message).join("; ");
+      if (leftOut) problems.push({ id, leftOut, step: null, message });
+      continue;
+    }
+    for (const problem of await referenceProblems(collection.doc, collection.path)) {
+      problems.push({ id, leftOut, ...problem });
+    }
+  }
+  return problems;
+}
+function list(project, selection, problems, ctx, p) {
   const { settings } = project;
   ctx.out(field("Project", `${project.name} ${p.dim(project.root)}`));
   ctx.out(
@@ -1379,8 +1428,7 @@ function list(project, selection, ctx, p) {
   );
   ctx.out(field("Flags", flagLine(project.flags, p)));
   if (project.caFiles.length > 0) ctx.out(field("CA files", project.caFiles.join(", ")));
-  if (settings.tags.length > 0) ctx.out(field("Tags", settings.tags.join(", ")));
-  if (settings.notTags.length > 0) ctx.out(field("Not tags", settings.notTags.join(", ")));
+  for (const line of settingLines(project, p)) ctx.out(line);
   ctx.out("");
   const width = nameWidthFor(selection.targets.map((t) => t.id));
   const dirWidth = Math.max(
@@ -1406,6 +1454,12 @@ function list(project, selection, ctx, p) {
   for (const target of selection.targets.filter((t) => t.broken)) {
     ctx.out(`${p.red("broken")} ${target.id}: ${target.broken}`);
   }
+  const leftOut = { excluded: " (excluded)", tags: " (left out by tags)" };
+  for (const problem of problems) {
+    const step = problem.step === null ? "" : `, ${problem.stage ? `${problem.stage} ` : ""}step ${problem.step + 1}`;
+    const where = `${problem.id}${problem.leftOut ? leftOut[problem.leftOut] : ""}${step}`;
+    ctx.out(`${p.red("broken")} ${where}: ${problem.message}`);
+  }
   if (selection.excluded.length > 0) {
     ctx.out(field("Excluded", `${selection.excluded.join(", ")} ${p.dim("(exclude: true)")}`));
   }
@@ -1414,8 +1468,20 @@ function list(project, selection, ctx, p) {
   }
   const steps = selection.targets.reduce((n, t) => n + stepCountOf(t), 0);
   ctx.out(field("Total", `${selection.targets.length} collections, ${steps} steps`));
-  return EXIT.passed;
 }
+function settingLines(project, p) {
+  const rows = Object.keys(SETTING_KEYS).filter((key) => project.settingSources[key] !== DEFAULT_SOURCE).map((key) => ({
+    cell: `${key}: ${shownSetting(project.settings[key])}`,
+    source: project.settingSources[key]
+  }));
+  if (rows.length === 0) return [field("Settings", p.dim("all defaults"))];
+  const width = Math.max(...rows.map((row) => row.cell.length));
+  const indent = " ".repeat(field("Settings", "").length);
+  return rows.map(
+    (row, i) => `${i === 0 ? field("Settings", "") : indent}${row.cell.padEnd(width)}  ${p.dim(row.source)}`
+  );
+}
+var shownSetting = (value) => Array.isArray(value) ? value.length > 0 ? value.join(", ") : "[]" : String(value ?? "none");
 async function run(project, selection, ctx, p, emit = null) {
   const { settings } = project;
   const width = nameWidthFor(selection.targets.map((t) => t.id));
@@ -1603,6 +1669,8 @@ function usage(p) {
     "",
     `  ${p.bold("Commands:")}`,
     "    g, get          List the collections `gta all` would run, without running them.",
+    "                    Exits 1 on a broken collection, or a use:, extends: or body",
+    "                    file that would stop a run, in any collection.",
     "    a, all          Run every collection, less those with exclude: true.",
     "    <list>          Run the collections and directories named, comma separated,",
     "                    in that order: smoke,checkout/sessions,payments",
@@ -1617,7 +1685,8 @@ function usage(p) {
     "                    Override a feature flag for this run; any number of them.",
     "                    GTA_FLAG_<name>=value does the same from the environment.",
     "",
-    `  ${p.bold("Settings")} (settings.yml, then GTA_* environment variables, then --flags):`,
+    `  ${p.bold("Settings")} (the global project's settings.yml, then this project's, then`,
+    "  GTA_* environment variables, then --flags; gta get shows where each came from):",
     ...settings,
     "",
     `  ${p.bold("Exit code:")} 0 passed, 1 failed, 2 could not run (or write a report).`

package/dist/worker.js

@@ -3,7 +3,7 @@ import { createRequire as __gtaCreateRequire } from 'node:module';
 const require = __gtaCreateRequire(import.meta.url);
 import {
   runJob
-} from "./chunks/chunk-VRAFYQNE.js";
+} from "./chunks/chunk-OM3ZR56O.js";
 
 // src/worker.ts
 import { parentPort, workerData } from "node:worker_threads";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schwabyio/gta",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "type": "module",
   "description": "gta, the Gravity Test Automation command-line runner: HTTP API tests written as YAML files, run from a terminal or CI.",
   "keywords": [