Merge pull request #3631 from obsidian-tasks-group/refactor-test-data-loading

internal: Refactor loading of test data, to simplify code

Author: claremacrae

contributing/Testing/Using Obsidian API in tests.md

@@ -13,13 +13,16 @@ The Tasks plugin uses data created by the Obsidian API. The Obsidian API does no
 So we need a way to access Obsidian-generated data in our tests. This page tries to describe this mechanism.
 
 1. [resources/sample_vaults/Tasks-Demo/Test Data](https://github.com/obsidian-tasks-group/obsidian-tasks/tree/main/resources/sample_vaults/Tasks-Demo/Test%20Data) contains representative samples Markdown files for different scenarios.
-2. The process described in [[#Test data creation sequence]] converts these files to matching JSON files in [tests/Obsidian/\_\_test_data\_\_](https://github.com/obsidian-tasks-group/obsidian-tasks/tree/main/tests/Obsidian/__test_data__).
-3. See all the [uses of this data so far, in Tasks tests](https://github.com/search?q=repo%3Aobsidian-tasks-group%2Fobsidian-tasks+__test_data__+language%3ATypeScript&type=code&l=TypeScript).
+2. The process described in [[#Test data creation sequence]] below converts these files to matching JSON files in [tests/Obsidian/\_\_test_data\_\_](https://github.com/obsidian-tasks-group/obsidian-tasks/tree/main/tests/Obsidian/__test_data__).
+3. In tests:
+    - use [MockDataLoader.get()](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/tests/TestingTools/MockDataLoader.ts) and some related functions, to read in the saved JSON files to memory
+    - `MockDataName` in [AllCacheSampleData.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/tests/Obsidian/AllCacheSampleData.ts) shows the names of all the available files, in a type-safe way.
+4. See all the [uses of this data so far, in Tasks tests](https://github.com/search?type=code&q=repo%3Aobsidian-tasks-group%2Fobsidian-tasks+%2F%28AllMockDataNames%7Cbuilder.mockData%7CgetMockDataAndReadTasks%7ClistPathAndData%7CMockDataLoader%7CMockDataName%7CreadTasksFromSimulatedFile%7CSimulatedFile%29%2F).
 
 ## Test data creation sequence
-  
+
 If using this on an Obsidian version newer than the one in saved `tests/Obsidian/__test_data__/*.json`, go to Settings → Files and links → Advanced → Rebuild vault cache.
-  
+
 - Create a sample markdown file in Tasks demo vault (root/Test Data/) with the simplest content to represent your test case. Choose a meaningful file name in snake case. See example in `Test Data/one_task.md`.
   - There is a Templater template that may help with creating a new file, for single-tasks cases: `resources/sample_vaults/Tasks-Demo/_meta/templates/Test Data file.md`.
 - Open any other note in the vault, just so that Templater will run.

resources/sample_vaults/Tasks-Demo/_meta/templater_scripts/convert_test_data_markdown_to_js.js

@@ -125,30 +125,33 @@ async function convertMarkdownFileToTestFunction(filePath, tp) {
 async function writeListOfAllTestFunctions(files) {
     const basenames = files.map((file) => getBasename(file));
 
-    const imports = basenames.map((filename) => `import ${filename} from './__test_data__/${filename}.json';`);
-    const functions = basenames.map((filename) => `        ${filename},`);
-
     const content = `// DO NOT EDIT!
 // This file is machine-generated in the test vault, by convert_test_data_markdown_to_js.js.
 
 import type { SimulatedFile } from './SimulatedFile';
 
-${imports.join('\n')}
+export type MockDataName =
+    | '${basenames.join("'\n    | '")}';
 
 /**
- * All the sample data in \`resources/sample_vaults/Tasks-Demo/Test Data\`.
+ * Names of all the sample data in \`resources/sample_vaults/Tasks-Demo/Test Data\`.
+ * Example use:
+ *
+ * \`\`\`typescript
+ *      const tasks: Task[] = AllMockDataNames.flatMap((testDataName) => {
+ *          return readTasksFromSimulatedFile(testDataName);
+ *      });
+ * \`\`\`
  *
  * Related code that uses some or all of this data:
  * - {@link SimulatedFile}
  * - {@link readTasksFromSimulatedFile}
  * - {@link getTasksFileFromMockData}
  * - {@link listPathAndData}
  */
-export function allCacheSampleData(): SimulatedFile[] {
-    return [
-${functions.join('\n')}
-    ];
-}
+export const AllMockDataNames: MockDataName[] = [
+    '${basenames.join("',\n    '")}',
+];
 `;
 
     const testSourceFile = getOutputFilePath('AllCacheSampleData.ts');

tests/DocumentationSamples/DefaultsDocs/DocsSamplesForDefaults.test.ts

@@ -2,23 +2,23 @@ import type { Pos } from 'obsidian';
 
 import { verify, verifyAsJson } from 'approvals/lib/Providers/Jest/JestApprovals';
 import { getTasksFileFromMockData } from '../../TestingTools/MockDataHelpers';
-import docs_sample_for_task_properties_reference from '../../Obsidian/__test_data__/docs_sample_for_task_properties_reference.json';
-import query_file_defaults_all_options_null from '../../Obsidian/__test_data__/query_file_defaults_all_options_null.json';
-import query_file_defaults_all_options_true from '../../Obsidian/__test_data__/query_file_defaults_all_options_true.json';
-import query_file_defaults_short_mode from '../../Obsidian/__test_data__/query_file_defaults_short_mode.json';
 import { verifyWithFileExtension } from '../../TestingTools/ApprovalTestHelpers';
 import { verifyMarkdown, verifyMarkdownForDocs } from '../../TestingTools/VerifyMarkdown';
 import { QueryFileDefaults } from '../../../src/Query/QueryFileDefaults';
+import { MockDataLoader } from '../../TestingTools/MockDataLoader';
+import type { MockDataName } from '../../Obsidian/AllCacheSampleData';
 
-function extractFrontmatter(data: any) {
-    const queryFile = getTasksFileFromMockData(data);
+function extractFrontmatter(testDataName: MockDataName) {
+    const data = MockDataLoader.get(testDataName);
+    const queryFile = getTasksFileFromMockData(testDataName);
     const pos: Pos | undefined = queryFile.cachedMetadata.frontmatterPosition;
     return data.fileContents.slice(pos?.start.offset ?? 0, pos?.end.offset ?? 0);
 }
 
 describe('DocsSamplesForDefaults', () => {
     it('supported-properties-empty', () => {
-        const frontmatter = extractFrontmatter(query_file_defaults_all_options_null);
+        const testDataName = 'query_file_defaults_all_options_null';
+        const frontmatter = extractFrontmatter(testDataName);
 
         // Make sure that any trailing spaces have been removed from the
         // properties in query_file_defaults_all_options_null.md, to avoid
@@ -30,25 +30,24 @@ describe('DocsSamplesForDefaults', () => {
     });
 
     it('supported-properties-full', () => {
-        verifyWithFileExtension(extractFrontmatter(query_file_defaults_all_options_true), '.yaml');
+        verifyWithFileExtension(extractFrontmatter('query_file_defaults_all_options_true'), '.yaml');
     });
 
     it('interpret_properties', () => {
-        verifyWithFileExtension(extractFrontmatter(docs_sample_for_task_properties_reference), '.yaml');
+        verifyWithFileExtension(extractFrontmatter('docs_sample_for_task_properties_reference'), '.yaml');
     });
 
     describe('demo-short-mode', () => {
-        // Load query_file_defaults_short_mode.json
-        const data = query_file_defaults_short_mode;
+        const testDataName = 'query_file_defaults_short_mode';
 
         it('yaml', () => {
             // Extract the frontmatter to a file, for docs
-            verifyWithFileExtension(extractFrontmatter(data), '.yaml');
+            verifyWithFileExtension(extractFrontmatter(testDataName), '.yaml');
         });
 
         it('instructions', () => {
             // Create the instruction from it, for docs
-            const tasksFile = getTasksFileFromMockData(data);
+            const tasksFile = getTasksFileFromMockData(testDataName);
             const generatedSource = new QueryFileDefaults().source(tasksFile);
             verify(generatedSource);
         });