Enable smarter test searches (#800)

* Allow doctests to be run. Integrate more metadata in code lens

* Fix up formatting

* Fix up case of no doctests

* Clean up the code style

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

Co-authored-by: Steve Cohen <scohen@scohen.org>

---------

Co-authored-by: Carl Foster <cfoster@squiz.net>
Co-authored-by: Steve Cohen <scohen@scohen.org>

Author: 3 people

apps/language_server/lib/language_server/ex_unit_test_tracer.ex

@@ -76,11 +76,14 @@ defmodule ElixirLS.LanguageServer.ExUnitTestTracer do
         test_info
         |> Enum.group_by(fn %ExUnit.Test{tags: tags} -> {tags.describe, tags.describe_line} end)
         |> Enum.map(fn {{describe, describe_line}, tests} ->
+          grouped_tests = Enum.group_by(tests, fn %ExUnit.Test{tags: tags} -> tags.test_type end)
+
           tests =
-            tests
+            grouped_tests
+            |> Map.get(:test, [])
             |> Enum.map(fn %ExUnit.Test{tags: tags} = test ->
               # drop test prefix
-              "test " <> test_name = Atom.to_string(test.name)
+              test_name = drop_test_prefix(test.name)
 
               test_name =
                 if describe != nil do
@@ -96,6 +99,21 @@ defmodule ElixirLS.LanguageServer.ExUnitTestTracer do
               }
             end)
 
+          tests =
+            case grouped_tests do
+              %{doctest: [doctest | _]} ->
+                test_meta = %{
+                  name: "doctest #{inspect(doctest.tags.doctest)}",
+                  line: doctest.tags.line - 1,
+                  type: :doctest
+                }
+
+                [test_meta | tests]
+
+              _ ->
+                tests
+            end
+
           %{
             describe: describe,
             line: if(describe_line, do: describe_line - 1),
@@ -112,4 +130,10 @@ defmodule ElixirLS.LanguageServer.ExUnitTestTracer do
   def trace(_, %Macro.Env{} = _env) do
     :ok
   end
+
+  defp drop_test_prefix(test_name) when is_atom(test_name),
+    do: test_name |> Atom.to_string() |> drop_test_prefix
+
+  defp drop_test_prefix("test " <> rest), do: rest
+  defp drop_test_prefix(test_name), do: test_name
 end

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

@@ -53,7 +53,8 @@ defmodule ElixirLS.LanguageServer.Providers.CodeLens.Test do
       %{
         "filePath" => file_path,
         "testName" => block.name,
-        "projectDir" => project_dir
+        "projectDir" => project_dir,
+        "module" => get_module_name(block.module)
       }
       |> Map.merge(if block.describe != nil, do: %{"describe" => block.describe.name}, else: %{})
     end
@@ -70,17 +71,18 @@ defmodule ElixirLS.LanguageServer.Providers.CodeLens.Test do
       CodeLens.build_code_lens(block.line, "Run tests", @run_test_command, %{
         "filePath" => file_path,
         "describe" => block.name,
-        "projectDir" => project_dir
+        "projectDir" => project_dir,
+        "module" => get_module_name(block.module)
       })
     end)
   end
 
   defp find_test_blocks(lines_to_env_list, calls_list, describe_blocks, source_lines) do
-    runnable_functions = [{:test, 3}, {:test, 2}]
+    runnable_functions = [test: 3, test: 2, doctest: 2, doctest: 1]
 
     for func <- runnable_functions,
         {line, _col} <- calls_to(calls_list, func) do
-      {_line, %{scope_id: scope_id}} =
+      {_line, %{scope_id: scope_id, module: module}} =
         Enum.find(lines_to_env_list, fn {env_line, _env} -> env_line == line end)
 
       describe =
@@ -89,11 +91,23 @@ defmodule ElixirLS.LanguageServer.Providers.CodeLens.Test do
           describe.body_scope_id == scope_id
         end)
 
-      %{"name" => test_name} =
-        ~r/^\s*test "(?<name>.*)"(,.*)?/
-        |> Regex.named_captures(Enum.at(source_lines, line - 1))
-
-      %TestBlock{name: test_name, describe: describe, line: line}
+      test_name =
+        source_lines
+        |> Enum.at(line - 1)
+        |> String.trim()
+        |> case do
+          "test " <> rest ->
+            rest
+            |> String.split(~s("))
+            |> Enum.at(1)
+
+          "doctest" <> _ = line ->
+            line
+            |> String.split(~s(,))
+            |> Enum.at(0)
+        end
+
+      %TestBlock{name: test_name, describe: describe, line: line, module: module}
     end
   end
 
@@ -145,4 +159,10 @@ defmodule ElixirLS.LanguageServer.Providers.CodeLens.Test do
       {:ok, buffer_file_metadata}
     end
   end
+
+  defp get_module_name(module) do
+    module
+    |> Module.split()
+    |> Enum.join(".")
+  end
 end

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

@@ -1,22 +1,28 @@
 defmodule ElixirLS.LanguageServer.Providers.CodeLens.Test.DescribeBlock do
   alias ElixirSense.Core.State.Env
 
-  @struct_keys [:line, :name, :body_scope_id]
+  @struct_keys [:line, :name, :body_scope_id, :module]
 
   @enforce_keys @struct_keys
   defstruct @struct_keys
 
   def find_block_info(line, lines_to_env_list, lines_to_env_list_length, source_lines) do
     name = get_name(source_lines, line)
 
+    module =
+      lines_to_env_list
+      |> Enum.find(fn {env_line, _env} -> env_line == line end)
+      |> elem(1)
+      |> Map.get(:module)
+
     body_scope_id =
       get_body_scope_id(
         line,
         lines_to_env_list,
         lines_to_env_list_length
       )
 
-    %__MODULE__{line: line, body_scope_id: body_scope_id, name: name}
+    %__MODULE__{line: line, body_scope_id: body_scope_id, name: name, module: module}
   end
 
   defp get_name(source_lines, declaration_line) do

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

@@ -1,5 +1,5 @@
 defmodule ElixirLS.LanguageServer.Providers.CodeLens.Test.TestBlock do
-  @struct_keys [:name, :describe, :line]
+  @struct_keys [:name, :describe, :line, :module]
 
   @enforce_keys @struct_keys
   defstruct @struct_keys