Fix some test lenses bugs (#443)

* fix: Module test lenses are always placed on module declaration line

* Sort environment info from the start

Author: Étienne Lévesque

apps/language_server/lib/language_server/providers/code_lens/test.ex

@@ -13,7 +13,6 @@ defmodule ElixirLS.LanguageServer.Providers.CodeLens.Test do
   alias ElixirLS.LanguageServer.Providers.CodeLens.Test.TestBlock
   alias ElixirLS.LanguageServer.SourceFile
   alias ElixirSense.Core.Parser
-  alias ElixirSense.Core.Metadata
 
   @run_test_command "elixir.lens.test.run"
 
@@ -28,7 +27,9 @@ defmodule ElixirLS.LanguageServer.Providers.CodeLens.Test do
         |> Enum.map(fn {_k, v} -> v end)
         |> List.flatten()
 
-      lines_to_env_list = Map.to_list(buffer_file_metadata.lines_to_env)
+      lines_to_env_list =
+        buffer_file_metadata.lines_to_env
+        |> Enum.sort_by(&elem(&1, 0))
 
       describe_blocks = find_describe_blocks(lines_to_env_list, calls_list, source_lines)
       describe_lenses = get_describe_lenses(describe_blocks, file_path)
@@ -39,7 +40,7 @@ defmodule ElixirLS.LanguageServer.Providers.CodeLens.Test do
         |> get_test_lenses(file_path)
 
       module_lenses =
-        buffer_file_metadata
+        lines_to_env_list
         |> get_test_modules()
         |> get_module_lenses(file_path)
 
@@ -119,7 +120,7 @@ defmodule ElixirLS.LanguageServer.Providers.CodeLens.Test do
     end)
   end
 
-  defp get_test_modules(%Metadata{lines_to_env: lines_to_env}) do
+  defp get_test_modules(lines_to_env) do
     lines_to_env
     |> Enum.group_by(fn {_line, env} -> env.module end)
     |> Enum.filter(fn {_module, module_lines_to_env} -> is_test_module?(module_lines_to_env) end)

apps/language_server/test/providers/code_lens/test_test.exs

@@ -153,6 +153,161 @@ defmodule ElixirLS.LanguageServer.Providers.CodeLens.TestTest do
            )
   end
 
+  describe "in large files" do
+    setup do
+      text = """
+      defmodule ElixirLS.LanguageServer.DiagnosticsTest do
+        alias ElixirLS.LanguageServer.Diagnostics
+        use ExUnit.Case
+
+        describe "normalize/2" do
+          test "extract the stacktrace from the message and format it" do
+            root_path = Path.join(__DIR__, "fixtures/build_errors")
+            file = Path.join(root_path, "lib/has_error.ex")
+            position = 2
+
+            message = \"""
+            ** (CompileError) some message
+
+            Hint: Some hint
+            (elixir 1.10.1) lib/macro.ex:304: Macro.pipe/3
+            (stdlib 3.7.1) lists.erl:1263: :lists.foldl/3
+            (elixir 1.10.1) expanding macro: Kernel.|>/2
+            expanding macro: SomeModule.sigil_L/2
+            lib/my_app/my_module.ex:10: MyApp.MyModule.render/1
+            \"""
+
+            [diagnostic | _] =
+              [build_diagnostic(message, file, position)]
+              |> Diagnostics.normalize(root_path)
+
+            assert diagnostic.message == \"""
+            (CompileError) some message
+
+            Hint: Some hint
+
+            Stacktrace:
+            │ (elixir 1.10.1) lib/macro.ex:304: Macro.pipe/3
+            │ (stdlib 3.7.1) lists.erl:1263: :lists.foldl/3
+            │ (elixir 1.10.1) expanding macro: Kernel.|>/2
+            │ expanding macro: SomeModule.sigil_L/2
+            │ lib/my_app/my_module.ex:10: MyApp.MyModule.render/1
+            \"""
+          end
+
+          test "update file and position if file is present in the message" do
+            root_path = Path.join(__DIR__, "fixtures/build_errors")
+            file = Path.join(root_path, "lib/has_error.ex")
+            position = 2
+
+            message = \"""
+            ** (CompileError) lib/has_error.ex:3: some message
+            lib/my_app/my_module.ex:10: MyApp.MyModule.render/1
+            \"""
+
+            [diagnostic | _] =
+              [build_diagnostic(message, file, position)]
+              |> Diagnostics.normalize(root_path)
+
+            assert diagnostic.message == \"""
+            (CompileError) some message
+
+            Stacktrace:
+            │ lib/my_app/my_module.ex:10: MyApp.MyModule.render/1
+            \"""
+
+            assert diagnostic.position == 3
+          end
+
+          test "update file and position if file is present in the message (umbrella)" do
+            root_path = Path.join(__DIR__, "fixtures/umbrella")
+            file = Path.join(root_path, "lib/file_to_be_replaced.ex")
+            position = 3
+
+            message = \"""
+            ** (CompileError) lib/app2.ex:5: some message
+            (elixir 1.10.1) lib/macro.ex:304: Macro.pipe/3
+            lib/my_app/my_module.ex:10: MyApp.MyModule.render/1
+            \"""
+
+            [diagnostic | _] =
+              [build_diagnostic(message, file, position)]
+              |> Diagnostics.normalize(root_path)
+
+            assert diagnostic.message =~ "(CompileError) some message"
+            assert diagnostic.file =~ "umbrella/apps/app2/lib/app2.ex"
+            assert diagnostic.position == 5
+          end
+
+          test "don't update file nor position if file in message does not exist" do
+            root_path = Path.join(__DIR__, "fixtures/build_errors_on_external_resource")
+            file = Path.join(root_path, "lib/has_error.ex")
+            position = 2
+
+            message = \"""
+            ** (CompileError) lib/non_existing.ex:3: some message
+            lib/my_app/my_module.ex:10: MyApp.MyModule.render/1
+            \"""
+
+            [diagnostic | _] =
+              [build_diagnostic(message, file, position)]
+              |> Diagnostics.normalize(root_path)
+
+            assert diagnostic.message == \"""
+            (CompileError) lib/non_existing.ex:3: some message
+
+            Stacktrace:
+            │ lib/my_app/my_module.ex:10: MyApp.MyModule.render/1
+            \"""
+
+            assert diagnostic.position == 2
+          end
+
+          defp build_diagnostic(message, file, position) do
+            %Mix.Task.Compiler.Diagnostic{
+              compiler_name: "Elixir",
+              details: nil,
+              file: file,
+              message: message,
+              position: position,
+              severity: :error
+            }
+          end
+        end
+      end
+      """
+
+      %{text: text}
+    end
+
+    test "returns module lens on the module declaration line", %{text: text} do
+      uri = "file://project/file.ex"
+
+      {:ok, lenses} = CodeLens.Test.code_lens(uri, text)
+
+      assert Enum.member?(
+               lenses,
+               build_code_lens(0, :module, "/file.ex", %{
+                 "module" => ElixirLS.LanguageServer.DiagnosticsTest
+               })
+             )
+    end
+
+    test "returns test lenses with describe info", %{text: text} do
+      uri = "file://project/file.ex"
+
+      {:ok, lenses} = CodeLens.Test.code_lens(uri, text)
+
+      assert Enum.member?(
+               lenses,
+               build_code_lens(5, :test, "/file.ex", %{
+                 "testName" => "extract the stacktrace from the message and format it",
+                 "describe" => "normalize/2"
+               })
+             )
+    end
+  end
+
   defp build_code_lens(line, target, file_path, args) do
     arguments =
       %{