Add Pipenv support (#150)

* Start to manage pipenv

* rework on pipenv

* Clean code

* adding unit test for Unix env

* add pipenv install to travis

* update travis.yml

* add sudo

* monkeypatch pipenv for unit tests

* add mockspawn to devDependencies, split code into smaller functions, remove async

Author: tvallois

lib/main.js

@@ -1,7 +1,7 @@
 const cp = require("child_process");
 const { shell } = require("electron");
 const { AutoLanguageClient } = require("atom-languageclient");
-const { detectVirtualEnv, sanitizeConfig } = require("./utils");
+const { detectVirtualEnv, detectPipEnv, replacePipEnvPathVar, sanitizeConfig } = require("./utils");
 
 // Ref: https://github.com/nteract/hydrogen/blob/master/lib/autocomplete-provider.js#L33
 // adapted from http://stackoverflow.com/q/5474008
@@ -42,22 +42,17 @@ class PythonLanguageClient extends AutoLanguageClient {
 
   async startServerProcess(projectPath) {
     await new Promise(resolve => atom.whenShellEnvironmentLoaded(resolve));
-
-    const venvPath = await detectVirtualEnv(projectPath);
-
+    const venvPath = await detectPipEnv(projectPath) || await detectVirtualEnv(projectPath);
     const pylsEnvironment = Object.assign({}, process.env);
-
     if (venvPath) {
       pylsEnvironment["VIRTUAL_ENV"] = venvPath;
     }
-
-    const python = atom.config.get("ide-python.python");
-
+    let python = atom.config.get("ide-python.python");
+    python = replacePipEnvPathVar(python, venvPath);
     const childProcess = cp.spawn(python, ["-m", "pyls"], {
       cwd: projectPath,
       env: pylsEnvironment
     });
-
     childProcess.on("error", err => {
       const description =
         err.code == "ENOENT"

lib/utils.js

@@ -1,8 +1,26 @@
+const cp = require("child_process");
 const { Directory } = require("atom");
 
 const VIRTUAL_ENV_BIN_DIRS = ["bin", "Scripts"];
 const VIRTUAL_ENV_EXECUTABLES = ["python", "python.exe"];
 
+function detectPipEnv(path) {
+  return new Promise(resolve => {
+    const pipEnvProcess = cp.spawn('pipenv', ["--venv"], {
+      cwd: path
+    });
+    pipEnvProcess.stdout.on('data', (data) => {
+      resolve(`${data}`.trim());
+    });
+    pipEnvProcess.stderr.on('data', () => {
+      resolve(null);
+    });
+    pipEnvProcess.on('error', () => {
+      resolve(null);
+    })
+  });
+}
+
 async function detectVirtualEnv(path) {
   const entries = await new Promise(resolve =>
     new Directory(path).getEntries((error, entries) => {
@@ -13,7 +31,6 @@ async function detectVirtualEnv(path) {
       }
     })
   );
-
   if (entries) {
     for (let entry of entries) {
       if (entry.isDirectory()) {
@@ -51,5 +68,14 @@ function sanitizeConfig(config) {
   return config;
 }
 
+function replacePipEnvPathVar(pythonPath, pipEnvPath) {
+  if (pythonPath.indexOf('$PIPENV_PATH') !== -1 && pipEnvPath) {
+    return pythonPath.replace('$PIPENV_PATH', pipEnvPath);
+  }
+  return pythonPath;
+}
+
 exports.detectVirtualEnv = detectVirtualEnv;
 exports.sanitizeConfig = sanitizeConfig;
+exports.detectPipEnv = detectPipEnv;
+exports.replacePipEnvPathVar = replacePipEnvPathVar;

package.json

@@ -28,6 +28,9 @@
   "dependencies": {
     "atom-languageclient": "0.9.9"
   },
+  "devDependencies": {
+    "mock-spawn": "^0.2.6"
+  },
   "enhancedScopes": [
     "source.python"
   ],
@@ -37,7 +40,7 @@
       "order": 1,
       "type": "string",
       "default": "python",
-      "description": "Absolute path of your Python binary. This is used to launch the Python language server. Make sure to install `pyls` for this version of Python. Changes will take effect after a restart of the language server."
+      "description": "Absolute path of your Python binary. This is used to launch the Python language server. Make sure to install `pyls` for this version of Python. Changes will take effect after a restart of the language server. Use $PIPENV_PATH if you want to use the pipenv path of your project"
     },
     "pylsConfigurationSources": {
       "order": 2,

spec/utils-spec.js

@@ -1,5 +1,8 @@
 const path = require("path");
-const { detectVirtualEnv, sanitizeConfig } = require("../lib/utils");
+const mockSpawn = require("mock-spawn");
+const assert = require("assert");
+const child_process = require('child_process');
+const { detectVirtualEnv, sanitizeConfig, detectPipEnv, replacePipEnvPathVar } = require("../lib/utils");
 
 const venvFixturesDir = path.join(__dirname, "fixtures", "venv");
 
@@ -51,6 +54,61 @@ describe("detectVirtualEnv", () => {
   });
 });
 
+describe("detect PipEnv", () => {
+  const spawn = mockSpawn()
+  child_process.spawn = spawn
+  spawn.sequence.add(function (cb) {
+    this.emit('error', new Error('spawn ENOENT'));
+    setTimeout(function() { return cb(8); }, 10);
+  });
+  it("with no pipenv", () => {
+    waitsForPromise(() => {
+      return detectPipEnv("/home/mock_pipenv").then(venv => {
+        expect(venv).toBeNull();
+        assert.equal('pipenv', spawn.calls[0].command);
+        assert.deepEqual(['--venv'], spawn.calls[0].args);
+      });
+    });
+  });
+
+  it("with Unix pipenv", () => {
+    spawn.sequence.add(spawn.simple(1, '/home/tvallois/.local/share/virtualenvs/unix-XZE001N_'));
+    waitsForPromise(() => {
+      return detectPipEnv("/home/mock_pipenv").then(venv => {
+        expect(venv).toBe('/home/tvallois/.local/share/virtualenvs/unix-XZE001N_');
+        assert.equal('pipenv', spawn.calls[1].command);
+        assert.deepEqual(['--venv'], spawn.calls[1].args);
+      });
+    });
+  });
+
+  it("with Windows pipenv", () => {
+    spawn.sequence.add(spawn.simple(1, 'C:\\Program Files\\tvallois\\virtualenvs\\windows-XZE001N_'));
+    waitsForPromise(() => {
+      return detectPipEnv("C:\\Program Files\\mock_pipenv").then(venv => {
+        expect(venv).toBe('C:\\Program Files\\tvallois\\virtualenvs\\windows-XZE001N_');
+        assert.equal('pipenv', spawn.calls[2].command);
+        assert.deepEqual(['--venv'], spawn.calls[2].args);
+      });
+    });
+  });
+});
+
+describe("replacePipEnvPathVar", () => {
+  it("replace $PIPENV_PATH", () => {
+    expect(replacePipEnvPathVar("$PIPENV_PATH/bin/python",
+     "/home/tvallois/.local/share/virtualenvs/unix-XZE001N_"))
+     .toEqual("/home/tvallois/.local/share/virtualenvs/unix-XZE001N_/bin/python");
+  });
+
+  it("no $PIPENV_PATH", () => {
+    expect(replacePipEnvPathVar("python",
+     "/home/tvallois/.local/share/virtualenvs/unix-XZE001N_"))
+     .toEqual("python");
+  });
+
+});
+
 describe("sanitizeConfig", () => {
   it("converts 'null' to null", () => {
     const config = {