Unify baseline generation and verification

Author: sheetalkamat

tests/build.ts

@@ -1,5 +1,4 @@
 import * as vt from 'vscode-textmate/release/main';
-import fs = require('fs');
 import path = require('path');
 
 const tsGrammarFileName = "TypeScript.tmLanguage"
@@ -87,7 +86,8 @@ function getBaseline(grammar: Grammar, outputLines: string[]) {
     return grammarInfo + outputLines.join('\n');
 }
 
-function getScopesAtMarkers(text: string, grammar: vt.IGrammar): { markerScopes: string, wholeBaseline: string } {
+export function generateScopes(text: string, parsedFileName: path.ParsedPath): { markerScopes: string, wholeBaseline: string } {
+    const grammar = parsedFileName.ext === '.tsx' ? tsReactGrammar : tsGrammar;
     const oriLines = text.split('\n');
 
     let mainGrammar = initGrammar(grammar);
@@ -155,35 +155,4 @@ function writeTokenLine(token: vt.IToken, preTextForToken: string, postTextForTo
     }
     outputLines.push(startingSpaces + locatingString);
     outputLines.push(startingSpaces + preTextForToken + token.scopes.join(' ') + postTextForToken);
-}
-
-const generatedFolder = "generated";
-
-function ensureCleanGeneratedFolder() {
-    if (fs.existsSync(generatedFolder)) {
-        for (const fileName of fs.readdirSync(generatedFolder)) {
-            fs.unlinkSync(path.join(generatedFolder, fileName));
-        }
-        fs.rmdirSync(generatedFolder);
-    }
-    fs.mkdirSync(generatedFolder);
-}
-
-// Ensure generated folder
-ensureCleanGeneratedFolder();
-
-// Generate the new baselines
-for (var fileName of fs.readdirSync('cases')) {
-    const text = fs.readFileSync(path.join('./cases', fileName), 'utf8');
-    const parsedFileName = path.parse(fileName);
-    const grammar = parsedFileName.ext === '.tsx' ? tsReactGrammar : tsGrammar;
-
-    const outputFileName = path.join(generatedFolder, parsedFileName.name + '.txt');
-    const { markerScopes, wholeBaseline } = getScopesAtMarkers(text, grammar);
-    if (markerScopes) {
-        fs.writeFileSync(outputFileName, markerScopes, "utf8");
-    }
-
-    const outputBaselineName = path.join(generatedFolder, parsedFileName.name + '.baseline.txt');
-    fs.writeFileSync(outputBaselineName, wholeBaseline, "utf8");
-}
+}

tests/package.json

@@ -5,7 +5,7 @@
   "description": "",
   "main": "test.ts",
   "scripts": {
-    "pretest": "node ../build/build.js && tsc && node ./build.js",
+    "pretest": "node ../build/build.js && tsc",
     "test": "mocha test.js"
   },
   "dependencies": {

tests/test.ts

@@ -1,26 +1,48 @@
 import fs = require('fs');
+import path = require('path');
 import chai = require('chai');
+import build = require('./build');
 
-function getFileText(file: string) {
-    return fs.existsSync(file) ? fs.readFileSync(file, 'utf8') : undefined;
+const generatedFolder = "generated";
+const baselineFolder = "baselines";
+
+function ensureCleanGeneratedFolder() {
+    if (fs.existsSync(generatedFolder)) {
+        for (const fileName of fs.readdirSync(generatedFolder)) {
+            fs.unlinkSync(path.join(generatedFolder, fileName));
+        }
+        fs.rmdirSync(generatedFolder);
+    }
+    fs.mkdirSync(generatedFolder);
 }
 
-describe("Compare generated with baselines", () => {
-    for (var file of fs.readdirSync('generated')) {
-        var generatedText = getFileText('generated/' + file);
-        var baselinesText = getFileText('baselines/' + file);
+// Ensure generated folder
+ensureCleanGeneratedFolder();
 
-        addTestCase(file, generatedText, baselinesText);
-    }
-})
+// Generate the new baselines
+for (const fileName of fs.readdirSync('cases')) {
+    describe("Generating baseline for " + fileName, () => {
+        const text = fs.readFileSync(path.join('./cases', fileName), 'utf8');
+        const parsedFileName = path.parse(fileName);
+        const { markerScopes, wholeBaseline } = build.generateScopes(text, parsedFileName);
+        if (markerScopes) {
+            addTestCase(parsedFileName.name + '.txt', markerScopes);
+        }
+        addTestCase(parsedFileName.name + '.baseline.txt', wholeBaseline);
+    });
+}
+
+function addTestCase(file: string, generatedText: string) {
+    const generatedFileName = path.join(generatedFolder, file);
+    fs.writeFileSync(generatedFileName, generatedText, "utf8");
 
-function addTestCase(file: string, generatedText: string, baselinesText: string) {
-    it('Comparing ' + file, () => {
-        if (baselinesText === undefined) {
-            chai.assert(false, "Extra generated baseline");
+    it('Comparing generated' + file, () => {
+        const baselineFile = path.join(baselineFolder, file);
+        if (fs.existsSync(baselineFile)) {
+            chai.assert.equal(generatedText, fs.readFileSync(baselineFile, 'utf8'), "Expected baselines to match");
         }
         else {
-            chai.assert.equal(generatedText, baselinesText, "Expected baselines to match");
+            chai.assert(false, "New generated baseline");
         }
     });
 }