Add tests

Author: Kartik Raj

src/client/pythonEnvironments/common/environmentIdentifier.ts

@@ -1,24 +1,11 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import * as fsapi from 'fs-extra';
 import * as path from 'path';
 import { traceWarning } from '../../common/logger';
-import { createDeferred } from '../../common/utils/async';
 import { getEnvironmentVariable } from '../../common/utils/platform';
 import { EnvironmentType } from '../info';
-
-function pathExists(absPath: string): Promise<boolean> {
-    const deferred = createDeferred<boolean>();
-    fsapi.exists(absPath, (result) => {
-        deferred.resolve(result);
-    });
-    return deferred.promise;
-}
-
-function readFile(filePath: string): Promise<string> {
-    return fsapi.readFile(filePath, 'utf-8');
-}
+import { pathExists, readFile } from './externalDependencies';
 
 /**
  * Checks if the given interpreter path belongs to a conda environment. Using
@@ -127,11 +114,11 @@ async function isWindowsStoreEnvironment(interpreterPath: string): Promise<boole
 }
 
 /**
- * Checks if a Pipfile associated with the provided directory exists.
+ * Returns the path to Pipfile associated with the provided directory.
  * @param cwd the directory to look into
  * @param lookIntoParentDirectories set to true if we should also search for Pipfile in parent directory
  */
-async function checkIfPipFileExists(cwd: string, lookIntoParentDirectories: boolean): Promise<boolean> {
+async function getAssociatedPipfile(cwd: string, lookIntoParentDirectories: boolean): Promise<string | undefined> {
     const pipFileName = getEnvironmentVariable('PIPENV_PIPFILE') || 'Pipfile';
     let depthToSearch = 1;
     if (lookIntoParentDirectories) {
@@ -144,15 +131,16 @@ async function checkIfPipFileExists(cwd: string, lookIntoParentDirectories: bool
             depthToSearch = 3;
         }
     }
-    while (depthToSearch > 0 && cwd === path.dirname(cwd)) {
+    while (depthToSearch > 0 && cwd !== path.dirname(cwd)) {
+        const pipFile = path.join(cwd, pipFileName);
         // eslint-disable-next-line no-await-in-loop
-        if (await pathExists(path.join(cwd, pipFileName))) {
-            return true;
+        if (await pathExists(pipFile)) {
+            return pipFile;
         }
         cwd = path.dirname(cwd);
         depthToSearch -= 1;
     }
-    return false;
+    return undefined;
 }
 
 /**
@@ -173,7 +161,7 @@ async function isLocalPipenvEnvironment(interpreterPath: string): Promise<boolea
         return false;
     }
     const directoryWhereVenvResides = path.dirname(path.dirname(path.dirname(interpreterPath)));
-    if (await checkIfPipFileExists(directoryWhereVenvResides, false)) {
+    if (await getAssociatedPipfile(directoryWhereVenvResides, false)) {
         // The directory must contain a Pipfile
         return true;
     }
@@ -185,31 +173,33 @@ async function isLocalPipenvEnvironment(interpreterPath: string): Promise<boolea
  * @param interpreterPath Absolute path to any python interpreter.
  */
 async function isGlobalPipenvEnvironment(interpreterPath: string): Promise<boolean> {
-    // Global pipenv environments have a .project file with the absolute path to the project.
-    // Also, the name of the project is used as a prefix in the environment folder.
+    // Global pipenv environments have a .project file with the absolute path to the project
+    // See https://github.com/pypa/pipenv/blob/9299ae1f7353bdd523a1829f3c7cad0ee67c2e3b/CHANGELOG.rst#L754
+    // Also, the name of the directory where Pipfile resides is used as a prefix in the environment folder.
     // This is the layout we wish to verify.
-    // <Environment folder>  <--- check if the name of the project is used as a prefix
+    // <Environment folder>
     // |__ .project  <--- check if .project exists here
     // |__ Scripts/bin
     //     |__ python  <--- interpreterPath
     const dotProjectFile = path.join(path.dirname(path.dirname(interpreterPath)), '.project');
-    if (!await pathExists(dotProjectFile)) {
+    if (!(await pathExists(dotProjectFile))) {
         return false;
     }
 
     const project = await readFile(dotProjectFile);
-    if (!await pathExists(project)) {
+    if (!(await pathExists(project))) {
         return false;
     }
 
-    // The name of the project is used as a prefix in the environment folder.
-    if (interpreterPath.indexOf(`${path.sep}${path.basename(project)}-`) === -1) {
+    // PIPENV_NO_INHERIT is used to tell pipenv not to look for Pipfile in parent directories
+    // https://pipenv.pypa.io/en/latest/advanced/#pipenv.environments.PIPENV_NO_INHERIT
+    const pipFile = await getAssociatedPipfile(project, !getEnvironmentVariable('PIPENV_NO_INHERIT'));
+    if (!pipFile) {
         return false;
     }
 
-    // PIPENV_NO_INHERIT is used to tell pipenv not to look for Pipfile in parent directories
-    // https://pipenv.pypa.io/en/latest/advanced/#pipenv.environments.PIPENV_NO_INHERIT
-    if (!checkIfPipFileExists(project, !getEnvironmentVariable('PIPENV_NO_INHERIT'))) {
+    // The name of the directory where Pipfile resides is used as a prefix in the environment folder.
+    if (interpreterPath.indexOf(`${path.sep}${path.basename(path.dirname(pipFile))}-`) === -1) {
         return false;
     }
 

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';
 
 suite('Environment Identifier', () => {
@@ -19,8 +20,9 @@ suite('Environment Identifier', () => {
         'test',
         'pythonEnvironments',
         'common',
-        'envlayouts'
+        'envlayouts',
     );
+    let getEnvVar: sinon.SinonStub;
     suite('Conda', () => {
         test('Conda layout with conda-meta and python binary in the same directory', async () => {
             const interpreterPath: string = path.join(testLayoutsRoot, 'conda1', 'python.exe');
@@ -34,8 +36,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'];
@@ -59,7 +99,7 @@ suite('Environment Identifier', () => {
                     'Microsoft',
                     'WindowsApps',
                     'PythonSoftwareFoundation.Python.3.8_qbz5n2kfra8p0',
-                    exe
+                    exe,
                 );
                 const envType: EnvironmentType = await identifyEnvironment(interpreterPath);
                 assert.deepEqual(envType, EnvironmentType.WindowsStore);
@@ -69,7 +109,7 @@ suite('Environment Identifier', () => {
                     fakeProgramFilesPath,
                     'WindowsApps',
                     'PythonSoftwareFoundation.Python.3.8_qbz5n2kfra8p0',
-                    exe
+                    exe,
                 );
                 const envType: EnvironmentType = await identifyEnvironment(interpreterPath);
                 assert.deepEqual(envType, EnvironmentType.WindowsStore);
@@ -86,7 +126,7 @@ suite('Environment Identifier', () => {
                     fakeProgramFilesPath,
                     'WindowsApps',
                     'PythonSoftwareFoundation.Python.3.8_qbz5n2kfra8p0',
-                    exe
+                    exe,
                 );
                 const envType: EnvironmentType = await identifyEnvironment(interpreterPath);
                 assert.deepEqual(envType, EnvironmentType.WindowsStore);

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"