Fix CI and improve ExUnit results

Author: josevalim

lib/ex_unit/lib/ex_unit/cli_formatter.ex

@@ -43,9 +43,9 @@ defmodule ExUnit.CLIFormatter do
   end
 
   def handle_cast({:suite_finished, times_us}, config) do
-    test_type_counts = collect_test_type_counts(config)
+    test_counter = collect_test_counter(config)
 
-    if test_type_counts == 0 and config.excluded_counter > 0 do
+    if test_counter == 0 and config.excluded_counter > 0 do
       IO.puts(invalid("All tests have been excluded.", config))
     end
 
@@ -83,10 +83,7 @@ defmodule ExUnit.CLIFormatter do
   def handle_cast({:test_finished, %ExUnit.Test{state: {:excluded, reason}} = test}, config)
       when is_binary(reason) do
     if config.trace, do: IO.puts(trace_test_excluded(test))
-
-    test_counter = update_test_counter(config.test_counter, test)
-    config = %{config | test_counter: test_counter, excluded_counter: config.excluded_counter + 1}
-
+    config = %{config | excluded_counter: config.excluded_counter + 1}
     {:noreply, config}
   end
 
@@ -98,10 +95,7 @@ defmodule ExUnit.CLIFormatter do
       IO.write(skipped("*", config))
     end
 
-    test_counter = update_test_counter(config.test_counter, test)
-    config = %{config | test_counter: test_counter, skipped_counter: config.skipped_counter + 1}
-
-    {:noreply, config}
+    {:noreply, %{config | skipped_counter: config.skipped_counter + 1}}
   end
 
   def handle_cast(
@@ -115,10 +109,7 @@ defmodule ExUnit.CLIFormatter do
       IO.write(invalid("?", config))
     end
 
-    test_counter = update_test_counter(config.test_counter, test)
-    config = %{config | test_counter: test_counter, invalid_counter: config.invalid_counter + 1}
-
-    {:noreply, config}
+    {:noreply, %{config | invalid_counter: config.invalid_counter + 1}}
   end
 
   def handle_cast({:test_finished, %ExUnit.Test{state: {:failed, failures}} = test}, config) do
@@ -287,10 +278,6 @@ defmodule ExUnit.CLIFormatter do
     end
   end
 
-  defp update_test_counter(test_counter, %{state: {:excluded, _reason}}) do
-    test_counter
-  end
-
   defp update_test_counter(test_counter, %{tags: %{test_type: test_type}}) do
     Map.update(test_counter, test_type, 1, &(&1 + 1))
   end
@@ -366,26 +353,22 @@ defmodule ExUnit.CLIFormatter do
   ## Printing
 
   defp print_summary(config, force_failures?) do
-    test_type_counts = collect_test_type_counts(config)
-    test_counter = test_counter_or_default(config, test_type_counts)
-
-    passed_total =
-      test_type_counts - config.failure_counter - config.skipped_counter - config.invalid_counter
+    test_counter = collect_test_counter(config)
+    passed_counter = test_counter - config.failure_counter
 
-    # Passed line: "Passed: 447/455 (53/54 doctests, 393/403 tests)" or
-    # "Passed: 455 (70 tests, 14 properties)" when all pass
-    all_passed? = passed_total == test_type_counts
+    # Passed line: "Result: 447/455 passed (53/54 doctests, 393/403 tests)" or
+    # "Result: 455 passed (70 tests, 14 properties)" when all pass
+    all_passed? = config.failure_counter == 0
 
     passed_breakdown =
-      format_passed_breakdown(test_counter, config.failure_type_counter, all_passed?)
+      format_passed_breakdown(config.test_counter, config.failure_type_counter, all_passed?)
 
     passed_line =
-      if all_passed? do
-        "Passed: #{passed_total}"
-      else
-        "Passed: #{passed_total}/#{test_type_counts}"
-      end
-      |> if_true(passed_breakdown != "", &(&1 <> " (#{passed_breakdown})"))
+      cond do
+        test_counter == 0 -> "Result: 0 tests"
+        all_passed? -> "Result: #{passed_counter} passed"
+        true -> "Result: #{passed_counter}/#{test_counter} passed"
+      end <> passed_breakdown
 
     # Failed line: "Failed: 8 tests, 1 property"
     failed_line =
@@ -408,7 +391,7 @@ defmodule ExUnit.CLIFormatter do
       )
       |> if_true(
         config.excluded_counter > 0,
-        &(&1 <> " (#{config.excluded_counter} excluded)")
+        &(&1 <> ", #{config.excluded_counter} excluded")
       )
 
     cond do
@@ -418,7 +401,7 @@ defmodule ExUnit.CLIFormatter do
       config.invalid_counter > 0 ->
         IO.puts(invalid(message, config))
 
-      test_type_counts > 0 && config.excluded_counter == test_type_counts ->
+      test_counter > 0 && config.excluded_counter == test_counter ->
         IO.puts(invalid(message, config))
 
       true ->
@@ -455,41 +438,35 @@ defmodule ExUnit.CLIFormatter do
   end
 
   defp format_passed_breakdown(test_counter, failure_type_counter, all_passed?) do
-    # If there are no different test types, we just print "Passed: N/N"
-    # without the type.
+    # If there are no different test types, we just print "Result: N/N passed" without the type.
     if map_size(test_counter) in 0..1 do
       ""
     else
-      test_counter
-      |> Map.keys()
-      |> Enum.sort()
-      |> Enum.map_join(", ", fn type ->
-        total = Map.fetch!(test_counter, type)
-
-        if all_passed? do
-          "#{total} #{pluralize_type(total, type)}"
-        else
-          failed = Map.get(failure_type_counter, type, 0)
-          passed = total - failed
-          "#{passed}/#{total} #{pluralize_type(total, type)}"
-        end
-      end)
+      entries =
+        test_counter
+        |> Map.keys()
+        |> Enum.sort()
+        |> Enum.map_join(", ", fn type ->
+          total = Map.fetch!(test_counter, type)
+
+          if all_passed? do
+            "#{total} #{pluralize_type(total, type)}"
+          else
+            failed = Map.get(failure_type_counter, type, 0)
+            passed = total - failed
+            "#{passed}/#{total} #{pluralize_type(total, type)}"
+          end
+        end)
+
+      " (" <> entries <> ")"
     end
   end
 
   defp pluralize_type(count, type) do
     pluralize(count, type, ExUnit.plural_rule(to_string(type)))
   end
 
-  defp test_counter_or_default(_config, 0) do
-    %{test: 0}
-  end
-
-  defp test_counter_or_default(%{test_counter: test_counter} = _config, _test_type_counts) do
-    test_counter
-  end
-
-  defp collect_test_type_counts(%{test_counter: test_counter} = _config) do
+  defp collect_test_counter(%{test_counter: test_counter} = _config) do
     Enum.reduce(test_counter, 0, fn {_, count}, acc ->
       acc + count
     end)

lib/ex_unit/test/ex_unit/callbacks_test.exs

@@ -36,7 +36,7 @@ defmodule ExUnit.CallbacksTest do
       end
     end
 
-    assert capture_io(fn -> ExUnit.run() end) =~ "Passed: 1"
+    assert capture_io(fn -> ExUnit.run() end) =~ "Result: 1 passed"
   end
 
   test "named callbacks run custom code in order" do
@@ -66,7 +66,7 @@ defmodule ExUnit.CallbacksTest do
       defp store_5(context), do: store(context, 5)
     end
 
-    assert capture_io(fn -> ExUnit.run() end) =~ "Passed: 1"
+    assert capture_io(fn -> ExUnit.run() end) =~ "Result: 1 passed"
   end
 
   test "named callbacks support {module, function} tuples" do
@@ -87,7 +87,7 @@ defmodule ExUnit.CallbacksTest do
       def setup_3(_), do: [setup_3: true]
     end
 
-    assert capture_io(fn -> ExUnit.run() end) =~ "Passed: 1"
+    assert capture_io(fn -> ExUnit.run() end) =~ "Result: 1 passed"
   end
 
   test "doesn't choke on setup errors" do
@@ -141,7 +141,7 @@ defmodule ExUnit.CallbacksTest do
       end
     end
 
-    assert capture_io(fn -> ExUnit.run() end) =~ "Passed: 0/1"
+    assert capture_io(fn -> ExUnit.run() end) =~ "Result: 0 tests"
   end
 
   test "doesn't choke on dead supervisor" do
@@ -253,7 +253,7 @@ defmodule ExUnit.CallbacksTest do
 
     output = capture_io(fn -> ExUnit.run() end)
     assert output =~ "on_exit run"
-    assert output =~ "Passed: 1"
+    assert output =~ "Result: 1 passed"
   end
 
   test "runs multiple on_exit exits and overrides by ref" do

lib/ex_unit/test/ex_unit/doc_test_test.exs

@@ -1084,7 +1084,7 @@ defmodule ExUnit.DocTestTest do
       doctest ExUnit.DocTestTest.Numbered
     end
 
-    assert capture_io(fn -> ExUnit.run() end) =~ "Passed: 1"
+    assert capture_io(fn -> ExUnit.run() end) =~ "Result: 1 passed"
   end
 
   test "IEx prompt contains host" do
@@ -1253,7 +1253,7 @@ defmodule ExUnit.DocTestTest do
       end
 
       output = capture_io(fn -> ExUnit.run() end)
-      assert output =~ "Passed: 2"
+      assert output =~ "Result: 2 passed"
     end
 
     test "failing" do

lib/ex_unit/test/ex_unit/register_test.exs

@@ -42,7 +42,7 @@ defmodule ExUnit.RegisterTest do
 
     assert capture_io(fn ->
              assert ExUnit.run() == %{failures: 0, skipped: 0, total: 2, excluded: 0}
-           end) =~ "Passed: 2 (1 property, 1 test)"
+           end) =~ "Result: 2 passed (1 property, 1 test)"
   end
 
   test "plural test types" do
@@ -96,6 +96,6 @@ defmodule ExUnit.RegisterTest do
 
     assert capture_io(fn ->
              assert ExUnit.run() == %{failures: 0, skipped: 0, total: 4, excluded: 0}
-           end) =~ "Passed: 4 (2 properties, 2 tests)"
+           end) =~ "Result: 4 passed (2 properties, 2 tests)"
   end
 end

lib/ex_unit/test/ex_unit_test.exs

@@ -33,7 +33,7 @@ defmodule ExUnitTest do
     assert capture_io(fn ->
              assert ExUnit.async_run() |> ExUnit.await_run() ==
                       %{failures: 0, skipped: 0, total: 0, excluded: 0}
-           end) =~ "\nPassed: 0\n"
+           end) =~ "\nResult: 0 tests\n"
   end
 
   test "supports rerunning given modules" do
@@ -139,7 +139,7 @@ defmodule ExUnitTest do
     assert result =~ ~r"\* test true \[.*test/ex_unit_test.exs:#{line}\]"
 
     assert result =~ "Showing results so far..."
-    assert result =~ "Passed: 0"
+    assert result =~ "Result: 0 tests"
   end
 
   test "doesn't hang on exits" do
@@ -332,11 +332,11 @@ defmodule ExUnitTest do
 
     {result, output} = run_with_filter([exclude: [even: true]], [ParityTest])
     assert result == %{failures: 0, skipped: 0, excluded: 1, total: 4}
-    assert output =~ "Passed: 3"
+    assert output =~ "Result: 3 passed"
 
     {result, output} = run_with_filter([exclude: :even], [ParityTest])
     assert result == %{failures: 0, skipped: 0, excluded: 3, total: 4}
-    assert output =~ "Passed: 1"
+    assert output =~ "Result: 1 passed"
 
     {result, output} = run_with_filter([exclude: :even, include: [even: true]], [ParityTest])
     assert result == %{failures: 1, skipped: 0, excluded: 2, total: 4}
@@ -493,7 +493,7 @@ defmodule ExUnitTest do
         assert ExUnit.run() == %{failures: 0, skipped: 2, total: 2, excluded: 0}
       end)
 
-    assert output =~ "Passed: 0/2"
+    assert output =~ "Result: 0 tests"
   end
 
   test "filtering cases with :module tag" do
@@ -511,7 +511,7 @@ defmodule ExUnitTest do
     {result, output} = run_with_filter([exclude: :module], [])
 
     assert result == %{failures: 0, skipped: 0, excluded: 2, total: 2}
-    assert output =~ "Passed: 0"
+    assert output =~ "Result: 0 tests"
 
     {result, output} =
       [exclude: :test, include: [module: "ExUnitTest.SecondTestModule"]]
@@ -644,7 +644,7 @@ defmodule ExUnitTest do
 
     assert capture_io(fn ->
              assert ExUnit.run() == %{failures: 0, skipped: 0, total: 3, excluded: 0}
-           end) =~ "Passed: 3"
+           end) =~ "Result: 3 passed"
   end
 
   # Skipped and excluded tests should be included in the stats
@@ -682,7 +682,7 @@ defmodule ExUnitTest do
       end)
 
     refute output =~ max_failures_reached_msg()
-    assert output =~ "Passed: 0/5"
+    assert output =~ "Result: 0 tests"
   end
 
   test "parameterized tests" do
@@ -727,7 +727,7 @@ defmodule ExUnitTest do
     end
 
     configure_and_reload_on_exit(trace: true)
-    assert capture_io(fn -> ExUnit.run() end) =~ "Passed: 0"
+    assert capture_io(fn -> ExUnit.run() end) =~ "Result: 0 tests"
 
     defmodule EmptyGroupedParameterizedTests do
       use ExUnit.Case, async: true, parameterize: [], group: :example
@@ -738,7 +738,7 @@ defmodule ExUnitTest do
     end
 
     configure_and_reload_on_exit(trace: true)
-    assert capture_io(fn -> ExUnit.run() end) =~ "Passed: 0"
+    assert capture_io(fn -> ExUnit.run() end) =~ "Result: 0 tests"
   end
 
   describe "after_suite/1" do
@@ -912,7 +912,7 @@ defmodule ExUnitTest do
         end)
 
       assert output =~ max_failures_reached_msg()
-      assert output =~ "Passed: 0/3"
+      assert output =~ "Result: 0 tests"
     end
 
     test ":max_failures flushes all async/sync cases" do
@@ -1103,7 +1103,7 @@ defmodule ExUnitTest do
       end)
 
     assert output =~ "All tests have been excluded.\n"
-    assert output =~ "Passed: 0"
+    assert output =~ "Result: 0 tests"
   end
 
   test "tests are run in compile order (FIFO)" do

lib/mix/lib/mix/tasks/test.coverage.ex

@@ -81,9 +81,9 @@ defmodule Mix.Tasks.Test.Coverage do
   to compute coverage, leading to better performance when running a test suite
   with coverage enabled.
 
-  You can enable it by setting:
+  You can enable it by running:
 
-      ERL_COMPILER_OPTIONS=line_coverage mix test.coverage
+      ERL_COMPILER_OPTIONS=line_coverage mix test
 
   ## Exporting coverage
 

lib/mix/test/mix/cli_test.exs

@@ -253,7 +253,7 @@ defmodule Mix.CLITest do
 
       output = mix(~w[test test/new_with_tests_test.exs --cover])
       assert File.regular?("_build/test/lib/new_with_tests/ebin/Elixir.NewWithTests.beam")
-      assert output =~ "1 doctest, 1 test, 0 failures"
+      assert output =~ "Result: 2 passed (1 doctest, 1 test)"
       assert output =~ "Generating cover results ..."
       assert File.regular?("cover/Elixir.NewWithTests.html")
     end)
@@ -267,7 +267,7 @@ defmodule Mix.CLITest do
 
       output = mix(~w[test])
       assert File.regular?("_build/test/lib/sup_with_tests/ebin/Elixir.SupWithTests.beam")
-      assert output =~ "1 doctest, 1 test, 0 failures"
+      assert output =~ "Result: 2 passed (1 doctest, 1 test)"
     end)
   end
 end