Refactor tests to get more Mix project tests

Author: mauricerkelly

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,17 @@ const lintElixirc = async (textEditor) => {
 
   const fileText = textEditor.getText();
   const execOpts = await getOpts(filePath);
+
+  const argsAsString = elixircArgs.join(' ');
+  const optsAsString = JSON.stringify(execOpts);
+  // eslint-disable-next-line no-console
+  console.log(`Executing the command: ${elixircPath} ${argsAsString} ${optsAsString}`);
+
   const result = await exec(elixircPath, elixircArgs, execOpts);
+  const str = JSON.stringify(result, null, 2);
+  // eslint-disable-next-line no-console
+  console.log(`Result: ${str}`);
+
   // Cleanup the temp dir
   tempDir.removeCallback();
   if (textEditor.getText() !== fileText) {
@@ -324,7 +337,15 @@ const lintMix = async (textEditor) => {
   const filePath = textEditor.getPath();
   const fileText = textEditor.getText();
   const execOpts = await getOpts(filePath);
+
+  const optsAsString = JSON.stringify(execOpts);
+  // eslint-disable-next-line no-console
+  console.log(`Executing the command: ${mixPath} compile ${optsAsString}`);
+
   const result = await exec(mixPath, ['compile'], execOpts);
+  const str = JSON.stringify(result, null, 4);
+  // eslint-disable-next-line no-console
+  console.log(`Result: ${str}`);
   if (textEditor.getText() !== fileText) {
     // File contents have changed since the run was triggered, don't update messages
     return null;
@@ -371,12 +392,20 @@ export default {
       name: 'Elixir',
       async lint(textEditor) {
         const filePath = textEditor.getPath();
+        // const forcedElixirc = isForcedElixirc();
+        // const mixProject = await isMixProject(filePath);
+        // const exsFile = isExsFile(filePath);
+        // const phoenixProject = (await isPhoenixProject());
         if (
           isForcedElixirc() ||
             !(await isMixProject(filePath)) ||
             isExsFile(filePath) ||
             (await isPhoenixProject(filePath))
         ) {
+          // forcedElixirc ||
+          //   !mixProject ||
+          //   exsFile ||
+          //   phoenixProject) {
           return lintElixirc(textEditor);
         }
         return lintMix(textEditor);

spec/fixtures/error-mode1.ex renamed to spec/fixtures/elixirc/error-mode1.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

spec/fixtures/error-mode2.ex renamed to spec/fixtures/elixirc/error-mode2.ex

@@ -0,0 +1,5 @@
+defmodule Script do
+  defp simple_function do
+    :ok
+  end
+end

spec/fixtures/script.exs renamed to spec/fixtures/elixirc/script.exs

@@ -1,105 +1,147 @@
 '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', 'lib', 'proj.ex');
-const errorMode1Path = join(__dirname, 'fixtures', 'error-mode1.ex');
-const errorMode2Path = join(__dirname, 'fixtures', 'error-mode2.ex');
-const exsFilePath = join(__dirname, 'fixtures', 'script.exs');
+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 mixBuildDirectory = join(__dirname, 'fixtures', 'proj', '_build');
+const validPathMix = join(__dirname, 'fixtures', 'mix-proj', 'lib', 'valid.ex');
+const warningPathMix = join(__dirname, 'fixtures', 'mix-proj', 'lib', 'warning.ex');
+const errorMode1PathMix = join(__dirname, 'fixtures', 'mix-proj', 'lib', 'error-mode1.ex');
+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', () => {
-  describe('when using the standard configuration', () => {
-    let lint;
-
-    beforeEach(() => {
-      atom.config.set('linter-elixirc.forceElixirc', false);
-      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(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 1 errors for elixirc', () => {
-      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) => {
-          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(warningPath);
-          expect(messages[0].location.position).toEqual([[20, 4], [20, 20]]);
-        }),
-      );
-    });
-
-    it('works with .exs files', () => {
-      waitsForPromise(() =>
-        atom.workspace.open(exsFilePath).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(exsFilePath);
-          expect(messages[0].location.position).toEqual([[1, 2], [1, 25]]);
-        }),
-      );
+  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);
+          }),
+        );
+      });
     });
+  });
 
-    it('finds nothing wrong with a valid file', () => {
-      waitsForPromise(() =>
-        atom.workspace.open(validPath).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]]);
+          }),
+        );
+      });
     });
   });
 });
@@ -122,13 +164,13 @@ describe('when using the setting forceElixirc', () => {
 
   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 "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(warningPath);
-        expect(messages[0].location.position).toEqual([[20, 4], [20, 20]]);
+        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]]);
       }),
     );
   });