Merge pull request #290 from duffelhq/feature/flag_name_to_api

Allows flag_name to pass thru to the coveralls.io API

README.md

@@ -143,7 +143,7 @@ Usage: mix coveralls <Options>
                         github repo, so must be exact. Example: If your source file path is "/home/runs/app/test.ex",
                         and your git repo resides in "app", then the root path should be: "/home/runs/app/" (from
                         coveralls.io)
-
+    --flagname          Job flag name which will be shown in the Coveralls UI
 
 Usage: mix coveralls.detail [--filter file-name-pattern]
   Used to display coverage with detail

lib/excoveralls/circle.ex

@@ -22,7 +22,8 @@ defmodule ExCoveralls.Circle do
       service_pull_request: get_pull_request(),
       source_files: stats,
       git: generate_git_info(),
-      parallel: options[:parallel]
+      parallel: options[:parallel],
+      flag_name: options[:flagname]
     })
   end
 

lib/excoveralls/drone.ex

@@ -22,7 +22,8 @@ defmodule ExCoveralls.Drone do
       service_pull_request: get_pull_request(),
       source_files: stats,
       git: generate_git_info(),
-      parallel: options[:parallel]
+      parallel: options[:parallel],
+      flag_name: options[:flagname]
     })
   end
 

lib/excoveralls/github.ex

@@ -22,6 +22,7 @@ defmodule ExCoveralls.Github do
       service_name: "github",
       source_files: stats,
       parallel: options[:parallel],
+      flag_name: options[:flagname],
       git: git_info()
     }
     |> Map.merge(job_data())

lib/excoveralls/gitlab.ex

@@ -25,7 +25,8 @@ defmodule ExCoveralls.Gitlab do
       service_pull_request: get_pull_request(),
       source_files: stats,
       git: generate_git_info(),
-      parallel: options[:parallel]
+      parallel: options[:parallel],
+      flag_name: options[:flagname]
     })
   end
 

lib/excoveralls/post.ex

@@ -19,6 +19,7 @@ defmodule ExCoveralls.Post do
       service_number: options[:service_number],
       source_files: source_info,
       parallel: options[:parallel],
+      flag_name: options[:flagname],
       git: generate_git_info(options)
     })
   end

lib/excoveralls/semaphore.ex

@@ -22,7 +22,8 @@ defmodule ExCoveralls.Semaphore do
       service_pull_request: get_pull_request(),
       source_files: stats,
       git: generate_git_info(),
-      parallel: options[:parallel]
+      parallel: options[:parallel],
+      flag_name: options[:flagname]
     })
   end
 

lib/excoveralls/task/util.ex

@@ -26,6 +26,7 @@ Usage: mix coveralls <Options>
                         github repo, so must be exact. Example: If your source file path is "/home/runs/app/test.ex",
                         and your git repo resides in "app", then the root path should be: "/home/runs/app/" (from
                         coveralls.io)
+    --flagname          Job flag name which will be shown in the Coveralls UI
 
 Usage: mix coveralls.detail [--filter file-name-pattern]
   Used to display coverage with detail

lib/mix/tasks.ex

@@ -33,7 +33,7 @@ defmodule Mix.Tasks.Coveralls do
         message: "Please specify 'test_coverage: [tool: ExCoveralls]' in the 'project' section of mix.exs"
     end
 
-    switches = [filter: :string, umbrella: :boolean, verbose: :boolean, pro: :boolean, parallel: :boolean, sort: :string, output_dir: :string, subdir: :string, rootdir: :string]
+    switches = [filter: :string, umbrella: :boolean, verbose: :boolean, pro: :boolean, parallel: :boolean, sort: :string, output_dir: :string, subdir: :string, rootdir: :string, flagname: :string]
     aliases = [f: :filter, u: :umbrella, v: :verbose, o: :output_dir]
     {args, common_options} = parse_common_options(args, switches: switches, aliases: aliases)
     all_options = options ++ common_options
@@ -65,6 +65,7 @@ defmodule Mix.Tasks.Coveralls do
   def parse_common_options(args, common_options) do
     common_switches = Keyword.get(common_options, :switches, [])
     common_aliases = Keyword.get(common_options, :aliases, [])
+
     {common_options, _remaining, _invalid} = OptionParser.parse(args, common_options)
 
     # the switches that excoveralls supports
@@ -272,7 +273,7 @@ defmodule Mix.Tasks.Coveralls do
       aliases = [f: :filter, u: :umbrella, v: :verbose]
       {remaining, options} = Mix.Tasks.Coveralls.parse_common_options(
         args,
-        switches: switches ++ [sha: :string, token: :string, committer: :string, branch: :string, message: :string, name: :string],
+        switches: switches ++ [sha: :string, token: :string, committer: :string, branch: :string, message: :string, name: :string, flagname: :string],
         aliases: aliases ++ [n: :name, b: :branch, c: :committer, m: :message, s: :sha, t: :token]
       )
 
@@ -289,6 +290,7 @@ defmodule Mix.Tasks.Coveralls do
           umbrella:     options[:umbrella],
           verbose:      options[:verbose],
           parallel:     options[:parallel],
+          flag_name:    options[:flagname] || "",
           rootdir:      options[:rootdir] || "",
           subdir:       options[:subdir] || ""
         ])

test/mix/tasks_test.exs

@@ -117,6 +117,12 @@ defmodule Mix.Tasks.CoverallsTest do
     assert(ExCoveralls.ConfServer.get == [type: "circle", parallel: true, args: []])
   end
 
+  test_with_mock "circle --parallel --flagname someflag", Runner, [run: fn(_, _) -> nil end] do
+    Mix.Tasks.Coveralls.Circle.run(["--parallel", "--flagname", "someflag"])
+    assert(called Runner.run("test", ["--cover"]))
+    assert(ExCoveralls.ConfServer.get == [type: "circle", parallel: true, flagname: "someflag", args: []])
+  end
+
   test_with_mock "semaphore", Runner, [run: fn(_, _) -> nil end] do
     Mix.Tasks.Coveralls.Semaphore.run([])
     assert(called Runner.run("test", ["--cover"]))
@@ -142,14 +148,14 @@ defmodule Mix.Tasks.CoverallsTest do
     System.put_env("COVERALLS_REPO_TOKEN", "dummy_token")
     System.put_env("COVERALLS_SERVICE_NAME", "dummy_service_name")
 
-    args = ["-b", "branch", "-c", "committer", "-m", "message", "-s", "asdf", "--rootdir", "umbrella0/", "--subdir", "", "--build", "1"]
+    args = ["-b", "branch", "-c", "committer", "-m", "message", "-s", "asdf", "--rootdir", "umbrella0/", "--subdir", "", "--build", "1", "--flagname", "arbitrary_value"]
     Mix.Tasks.Coveralls.Post.run(args)
     assert(called Runner.run("test", ["--cover"]))
     assert(ExCoveralls.ConfServer.get ==
              [type: "post", endpoint: nil, token: "dummy_token",
               service_name: "dummy_service_name", service_number: "1", branch: "branch",
               committer: "committer", sha: "asdf", message: "message",
-              umbrella: nil, verbose: nil, parallel: nil, rootdir: "umbrella0/", subdir: "", args: []])
+              umbrella: nil, verbose: nil, parallel: nil, flag_name: "arbitrary_value", rootdir: "umbrella0/", subdir: "", args: []])
 
     System.put_env("COVERALLS_REPO_TOKEN", org_token)
     System.put_env("COVERALLS_SERVICE_NAME", org_name)
@@ -169,7 +175,7 @@ defmodule Mix.Tasks.CoverallsTest do
              [type: "post", endpoint: nil, token: "token",
               service_name: "excoveralls", service_number: "", branch: "",
               committer: "", sha: "", message: "[no commit message]",
-              umbrella: nil, verbose: nil, parallel: nil, rootdir: "", subdir: "", args: []])
+              umbrella: nil, verbose: nil, parallel: nil, flag_name: "", rootdir: "", subdir: "", args: []])
 
     if org_token != nil do
       System.put_env("COVERALLS_REPO_TOKEN", org_token)

test/post_test.exs

@@ -30,11 +30,12 @@ defmodule ExCoveralls.PostTest do
         branch: "",
         committer: "",
         message: "",
-        sha: ""
+        sha: "",
+        flagname: "arbitrary_value"
       ])
 
     assert json ==
-       "{\"git\":{\"branch\":\"\",\"head\":{\"committer_name\":\"\",\"id\":\"\",\"message\":\"\"}}," <>
+      "{\"flag_name\":\"arbitrary_value\",\"git\":{\"branch\":\"\",\"head\":{\"committer_name\":\"\",\"id\":\"\",\"message\":\"\"}}," <>
          "\"parallel\":null," <>
          "\"repo_token\":\"1234567890\"," <>
          "\"service_name\":\"local\"," <>