Merge pull request #7397 from lafirest/test/prometheus_coverage

test(prometheus): improve test coverage to 88%

apps/emqx_management/test/emqx_mgmt_api_test_util.erl

@@ -53,13 +53,13 @@ set_special_configs(_App) ->
 request_api(Method, Url) ->
     request_api(Method, Url, [], auth_header_(), []).
 
-request_api(Method, Url, Auth) ->
-    request_api(Method, Url, [], Auth, []).
+request_api(Method, Url, AuthOrHeaders) ->
+    request_api(Method, Url, [], AuthOrHeaders, []).
 
-request_api(Method, Url, QueryParams, Auth) ->
-    request_api(Method, Url, QueryParams, Auth, []).
+request_api(Method, Url, QueryParams, AuthOrHeaders) ->
+    request_api(Method, Url, QueryParams, AuthOrHeaders, []).
 
-request_api(Method, Url, QueryParams, Auth, [])
+request_api(Method, Url, QueryParams, AuthOrHeaders, [])
   when (Method =:= options) orelse
          (Method =:= get) orelse
          (Method =:= put) orelse
@@ -70,9 +70,9 @@ request_api(Method, Url, QueryParams, Auth, [])
                  "" -> Url;
                  _ -> Url ++ "?" ++ QueryParams
              end,
-    do_request_api(Method, {NewUrl, [Auth]});
-request_api(Method, Url, QueryParams, Auth, Body)
-    when (Method =:= post) orelse
+    do_request_api(Method, {NewUrl, build_http_header(AuthOrHeaders)});
+request_api(Method, Url, QueryParams, AuthOrHeaders, Body)
+  when (Method =:= post) orelse
          (Method =:= patch) orelse
          (Method =:= put) orelse
          (Method =:= delete) ->
@@ -80,7 +80,7 @@ request_api(Method, Url, QueryParams, Auth, Body)
                  "" -> Url;
                  _ -> Url ++ "?" ++ QueryParams
              end,
-    do_request_api(Method, {NewUrl, [Auth], "application/json", emqx_json:encode(Body)}).
+    do_request_api(Method, {NewUrl, build_http_header(AuthOrHeaders), "application/json", emqx_json:encode(Body)}).
 
 do_request_api(Method, Request)->
     ct:pal("Method: ~p, Request: ~p", [Method, Request]),
@@ -100,6 +100,12 @@ auth_header_() ->
     {ok, Token} = emqx_dashboard_admin:sign_token(Username, Password),
     {"Authorization", "Bearer " ++ binary_to_list(Token)}.
 
+build_http_header(X) when is_list(X) ->
+    X;
+
+build_http_header(X) ->
+    [X].
+
 api_path(Parts)->
     ?SERVER ++ filename:join([?BASE_PATH | Parts]).
 

apps/emqx_prometheus/test/emqx_prometheus_SUITE.erl

@@ -21,9 +21,58 @@
 -compile(nowarn_export_all).
 -compile(export_all).
 
+-define(CLUSTER_RPC_SHARD, emqx_cluster_rpc_shard).
+-define(CONF_DEFAULT, <<"
+prometheus {
+  push_gateway_server = \"http://127.0.0.1:9091\"
+  interval = \"1s\"
+  enable = true
+}
+">>).
+
+%%--------------------------------------------------------------------
+%% Setups
+%%--------------------------------------------------------------------
+
 all() -> emqx_common_test_helpers:all(?MODULE).
 
+init_per_suite(Cfg) ->
+    application:load(emqx_conf),
+    ok = ekka:start(),
+    ok = mria_rlog:wait_for_shards([?CLUSTER_RPC_SHARD], infinity),
+    meck:new(emqx_alarm, [non_strict, passthrough, no_link]),
+    meck:expect(emqx_alarm, activate, 3, ok),
+    meck:expect(emqx_alarm, deactivate, 3, ok),
+
+    load_config(),
+    emqx_common_test_helpers:start_apps([emqx_prometheus]),
+    Cfg.
+
+end_per_suite(_Cfg) ->
+    ekka:stop(),
+    mria:stop(),
+    mria_mnesia:delete_schema(),
+    meck:unload(emqx_alarm),
+
+    emqx_common_test_helpers:stop_apps([emqx_prometheus]).
+
+load_config() ->
+    ok = emqx_common_test_helpers:load_config(emqx_prometheus_schema, ?CONF_DEFAULT).
+
+%%--------------------------------------------------------------------
+%% Test cases
+%%--------------------------------------------------------------------
+
 t_start_stop(_) ->
     ?assertMatch(ok, emqx_prometheus:start()),
     ?assertMatch(ok, emqx_prometheus:stop()),
-    ?assertMatch(ok, emqx_prometheus:restart()).
+    ?assertMatch(ok, emqx_prometheus:restart()),
+    %% wait the interval timer tigger
+    timer:sleep(2000).
+
+t_test(_) ->
+    ok.
+
+t_only_for_coverage(_) ->
+    ?assertEqual("5.0.0", emqx_prometheus_proto_v1:introduced_in()),
+    ok.

apps/emqx_prometheus/test/emqx_prometheus_api_SUITE.erl

@@ -0,0 +1,99 @@
+%%--------------------------------------------------------------------
+%% Copyright (C) 2020-2022 EMQ Technologies Co., Ltd. All Rights Reserved.
+%%
+%% Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+%%--------------------------------------------------------------------
+
+-module(emqx_prometheus_api_SUITE).
+
+-compile(export_all).
+-compile(nowarn_export_all).
+
+-include_lib("eunit/include/eunit.hrl").
+-include_lib("common_test/include/ct.hrl").
+-define(CLUSTER_RPC_SHARD, emqx_cluster_rpc_shard).
+
+-define(LOGT(Format, Args), ct:pal("TEST_SUITE: " ++ Format, Args)).
+
+%%--------------------------------------------------------------------
+%% Setups
+%%--------------------------------------------------------------------
+
+all() ->
+    emqx_common_test_helpers:all(?MODULE).
+
+init_per_suite(Config) ->
+    application:load(emqx_conf),
+    ok = ekka:start(),
+    ok = mria_rlog:wait_for_shards([?CLUSTER_RPC_SHARD], infinity),
+
+    meck:new(mria_rlog, [non_strict, passthrough, no_link]),
+
+    emqx_prometheus_SUITE:load_config(),
+    emqx_mgmt_api_test_util:init_suite([emqx_prometheus]),
+
+    Config.
+
+end_per_suite(Config) ->
+    ekka:stop(),
+    mria:stop(),
+    mria_mnesia:delete_schema(),
+
+    meck:unload(mria_rlog),
+
+    emqx_mgmt_api_test_util:end_suite([emqx_prometheus]),
+    Config.
+
+init_per_testcase(_, Config) ->
+    {ok, _} = emqx_cluster_rpc:start_link(),
+    Config.
+
+%%--------------------------------------------------------------------
+%% Cases
+%%--------------------------------------------------------------------
+t_prometheus_api(_) ->
+    Path = emqx_mgmt_api_test_util:api_path(["prometheus"]),
+    Auth = emqx_mgmt_api_test_util:auth_header_(),
+    {ok, Response} = emqx_mgmt_api_test_util:request_api(get, Path, "", Auth),
+
+    Conf = emqx_json:decode(Response, [return_maps]),
+    ?assertMatch(#{<<"push_gateway_server">> := _,
+                   <<"interval">> := _,
+                   <<"enable">> := _}, Conf),
+
+    NewConf = Conf#{<<"interval">> := <<"2s">>},
+    {ok, Response2} = emqx_mgmt_api_test_util:request_api(put, Path, "", Auth, NewConf),
+
+    Conf2 = emqx_json:decode(Response2, [return_maps]),
+    ?assertMatch(NewConf, Conf2),
+    ok.
+
+t_stats_api(_) ->
+    Path = emqx_mgmt_api_test_util:api_path(["prometheus", "stats"]),
+    Auth = emqx_mgmt_api_test_util:auth_header_(),
+    Headers = [{"accept", "application/json"}, Auth],
+    {ok, Response} = emqx_mgmt_api_test_util:request_api(get, Path, "", Headers),
+
+    Data = emqx_json:decode(Response, [return_maps]),
+    ?assertMatch(#{<<"client">> := _, <<"delivery">> := _}, Data),
+
+    {ok, _} = emqx_mgmt_api_test_util:request_api(get, Path, "", Auth),
+
+    ok = meck:expect(mria_rlog, backend, fun() -> rlog end),
+    {ok, _} = emqx_mgmt_api_test_util:request_api(get, Path, "", Auth),
+
+    ok.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%% Internal Functions
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%