Merge pull request #95 from mauricerkelly/improve-unit-testing

mauricerkelly · web-flow · commit 19805932ca14 · 2017-06-20T21:01:40.000+01:00
Improve unit testing
diff --git a/lib/init.js b/lib/init.js
@@ -257,9 +257,12 @@ const handleResult = async (compileResult, filePath) => {
     const errorStack = await parseError(resultString, filePath);
     const warningStack = await parseWarning(resultString, filePath);
     const legacyWarningStack = await parseLegacyWarning(resultString, filePath);
-    return errorStack.concat(warningStack).concat(legacyWarningStack)
+
+    const results = errorStack.concat(warningStack).concat(legacyWarningStack)
       .filter(error => error !== null)
       .map(error => error);
+
+    return results;
   } catch (Error) {
     // eslint-disable-next-line no-console
     console.error('linter-elixirc:', Error);
@@ -310,7 +313,9 @@ const lintElixirc = async (textEditor) => {
 
   const fileText = textEditor.getText();
   const execOpts = await getOpts(filePath);
+
   const result = await exec(elixircPath, elixircArgs, execOpts);
+
   // Cleanup the temp dir
   tempDir.removeCallback();
   if (textEditor.getText() !== fileText) {
@@ -324,6 +329,7 @@ const lintMix = async (textEditor) => {
   const filePath = textEditor.getPath();
   const fileText = textEditor.getText();
   const execOpts = await getOpts(filePath);
+
   const result = await exec(mixPath, ['compile'], execOpts);
   if (textEditor.getText() !== fileText) {
     // File contents have changed since the run was triggered, don't update messages
diff --git a/package.json b/package.json
@@ -52,7 +52,8 @@
   "devDependencies": {
     "eslint": "^3.13.0",
     "eslint-config-airbnb-base": "^11.0.1",
-    "eslint-plugin-import": "^2.2.0"
+    "eslint-plugin-import": "^2.2.0",
+    "fs-extra": "^3.0.1"
   },
   "eslintConfig": {
     "extends": "airbnb-base",
diff --git a/spec/fixtures/elixirc/error-mode1.ex b/spec/fixtures/elixirc/error-mode1.ex
diff --git a/spec/fixtures/elixirc/error-mode2.ex b/spec/fixtures/elixirc/error-mode2.ex
diff --git a/spec/fixtures/elixirc/script.exs b/spec/fixtures/elixirc/script.exs
@@ -0,0 +1,5 @@
+defmodule Script do
+  defp simple_function do
+    :ok
+  end
+end
diff --git a/spec/fixtures/elixirc/valid.ex b/spec/fixtures/elixirc/valid.ex
diff --git a/spec/fixtures/elixirc/warning.ex b/spec/fixtures/elixirc/warning.ex
@@ -18,11 +18,16 @@ defmodule Proj do
   end
 
   def handle_call({:get, key}, _caller, state) do
+    prepare_for_call
     {:reply, Map.get(state, key), state}
   end
 
   def handle_cast({:put, key, val}, state) do
     {:noreply, Map.put(state, key, val), state}
   end
 
+  def prepare_for_call() do
+    :ok
+  end
+
 end
diff --git a/spec/fixtures/mix-proj/lib/error-mode2.ex b/spec/fixtures/mix-proj/lib/error-mode2.ex
@@ -0,0 +1,14 @@
+# Single line error, still mode 2
+defmodule Identicon do
+  def main(input) do
+    input
+    |> hash_input
+  end
+
+  def has_input(input) do
+    hex = :crypto.has(:md5, input)
+    |> :binary.bin_to_list
+
+    %Identicon.Image{hex: hex}
+  end
+end
diff --git a/spec/fixtures/mix-proj/lib/script.exs b/spec/fixtures/mix-proj/lib/script.exs
@@ -0,0 +1,5 @@
+defmodule Script do
+  defp simple_function do
+    :ok
+  end
+end
diff --git a/spec/fixtures/mix-proj/mix.exs b/spec/fixtures/mix-proj/mix.exs
@@ -7,7 +7,7 @@ defmodule Proj.Mixfile do
      elixir: "~> 1.4",
      build_embedded: Mix.env == :prod,
      start_permanent: Mix.env == :prod,
-     deps: deps]
+     deps: deps()]
   end
 
   # Configuration for the OTP application
diff --git a/spec/linter-elixirc-spec.js b/spec/linter-elixirc-spec.js
@@ -1,16 +1,154 @@
 'use babel';
 
 import { join } from 'path';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { remove } from 'fs-extra';
 
-const validPath = join(__dirname, 'fixtures', 'valid.ex');
-const warningPath = join(__dirname, 'fixtures', 'proj', 'mix.exs');
-const errorMode1Path = join(__dirname, 'fixtures', 'error-mode1.ex');
-const errorMode2Path = join(__dirname, 'fixtures', 'error-mode2.ex');
+const validPathElixirc = join(__dirname, 'fixtures', 'elixirc', 'valid.ex');
+const warningPathElixirc = join(__dirname, 'fixtures', 'elixirc', 'warning.ex');
+const errorMode1PathElixirc = join(__dirname, 'fixtures', 'elixirc', 'error-mode1.ex');
+const errorMode2PathElixirc = join(__dirname, 'fixtures', 'elixirc', 'error-mode2.ex');
+const exsFilePathElixirc = join(__dirname, 'fixtures', 'elixirc', 'script.exs');
+
+const errorMode2PathMix = join(__dirname, 'fixtures', 'mix-proj', 'lib', 'error-mode2.ex');
+const exsFilePathMix = join(__dirname, 'fixtures', 'mix-proj', 'lib', 'script.exs');
+
+const mixBuildDirectory = join(__dirname, 'fixtures', 'mix-proj', '_build');
+remove(mixBuildDirectory);
 
 describe('The elixirc provider for Linter', () => {
-  const lint = require('../lib/init.js').provideLinter().lint;
+  describe('when not working inside a Mix project', () => {
+    describe('and using the standard configuration', () => {
+      let lint;
+
+      beforeEach(() => {
+        lint = require('../lib/init.js').provideLinter().lint;
+        atom.workspace.destroyActivePaneItem();
+
+        waitsForPromise(() =>
+          Promise.all([
+            atom.packages.activatePackage('linter-elixirc'),
+            atom.packages.activatePackage('language-elixir'),
+          ]),
+        );
+      });
+
+      it('works with mode 1 errors', () => {
+        waitsForPromise(() =>
+          atom.workspace.open(errorMode1PathElixirc).then(editor =>
+            lint(editor)).then((messages) => {
+              expect(messages.length).toBe(1);
+              expect(messages[0].severity).toBe('error');
+              expect(messages[0].html).not.toBeDefined();
+              expect(messages[0].excerpt).toBe('(ArgumentError) Dangerous is not available');
+              expect(messages[0].location.file).toBe(errorMode1PathElixirc);
+              expect(messages[0].location.position).toEqual([[1, 0], [1, 32]]);
+            }),
+        );
+      });
+
+      it('works with mode 2 errors', () => {
+        waitsForPromise(() =>
+          atom.workspace.open(errorMode2PathElixirc).then(editor =>
+            lint(editor)).then((messages) => {
+              expect(messages.length).toBe(1);
+              expect(messages[0].severity).toBe('error');
+              expect(messages[0].html).not.toBeDefined();
+              expect(messages[0].excerpt).toBe('(CompileError) module Usefulness is not loaded and could not be found');
+              expect(messages[0].location.file).toBe(errorMode2PathElixirc);
+              expect(messages[0].location.position).toEqual([[3, 2], [3, 20]]);
+            }),
+        );
+      });
+
+      it('works with warnings', () => {
+        waitsForPromise(() =>
+          atom.workspace.open(warningPathElixirc).then(editor => lint(editor)).then((messages) => {
+            expect(messages.length).toBe(1);
+            expect(messages[0].severity).toBe('warning');
+            expect(messages[0].html).not.toBeDefined();
+            expect(messages[0].excerpt).toBe('variable "prepare_for_call" does not exist and is being expanded to "prepare_for_call()", please use parentheses to remove the ambiguity or change the variable name');
+            expect(messages[0].location.file).toBe(warningPathElixirc);
+            expect(messages[0].location.position).toEqual([[20, 4], [20, 20]]);
+          }),
+        );
+      });
+
+      it('works with .exs files', () => {
+        waitsForPromise(() =>
+          atom.workspace.open(exsFilePathElixirc).then(editor => lint(editor)).then((messages) => {
+            expect(messages.length).toBe(1);
+            expect(messages[0].severity).toBe('warning');
+            expect(messages[0].html).not.toBeDefined();
+            expect(messages[0].excerpt).toBe('function simple_function/0 is unused');
+            expect(messages[0].location.file).toBe(exsFilePathElixirc);
+            expect(messages[0].location.position).toEqual([[1, 2], [1, 25]]);
+          }),
+        );
+      });
+
+      it('finds nothing wrong with a valid file', () => {
+        waitsForPromise(() =>
+          atom.workspace.open(validPathElixirc).then(editor => lint(editor)).then((messages) => {
+            expect(messages.length).toBe(0);
+          }),
+        );
+      });
+    });
+  });
+
+  describe('when working inside a Mix project', () => {
+    describe('and using the standard configuration', () => {
+      let lint;
+
+      beforeEach(() => {
+        lint = require('../lib/init.js').provideLinter().lint;
+        atom.workspace.destroyActivePaneItem();
+
+        waitsForPromise(() =>
+          Promise.all([
+            atom.packages.activatePackage('linter-elixirc'),
+            atom.packages.activatePackage('language-elixir'),
+          ]),
+        );
+      });
+
+      it('works with mode 2 errors', () => {
+        waitsForPromise(() =>
+          atom.workspace.open(errorMode2PathMix).then(editor =>
+            lint(editor)).then((messages) => {
+              expect(messages.length).toBe(1);
+              expect(messages[0].severity).toBe('error');
+              expect(messages[0].html).not.toBeDefined();
+              expect(messages[0].excerpt).toBe('(CompileError) Identicon.Image.__struct__/1 is undefined, cannot expand struct Identicon.Image');
+              expect(messages[0].location.file).toBe(errorMode2PathMix);
+              expect(messages[0].location.position).toEqual([[11, 4], [11, 30]]);
+            }),
+        );
+      });
+
+      it('works with .exs files', () => {
+        waitsForPromise(() =>
+          atom.workspace.open(exsFilePathMix).then(editor => lint(editor)).then((messages) => {
+            expect(messages.length).toBe(1);
+            expect(messages[0].severity).toBe('warning');
+            expect(messages[0].html).not.toBeDefined();
+            expect(messages[0].excerpt).toBe('function simple_function/0 is unused');
+            expect(messages[0].location.file).toBe(exsFilePathMix);
+            expect(messages[0].location.position).toEqual([[1, 2], [1, 25]]);
+          }),
+        );
+      });
+    });
+  });
+});
+
+describe('when using the setting forceElixirc', () => {
+  let lint;
 
   beforeEach(() => {
+    atom.config.set('linter-elixirc.forceElixirc', true);
+    lint = require('../lib/init.js').provideLinter().lint;
     atom.workspace.destroyActivePaneItem();
 
     waitsForPromise(() =>
@@ -21,49 +159,15 @@ describe('The elixirc provider for Linter', () => {
     );
   });
 
-  it('works with mode 1 errors', () => {
-    waitsForPromise(() =>
-      atom.workspace.open(errorMode1Path).then(editor => lint(editor)).then((messages) => {
-        expect(messages.length).toBe(1);
-        expect(messages[0].severity).toBe('error');
-        expect(messages[0].html).not.toBeDefined();
-        expect(messages[0].excerpt).toBe('(ArgumentError) Dangerous is not available');
-        expect(messages[0].location.file).toBe(errorMode1Path);
-        expect(messages[0].location.position).toEqual([[1, 0], [1, 32]]);
-      }),
-    );
-  });
-
-  it('works with mode 2 errors', () => {
-    waitsForPromise(() =>
-      atom.workspace.open(errorMode2Path).then(editor => lint(editor)).then((messages) => {
-        expect(messages.length).toBe(1);
-        expect(messages[0].severity).toBe('error');
-        expect(messages[0].html).not.toBeDefined();
-        expect(messages[0].excerpt).toBe('(CompileError) module Usefulness is not loaded and could not be found');
-        expect(messages[0].location.file).toBe(errorMode2Path);
-        expect(messages[0].location.position).toEqual([[3, 2], [3, 20]]);
-      }),
-    );
-  });
-
   it('works with warnings', () => {
     waitsForPromise(() =>
-      atom.workspace.open(warningPath).then(editor => lint(editor)).then((messages) => {
+      atom.workspace.open(errorMode2PathMix).then(editor => lint(editor)).then((messages) => {
         expect(messages.length).toBe(1);
-        expect(messages[0].severity).toBe('warning');
+        expect(messages[0].severity).toBe('error');
         expect(messages[0].html).not.toBeDefined();
-        expect(messages[0].excerpt).toBe('variable "deps" does not exist and is being expanded to "deps()", please use parentheses to remove the ambiguity or change the variable name');
-        expect(messages[0].location.file).toBe(warningPath);
-        expect(messages[0].location.position).toEqual([[9, 5], [9, 16]]);
-      }),
-    );
-  });
-
-  it('finds nothing wrong with a valid file', () => {
-    waitsForPromise(() =>
-      atom.workspace.open(validPath).then(editor => lint(editor)).then((messages) => {
-        expect(messages.length).toBe(0);
+        expect(messages[0].excerpt).toBe('(CompileError) Identicon.Image.__struct__/1 is undefined, cannot expand struct Identicon.Image');
+        expect(messages[0].location.file).toBe(errorMode2PathMix);
+        expect(messages[0].location.position).toEqual([[11, 4], [11, 30]]);
       }),
     );
   });

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +defmodule Script do
 +  defp simple_function do
 +    :ok
 +  end
 +end