Split detectVirtualEnv to a separate file and add specs

Author: segevfiner

lib/main.js

@@ -1,15 +1,12 @@
 const cp = require("child_process");
 const { shell } = require("electron");
 const { AutoLanguageClient } = require("atom-languageclient");
-const { Directory } = require("atom");
+const { detectVirtualEnv } = require("./utils");
 
 // Ref: https://github.com/nteract/hydrogen/blob/master/lib/autocomplete-provider.js#L33
 // adapted from http://stackoverflow.com/q/5474008
 const PYTHON_REGEX = /(([^\d\W]|[\u00A0-\uFFFF])[\w.\u00A0-\uFFFF]*)|\.$/;
 
-const VIRTUAL_ENV_BIN_DIRS = ["bin", "Scripts"];
-const VIRTUAL_ENV_EXECUTABLES = ["python", "python.exe"];
-
 class PythonLanguageClient extends AutoLanguageClient {
   getGrammarScopes() {
     return ["source.python"];
@@ -31,49 +28,10 @@ class PythonLanguageClient extends AutoLanguageClient {
     return { pyls: { plugins: configuration } }
   }
 
-  async detectVirtualEnv(path) {
-    const entries = await new Promise(resolve =>
-      new Directory(path).getEntries((error, entries) => {
-        if (error === null) {
-          resolve(entries);
-        } else {
-          resolve(null);
-        }
-      })
-    );
-
-    if (entries) {
-      for (let entry of entries) {
-        if (entry.isDirectory()) {
-          if (VIRTUAL_ENV_BIN_DIRS.indexOf(entry.getBaseName()) !== -1) {
-            for (let executable of VIRTUAL_ENV_EXECUTABLES) {
-              if (await entry.getFile(executable).exists()) {
-                return path;
-              }
-            }
-          } else {
-            for (let dir_name of VIRTUAL_ENV_BIN_DIRS) {
-              for (let executable of VIRTUAL_ENV_EXECUTABLES) {
-                if (
-                  await entry
-                    .getSubdirectory(dir_name)
-                    .getFile(executable)
-                    .exists()
-                ) {
-                  return entry.getPath();
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-
   async startServerProcess(projectPath) {
     await new Promise(resolve => atom.whenShellEnvironmentLoaded(resolve));
 
-    const venvPath = await this.detectVirtualEnv(projectPath)
+    const venvPath = await detectVirtualEnv(projectPath)
 
     const pylsEnvironment = Object.assign({}, process.env);
 

lib/utils.js

@@ -0,0 +1,45 @@
+const { Directory } = require("atom");
+
+const VIRTUAL_ENV_BIN_DIRS = ["bin", "Scripts"];
+const VIRTUAL_ENV_EXECUTABLES = ["python", "python.exe"];
+
+async function detectVirtualEnv(path) {
+  const entries = await new Promise(resolve =>
+    new Directory(path).getEntries((error, entries) => {
+      if (error === null) {
+        resolve(entries);
+      } else {
+        resolve(null);
+      }
+    })
+  );
+
+  if (entries) {
+    for (let entry of entries) {
+      if (entry.isDirectory()) {
+        if (VIRTUAL_ENV_BIN_DIRS.indexOf(entry.getBaseName()) !== -1) {
+          for (let executable of VIRTUAL_ENV_EXECUTABLES) {
+            if (await entry.getFile(executable).exists()) {
+              return path;
+            }
+          }
+        } else {
+          for (let dir_name of VIRTUAL_ENV_BIN_DIRS) {
+            for (let executable of VIRTUAL_ENV_EXECUTABLES) {
+              if (
+                await entry
+                  .getSubdirectory(dir_name)
+                  .getFile(executable)
+                  .exists()
+              ) {
+                return entry.getPath();
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
+exports.detectVirtualEnv = detectVirtualEnv;

spec/fixtures/venv/none/.gitignore

@@ -0,0 +1,52 @@
+const path = require("path");
+const { detectVirtualEnv } = require("../lib/utils");
+
+const venvFixturesDir = path.join(__dirname, "fixtures", "venv");
+
+describe("detectVirtualEnv", () => {
+  it("detects no virtual env when there isn't any", () => {
+    waitsForPromise(() => {
+      return detectVirtualEnv(path.join(venvFixturesDir, "none")).then(venv => {
+        expect(venv).toBeUndefined();
+      });
+    });
+  });
+
+  it("detects a Unix virtual env at the root", () => {
+    const projectPath = path.join(venvFixturesDir, "unix");
+    waitsForPromise(() => {
+      return detectVirtualEnv(projectPath).then(venv => {
+        expect(venv).toEqual(projectPath);
+      });
+    });
+  });
+
+  it("detects a Windows virtual env at the root", () => {
+    const projectPath = path.join(venvFixturesDir, "windows");
+    waitsForPromise(() => {
+      return detectVirtualEnv(projectPath).then(venv => {
+        expect(venv).toEqual(projectPath);
+      });
+    });
+  });
+
+  it("detects a Unix virtual env in a subdirectory", () => {
+    const projectPath = path.join(venvFixturesDir, "unix-subdir");
+    const venvPath = path.join(projectPath, "venv");
+    waitsForPromise(() => {
+      return detectVirtualEnv(projectPath).then(venv => {
+        expect(venv).toEqual(venvPath);
+      });
+    });
+  });
+
+  it("detects a Windows virtual env in a subdirectory", () => {
+    const projectPath = path.join(venvFixturesDir, "windows-subdir");
+    const venvPath = path.join(projectPath, "venv");
+    waitsForPromise(() => {
+      return detectVirtualEnv(projectPath).then(venv => {
+        expect(venv).toEqual(venvPath);
+      });
+    });
+  });
+});