eunit->CT (seshat_test -> seshat_SUITE)

Author: mkuratczyk

src/seshat.erl

@@ -20,7 +20,8 @@
          format/1,
          format/2,
          text_format/3,
-         format_one/2
+         format_one/2,
+         resolve_fields_spec/1
         ]).
 
 -type group() :: term().

test/seshat_test.erl renamed to test/seshat_SUITE.erl

@@ -5,97 +5,85 @@
 %% Copyright (c) 2007-2023 Broadcom. All Rights Reserved. The term Broadcom refers to Broadcom Inc. and/or its subsidiaries.
 %%
 
--module(seshat_test).
+-module(seshat_SUITE).
 -include_lib("eunit/include/eunit.hrl").
 
-setup() ->
-    {ok, _} = application:ensure_all_started(seshat).
+-compile(nowarn_export_all).
+-compile(export_all).
+
+all() ->
+    [overview,
+     counters_with_persistent_term_field_spec,
+     format_group,
+     format_one,
+     format_with_many_labels,
+     format_ratio,
+     format_time_metrics,
+     format_selected_metrics,
+     text_format_selected_metrics,
+     invalid_fields].
+
+init_per_suite(Config) ->
+    {ok, _} = application:ensure_all_started(seshat),
+    Config.
+
+end_per_suite(_Config) ->
+    ok = application:stop(seshat),
+    ok.
 
-cleanup(_) ->
-    ok = application:stop(seshat).
+init_per_testcase(TestCaseName, Config) ->
+    Group = TestCaseName,
+    seshat:new_group(Group),
+    [{group, Group} | Config].
 
-test_suite_test_() ->
-    {foreach,
-     fun setup/0,
-     fun cleanup/1,
-     [ fun overview/0,
-       fun counters_with_persistent_term_field_spec/0,
-       fun format_group/0,
-       fun format_one/0,
-       fun format_with_many_labels/0,
-       fun format_ratio/0,
-       fun format_time_metrics/0,
-       fun format_selected_metrics/0,
-       fun text_format_selected_metrics/0,
-       fun invalid_fields/0 ]}.
+end_per_testcase(TestCaseName, _Config) ->
+    seshat:delete_group(TestCaseName),
+    ok.
 
-overview() ->
+%% Test cases
+overview(_Config) ->
     Group = ?FUNCTION_NAME,
     Counters = [
-                {
-                 carrots_eaten_total, 1, counter,
-                 "Total number of carrots eaten on a meal"
-                },
-                {
-                 holes_dug_total, 2, counter,
-                 "Total number of holes dug in an afternoon"
-                }
+                {carrots_eaten_total, 1, counter, "Total number of carrots eaten on a meal"},
+                {holes_dug_total, 2, counter, "Total number of holes dug in an afternoon"}
                ],
-    seshat:new_group(Group),
     seshat:new(Group, "rabbit", Counters),
     set_value(Group, "rabbit", carrots_eaten_total, 3),
     set_value(Group, "rabbit", holes_dug_total, 1),
     Overview = seshat:overview(Group),
     ?assertEqual(
-       #{"rabbit" => #{carrots_eaten_total => 3,
-                       holes_dug_total => 1}},
+       #{"rabbit" => #{carrots_eaten_total => 3, holes_dug_total => 1}},
        Overview),
-
-    ?assertMatch(#{carrots_eaten_total := 3,
-                   holes_dug_total := 1},
+    ?assertMatch(#{carrots_eaten_total := 3, holes_dug_total := 1},
                  seshat:overview(Group, "rabbit")),
-
     ?assertMatch(#{holes_dug_total := 1},
                  seshat:counters(Group, "rabbit", [holes_dug_total])),
     ok.
 
-counters_with_persistent_term_field_spec() ->
+counters_with_persistent_term_field_spec(_Config) ->
     Group = ?FUNCTION_NAME,
     Counters = [
-                {
-                 carrots_eaten_total, 1, counter,
-                 "Total number of carrots eaten on a meal"
-                },
-                {
-                 holes_dug_total, 2, counter,
-                 "Total number of holes dug in an afternoon"
-                }
+                {carrots_eaten_total, 1, counter, "Total number of carrots eaten on a meal"},
+                {holes_dug_total, 2, counter, "Total number of holes dug in an afternoon"}
                ],
-
     persistent_term:put(pets_field_spec, Counters),
-    seshat:new_group(Group),
     seshat:new(Group, "rabbit", {persistent_term, pets_field_spec}),
     set_value(Group, "rabbit", carrots_eaten_total, 3),
     set_value(Group, "rabbit", holes_dug_total, 1),
     Overview = seshat:overview(Group),
     ?assertEqual(
-       #{"rabbit" => #{carrots_eaten_total => 3,
-                       holes_dug_total => 1}},
+       #{"rabbit" => #{carrots_eaten_total => 3, holes_dug_total => 1}},
        Overview),
-
-    ?assertMatch(#{carrots_eaten_total := 3,
-                   holes_dug_total := 1},
+    ?assertMatch(#{carrots_eaten_total := 3, holes_dug_total := 1},
                  seshat:overview(Group, "rabbit")),
-
     ?assertMatch(#{holes_dug_total := 1},
                  seshat:counters(Group, "rabbit", [holes_dug_total])),
-
+    persistent_term:erase(pets_field_spec),
     ok.
 
-format_group() ->
+format_group(_Config) ->
     Group = ?FUNCTION_NAME,
     Counters = [{reads, 1, counter, "Total reads"}],
-    seshat:new_group(Group),
     seshat:new(Group, widget1, Counters, #{component => widget1}),
     seshat:new(Group, widget2, Counters, #{component => widget2}),
     seshat:new(Group, screw, Counters), % no labels, will be omitted
@@ -107,10 +95,9 @@ format_group() ->
     ?assertEqual(ExpectedMap, Result),
     ok.
 
-format_one() ->
+format_one(_Config) ->
     Group = ?FUNCTION_NAME,
     Counters = [{reads, 1, counter, "Total reads"}],
-    seshat:new_group(Group),
     seshat:new(Group, widget1, Counters, #{component => widget1}),
     seshat:new(Group, widget2, Counters, #{component => widget2}),
     Result = seshat:format_one(Group, widget2),
@@ -120,10 +107,9 @@ format_one() ->
     ?assertEqual(ExpectedMap, Result),
     ok.
 
-format_with_many_labels() ->
+format_with_many_labels(_Config) ->
     Group = ?FUNCTION_NAME,
     Counters = [{reads, 1, counter, "Total reads"}],
-    seshat:new_group(Group),
     seshat:new(Group, widget1, Counters, #{component => "widget1", status => up}),
     seshat:new(Group, widget2, Counters, #{component => "widget2", status => down}),
     set_value(Group, widget1, reads, 1),
@@ -136,14 +122,13 @@ format_with_many_labels() ->
     ?assertEqual(ExpectedMap, Result),
     ok.
 
-format_selected_metrics() ->
+format_selected_metrics(_Config) ->
     Group = ?FUNCTION_NAME,
     Counters = [
                 {reads, 1, counter, "Total reads"},
                 {writes, 2, counter, "Total writes"},
                 {lookups, 3, counter, "Total lookups"}
                ],
-    seshat:new_group(Group),
     seshat:new(Group, thing1, Counters, #{component => "thing1"}),
     seshat:new(Group, thing2, Counters, #{component => "thing2"}),
     Result = seshat:format(Group, [reads, writes]),
@@ -158,29 +143,25 @@ format_selected_metrics() ->
     ?assertEqual(ExpectedMap, Result),
     ok.
 
-invalid_fields() ->
-    Group = widgets,
+invalid_fields(_Config) ->
+    Group = ?FUNCTION_NAME,
     Fields = [{reads, 1, counter, "Total reads"},
-              {writes, 3, counter, "Total writes"}],
-    seshat:new_group(Group),
+              {writes, 3, counter, "Total writes"}], % Index 2 is missing
     ?assertError(invalid_field_specification,
                  seshat:new(Group, invalid_fields, Fields)),
-
     ok.
 
-format_ratio() ->
+format_ratio(_Config) ->
     Group = ?FUNCTION_NAME,
     Counters = [{pings, 1, ratio, "Some ratio that happens to be 0%"},
                 {pongs, 2, ratio, "Some ratio that happens to be 17%"},
                 {pangs, 3, ratio, "Some ratio that happens to be 33%"},
                 {rings, 4, ratio, "Some ratio that happens to be 100%"}],
-    seshat:new_group(Group),
     seshat:new(Group, test_component, Counters, #{component => test}),
     set_value(Group, test_component, pings, 0),
     set_value(Group, test_component, pongs, 17),
     set_value(Group, test_component, pangs, 33),
     set_value(Group, test_component, rings, 100),
-
     Result = seshat:format(Group),
     ExpectedMap = #{pings => #{type => gauge,
                                help => "Some ratio that happens to be 0%",
@@ -197,58 +178,46 @@ format_ratio() ->
     ?assertEqual(ExpectedMap, Result),
     ok.
 
-    format_time_metrics() ->
-        Group = ?FUNCTION_NAME,
-        Counters = [
-                    {job_duration, 2, time_s, "Job duration"},
-                    {short_latency, 3, time_ms, "Short latency"},
-                    {long_latency, 1, time_ms, "Request latency"}
-                   ],
-        seshat:new_group(Group),
-        Labels = #{component => test},
-        seshat:new(Group, test_component, Counters, Labels),
-
-        % Set values (1500 ms, 30 s, 5 ms)
-        set_value(Group, test_component, job_duration, 30),
-        set_value(Group, test_component, short_latency, 5),
-        set_value(Group, test_component, long_latency, 1500),
-
-        MapResult = seshat:format(Group),
-        ExpectedMap = #{
-            job_duration => #{type => gauge,
-                              help => "Job duration",
-                              values => #{Labels => 30.0}},
-            short_latency => #{type => gauge,
-                               help => "Short latency",
-                               values => #{Labels => 0.005}},
-            long_latency => #{type => gauge,
-                              help => "Request latency",
-                              values => #{Labels => 1.5}}
-        },
-        ?assertEqual(ExpectedMap, MapResult),
-
-        Prefix = "myapp",
-        MetricNames = [job_duration, short_latency, long_latency], % Added new metric name
-        TextResult = seshat:text_format(Group, Prefix, MetricNames),
-
-        ExpectedLines = [
-            "# HELP myapp_job_duration_seconds Job duration",
-            "# TYPE myapp_job_duration_seconds gauge",
-            "myapp_job_duration_seconds{component=\"test\"} 30.0",
-            "# HELP myapp_short_latency_seconds Short latency",
-            "# TYPE myapp_short_latency_seconds gauge",
-            "myapp_short_latency_seconds{component=\"test\"} 0.005",
-            "# HELP myapp_long_latency_seconds Request latency",
-            "# TYPE myapp_long_latency_seconds gauge",
-            "myapp_long_latency_seconds{component=\"test\"} 1.5"
-        ],
-        ExpectedResult = list_to_binary(string:join(ExpectedLines, "\n") ++ "\n"),
+format_time_metrics(_Config) ->
+    Group = ?FUNCTION_NAME,
+    Counters = [
+                {job_duration, 2, time_s, "Job duration"},
+                {short_latency, 3, time_ms, "Short latency"},
+                {long_latency, 1, time_ms, "Request latency"}
+               ],
+    Labels = #{component => test},
+    seshat:new(Group, test_component, Counters, Labels),
+    set_value(Group, test_component, job_duration, 30),
+    set_value(Group, test_component, short_latency, 5),
+    set_value(Group, test_component, long_latency, 1500),
+    MapResult = seshat:format(Group),
+    ExpectedMap = #{
+        job_duration => #{type => gauge, help => "Job duration", values => #{Labels => 30.0}},
+        short_latency => #{type => gauge, help => "Short latency", values => #{Labels => 0.005}},
+        long_latency => #{type => gauge, help => "Request latency", values => #{Labels => 1.5}}
+    },
+    ?assertEqual(ExpectedMap, MapResult),
+    Prefix = "myapp",
+    MetricNames = [job_duration, short_latency, long_latency],
+    TextResult = seshat:text_format(Group, Prefix, MetricNames),
+    ExpectedLines = [
+        "# HELP myapp_job_duration_seconds Job duration",
+        "# TYPE myapp_job_duration_seconds gauge",
+        "myapp_job_duration_seconds{component=\"test\"} 30.0",
+        "# HELP myapp_short_latency_seconds Short latency",
+        "# TYPE myapp_short_latency_seconds gauge",
+        "myapp_short_latency_seconds{component=\"test\"} 0.005",
+        "# HELP myapp_long_latency_seconds Request latency",
+        "# TYPE myapp_long_latency_seconds gauge",
+        "myapp_long_latency_seconds{component=\"test\"} 1.5"
+    ],
+    ExpectedResult = list_to_binary(string:join(ExpectedLines, "\n") ++ "\n"),
 
-        ?assertEqual(ExpectedResult, TextResult),
-        ok.
+    assertEqualIgnoringOrder(ExpectedResult, TextResult),
+    ok.
 
-text_format_selected_metrics() ->
-    Group = widgets,
+text_format_selected_metrics(_Config) ->
+    Group = ?FUNCTION_NAME,
     Counters = [
                 {reads, 1, counter, "Total reads"},
                 {writes, 2, counter, "Total writes"},
@@ -257,7 +226,6 @@ text_format_selected_metrics() ->
                 {duration, 5, time_s, "Duration"},
                 {npc, 6, gauge, "A metric we don't request in a call to text_format/3"}
                ],
-    seshat:new_group(Group),
     seshat:new(Group, thing1, Counters, #{component => "thing1", version => "1.2.3"}),
     seshat:new(Group, thing2, Counters, #{component => "thing2", some_atom => atom_value}),
     seshat:new(Group, thing3, Counters, #{component => "thing3", some_binary => <<"binary_value">>}),
@@ -266,19 +234,19 @@ text_format_selected_metrics() ->
     set_value(Group, thing1, cached, 10),
     set_value(Group, thing1, latency, 5),
     set_value(Group, thing1, duration, 123),
-    set_value(Group, thing1, npc, 1), % to be ignored
+    set_value(Group, thing1, npc, 1),  % to be ignored
     set_value(Group, thing2, reads, 3),
     set_value(Group, thing2, writes, 4),
     set_value(Group, thing2, cached, 100),
     set_value(Group, thing2, latency, 6),
     set_value(Group, thing2, duration, 234),
-    set_value(Group, thing2, npc, 1), % to be ignored
+    set_value(Group, thing2, npc, 1),  % to be ignored
     set_value(Group, thing3, reads, 1234),
     set_value(Group, thing3, writes, 4321),
     set_value(Group, thing3, cached, 17),
     set_value(Group, thing3, latency, 7),
     set_value(Group, thing3, duration, 345),
-    set_value(Group, thing3, npc, 1), % to be ignored
+    set_value(Group, thing3, npc, 1),  % to be ignored
 
     Result = seshat:text_format(Group, "acme", [reads, writes, cached, latency, duration]),
     ExpectedLines = [
@@ -310,18 +278,18 @@ text_format_selected_metrics() ->
     ],
     ExpectedResult = list_to_binary(string:join(ExpectedLines, "\n") ++ "\n"),
 
-    ?assertEqual(ExpectedResult, Result),
+    assertEqualIgnoringOrder(ExpectedResult, Result),
     ok.
 
-%% test helpers
-
+%% Helpers
 set_value(Group, Id, Name, Value) ->
-    [{Id, CRef, FieldSpec, _Labels}] = ets:lookup(seshat_counters_server:get_table(Group), Id),
-    Fields = resolve_fieldspec(FieldSpec),
+    Table = seshat_counters_server:get_table(Group),
+    [{Id, CRef, FieldSpec, _Labels}] = ets:lookup(Table, Id),
+    Fields = seshat:resolve_fields_spec(FieldSpec),
     {Name, Index, _Type, _Help} = lists:keyfind(Name, 1, Fields),
-    counters:put(CRef, Index, Value).
+    ok = counters:put(CRef, Index, Value).
 
-resolve_fieldspec(Fields = FieldSpec) when is_list(FieldSpec) ->
-    Fields;
-resolve_fieldspec({persistent_term, PTerm}) ->
-    persistent_term:get(PTerm).
+assertEqualIgnoringOrder(Expected, Actual) ->
+    ExpectedSorted = lists:sort(binary:split(Expected, <<"\n">>, [global, trim])),
+    ActualSorted = lists:sort(binary:split(Actual, <<"\n">>, [global, trim])),
+    ?assertEqual(ExpectedSorted, ActualSorted).