Add tests

Author: Kartik Raj

src/client/pythonEnvironments/common/environmentIdentifier.ts

@@ -1,19 +1,10 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import * as fsapi from 'fs-extra';
 import * as path from 'path';
-import { createDeferred } from '../../common/utils/async';
 import { isWindowsStoreEnvironment } from '../discovery/locators/services/windowsStoreLocator';
 import { EnvironmentType } from '../info';
-
-function pathExists(absPath: string): Promise<boolean> {
-    const deferred = createDeferred<boolean>();
-    fsapi.exists(absPath, (result) => {
-        deferred.resolve(result);
-    });
-    return deferred.promise;
-}
+import { pathExists } from './externalDependencies';
 
 /**
  * Checks if the given interpreter path belongs to a conda environment. Using

src/client/pythonEnvironments/common/externalDependencies.ts

@@ -1,7 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+import * as fsapi from 'fs-extra';
 import { ExecutionResult, IProcessServiceFactory } from '../../common/process/types';
+import { createDeferred } from '../../common/utils/async';
 import { IServiceContainer } from '../../ioc/types';
 
 let internalServiceContainer: IServiceContainer;
@@ -17,3 +19,15 @@ export async function shellExecute(command: string, timeout: number): Promise<Ex
     const proc = await getProcessFactory().create();
     return proc.shellExec(command, { timeout });
 }
+
+export function pathExists(absPath: string): Promise<boolean> {
+    const deferred = createDeferred<boolean>();
+    fsapi.exists(absPath, (result) => {
+        deferred.resolve(result);
+    });
+    return deferred.promise;
+}
+
+export function readFile(filePath: string): Promise<string> {
+    return fsapi.readFile(filePath, 'utf-8');
+}

src/test/pythonEnvironments/common/environmentIdentifier.unit.test.ts

@@ -6,6 +6,7 @@ import * as path from 'path';
 import * as sinon from 'sinon';
 import * as platformApis from '../../../client/common/utils/platform';
 import { identifyEnvironment } from '../../../client/pythonEnvironments/common/environmentIdentifier';
+import * as externalDependencies from '../../../client/pythonEnvironments/common/externalDependencies';
 import { EnvironmentType } from '../../../client/pythonEnvironments/info';
 import { TEST_LAYOUT_ROOT } from './commonTestConstants';
 
@@ -23,8 +24,46 @@ suite('Environment Identifier', () => {
         });
     });
 
+    suite('Pipenv', () => {
+        let readFile: sinon.SinonStub;
+        setup(() => {
+            getEnvVar = sinon.stub(platformApis, 'getEnvironmentVariable');
+            readFile = sinon.stub(externalDependencies, 'readFile');
+        });
+
+        teardown(() => {
+            readFile.restore();
+            getEnvVar.restore();
+        });
+
+        test('Path to a general global pipenv environment', async () => {
+            const expectedDotProjectFile = path.join(testLayoutsRoot, 'pipenv', 'globalEnvironments', 'project2-vnNIWe9P', '.project');
+            const expectedProjectFile = path.join(testLayoutsRoot, 'pipenv', 'project2');
+            readFile.withArgs(expectedDotProjectFile).resolves(expectedProjectFile);
+            const interpreterPath: string = path.join(testLayoutsRoot, 'pipenv', 'globalEnvironments', 'project2-vnNIWe9P', 'bin', 'python');
+            const envType: EnvironmentType = await identifyEnvironment(interpreterPath);
+            assert.equal(envType, EnvironmentType.Pipenv);
+        });
+
+        test('Path to a global pipenv environment whose Pipfile lies at 3 levels above the project the environment is associated with', async () => {
+            getEnvVar.withArgs('PIPENV_MAX_DEPTH').returns('5');
+            const expectedDotProjectFile = path.join(testLayoutsRoot, 'pipenv', 'globalEnvironments', 'grandparent-2s1eXEJ2', '.project');
+            const expectedProjectFile = path.join(testLayoutsRoot, 'pipenv', 'grandparent', 'parent', 'child', 'project3');
+            readFile.withArgs(expectedDotProjectFile).resolves(expectedProjectFile);
+            const interpreterPath: string = path.join(testLayoutsRoot, 'pipenv', 'globalEnvironments', 'grandparent-2s1eXEJ2', 'Scripts', 'python.exe');
+            const envType: EnvironmentType = await identifyEnvironment(interpreterPath);
+            assert.equal(envType, EnvironmentType.Pipenv);
+        });
+
+        test('Path to a local pipenv environment with a custom Pipfile name', async () => {
+            getEnvVar.withArgs('PIPENV_PIPFILE').returns('CustomPipfileName');
+            const interpreterPath: string = path.join(testLayoutsRoot, 'pipenv', 'project1', '.venv', 'Scripts', 'python.exe');
+            const envType: EnvironmentType = await identifyEnvironment(interpreterPath);
+            assert.equal(envType, EnvironmentType.Pipenv);
+        });
+    });
+
     suite('Windows Store', () => {
-        let getEnvVar: sinon.SinonStub;
         const fakeLocalAppDataPath = 'X:\\users\\user\\AppData\\Local';
         const fakeProgramFilesPath = 'X:\\Program Files';
         const executable = ['python.exe', 'python3.exe', 'python3.8.exe'];

src/test/pythonEnvironments/common/envlayouts/pipenv/globalEnvironments/grandparent-2s1eXEJ2/.project

@@ -0,0 +1 @@
+Absolute path to \src\test\pythonEnvironments\common\envlayouts\pipenv\grandparent\parent\child\project3

src/test/pythonEnvironments/common/envlayouts/pipenv/globalEnvironments/grandparent-2s1eXEJ2/Scripts/python.exe

@@ -0,0 +1 @@
+Not real python exe

src/test/pythonEnvironments/common/envlayouts/pipenv/globalEnvironments/project2-vnNIWe9P/.project

@@ -0,0 +1 @@
+Absolute path to \src\test\pythonEnvironments\common\envlayouts\pipenv\project2

src/test/pythonEnvironments/common/envlayouts/pipenv/globalEnvironments/project2-vnNIWe9P/bin/python

@@ -0,0 +1 @@
+Not a real python binary

src/test/pythonEnvironments/common/envlayouts/pipenv/grandparent/Pipfile

@@ -0,0 +1,11 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+
+[requires]
+python_version = "3.7"

src/test/pythonEnvironments/common/envlayouts/pipenv/grandparent/parent/child/project3/dummyFile

@@ -0,0 +1,11 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+
+[requires]
+python_version = "3.7"

src/test/pythonEnvironments/common/envlayouts/pipenv/project1/CustomPipfileName

@@ -0,0 +1,11 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+
+[requires]
+python_version = "3.7"