Merge pull request #102 from yknx4/feature/pr-message

feat: pr message with diff data

Author: yknx4

.github/workflows/tests.yml

@@ -37,6 +37,7 @@ jobs:
           mix deps.get
           mix deps.compile
           mix dialyzer --plt
+          mix compile
 
   static-code-analysis:
     needs: dependencies
@@ -118,14 +119,16 @@ jobs:
           files: cover/excoveralls.json
           fail_ci_if_error: true
       - name: LibreCov
-        continue-on-error: true
         env:
           SHA: ${{github.sha}}
-          BRANCH: ${{ steps.extract_branch.outputs.branch }}
+          BRANCH: ${{ github.ref }}
           TOKEN: ${{ secrets.OPENCOV_TOKEN }}
           COVERALLS_ENDPOINT: ${{ secrets.OPENCOV_ENDPOINT }}
+          RUN_NUMBER: ${{ github.run_id }}
         run: |
           MIX_ENV=test mix coveralls.post \
+          --name github-actions \
+          --build "$RUN_NUMBER" \
           --sha "$SHA" \
           --committer "$(git log -1 $SHA --pretty=format:'%cN')" \
           --message "$(git log -1 $SHA --pretty=format:'%s')" \

.gitignore

@@ -11,4 +11,5 @@ config/local.exs
 *.coverdata
 
 *.dump
-*.pem
+*.pem
+cover

config/prod.exs

@@ -1,5 +1,7 @@
 use Mix.Config
 
+config :tesla, Tesla.Middleware.Logger, filter_headers: ["authorization"]
+
 config :librecov, Librecov.Endpoint,
   http: [port: {:system, "PORT"}, compress: true],
   url: [
@@ -42,7 +44,7 @@ config :sentry,
   tags: %{
     env: "production"
   },
-  included_environments: [:production]
+  included_environments: ["production"]
 
 if File.exists?(Path.join(__DIR__, "prod.secret.exs")) do
   import_config "prod.secret.exs"

lib/opencov/helpers/coverage.ex

@@ -0,0 +1,22 @@
+defmodule Librecov.Helpers.Coverage do
+  @doc """
+  Print friendly percentage of coverage.
+
+  ## Examples
+    iex> Librecov.Helpers.Coverage.format_coverage(65.215478)
+    "65.22%"
+  """
+  def format_coverage(coverage), do: "#{Float.round(coverage, 2)}%"
+
+  @doc """
+  Coverage differ with null handling.
+
+  ## Examples
+    iex> Librecov.Helpers.Coverage.coverage_diff(65.215478, nil)
+    65.215478
+    iex> Librecov.Helpers.Coverage.coverage_diff(65.0, 70.0)
+    -5.0
+  """
+  def coverage_diff(coverage, nil), do: coverage
+  def coverage_diff(coverage, previous_coverage), do: coverage - previous_coverage
+end

lib/opencov/services/github/checks.ex

@@ -3,15 +3,32 @@ defmodule Librecov.Services.Github.Checks do
   alias ExOctocat.Connection
   alias ExOctocat.Api.Checks
   alias Librecov.Build
+  import Librecov.Helpers.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()
+  def finish_check(
+        token,
+        owner,
+        repo,
+        %Build{
+          coverage: coverage,
+          previous_coverage: previous_coverage,
+          commit_sha: commit
+        },
+        base_coverage
+      ) do
+    real_previous_coverage = base_coverage || previous_coverage || 0.0
+    cov_dif = coverage_diff(coverage, real_previous_coverage) |> format_coverage()
     cov = coverage |> format_coverage()
 
+    Logger.info("""
+    Repo: #{owner}/#{repo}
+    Commit: #{commit}
+    Coverage: #{cov}
+    Coverage diff: #{cov_dif}
+    Project Previous Coverage: #{base_coverage}
+    Build Previous Coverage: #{previous_coverage}
+    """)
+
     conn =
       token
       |> Connection.new()
@@ -35,7 +52,7 @@ defmodule Librecov.Services.Github.Checks do
              body: %{
                name: "LibreCov/diff",
                head_sha: commit,
-               conclusion: coverage_diff(coverage, previous_coverage) |> diff_conclusion(),
+               conclusion: coverage_diff(coverage, real_previous_coverage) |> diff_conclusion(),
                output: %{
                  title: "Coverage changed #{cov_dif}",
                  summary: "changed #{cov_dif}"
@@ -65,9 +82,4 @@ defmodule Librecov.Services.Github.Checks do
   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

lib/opencov/services/github/comments.ex

@@ -0,0 +1,57 @@
+defmodule Librecov.Services.Github.Comments do
+  require Logger
+  alias ExOctocat.Connection
+  alias ExOctocat.Api.Issues
+  alias Librecov.Services.Github.PullRequests
+  alias ExOctocat.Model.PullRequestSimple
+
+  def add_pr_comment(_, _, _, _, nil) do
+    Logger.warn("Skipping because branch is nil.")
+  end
+
+  def add_pr_comment(pr_message, token, owner, repo, branch) do
+    case token |> PullRequests.find_prs_for_branch(owner, repo, branch) do
+      {:ok, []} ->
+        Logger.info("No pull requests found for branch #{branch}")
+        {:error, :pr_not_found}
+
+      {:ok, prs} when is_list(prs) ->
+        {:ok, prs |> Enum.map(&add_pr_message(token, pr_message, &1))}
+
+      {_, e} when is_exception(e) ->
+        Logger.error(e |> Exception.message())
+        Sentry.capture_exception(e)
+        {:error, e}
+
+      {_, %{message: message}} ->
+        Logger.error(message)
+
+        raise(
+          "Error processing add_pr_comment(pr_message, #{token}, #{owner}, #{repo}, #{branch}): #{message}."
+        )
+
+      e ->
+        raise(
+          "Error processing add_pr_comment(pr_message, #{token}, #{owner}, #{repo}, #{branch})."
+        )
+    end
+  end
+
+  def add_pr_message(token, pr_message, %PullRequestSimple{
+        number: issue_number,
+        base: %{repo: %{name: repo, owner: %{login: owner}}}
+      }) do
+    Logger.info("Sending pr_message to #{owner}/#{repo}##{issue_number}.")
+
+    {:ok, %{id: id} = comment} =
+      token
+      |> Connection.new()
+      |> Issues.issues_create_comment(owner, repo, issue_number, body: %{body: pr_message})
+
+    Logger.info(
+      "Succesfully sent message to #{owner}/#{repo}##{issue_number}. IssueComment##{id}"
+    )
+
+    comment
+  end
+end

lib/opencov/services/github/pull_requests.ex

@@ -0,0 +1,11 @@
+defmodule Librecov.Services.Github.PullRequests do
+  require Logger
+  alias ExOctocat.Connection
+  alias ExOctocat.Api.Pulls
+
+  def find_prs_for_branch(token, owner, repo, branch) do
+    token
+    |> Connection.new()
+    |> Pulls.pulls_list(owner, repo, state: "open", sort: "updated", head: "#{owner}:#{branch}")
+  end
+end

lib/opencov/templates/comment_template.ex

@@ -0,0 +1,107 @@
+defmodule Librecov.Templates.CommentTemplate do
+  alias Librecov.Build
+  alias Librecov.Project
+  alias Librecov.Endpoint
+  alias Librecov.JobManager
+  alias Librecov.File
+  alias Librecov.Job
+  import Librecov.Router.Helpers
+  import Librecov.Helpers.Coverage
+
+  def coverage_message(
+        %Project{
+          current_coverage: project_coverage
+        },
+        %Build{
+          id: build_id,
+          coverage: coverage,
+          previous_coverage: previous_coverage,
+          commit_sha: commit,
+          branch: branch
+        },
+        %Job{} = job
+      ) do
+    real_previous_coverage = project_coverage || previous_coverage || 0.0
+    cov_dif = coverage_diff(coverage, real_previous_coverage)
+
+    report_url = build_url(Endpoint, :show, build_id)
+
+    job =
+      job
+      |> JobManager.preload_files()
+
+    files =
+      job.files
+      |> Enum.filter(fn %File{coverage: coverage, previous_coverage: previous_coverage} ->
+        coverage_diff(coverage, previous_coverage) != 0
+      end)
+
+    """
+    # [Librecov](#{report_url}) Report
+    #{merge_message(cov_dif, branch, commit, report_url)}
+    #{diff_message(cov_dif, coverage)}
+    #{impacted_files_message(report_url, files)}
+    ------
+
+    [Continue to review full report at Librecov](#{report_url}).
+    > **Legend**
+    > `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
+    > Powered by [Librecov](#{project_url(Endpoint, :index)}).
+    """
+  end
+
+  defp merge_message(_, nil, _, _), do: ""
+  defp merge_message(_, _, nil, _), do: ""
+
+  defp merge_message(0.0, branch, commit, report_url),
+    do:
+      "> Merging [#{branch |> format_branch()}](#{report_url}) (#{commit |> format_commit()}) will **not change** coverage."
+
+  defp merge_message(cov_dif, branch, commit, report_url),
+    do:
+      "> Merging [#{branch |> format_branch()}](#{report_url}) (#{commit |> format_commit()}) will **#{cov_dif |> diff_verb()}** coverage by `#{cov_dif |> format_coverage()}`."
+
+  defp diff_message(0.0, _), do: "> The diff coverage is `n/a`."
+  defp diff_message(_, coverage), do: "> The diff coverage is `#{coverage |> format_coverage()}`."
+
+  defp impacted_files_message(_, []), do: ""
+
+  defp impacted_files_message(report_url, files) do
+    """
+
+    | [Impacted Files](#{report_url}) | Coverage Δ | |
+    |---|---|---|
+    #{files |> Enum.map(&file_line/1) |> Enum.join("\n")}
+
+    """
+  end
+
+  defp file_line(%File{
+         id: file_id,
+         name: filename,
+         coverage: coverage,
+         previous_coverage: previous_coverage
+       }) do
+    cov_diff = coverage_diff(coverage, previous_coverage)
+
+    "| [#{filename}](#{file_url(Endpoint, :show, file_id)}) | `#{coverage |> format_coverage()} <#{cov_diff |> format_coverage()}> (#{cov_diff |> file_icon()})` | #{cov_diff |> diff_emoji()} |"
+  end
+
+  defp diff_emoji(diff) when diff == 0, do: ""
+  defp diff_emoji(diff) when diff < 0, do: "⬇️"
+  defp diff_emoji(diff) when diff > 0, do: "⬆️"
+
+  defp file_icon(diff) when diff >= 0.0 and diff <= 0.01, do: "ø"
+  defp file_icon(_diff), do: "Δ"
+
+  defp format_commit(commit), do: String.slice(commit, 0, 7)
+
+  defp format_branch(""), do: "this"
+  defp format_branch(nil), do: "this"
+  defp format_branch("refs/heads/" <> branch), do: branch
+  defp format_branch(branch), do: branch
+
+  defp diff_verb(diff) when diff == 0, do: "mantain"
+  defp diff_verb(diff) when diff < 0, do: "decrease"
+  defp diff_verb(diff) when diff > 0, do: "increase"
+end

mix.exs

@@ -72,7 +72,7 @@ defmodule Librecov.Mixfile do
       {:meck, "~> 0.9", override: true},
       {:tesla, "~> 1.2"},
       {:poison, "~> 3.0"},
-      {:ex_octocat, github: "yknx4/ex_octocat", tag: "v1.1.4"}
+      {:ex_octocat, github: "yknx4/ex_octocat", tag: "v1.1.4.1"}
     ]
   end
 

mix.lock

@@ -20,7 +20,7 @@
   "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"},
   "ex_crypto": {:hex, :ex_crypto, "0.10.0", "af600a89b784b36613a989da6e998c1b200ff1214c3cfbaf8deca4aa2f0a1739", [:mix], [{:poison, ">= 2.0.0", [hex: :poison, repo: "hexpm", optional: false]}], "hexpm", "ccc7472cfe8a0f4565f97dce7e9280119bf15a5ea51c6535e5b65f00660cde1c"},
   "ex_machina": {:hex, :ex_machina, "2.7.0", "b792cc3127fd0680fecdb6299235b4727a4944a09ff0fa904cc639272cd92dc7", [:mix], [{:ecto, "~> 2.2 or ~> 3.0", [hex: :ecto, repo: "hexpm", optional: true]}, {:ecto_sql, "~> 3.0", [hex: :ecto_sql, repo: "hexpm", optional: true]}], "hexpm", "419aa7a39bde11894c87a615c4ecaa52d8f107bbdd81d810465186f783245bf8"},
-  "ex_octocat": {:git, "https://github.com/yknx4/ex_octocat.git", "a244cb0c183015c44d5deaa2ebf9b7d492dfb775", [tag: "v1.1.4"]},
+  "ex_octocat": {:git, "https://github.com/yknx4/ex_octocat.git", "034c249fe1476667a6def8f8977d74e3d47c7d4a", [tag: "v1.1.4.1"]},
   "excoveralls": {:hex, :excoveralls, "0.14.2", "f9f5fd0004d7bbeaa28ea9606251bb643c313c3d60710bad1f5809c845b748f0", [:mix], [{:hackney, "~> 1.16", [hex: :hackney, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "ca6fd358621cb4d29311b29d4732c4d47dac70e622850979bc54ed9a3e50f3e1"},
   "exgravatar": {:hex, :exgravatar, "2.0.2", "638412896170409da114f98947d3f8d4f38e851b0e329c1cc4cd324d5e2ea081", [:mix], [], "hexpm", "f3deb5baa6fcf354a965d794ee73a956d95f1f79f41bddf69800c713cfb014a1"},
   "exjsx": {:hex, :exjsx, "4.0.0", "60548841e0212df401e38e63c0078ec57b33e7ea49b032c796ccad8cde794b5c", [:mix], [{:jsx, "~> 2.8.0", [hex: :jsx, repo: "hexpm", optional: false]}], "hexpm", "32e95820a97cffea67830e91514a2ad53b888850442d6d395f53a1ac60c82e07"},