feat: add diff and better messaging

Author: yknx4

lib/opencov/services/github/checks.ex

@@ -2,29 +2,57 @@ defmodule Librecov.Services.Github.Checks do
   require Logger
   alias ExOctocat.Connection
   alias ExOctocat.Api.Checks
+  alias Librecov.Build
 
-  def finish_check(token, commit, owner, repo, coverage) do
-    token
-    |> Connection.new()
-    |> Checks.checks_create(owner, repo,
-      body: %{
-        name: "Open Coverage",
-        head_sha: commit,
-        conclusion: "success",
-        output: %{
-          title: "Coverage at #{coverage}%",
-          summary: "#{coverage}%"
-        }
-      }
-    )
+  def finish_check(token, owner, repo, %Build{
+        coverage: coverage,
+        previous_coverage: previous_coverage,
+        commit_sha: commit
+      }) do
+    cov_dif = coverage_diff(coverage, previous_coverage) |> format_coverage()
+    cov = coverage |> format_coverage()
+
+    conn =
+      token
+      |> Connection.new()
+
+    with {:ok, commit_check} <-
+           conn
+           |> Checks.checks_create(owner, repo,
+             body: %{
+               name: "LibreCov/commit",
+               head_sha: commit,
+               conclusion: "success",
+               output: %{
+                 title: "Coverage at #{cov} (#{cov_dif})",
+                 summary: "#{cov}% (#{cov_dif})"
+               }
+             }
+           ),
+         {:ok, diff_check} <-
+           conn
+           |> Checks.checks_create(owner, repo,
+             body: %{
+               name: "LibreCov/diff",
+               head_sha: commit,
+               conclusion: coverage_diff(coverage, previous_coverage) |> diff_conclusion(),
+               output: %{
+                 title: "Coverage changed #{cov_dif}",
+                 summary: "changed #{cov_dif}"
+               }
+             }
+           ) do
+      Logger.info("Finished check of commit #{commit} with diff: #{cov_dif} coverage: #{cov}.")
+      {:ok, [commit_check, diff_check]}
+    end
   end
 
   def create_check(token, commit, owner, repo) do
     token
     |> Connection.new()
     |> Checks.checks_create(owner, repo,
       body: %{
-        name: "Open Coverage",
+        name: "LibreCov/commit",
         head_sha: commit,
         output: %{
           title: "Waiting for tests to finish.",
@@ -33,4 +61,13 @@ defmodule Librecov.Services.Github.Checks do
       }
     )
   end
+
+  defp diff_conclusion(diff) when diff == 0, do: "neutral"
+  defp diff_conclusion(diff) when diff < 0, do: "failure"
+  defp diff_conclusion(diff) when diff > 0, do: "success"
+
+  defp format_coverage(coverage), do: "#{Float.round(coverage, 2)}%"
+
+  defp coverage_diff(coverage, nil), do: coverage
+  defp coverage_diff(coverage, previous_coverage), do: coverage - previous_coverage
 end

test/lib/services/github/checks_test.exs

@@ -3,6 +3,7 @@ defmodule Librecov.Services.Github.ChecksTests do
   import Tesla.Mock
 
   alias Librecov.Services.Github.Checks
+  alias Librecov.Build
 
   @create_check %{
     "id" => 4,
@@ -111,8 +112,43 @@ defmodule Librecov.Services.Github.ChecksTests do
     assert Map.has_key?(project, :id)
   end
 
-  test "it finished a check" do
-    {:ok, project} = Checks.finish_check("asdfasdf", "qwerqwer", "github", "hello-world", 54.4444)
-    assert Map.has_key?(project, :id)
+  @base_build %Build{
+    commit_sha: "ce587453ced02b1526dfb4cb910479d431683101",
+    coverage: 97.12345
+  }
+
+  test "it finishes a check with nil previous coverage" do
+    {:ok, checks} = Checks.finish_check("asdfasdf", "github", "hello-world", @base_build)
+    checks |> Enum.each(fn check -> assert Map.has_key?(check, :id) end)
+  end
+
+  test "it finishes a check with 0 diff coverage" do
+    {:ok, checks} =
+      Checks.finish_check("asdfasdf", "github", "hello-world", %Build{
+        @base_build
+        | previous_coverage: @base_build.coverage
+      })
+
+    checks |> Enum.each(fn check -> assert Map.has_key?(check, :id) end)
+  end
+
+  test "it finishes a check with positive diff coverage" do
+    {:ok, checks} =
+      Checks.finish_check("asdfasdf", "github", "hello-world", %Build{
+        @base_build
+        | previous_coverage: 99.99999
+      })
+
+    checks |> Enum.each(fn check -> assert Map.has_key?(check, :id) end)
+  end
+
+  test "it finishes a check with negative diff coverage" do
+    {:ok, checks} =
+      Checks.finish_check("asdfasdf", "github", "hello-world", %Build{
+        @base_build
+        | previous_coverage: 90.4321
+      })
+
+    checks |> Enum.each(fn check -> assert Map.has_key?(check, :id) end)
   end
 end

web/managers/project_manager.ex

@@ -80,7 +80,7 @@ defmodule Librecov.ProjectManager do
 
       with {owner, name} <- Project.name_and_owner(project),
            {:ok, token} <- Auth.login_token(owner) do
-        Checks.finish_check(token, build.commit_sha, owner, name, job.coverage)
+        Checks.finish_check(token, owner, name, build)
       end
 
       {build, job}