Fixes #22 to Detect anaconda from known locations (#221)

DonJayamanne · web-flow · commit fa820fe32a45 · 2017-11-22T12:19:43.000-08:00
Fixes #22 to Detect anaconda from known locations Also added a strict linter to lint modified files (background task) * look for conda file in known locations * gulp changes to watch strict linting * merged upstream * fix code review comments * inject windows flag into services
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -65,6 +65,24 @@
                     "fileLocation": "relative"
                 }
             ]
+        },
+        {
+            "type": "gulp",
+            "task": "hygiene-watch",
+            "isBackground": true,
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared"
+            },
+            "problemMatcher": [
+                "$tsc",
+                {
+                    "base": "$tslint5",
+                    "fileLocation": "relative"
+                }
+            ]
         }
     ]
 }
diff --git a/gulpfile.js b/gulpfile.js
@@ -12,6 +12,8 @@ const tsfmt = require('typescript-formatter');
 const tslint = require('tslint');
 const relative = require('relative');
 const ts = require('gulp-typescript');
+const watch = require('gulp-watch');
+const cp = require('child_process');
 
 /**
  * Hygiene works by creating cascading subsets of all our files and
@@ -212,47 +214,51 @@ const hygiene = exports.hygiene = (some, options) => {
 
 gulp.task('hygiene', () => hygiene());
 
-// this allows us to run hygiene as a git pre-commit hook.
-if (require.main === module) {
-    const cp = require('child_process');
+gulp.task('hygiene-watch', function () {
+    return watch(all, function () {
+        run(true, true);
+    });
+});
 
+function run(lintOnlyModifiedFiles, doNotExit) {
+    function exitProcessOnError(ex) {
+        console.error();
+        console.error(ex);
+        if (!doNotExit) {
+            process.exit(1);
+        }
+    }
     process.on('unhandledRejection', (reason, p) => {
         console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
-        process.exit(1);
+        exitProcessOnError();
     });
 
     cp.exec('git config core.autocrlf', (err, out) => {
         const skipEOL = out.trim() === 'true';
-
-        if (process.argv.length > 2) {
+        if (!lintOnlyModifiedFiles && process.argv.length > 2) {
             return hygiene(process.argv.slice(2), {
                 skipEOL: skipEOL
-            }).on('error', err => {
-                console.error();
-                console.error(err);
-                process.exit(1);
-            });
+            }).on('error', exitProcessOnError);
         }
 
-        cp.exec('git diff --cached --name-only', {
+        const cmd = lintOnlyModifiedFiles ? 'git diff --name-only' : 'git diff --cached --name-only';
+        cp.exec(cmd, {
             maxBuffer: 2000 * 1024
         }, (err, out) => {
             if (err) {
-                console.error();
-                console.error(err);
-                process.exit(1);
+                exitProcessOnError(err);
             }
-
             const some = out
                 .split(/\r?\n/)
                 .filter(l => !!l);
+
             hygiene(some, {
                 skipEOL: skipEOL
-            }).on('error', err => {
-                console.error();
-                console.error(err);
-                process.exit(1);
-            });
+            }).on('error', exitProcessOnError);
         });
     });
 }
+// this allows us to run hygiene as a git pre-commit hook.
+if (require.main === module) {
+    run();
+}
diff --git a/package.json b/package.json
@@ -1578,6 +1578,7 @@
         "gulp": "^3.9.1",
         "gulp-filter": "^5.0.1",
         "gulp-typescript": "^3.2.2",
+        "gulp-watch": "^4.3.11",
         "husky": "^0.14.3",
         "ignore-loader": "^0.1.1",
         "mocha": "^2.3.3",
@@ -1592,7 +1593,7 @@
         "tslint-microsoft-contrib": "^5.0.1",
         "typescript": "^2.5.2",
         "typescript-formatter": "^6.0.0",
-        "webpack": "^1.13.2",
-        "vscode": "^1.1.5"
+        "vscode": "^1.1.5",
+        "webpack": "^1.13.2"
     }
 }
diff --git a/src/client/interpreter/contracts.ts b/src/client/interpreter/contracts.ts
@@ -5,6 +5,10 @@ export interface IInterpreterLocatorService extends Disposable {
     getInterpreters(resource?: Uri): Promise<PythonInterpreter[]>;
 }
 
+export interface ICondaLocatorService {
+    getCondaFile(): Promise<string>;
+}
+
 export type PythonInterpreter = {
     path: string;
     companyDisplayName?: string;
diff --git a/src/client/interpreter/helpers.ts b/src/client/interpreter/helpers.ts
@@ -3,7 +3,7 @@ import { ConfigurationTarget, window, workspace } from 'vscode';
 import { RegistryImplementation } from '../common/registry';
 import { Is_64Bit, IS_WINDOWS } from '../common/utils';
 import { WorkspacePythonPath } from './contracts';
-import { CondaEnvService } from './locators/services/condaEnvService';
+import { CondaLocatorService } from './locators/services/condaLocator';
 import { WindowsRegistryService } from './locators/services/windowsRegistryService';
 
 export function getFirstNonEmptyLineFromMultilineString(stdout: string) {
@@ -29,14 +29,10 @@ export function getActiveWorkspaceUri(): WorkspacePythonPath | undefined {
     return undefined;
 }
 export async function getCondaVersion() {
-    let condaService: CondaEnvService;
-    if (IS_WINDOWS) {
-        const windowsRegistryProvider = new WindowsRegistryService(new RegistryImplementation(), Is_64Bit);
-        condaService = new CondaEnvService(windowsRegistryProvider);
-    } else {
-        condaService = new CondaEnvService();
-    }
-    return condaService.getCondaFile()
+    const windowsRegistryProvider = IS_WINDOWS ? new WindowsRegistryService(new RegistryImplementation(), Is_64Bit) : undefined;
+    const condaLocator = new CondaLocatorService(IS_WINDOWS, windowsRegistryProvider);
+
+    return condaLocator.getCondaFile()
         .then(async condaFile => {
             return new Promise<string>((resolve, reject) => {
                 child_process.execFile(condaFile, ['--version'], (_, stdout) => {
diff --git a/src/client/interpreter/locators/index.ts b/src/client/interpreter/locators/index.ts
@@ -9,6 +9,7 @@ import { VirtualEnvironmentManager } from '../virtualEnvs';
 import { fixInterpreterDisplayName, fixInterpreterPath } from './helpers';
 import { CondaEnvFileService, getEnvironmentsFile as getCondaEnvFile } from './services/condaEnvFileService';
 import { CondaEnvService } from './services/condaEnvService';
+import { CondaLocatorService } from './services/condaLocator';
 import { CurrentPathService } from './services/currentPathService';
 import { getKnownSearchPathsForInterpreters, KnownPathsService } from './services/KnownPathsService';
 import { getKnownSearchPathsForVirtualEnvs, VirtualEnvService } from './services/virtualEnvService';
@@ -66,10 +67,12 @@ export class PythonInterpreterLocatorService implements IInterpreterLocatorServi
         // The order of the services is important.
         if (IS_WINDOWS) {
             const windowsRegistryProvider = new WindowsRegistryService(new RegistryImplementation(), Is_64Bit);
+            const condaLocator = new CondaLocatorService(IS_WINDOWS, windowsRegistryProvider);
             locators.push(windowsRegistryProvider);
-            locators.push(new CondaEnvService(windowsRegistryProvider));
+            locators.push(new CondaEnvService(condaLocator));
         } else {
-            locators.push(new CondaEnvService());
+            const condaLocator = new CondaLocatorService(IS_WINDOWS);
+            locators.push(new CondaEnvService(condaLocator));
         }
         // Supplements the above list of conda environments.
         locators.push(new CondaEnvFileService(getCondaEnvFile(), versionService));
diff --git a/src/client/interpreter/locators/services/condaEnvService.ts b/src/client/interpreter/locators/services/condaEnvService.ts
@@ -4,33 +4,19 @@ import * as fs from 'fs-extra';
 import * as path from 'path';
 import { Uri } from 'vscode';
 import { VersionUtils } from '../../../common/versionUtils';
-import { IInterpreterLocatorService, PythonInterpreter } from '../../contracts';
+import { ICondaLocatorService, IInterpreterLocatorService, PythonInterpreter } from '../../contracts';
 import { AnacondaCompanyName, CONDA_RELATIVE_PY_PATH, CondaInfo } from './conda';
 import { CondaHelper } from './condaHelper';
 
 export class CondaEnvService implements IInterpreterLocatorService {
     private readonly condaHelper = new CondaHelper();
-    constructor(private registryLookupForConda?: IInterpreterLocatorService) {
+    constructor(private condaLocator: ICondaLocatorService) {
     }
     public async getInterpreters(resource?: Uri) {
         return this.getSuggestionsFromConda();
     }
     // tslint:disable-next-line:no-empty
     public dispose() { }
-    public async getCondaFile() {
-        if (this.registryLookupForConda) {
-            return this.registryLookupForConda.getInterpreters()
-                .then(interpreters => interpreters.filter(this.isCondaEnvironment))
-                .then(condaInterpreters => this.getLatestVersion(condaInterpreters))
-                .then(condaInterpreter => {
-                    return condaInterpreter ? path.join(path.dirname(condaInterpreter.path), 'conda.exe') : 'conda';
-                })
-                .then(async condaPath => {
-                    return fs.pathExists(condaPath).then(exists => exists ? condaPath : 'conda');
-                });
-        }
-        return Promise.resolve('conda');
-    }
     public isCondaEnvironment(interpreter: PythonInterpreter) {
         return (interpreter.displayName ? interpreter.displayName : '').toUpperCase().indexOf('ANACONDA') >= 0 ||
             (interpreter.companyDisplayName ? interpreter.companyDisplayName : '').toUpperCase().indexOf('CONTINUUM') >= 0;
@@ -73,7 +59,7 @@ export class CondaEnvService implements IInterpreterLocatorService {
             .then(interpreters => interpreters.map(interpreter => interpreter!));
     }
     private async getSuggestionsFromConda(): Promise<PythonInterpreter[]> {
-        return this.getCondaFile()
+        return this.condaLocator.getCondaFile()
             .then(async condaFile => {
                 return new Promise<PythonInterpreter[]>((resolve, reject) => {
                     // interrogate conda (if it's on the path) to find all environments.
diff --git a/src/client/interpreter/locators/services/condaLocator.ts b/src/client/interpreter/locators/services/condaLocator.ts
@@ -0,0 +1,69 @@
+'use strict';
+import * as child_process from 'child_process';
+import * as fs from 'fs-extra';
+import * as path from 'path';
+import { IS_WINDOWS } from '../../../common/utils';
+import { VersionUtils } from '../../../common/versionUtils';
+import { ICondaLocatorService, IInterpreterLocatorService, PythonInterpreter } from '../../contracts';
+// tslint:disable-next-line:no-require-imports no-var-requires
+const untildify: (value: string) => string = require('untildify');
+
+const KNOWN_CONDA_LOCATIONS = ['~/anaconda/bin/conda', '~/miniconda/bin/conda',
+    '~/anaconda2/bin/conda', '~/miniconda2/bin/conda',
+    '~/anaconda3/bin/conda', '~/miniconda3/bin/conda'];
+
+export class CondaLocatorService implements ICondaLocatorService {
+    constructor(private isWindows: boolean, private registryLookupForConda?: IInterpreterLocatorService) {
+    }
+    // tslint:disable-next-line:no-empty
+    public dispose() { }
+    public async getCondaFile(): Promise<string> {
+        const isAvailable = await this.isCondaInCurrentPath();
+        if (isAvailable) {
+            return 'conda';
+        }
+        if (this.isWindows && this.registryLookupForConda) {
+            return this.registryLookupForConda.getInterpreters()
+                .then(interpreters => interpreters.filter(this.isCondaEnvironment))
+                .then(condaInterpreters => this.getLatestVersion(condaInterpreters))
+                .then(condaInterpreter => {
+                    return condaInterpreter ? path.join(path.dirname(condaInterpreter.path), 'conda.exe') : 'conda';
+                })
+                .then(async condaPath => {
+                    return fs.pathExists(condaPath).then(exists => exists ? condaPath : 'conda');
+                });
+        }
+        return this.getCondaFileFromKnownLocations();
+    }
+    public isCondaEnvironment(interpreter: PythonInterpreter) {
+        return (interpreter.displayName ? interpreter.displayName : '').toUpperCase().indexOf('ANACONDA') >= 0 ||
+            (interpreter.companyDisplayName ? interpreter.companyDisplayName : '').toUpperCase().indexOf('CONTINUUM') >= 0;
+    }
+    public getLatestVersion(interpreters: PythonInterpreter[]) {
+        const sortedInterpreters = interpreters.filter(interpreter => interpreter.version && interpreter.version.length > 0);
+        // tslint:disable-next-line:no-non-null-assertion
+        sortedInterpreters.sort((a, b) => VersionUtils.compareVersion(a.version!, b.version!));
+        if (sortedInterpreters.length > 0) {
+            return sortedInterpreters[sortedInterpreters.length - 1];
+        }
+    }
+    public async isCondaInCurrentPath() {
+        return new Promise<boolean>((resolve, reject) => {
+            child_process.execFile('conda', ['--version'], (_, stdout) => {
+                if (stdout && stdout.length > 0) {
+                    resolve(true);
+                } else {
+                    resolve(false);
+                }
+            });
+        });
+    }
+    private async getCondaFileFromKnownLocations(): Promise<string> {
+        const condaFiles = await Promise.all(KNOWN_CONDA_LOCATIONS
+            .map(untildify)
+            .map(async (condaPath: string) => fs.pathExists(condaPath).then(exists => exists ? condaPath : '')));
+
+        const validCondaFiles = condaFiles.filter(condaPath => condaPath.length > 0);
+        return validCondaFiles.length === 0 ? 'conda' : validCondaFiles[0];
+    }
+}
diff --git a/src/test/interpreters/condaEnvService.test.ts b/src/test/interpreters/condaEnvService.test.ts
diff --git a/src/test/interpreters/mocks.ts b/src/test/interpreters/mocks.ts
diff --git a/tslint.json b/tslint.json

Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,24 @@`
`65`	`65`	`"fileLocation": "relative"`
`66`	`66`	`}`
`67`	`67`	`]`
	`68`	`+ },`
	`69`	`+ {`
	`70`	`+ "type": "gulp",`
	`71`	`+ "task": "hygiene-watch",`
	`72`	`+ "isBackground": true,`
	`73`	`+ "presentation": {`
	`74`	`+ "echo": true,`
	`75`	`+ "reveal": "always",`
	`76`	`+ "focus": false,`
	`77`	`+ "panel": "shared"`
	`78`	`+ },`
	`79`	`+ "problemMatcher": [`
	`80`	`+ "$tsc",`
	`81`	`+ {`
	`82`	`+ "base": "$tslint5",`
	`83`	`+ "fileLocation": "relative"`
	`84`	`+ }`
	`85`	`+ ]`
`68`	`86`	`}`
`69`	`87`	`]`
`70`	`88`	`}`