test: Allow different package names and versions for subfolders (#106)

We add a separate JSON file which tracks the project names and versions.
This makes it easy to add tests with unusual project names and versions,
to make sure we're handling those correctly end-to-end.

Author: varungandhi-src

packages/pyright-scip/snapshots/input/odd_pkg_name_1/main.py

@@ -0,0 +1,4 @@
+def main():
+    pass
+
+main()

packages/pyright-scip/snapshots/output/odd_pkg_name_1/main.py

@@ -0,0 +1,13 @@
+# < definition scip-python python package with space 0.1 main/__init__:
+#documentation (module) main
+
+def main():
+#   ^^^^ definition  package with space 0.1 main/main().
+#   documentation ```python
+#               > def main(): # -> None:
+#               > ```
+    pass
+
+main()
+#^^^ reference  package with space 0.1 main/main().
+

packages/pyright-scip/snapshots/packageInfo.json

@@ -0,0 +1,12 @@
+{
+  "default": {
+    "name": "snapshot-util",
+    "version": "0.1"
+  },
+  "special": {
+    "odd_pkg_name_1": {
+      "name": "package with space",
+      "version": "0.1"
+    }
+  }
+}

packages/pyright-scip/test/test-main.ts

@@ -1,25 +1,45 @@
 import { main } from '../src/main-impl';
 import * as path from 'path';
+import * as fs from 'fs';
 
 function testMain(mode: 'check' | 'update'): void {
     const nodePath = process.argv[0];
-    const argv = [
-        nodePath,
-        path.resolve('./index.js'),
-        'snapshot-dir',
-        './snapshots',
-        '--environment',
-        'snapshots/testEnv.json',
-        '--quiet',
-        '--project-name',
-        'snapshot-util',
-        '--project-version',
-        '0.1',
-    ];
-    if (mode === 'check') {
-        argv.push('--check');
+    const startCwd = process.cwd();
+    // Returns list of subdir names, not absolute paths.
+    const inputDir = path.join('.', 'snapshots', 'input');
+    const subdirNames = fs.readdirSync(inputDir);
+    const packageInfoPath = path.join('.', 'snapshots', 'packageInfo.json');
+    const packageInfo = JSON.parse(fs.readFileSync(packageInfoPath, 'utf8'));
+    for (const subdirName of subdirNames) {
+        console.assert(!subdirName.includes(path.sep));
+        let projectName = packageInfo['default']['name'];
+        let projectVersion = packageInfo['default']['version'];
+        if (subdirName in packageInfo['special']) {
+            projectName = packageInfo['special'][subdirName]['name'];
+            projectVersion = packageInfo['special'][subdirName]['version'];
+        }
+        const argv = [
+            nodePath,
+            path.resolve('./index.js'),
+            'snapshot-dir',
+            './snapshots',
+            '--environment',
+            'snapshots/testEnv.json',
+            '--quiet',
+            '--project-name',
+            projectName,
+            '--project-version',
+            projectVersion,
+            '--only',
+            subdirName,
+        ];
+        if (mode === 'check') {
+            argv.push('--check');
+        }
+        main(argv);
+        // main changes the working directory; reset it.
+        process.chdir(startCwd);
     }
-    main(argv);
 }
 
 if (process.argv.indexOf('--check') !== -1) {