Implement Test Coverage Reporting

Author: maennchen

.github/workflows/ci.yml

@@ -21,13 +21,16 @@ permissions:
 
 jobs:
   test_linux:
-    name: Ubuntu 24.04, Erlang/OTP ${{ matrix.otp_version }}${{ matrix.deterministic && ' (deterministic)' || '' }}
+    name: Ubuntu 24.04, Erlang/OTP ${{ matrix.otp_version }}${{ matrix.deterministic && ' (deterministic)' || '' }}${{ matrix.coverage && ' (coverage)' || '' }}
     strategy:
       fail-fast: false
       matrix:
         include:
           - otp_version: "27.1"
             deterministic: true
+          - otp_version: "27.1"
+            erlc_opts: "warnings_as_errors"
+            coverage: true
           - otp_version: "27.1"
             otp_latest: true
             erlc_opts: "warnings_as_errors"
@@ -65,9 +68,14 @@ jobs:
       - name: Erlang test suite
         run: make test_erlang
         continue-on-error: ${{ matrix.development }}
+        if: "${{ !matrix.coverage }}"
       - name: Elixir test suite
         run: make test_elixir
         continue-on-error: ${{ matrix.development }}
+        if: "${{ !matrix.coverage }}"
+      - name: "Calculate Coverage"
+        run: make cover
+        if: "${{ matrix.coverage }}"
       - name: Build docs (ExDoc main)
         if: ${{ matrix.otp_latest }}
         run: |
@@ -85,6 +93,12 @@ jobs:
           # Recompile System without .git
           cd lib/elixir && ../../bin/elixirc -o ebin lib/system.ex && cd -
           taskset 1 make check_reproducible
+      - name: "Upload Coverage Artifact"
+        if: "${{ matrix.coverage }}"
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+        with:
+          name: TestCoverage
+          path: cover/*
 
   test_windows:
     name: Windows Server 2019, Erlang/OTP ${{ matrix.otp_version }}

.gitignore

@@ -15,3 +15,4 @@
 /.eunit
 .elixir.plt
 erl_crash.dump
+/cover/

Makefile

@@ -25,6 +25,7 @@ GIT_REVISION = $(strip $(shell git rev-parse HEAD 2> /dev/null ))
 GIT_TAG = $(strip $(shell head="$(call GIT_REVISION)"; git tag --points-at $$head 2> /dev/null | grep -v latest | tail -1))
 SOURCE_DATE_EPOCH_PATH = lib/elixir/tmp/ebin_reproducible
 SOURCE_DATE_EPOCH_FILE = $(SOURCE_DATE_EPOCH_PATH)/SOURCE_DATE_EPOCH
+ROOT_DIR:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
 
 .PHONY: install install_man build_plt clean_plt dialyze test check_reproducible clean clean_elixir clean_man format docs Docs.zip Precompiled.zip zips
 .NOTPARALLEL:
@@ -53,6 +54,11 @@ lib/$(1)/ebin/Elixir.$(2).beam: $(wildcard lib/$(1)/lib/*.ex) $(wildcard lib/$(1
 test_$(1): test_formatted $(1)
 	@ echo "==> $(1) (ex_unit)"
 	$(Q) cd lib/$(1) && ../../bin/elixir -r "test/test_helper.exs" -pr "test/**/$(TEST_FILES)";
+
+cover/ex_unit_$(1).coverdata:
+	$(Q) mkdir -p "$(ROOT_DIR)/cover"
+	$(Q) COVER_FILE="$(ROOT_DIR)/cover/ex_unit_$(1).coverdata" $(MAKE) test_$(1)
+cover/combined.coverdata: cover/ex_unit_$(1).coverdata
 endef
 
 define WRITE_SOURCE_DATE_EPOCH
@@ -175,6 +181,7 @@ clean: clean_man
 	rm -rf lib/mix/test/fixtures/git_sparse_repo/
 	rm -rf lib/mix/test/fixtures/archive/ebin/
 	rm -f erl_crash.dump
+	rm -rf cover/*
 
 clean_elixir:
 	$(Q) rm -f lib/*/ebin/Elixir.*.beam
@@ -287,6 +294,17 @@ test_stdlib: compile
 		cd lib/elixir && ../../bin/elixir --sname primary -r "test/elixir/test_helper.exs" -pr "test/elixir/**/$(TEST_FILES)"; \
 	fi
 
+cover/ex_unit_stdlib.coverdata:
+	$(Q) mkdir -p "$(ROOT_DIR)/cover"
+	$(Q) COVER_FILE="$(ROOT_DIR)/cover/ex_unit_stdlib.coverdata" $(MAKE) test_stdlib
+cover/combined.coverdata: cover/ex_unit_stdlib.coverdata
+
+cover/combined.coverdata:
+	$(Q) bin/elixir ./lib/elixir/scripts/cover.exs
+
+.PHONY: cover
+cover: cover/combined.coverdata
+
 #==> Dialyzer tasks
 
 DIALYZER_OPTS = --no_check_plt --fullpath -Werror_handling -Wunmatched_returns -Wunderspecs

lib/eex/test/test_helper.exs

@@ -5,6 +5,8 @@
 {line_exclude, line_include} =
   if line = System.get_env("LINE"), do: {[:test], [line: line]}, else: {[], []}
 
+Code.eval_file("../../../elixir/scripts/cover_record.exs", __ENV__.file)
+
 ExUnit.start(
   trace: !!System.get_env("TRACE"),
   include: line_include,

lib/elixir/scripts/cover.exs

@@ -0,0 +1,42 @@
+#!bin/elixir
+
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: 2021 The Elixir Team
+
+root_dir = __ENV__.file |> Path.dirname() |> Path.join("../../..")
+cover_dir = Path.join(root_dir, "cover")
+coverdata_inputs = cover_dir |> Path.join("ex_unit_*.coverdata") |> Path.wildcard()
+coverdata_output = Path.join(cover_dir, "combined.coverdata")
+ebins = root_dir |> Path.join("lib/*/ebin") |> Path.wildcard()
+
+_ = :cover.stop()
+{:ok, cover_pid} = :cover.start()
+
+for ebin <- ebins,
+    result <- :cover.compile_beam_directory(String.to_charlist(ebin)) do
+  case result do
+    {:ok, _module} ->
+      :ok
+
+    {:error, reason} ->
+      raise "Failed to cover compile directory #{ebin} with reason: #{inspect(reason)}"
+  end
+end
+
+for file <- coverdata_inputs do
+  :ok = :cover.import(String.to_charlist(file))
+end
+
+:ok = :cover.export(String.to_charlist(coverdata_output))
+
+{:ok, _} = Application.ensure_all_started(:mix)
+
+# Silence analyse import messages emitted by cover
+{:ok, string_io} = StringIO.open("")
+Process.group_leader(cover_pid, string_io)
+
+:ok =
+  Mix.Tasks.Test.Coverage.generate_cover_results(
+    output: cover_dir,
+    summary: [threshold: 0]
+  )

lib/elixir/scripts/cover_record.exs

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: 2021 The Elixir Team
+
+root_dir = __ENV__.file |> Path.dirname() |> Path.join("../../..")
+ebins = root_dir |> Path.join("lib/*/ebin") |> Path.wildcard()
+
+case System.fetch_env("COVER_FILE") do
+  {:ok, file} ->
+    _ = :cover.stop()
+    {:ok, _pid} = :cover.start()
+
+    for ebin <- ebins,
+        result <- :cover.compile_beam_directory(String.to_charlist(ebin)) do
+      case result do
+        {:ok, _module} ->
+          :ok
+
+        {:error, reason} ->
+          raise "Failed to cover compile directory #{ebin} with reason: #{inspect(reason)}"
+      end
+    end
+
+    System.at_exit(fn _status ->
+      :ok = :cover.export(String.to_charlist(file))
+    end)
+
+    true
+
+  :error ->
+    false
+end

lib/elixir/test/elixir/exception_test.exs

@@ -556,7 +556,9 @@ defmodule ExceptionTest do
     end
 
     test "annotates function clause errors" do
-      assert blame_message(Access, & &1.fetch(:foo, :bar)) =~ """
+      message = blame_message(Access, & &1.fetch(:foo, :bar))
+
+      assert message =~ """
              no function clause matching in Access.fetch/2
 
              The following arguments were given to Access.fetch/2:
@@ -566,11 +568,15 @@ defmodule ExceptionTest do
 
                  # 2
                  :bar
+             """
 
-             Attempted function clauses (showing 5 out of 5):
+      if Access not in :cover.modules() do
+        assert message =~ """
+               Attempted function clauses (showing 5 out of 5):
 
-                 def fetch(-%module{} = container-, key)
-             """
+                   def fetch(-%module{} = container-, key)
+               """
+      end
     end
 
     test "annotates undefined function error with suggestions" do
@@ -863,10 +869,16 @@ defmodule ExceptionTest do
       {exception, stack} =
         Exception.blame(:error, :function_clause, [{Keyword, :pop, args, [line: 13]}])
 
-      assert %FunctionClauseError{kind: :def, args: ^args, clauses: [_]} = exception
+      if Keyword in :cover.modules() do
+        assert %FunctionClauseError{kind: nil, args: ^args, clauses: nil} = exception
+      else
+        assert %FunctionClauseError{kind: :def, args: ^args, clauses: [_]} = exception
+      end
+
       assert stack == [{Keyword, :pop, 3, [line: 13]}]
     end
 
+    @tag :require_ast
     test "annotates args and clauses from mfa" do
       import PathHelpers
 

lib/elixir/test/elixir/kernel/dialyzer_test.exs

@@ -8,6 +8,7 @@ defmodule Kernel.DialyzerTest do
   use ExUnit.Case, async: true
 
   @moduletag :dialyzer
+  @moduletag :require_ast
   import PathHelpers
 
   setup_all do

lib/elixir/test/elixir/module/types/integration_test.exs

@@ -458,6 +458,7 @@ defmodule Module.Types.IntegrationTest do
       assert_warnings(files, warnings)
     end
 
+    @tag :require_ast
     test "String.Chars protocol dispatch" do
       files = %{
         "a.ex" => """
@@ -520,6 +521,7 @@ defmodule Module.Types.IntegrationTest do
       assert_warnings(files, warnings, consolidate_protocols: true)
     end
 
+    @tag :require_ast
     test "Enumerable protocol dispatch" do
       files = %{
         "a.ex" => """

lib/elixir/test/elixir/module_test.exs

@@ -431,6 +431,7 @@ defmodule ModuleTest do
     assert backend.debug_info(:elixir_v1, ModuleCreateNoDebugInfo, data, []) == {:error, :missing}
   end
 
+  @tag :require_ast
   test "compiles to core" do
     {:ok, {Atom, [{~c"Dbgi", dbgi}]}} = Atom |> :code.which() |> :beam_lib.chunks([~c"Dbgi"])
     {:debug_info_v1, backend, data} = :erlang.binary_to_term(dbgi)

lib/elixir/test/elixir/protocol/consolidation_test.exs

@@ -246,6 +246,7 @@ defmodule Protocol.ConsolidationTest do
     end
   end
 
+  @tag :require_ast
   test "consolidation errors on missing BEAM files" do
     defprotocol NoBeam do
       def example(arg)

lib/elixir/test/elixir/test_helper.exs

@@ -120,9 +120,20 @@ source_exclude =
     []
   end
 
+cover_enabled? = Code.eval_file("../../../scripts/cover_record.exs", __ENV__.file)
+
+cover_exclude =
+  if cover_enabled? do
+    [:require_ast]
+  else
+    []
+  end
+
 ExUnit.start(
   trace: !!System.get_env("TRACE"),
   assert_receive_timeout: assert_timeout,
-  exclude: epmd_exclude ++ os_exclude ++ line_exclude ++ distributed_exclude ++ source_exclude,
+  exclude:
+    epmd_exclude ++
+      os_exclude ++ line_exclude ++ distributed_exclude ++ source_exclude ++ cover_exclude,
   include: line_include
 )

lib/elixir/test/erlang/test_helper.erl

@@ -14,10 +14,13 @@
 
 test() ->
   application:ensure_all_started(elixir),
-  case eunit:test(?TESTS) of
-    error -> erlang:halt(1);
-    _Res  -> erlang:halt(0)
-  end.
+  enable_coverage_report(),
+  ExitCode = case eunit:test(?TESTS) of
+    error -> 1;
+    _Res  -> 0
+  end,
+  write_report_coverage(),
+  erlang:halt(ExitCode).
 
 % Execute a piece of code and purge given modules right after
 run_and_remove(Fun, Modules) ->
@@ -39,3 +42,20 @@ throw_erlang(String) ->
   {ok, Tokens, _} = erl_scan:string(String),
   {ok, [Form]} = erl_parse:parse_exprs(Tokens),
   erlang:error(io:format("~p~n", [Form])).
+
+enable_coverage_report() ->
+  case os:getenv("COVER_FILE") of
+    false -> ok;
+    _File ->
+      _ = cover:stop(),
+      {ok, _Pid} = cover:start(),
+      Ebin = filename:dirname(filename:absname(?FILE)) ++ "/../../ebin",
+      % TODO: Check Result
+      cover:compile_beam_directory(Ebin)
+  end.
+
+write_report_coverage() ->
+  case os:getenv("COVER_FILE") of
+    false -> ok;
+    File -> cover:export(File)
+  end.

lib/ex_unit/lib/ex_unit/diff.ex

@@ -1162,6 +1162,7 @@ defmodule ExUnit.Diff do
     else
       other
       |> Map.to_list()
+      |> Enum.sort()
       |> Enum.map(&escape_pair/1)
       |> build_map_or_struct(struct)
     end