attempt to fix tests on < 1.17

Author: lukaszsamson

apps/language_server/test/providers/document_symbols_test.exs

@@ -24,6 +24,45 @@ defmodule ElixirLS.LanguageServer.Providers.DocumentSymbolsTest do
     results
   end
 
+  # Helper functions to make tests robust across Elixir versions by extracting only the essential fields
+  defp extract_document_symbol_fields(symbol) do
+    base_fields = %{
+      name: symbol.name,
+      kind: symbol.kind,
+      range: symbol.range,
+      selection_range: symbol.selection_range,
+      children: Enum.map(symbol.children || [], &extract_document_symbol_fields/1)
+    }
+
+    case symbol.detail do
+      nil -> base_fields
+      detail -> Map.put(base_fields, :detail, detail)
+    end
+  end
+
+  defp extract_symbol_information_fields(symbol) do
+    base_fields = %{
+      name: symbol.name,
+      kind: symbol.kind,
+      range: symbol.location.range
+    }
+
+    case symbol.container_name do
+      nil -> base_fields
+      container_name -> Map.put(base_fields, :container_name, container_name)
+    end
+  end
+
+  defp assert_document_symbols_match(actual, expected) when is_list(actual) do
+    actual_extracted = Enum.map(actual, &extract_document_symbol_fields/1)
+    assert actual_extracted == expected
+  end
+
+  defp assert_symbol_information_match(actual, expected) when is_list(actual) do
+    actual_extracted = Enum.map(actual, &extract_symbol_information_fields/1)
+    assert actual_extracted == expected
+  end
+
   test "returns hierarchical symbol information" do
     uri = "file:///project/file.ex"
     text = ~S[
@@ -2095,37 +2134,41 @@ defmodule ElixirLS.LanguageServer.Providers.DocumentSymbolsTest do
 
     parser_context = ParserContextBuilder.from_string(text)
 
-    assert {:ok,
-            [
-              %GenLSP.Structures.DocumentSymbol{
-                children: [],
-                kind: 20,
-                name: "config :logger :console",
-                range: range(1, 0, 5, 23),
-                selection_range: range(1, 0, 5, 23)
-              },
-              %GenLSP.Structures.DocumentSymbol{
-                children: [],
-                kind: 20,
-                name: "config :app :key",
-                range: range(6, 0, 6, 25),
-                selection_range: range(6, 0, 6, 25)
-              },
-              %GenLSP.Structures.DocumentSymbol{
-                children: [],
-                kind: 20,
-                name: "config :my_app [:ecto_repos]",
-                range: range(7, 0, 8, 26),
-                selection_range: range(7, 0, 8, 26)
-              },
-              %GenLSP.Structures.DocumentSymbol{
-                children: [],
-                kind: 20,
-                name: "config :my_app MyApp.Repo",
-                range: range(9, 0, 11, 22),
-                selection_range: range(9, 0, 11, 22)
-              }
-            ]} = get_document_symbols(uri, parser_context, true)
+    assert {:ok, document_symbols} = get_document_symbols(uri, parser_context, true)
+    assert length(document_symbols) == 4
+
+    expected_symbols = [
+      %{
+        children: [],
+        kind: 20,
+        name: "config :logger :console",
+        range: range(1, 0, 5, 23),
+        selection_range: range(1, 0, 5, 23)
+      },
+      %{
+        children: [],
+        kind: 20,
+        name: "config :app :key",
+        range: range(6, 0, 6, 25),
+        selection_range: range(6, 0, 6, 25)
+      },
+      %{
+        children: [],
+        kind: 20,
+        name: "config :my_app [:ecto_repos]",
+        range: range(7, 0, 8, 26),
+        selection_range: range(7, 0, 8, 26)
+      },
+      %{
+        children: [],
+        kind: 20,
+        name: "config :my_app MyApp.Repo",
+        range: range(9, 0, 11, 22),
+        selection_range: range(9, 0, 11, 22)
+      }
+    ]
+
+    assert_document_symbols_match(document_symbols, expected_symbols)
   end
 
   test "[flat] handles config" do
@@ -2147,37 +2190,33 @@ defmodule ElixirLS.LanguageServer.Providers.DocumentSymbolsTest do
 
     parser_context = ParserContextBuilder.from_string(text)
 
-    assert {:ok,
-            [
-              %GenLSP.Structures.SymbolInformation{
-                name: "config :logger :console",
-                kind: 20,
-                location: %{
-                  range: range(1, 0, 5, 23)
-                }
-              },
-              %GenLSP.Structures.SymbolInformation{
-                name: "config :app :key",
-                kind: 20,
-                location: %{
-                  range: range(6, 0, 6, 25)
-                }
-              },
-              %GenLSP.Structures.SymbolInformation{
-                name: "config :my_app [:ecto_repos]",
-                kind: 20,
-                location: %{
-                  range: range(7, 0, 8, 26)
-                }
-              },
-              %GenLSP.Structures.SymbolInformation{
-                name: "config :my_app MyApp.Repo",
-                kind: 20,
-                location: %{
-                  range: range(9, 0, 11, 22)
-                }
-              }
-            ]} = get_document_symbols(uri, parser_context, false)
+    assert {:ok, symbol_information} = get_document_symbols(uri, parser_context, false)
+    assert length(symbol_information) == 4
+
+    expected_symbols = [
+      %{
+        name: "config :logger :console",
+        kind: 20,
+        range: range(1, 0, 5, 23)
+      },
+      %{
+        name: "config :app :key",
+        kind: 20,
+        range: range(6, 0, 6, 25)
+      },
+      %{
+        name: "config :my_app [:ecto_repos]",
+        kind: 20,
+        range: range(7, 0, 8, 26)
+      },
+      %{
+        name: "config :my_app MyApp.Repo",
+        kind: 20,
+        range: range(9, 0, 11, 22)
+      }
+    ]
+
+    assert_symbol_information_match(symbol_information, expected_symbols)
   end
 
   test "[nested] handles a file with a top-level module without a name" do