refactor: modularize syntax grammar tests (#510)

* refactor: modularize syntax grammar tests

As we add more TextMate grammars and tests, the bash script we currently
have would not suffice because for an singular snapshot or unit tests,
the TextMate grammar testing software [we
use](https://github.com/PanAeon/vscode-tmgrammar-test) requires

1. The scope of the grammar to test
2. The grammar specification files
3. The test file itself

To conviniently express these requirements for each test, this commit
adds a test runner written in JavaScript with an array specifying the
layout of each test.

* fixup! refactor: modularize syntax grammar tests

* fixup! refactor: modularize syntax grammar tests

* fixup! refactor: modularize syntax grammar tests

Author: ayazhafiz

.gitignore

@@ -12,3 +12,5 @@ dist/
 .vscode/settings.json
 .vimrc
 .nvimrc
+syntaxes/test/*.js
+syntaxes/test/*.map

.travis.yml

@@ -17,7 +17,6 @@ script:
   - ./scripts/build.sh
   - ./scripts/test.sh
   - ./scripts/format.sh
-  - ./scripts/syntax.sh
 
 after_script:
   - ./scripts/cleanup.sh

package.json

@@ -71,14 +71,15 @@
     "compile:banner": "tsc -p server/banner.tsconfig.json && rollup -c banner.rollup.config.js",
     "compile:test": "tsc -b server/src/tests",
     "compile:integration": "tsc -b integration",
+    "compile:syntaxes-test": "tsc -b syntaxes/test",
     "format": "scripts/format.sh",
     "watch": "tsc -b -w",
     "postinstall": "vscode-install && cd client && yarn && cd ../server && yarn && cd ..",
     "package": "rm -rf dist && node scripts/package.js",
     "test": "yarn compile:test && jasmine server/out/tests/*_spec.js",
     "test:lsp": "yarn compile:integration && jasmine integration/out/lsp/*_spec.js",
     "test:e2e": "yarn compile:integration && ./scripts/e2e.sh",
-    "test:syntax": "./scripts/syntax.sh"
+    "test:syntaxes": "yarn compile:syntaxes-test && jasmine syntaxes/test/driver.js"
   },
   "dependencies": {
     "typescript": "~3.6.4"

scripts/syntax.sh

@@ -17,3 +17,6 @@ yarn run test:lsp
 # E2E test that brings up full vscode
 # TODO: Disabled for now because it cannot be run on Travis
 # yarn run test:e2e
+
+# Syntaxes tests
+yarn run test:syntaxes

scripts/test.sh

@@ -0,0 +1,7 @@
+[
+  {
+    "scopeName": "inline-template.ng",
+    "grammarFiles": ["syntaxes/inline-template.json"],
+    "testFile": "syntaxes/test/data/inline-template.ts"
+  }
+]

syntaxes/test/cases.json

@@ -1,4 +1,3 @@
-// SYNTAX TEST "template.ng"
 /* clang-format off */
 
 @Component({

syntaxes/test/inline_template.ts renamed to syntaxes/test/data/inline-template.ts

@@ -1,5 +1,3 @@
->// SYNTAX TEST "template.ng"
-#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ inline-template.ng
 >/* clang-format off */
 #^^^^^^^^^^^^^^^^^^^^^^^ inline-template.ng
 >

syntaxes/test/inline_template.ts.snap renamed to syntaxes/test/data/inline-template.ts.snap

@@ -0,0 +1,57 @@
+#!/usr/bin/env node
+// Usage:
+//   yarn test:syntaxes [options]
+//
+// Options:
+//   -u, --update    update snapshot files (always passes)
+
+import 'jasmine';
+
+import * as cp from 'child_process';
+import * as fs from 'fs';
+import * as path from 'path';
+import * as util from 'util';
+import * as SNAPSHOT_TEST_CASES from './cases.json';
+
+interface TestCase {
+  scopeName: string;
+  grammarFiles: string[];
+  testFile: string;
+}
+
+const dummyGrammarDir = path.join(__dirname, 'dummy');
+const DUMMY_GRAMMARS =
+    fs.readdirSync(dummyGrammarDir).map((file: string) => path.join(dummyGrammarDir, file));
+
+/** Wraps node's spawn in a Promise. */
+function spawn(...args: Parameters<typeof cp.spawn>): Promise<number> {
+  const child = cp.spawn(...args);
+
+  return new Promise((resolve, reject) => {
+    child.on('exit', (code: number) => {
+      if (code === 0)
+        resolve(0);
+      else
+        reject(code);
+    });
+  });
+}
+
+async function snapshotTest({scopeName, grammarFiles, testFile}: TestCase): Promise<number> {
+  grammarFiles.push(...DUMMY_GRAMMARS);
+  const grammarOptions = grammarFiles.reduce((acc, file) => [...acc, '-g', file], [] as string[]);
+  const extraArgs = process.argv.slice(3);
+  const options =
+      ['vscode-tmgrammar-snap', '-s', scopeName, ...grammarOptions, '-t', testFile, ...extraArgs];
+
+  return spawn('yarn', options, {stdio: 'inherit' /* use parent process IO */}).catch(code => code);
+}
+
+describe('snapshot tests', async () => {
+  it('should pass all cases', async () => {
+    for (let tc of SNAPSHOT_TEST_CASES) {
+      const ec = await snapshotTest(tc);
+      expect(ec).toBe(0);
+    }
+  });
+});