Generate tests properly

Author: Kartik Raj

src/test/pythonEnvironments/base/common.ts

@@ -3,7 +3,7 @@
 
 import { expect } from 'chai';
 import * as path from 'path';
-import { Event } from 'vscode';
+import { Event, Uri } from 'vscode';
 import { createDeferred, flattenIterator, iterable, mapToIterator } from '../../../client/common/utils/async';
 import { getArchitecture } from '../../../client/common/utils/platform';
 import { getVersionString } from '../../../client/common/utils/version';
@@ -35,6 +35,7 @@ export function createLocatedEnv(
     kind = PythonEnvKind.Unknown,
     exec: string | PythonExecutableInfo = 'python',
     distro: PythonDistroInfo = { org: '' },
+    searchLocation?: Uri,
 ): PythonEnvInfo {
     const location =
         locationStr === ''
@@ -57,6 +58,7 @@ export function createLocatedEnv(
         executable,
         location,
         version,
+        searchLocation,
     });
     env.arch = getArchitecture();
     env.distro = distro;

src/test/pythonEnvironments/base/info/env.unit.test.ts

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 import * as assert from 'assert';
+import { Uri } from 'vscode';
 import { Architecture } from '../../../../client/common/utils/platform';
 import { parseVersionInfo } from '../../../../client/common/utils/version';
 import { PythonEnvInfo, PythonDistroInfo, PythonEnvKind } from '../../../../client/pythonEnvironments/base/info';
@@ -11,6 +12,7 @@ import { createLocatedEnv } from '../common';
 suite('Environment helpers', () => {
     const name = 'my-env';
     const location = 'x/y/z/spam/';
+    const searchLocation = 'x/y/z';
     const arch = Architecture.x64;
     const version = '3.8.1';
     const kind = PythonEnvKind.Venv;
@@ -28,44 +30,50 @@ suite('Environment helpers', () => {
         distro?: PythonDistroInfo;
         display?: string;
         location?: string;
+        searchLocation?: string;
     }): PythonEnvInfo {
         const env = createLocatedEnv(
             info.location || '',
             info.version || '',
             info.kind || PythonEnvKind.Unknown,
             'python', // exec
             info.distro,
+            info.searchLocation ? Uri.file(info.searchLocation) : undefined,
         );
         env.name = info.name || '';
         env.arch = info.arch || Architecture.Unknown;
         env.display = info.display;
         return env;
     }
-    const tests: [PythonEnvInfo, string, string][] = [
-        [getEnv({}), 'Python', 'Python'],
-        [getEnv({ version, arch, name, kind, distro }), "Python 3.8.1 ('my-env')", "Python 3.8.1 ('my-env': venv)"],
-        // without "suffix" info
-        [getEnv({ version }), 'Python 3.8.1', 'Python 3.8.1'],
-        [getEnv({ arch }), 'Python 64-bit', 'Python 64-bit'],
-        [getEnv({ version, arch }), 'Python 3.8.1 64-bit', 'Python 3.8.1 64-bit'],
-        // with "suffix" info
-        [getEnv({ name }), "Python ('my-env')", "Python ('my-env')"],
-        [getEnv({ kind }), 'Python', 'Python (venv)'],
-        [getEnv({ name, kind }), "Python ('my-env')", "Python ('my-env': venv)"],
-        // env.location is ignored.
-        [getEnv({ location }), 'Python', 'Python'],
-        [getEnv({ name, location }), "Python ('my-env')", "Python ('my-env')"],
-    ];
-    tests.forEach(([env, expectedDisplay, expectedDetailedDisplay]) => {
+    function testGenerator() {
+        const tests: [PythonEnvInfo, string, string][] = [
+            [getEnv({}), 'Python', 'Python'],
+            [getEnv({ version, arch, name, kind, distro }), "Python 3.8.1 ('my-env')", "Python 3.8.1 ('my-env': venv)"],
+            // without "suffix" info
+            [getEnv({ version }), 'Python 3.8.1', 'Python 3.8.1'],
+            [getEnv({ arch }), 'Python 64-bit', 'Python 64-bit'],
+            [getEnv({ version, arch }), 'Python 3.8.1 64-bit', 'Python 3.8.1 64-bit'],
+            // with "suffix" info
+            [getEnv({ name }), "Python ('my-env')", "Python ('my-env')"],
+            [getEnv({ kind }), 'Python', 'Python (venv)'],
+            [getEnv({ name, kind }), "Python ('my-env')", "Python ('my-env': venv)"],
+            // env.location is ignored.
+            [getEnv({ location }), 'Python', 'Python'],
+            [getEnv({ name, location }), "Python ('my-env')", "Python ('my-env')"],
+            [getEnv({ name, location, searchLocation }), "Python ('my-env')", "Python ('my-env')"],
+        ];
+        return tests;
+    }
+    testGenerator().forEach(([env, expectedDisplay, expectedDetailedDisplay]) => {
         test(`"${expectedDisplay}"`, () => {
             setEnvDisplayString(env);
 
             assert.equal(env.display, expectedDisplay);
             assert.equal(env.detailedDisplayName, expectedDetailedDisplay);
         });
     });
-    tests.forEach(([env1, _d1, display1], index1) => {
-        tests.forEach(([env2, _d2, display2], index2) => {
+    testGenerator().forEach(([env1, _d1, display1], index1) => {
+        testGenerator().forEach(([env2, _d2, display2], index2) => {
             if (index1 === index2) {
                 test(`"${display1}" === "${display2}"`, () => {
                     assert.strictEqual(areEnvsDeepEqual(env1, env2), true);