feat: improve comparing expected and output contents

diplodoc-platform · Sep 16, 2021 · f94f03b · f94f03b
1 parent 5591094
commit f94f03b
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 29 deletions.
diff --git a/tests/mocks/single-page/test1/input/_includes/third-include.md b/tests/mocks/single-page/test1/input/_includes/third-include.md
@@ -1,2 +1,2 @@
-##Third include
+## Third include
 
diff --git a/tests/single-page.test.ts b/tests/single-page.test.ts
@@ -1,4 +1,4 @@
-import {isEqualDirectories, runYfmDocs, getTestPaths} from './utils';
+import {compareDirectories, runYfmDocs, getTestPaths} from './utils';
 
 describe('Single page', () => {
     test('Test1', () => {
@@ -7,9 +7,15 @@ describe('Single page', () => {
 
         runYfmDocs(inputPath, outputPath);
 
-        const isEqualOutput = isEqualDirectories(outputPath, expectedOutputPath);
+        const compareResult = compareDirectories(outputPath, expectedOutputPath);
 
-        expect(true).toEqual(isEqualOutput);
+        if (typeof compareResult === 'boolean') {
+            expect(true).toEqual(compareResult);
+        } else {
+            const {expectedContent, outputContent} = compareResult;
+
+            expect(expectedContent).toEqual(outputContent);
+        }
     });
 
     test('Test2', () => {
@@ -18,9 +24,15 @@ describe('Single page', () => {
 
         runYfmDocs(inputPath, outputPath);
 
-        const isEqualOutput = isEqualDirectories(outputPath, expectedOutputPath);
+        const compareResult = compareDirectories(outputPath, expectedOutputPath);
+
+        if (typeof compareResult === 'boolean') {
+            expect(true).toEqual(compareResult);
+        } else {
+            const {expectedContent, outputContent} = compareResult;
 
-        expect(true).toEqual(isEqualOutput);
+            expect(expectedContent).toEqual(outputContent);
+        }
     });
 
     test('Test3', () => {
@@ -29,8 +41,14 @@ describe('Single page', () => {
 
         runYfmDocs(inputPath, outputPath);
 
-        const isEqualOutput = isEqualDirectories(outputPath, expectedOutputPath);
+        const compareResult = compareDirectories(outputPath, expectedOutputPath);
+
+        if (typeof compareResult === 'boolean') {
+            expect(true).toEqual(compareResult);
+        } else {
+            const {expectedContent, outputContent} = compareResult;
 
-        expect(true).toEqual(isEqualOutput);
+            expect(expectedContent).toEqual(outputContent);
+        }
     });
 });
diff --git a/tests/utils.ts b/tests/utils.ts
@@ -7,40 +7,51 @@ import isEqual from 'lodash/isEqual';
 
 const yfmDocsPath = require.resolve('../build');
 
-export function isEqualDirectories(expectedOutputPath: string, outputPath: string): boolean {
-    let isEqualOutput = true;
 
+function getFileContent(filePath: string) {
+    try {
+        return readFileSync(filePath, 'utf8');
+    } catch {
+        return '';
+    }
+}
+
+export type CompareResult = {
+    expectedContent: string;
+    outputContent: string;
+} | boolean;
+
+export function compareDirectories(expectedOutputPath: string, outputPath: string): CompareResult {
     const filesFromExpectedOutput = walkSync(expectedOutputPath, {
         directories: false,
         includeBasePath: false,
     });
+    let compareResult: CompareResult = true;
 
     filesFromExpectedOutput.forEach((expectedFilePath) => {
-        try {
-            const fileExtension = extname(expectedFilePath);
-            const expectedContent = readFileSync(resolve(expectedOutputPath, expectedFilePath), 'utf8');
-            const outputContent = readFileSync(resolve(outputPath, expectedFilePath), 'utf8');
+        const fileExtension = extname(expectedFilePath);
+        const expectedContent = getFileContent(resolve(expectedOutputPath, expectedFilePath));
+        const outputContent = getFileContent(resolve(outputPath, expectedFilePath));
 
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            let preparedExpectedContent: any = expectedContent;
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            let preparedOutputContent: any = outputContent;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        let preparedExpectedContent: any = expectedContent;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        let preparedOutputContent: any = outputContent;
 
-            if (fileExtension === '.yaml') {
-                preparedExpectedContent = load(expectedContent);
-                preparedOutputContent = load(outputContent);
-            }
+        if (fileExtension === '.yaml') {
+            preparedExpectedContent = load(expectedContent);
+            preparedOutputContent = load(outputContent);
+        }
 
-            if (!isEqual(preparedExpectedContent, preparedOutputContent)) {
-                isEqualOutput = false;
-            }
-        } catch (e) {
-            console.error(e);
-            isEqualOutput = false;
+        if (!isEqual(preparedExpectedContent, preparedOutputContent)) {
+            compareResult = {
+                expectedContent: preparedExpectedContent,
+                outputContent: preparedOutputContent,
+            };
         }
     });
 
-    return isEqualOutput;
+    return compareResult;
 }
 
 export function runYfmDocs(inputPath: string, outputPath: string): void {