Merge pull request #104 from yknx4/features/open-api

feature: open api

Author: yknx4

.github/workflows/tests.yml

@@ -124,11 +124,10 @@ jobs:
           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" \
+          --name github \
+          --build "$GITHUB_RUN_ID" \
           --sha "$SHA" \
           --committer "$(git log -1 $SHA --pretty=format:'%cN')" \
           --message "$(git log -1 $SHA --pretty=format:'%s')" \

lib/opencov/plug/multipart_job.ex

@@ -0,0 +1,67 @@
+defmodule Librecov.Plug.MultipartJob do
+  @moduledoc """
+  Module plug that will cast a given multiform upload and convert it to the expected json
+  """
+
+  @behaviour Plug
+
+  alias Plug.Conn
+
+  @impl Plug
+  def init(opts) do
+    opts
+  end
+
+  @impl Plug
+  def call(conn, _) do
+    content_type =
+      case Conn.get_req_header(conn, "content-type") do
+        [header_value | _] ->
+          header_value
+          |> String.split(";")
+          |> Enum.at(0)
+
+        _ ->
+          nil
+      end
+
+    handle(content_type, conn)
+  end
+
+  def handle("application/json", %{params: %{"json" => json}} = conn) when is_binary(json) do
+    conn
+    |> put_parsed_job(json)
+  end
+
+  def handle("multipart/form-data", %{params: %{"json_file" => file}} = conn) do
+    conn
+    |> put_parsed_job(file |> read_file())
+  end
+
+  def handle(content_type, conn) do
+    conn
+  end
+
+  def put_parsed_job(conn, json) do
+    parsed_json = Jason.decode!(json)
+
+    %{
+      (conn
+       |> Conn.put_req_header("content-type", "application/json"))
+      | params: parsed_json,
+        body_params: parsed_json
+    }
+  end
+
+  defp read_file(%Plug.Upload{content_type: "gzip/json", path: path}) do
+    path
+    |> File.stream!([], 2048)
+    |> StreamGzip.gunzip()
+    |> Enum.into("")
+  end
+
+  defp read_file(%Plug.Upload{path: path}) do
+    path
+    |> File.read!()
+  end
+end

lib/opencov/services/github/comments.ex

@@ -30,7 +30,7 @@ defmodule Librecov.Services.Github.Comments do
           "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})."
         )

lib/opencov/templates/comment_template.ex

@@ -4,7 +4,6 @@ defmodule Librecov.Templates.CommentTemplate do
   alias Librecov.Endpoint
   alias Librecov.JobManager
   alias Librecov.File
-  alias Librecov.Job
   import Librecov.Router.Helpers
   import Librecov.Helpers.Coverage
 
@@ -18,22 +17,25 @@ defmodule Librecov.Templates.CommentTemplate do
           previous_coverage: previous_coverage,
           commit_sha: commit,
           branch: branch
-        },
-        %Job{} = job
+        } = build
       ) do
+    build = Repo.preload(build, :jobs)
     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
+    jobs =
+      build.jobs
       |> JobManager.preload_files()
 
     files =
-      job.files
-      |> Enum.filter(fn %File{coverage: coverage, previous_coverage: previous_coverage} ->
-        coverage_diff(coverage, previous_coverage) != 0
+      jobs
+      |> Enum.flat_map(fn job ->
+        job.files
+        |> Enum.filter(fn %File{coverage: coverage, previous_coverage: previous_coverage} ->
+          coverage_diff(coverage, previous_coverage) != 0
+        end)
       end)
 
     """

mix.exs

@@ -72,7 +72,8 @@ 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.1"}
+      {:ex_octocat, github: "yknx4/ex_octocat", tag: "v1.1.4.1"},
+      {:open_api_spex, "~> 3.10"}
     ]
   end
 

mix.lock

@@ -47,6 +47,7 @@
   "mock": {:hex, :mock, "0.3.7", "75b3bbf1466d7e486ea2052a73c6e062c6256fb429d6797999ab02fa32f29e03", [:mix], [{:meck, "~> 0.9.2", [hex: :meck, repo: "hexpm", optional: false]}], "hexpm", "4da49a4609e41fd99b7836945c26f373623ea968cfb6282742bcb94440cf7e5c"},
   "navigation_history": {:hex, :navigation_history, "0.4.0", "addf6342e434d3423ede47d7f1d5badc82591373d689ae13ef3d03cd9152a644", [:mix], [{:plug, "~> 1.1", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm", "a776c75c355361d028a572e6cfaffbb28cba9fffc801b8ca896f71197d208a91"},
   "oauth2": {:hex, :oauth2, "0.9.4", "632e8e8826a45e33ac2ea5ac66dcc019ba6bb5a0d2ba77e342d33e3b7b252c6e", [:mix], [{:hackney, "~> 1.7", [hex: :hackney, repo: "hexpm", optional: false]}], "hexpm", "407c6b9f60aa0d01b915e2347dc6be78adca706a37f0c530808942da3b62e7af"},
+  "open_api_spex": {:hex, :open_api_spex, "3.10.0", "94e9521ad525b3fcf6dc77da7c45f87fdac24756d4de588cb0816b413e7c1844", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:plug, "~> 1.7", [hex: :plug, repo: "hexpm", optional: false]}, {:poison, "~> 3.1", [hex: :poison, repo: "hexpm", optional: true]}], "hexpm", "2dbb2bde3d2b821f06936e8dfaf3284331186556291946d84eeba3750ac28765"},
   "parse_trans": {:hex, :parse_trans, "3.3.1", "16328ab840cc09919bd10dab29e431da3af9e9e7e7e6f0089dd5a2d2820011d8", [:rebar3], [], "hexpm", "07cd9577885f56362d414e8c4c4e6bdf10d43a8767abb92d24cbe8b24c54888b"},
   "phoenix": {:hex, :phoenix, "1.5.10", "3ee7d5c17ff9626d72d374d8fc8909bf00f4323fd15549fbe3abbbd38b5299c8", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:phoenix_html, "~> 2.13 or ~> 3.0", [hex: :phoenix_html, repo: "hexpm", optional: true]}, {:phoenix_pubsub, "~> 2.0", [hex: :phoenix_pubsub, repo: "hexpm", optional: false]}, {:plug, "~> 1.10", [hex: :plug, repo: "hexpm", optional: false]}, {:plug_cowboy, "~> 1.0 or ~> 2.2", [hex: :plug_cowboy, repo: "hexpm", optional: true]}, {:plug_crypto, "~> 1.1.2 or ~> 1.2", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "f9c2eaa5a8fe5a412610c6aa84ccdb6f3e92f333d4df7fbaeb0d5a157dbfb48d"},
   "phoenix_ecto": {:hex, :phoenix_ecto, "4.4.0", "0672ed4e4808b3fbed494dded89958e22fb882de47a97634c0b13e7b0b5f7720", [:mix], [{:ecto, "~> 3.3", [hex: :ecto, repo: "hexpm", optional: false]}, {:phoenix_html, "~> 2.14.2 or ~> 3.0", [hex: :phoenix_html, repo: "hexpm", optional: true]}, {:plug, "~> 1.9", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm", "09864e558ed31ee00bd48fcc1d4fc58ae9678c9e81649075431e69dbabb43cc1"},