Change mode attribute to array in Measurements (#33)

* Change mode attribute to array in Measurements

- closes #32

Signed-off-by: Tallys Martins <tallysmartins@gmail.com>

* Adds tests to Measurements module

Signed-off-by: Tallys Martins <tallysmartins@gmail.com>

* Apply review changes

Signed-off-by: Tallys Martins <tallysmartins@gmail.com>

Author: tallysmartins

lib/elixir_bench/benchmarks/measurement.ex

@@ -8,7 +8,7 @@ defmodule ElixirBench.Benchmarks.Measurement do
     belongs_to(:job, Job)
 
     field :sample_size, :integer
-    field :mode, :float
+    field :mode, {:array, :float}
     field :minimum, :float
     field :median, :float
     field :maximum, :float
@@ -27,7 +27,6 @@ defmodule ElixirBench.Benchmarks.Measurement do
 
   @fields [
     :sample_size,
-    :mode,
     :minimum,
     :median,
     :maximum,
@@ -40,10 +39,29 @@ defmodule ElixirBench.Benchmarks.Measurement do
     :percentiles
   ]
 
+  @required_fields @fields -- [:mode]
+
   @doc false
   def changeset(%Measurement{} = measurement, attrs) do
     measurement
     |> cast(attrs, @fields)
-    |> validate_required(@fields)
+    |> validate_required(@required_fields)
+    |> set_mode(attrs)
+  end
+
+  # Benchee can return a uniq value for mode so we need to make it an array
+  defp set_mode(changeset, attrs) do
+    mode = get_in(attrs, ["mode"])
+
+    mode =
+      cond do
+        is_integer(mode) or is_float(mode) ->
+          [mode]
+
+        true ->
+          mode
+      end
+
+    cast(changeset, %{mode: mode}, [:mode])
   end
 end

lib/elixir_bench_web/schema/content_types.ex

@@ -99,7 +99,7 @@ defmodule ElixirBenchWeb.Schema.ContentTypes do
     field :sample_size, :integer
     field :percentiles, list_of(:percentile), resolve: map_to_list(:percentiles, :name, :value)
 
-    field :mode, :float
+    field :mode, list_of(:float)
     field :minimum, :float
     field :median, :float
     field :maximum, :float

priv/repo/migrations/20180628155813_change_mode_to_array.exs

@@ -0,0 +1,10 @@
+defmodule ElixirBench.Repo.Migrations.ChangeModeToArray do
+  use Ecto.Migration
+
+  def change do
+    alter table(:measurements) do
+      remove :mode
+      add :mode, {:array, :float}
+    end
+  end
+end

test/elixir_bench/benchmarks/measurement_test.exs

@@ -0,0 +1,65 @@
+defmodule MeasurementTest do
+  alias ElixirBench.Benchmarks.Measurement
+  use ElixirBench.DataCase
+
+  @attrs %{
+    "average" => 465.8669101807624,
+    "ips" => 2146.5357984150173,
+    "maximum" => 13092.0,
+    "median" => 452.0,
+    "minimum" => 338.0,
+    "percentiles" => %{"50" => 452.0, "99" => 638.0},
+    "run_times" => [],
+    "sample_size" => 10677,
+    "std_dev" => 199.60367678670747,
+    "std_dev_ips" => 919.6970816229071,
+    "std_dev_ratio" => 0.4284564377179282,
+    "mode" => nil
+  }
+
+  describe "changeset/2" do
+    test "format and validade mode values" do
+      changeset = Measurement.changeset(%Measurement{}, %{@attrs | "mode" => ""})
+
+      assert changeset.valid?
+      refute Map.has_key?(changeset.changes, :mode)
+
+      changeset = Measurement.changeset(%Measurement{}, %{@attrs | "mode" => nil})
+
+      assert changeset.valid?
+      refute Map.has_key?(changeset.changes, :mode)
+
+      changeset = Measurement.changeset(%Measurement{}, %{@attrs | "mode" => 1})
+
+      assert changeset.valid?
+      assert [1.0] = changeset.changes.mode
+
+      changeset = Measurement.changeset(%Measurement{}, %{@attrs | "mode" => 1.2})
+
+      assert changeset.valid?
+      assert [1.2] = changeset.changes.mode
+
+      changeset = Measurement.changeset(%Measurement{}, %{@attrs | "mode" => [1.2, 1.4]})
+
+      assert changeset.valid?
+      assert [1.2, 1.4] = changeset.changes.mode
+
+      changeset = Measurement.changeset(%Measurement{}, %{@attrs | "mode" => [1.2, "1.4"]})
+
+      assert changeset.valid?
+      assert [1.2, 1.4] = changeset.changes.mode
+
+      changeset = Measurement.changeset(%Measurement{}, %{@attrs | "mode" => "str"})
+
+      refute changeset.valid?
+      refute Map.has_key?(changeset.changes, :mode)
+      assert [mode: {"is invalid", _}] = changeset.errors
+
+      changeset = Measurement.changeset(%Measurement{}, %{@attrs | "mode" => ["str"]})
+
+      refute changeset.valid?
+      refute Map.has_key?(changeset.changes, :mode)
+      assert [mode: {"is invalid", _}] = changeset.errors
+    end
+  end
+end

test/support/factory/elixir_bench_factory.ex

@@ -56,7 +56,7 @@ defmodule ElixirBench.Factory do
       benchmark: build(:benchmark, repo: repo),
       job: build(:job, job_attrs),
       sample_size: 12630,
-      mode: 369.0,
+      mode: [369.0],
       minimum: 306.0,
       median: 377.0,
       maximum: 12453.0,
@@ -90,7 +90,7 @@ defmodule ElixirBench.Factory do
           "maximum" => 12453.0,
           "median" => 377.0,
           "minimum" => 306.0,
-          "mode" => 369.0,
+          "mode" => nil,
           "percentiles" => %{"50" => 377.0, "99" => 578.6900000000005},
           "sample_size" => 12630,
           "std_dev" => 209.33476197004862,
@@ -104,7 +104,7 @@ defmodule ElixirBench.Factory do
           "maximum" => 32412.0,
           "median" => 397.0,
           "minimum" => 301.0,
-          "mode" => 378.0,
+          "mode" => [378.0, 379.0],
           "percentiles" => %{"50" => 397.0, "99" => 1003.3999999999942},
           "sample_size" => 11044,
           "std_dev" => 573.9417528830307,
@@ -118,7 +118,7 @@ defmodule ElixirBench.Factory do
           "maximum" => 13241.0,
           "median" => 450.0,
           "minimum" => 338.0,
-          "mode" => 442.0,
+          "mode" => [442.1],
           "percentiles" => %{"50" => 450.0, "99" => 727.0},
           "sample_size" => 10516,
           "std_dev" => 273.63253429178945,
@@ -132,7 +132,7 @@ defmodule ElixirBench.Factory do
           "maximum" => 13092.0,
           "median" => 452.0,
           "minimum" => 338.0,
-          "mode" => 440.0,
+          "mode" => [440.0],
           "percentiles" => %{"50" => 452.0, "99" => 638.0},
           "sample_size" => 10677,
           "std_dev" => 199.60367678670747,