%%-------------------------------------------------------------------- %% Copyright (c) 2023 EMQ Technologies Co., Ltd. All Rights Reserved. %%-------------------------------------------------------------------- -module(emqx_bridge_testlib). -compile(nowarn_export_all). -compile(export_all). -include_lib("eunit/include/eunit.hrl"). -include_lib("common_test/include/ct.hrl"). -include_lib("snabbkaffe/include/snabbkaffe.hrl"). -import(emqx_common_test_helpers, [on_exit/1]). %% ct setup helpers init_per_suite(Config, Apps) -> [{start_apps, Apps} | Config]. end_per_suite(Config) -> emqx_mgmt_api_test_util:end_suite(), ok = emqx_common_test_helpers:stop_apps([emqx_conf]), ok = emqx_connector_test_helpers:stop_apps(lists:reverse(?config(start_apps, Config))), _ = application:stop(emqx_connector), ok. init_per_group(TestGroup, BridgeType, Config) -> ProxyHost = os:getenv("PROXY_HOST", "toxiproxy"), ProxyPort = list_to_integer(os:getenv("PROXY_PORT", "8474")), emqx_common_test_helpers:reset_proxy(ProxyHost, ProxyPort), application:load(emqx_bridge), ok = emqx_common_test_helpers:start_apps([emqx_conf]), ok = emqx_connector_test_helpers:start_apps(?config(start_apps, Config)), {ok, _} = application:ensure_all_started(emqx_connector), emqx_mgmt_api_test_util:init_suite(), UniqueNum = integer_to_binary(erlang:unique_integer([positive])), MQTTTopic = <<"mqtt/topic/abc", UniqueNum/binary>>, [ {proxy_host, ProxyHost}, {proxy_port, ProxyPort}, {mqtt_topic, MQTTTopic}, {test_group, TestGroup}, {bridge_type, BridgeType} | Config ]. end_per_group(Config) -> ProxyHost = ?config(proxy_host, Config), ProxyPort = ?config(proxy_port, Config), emqx_common_test_helpers:reset_proxy(ProxyHost, ProxyPort), delete_all_bridges(), ok. init_per_testcase(TestCase, Config0, BridgeConfigCb) -> ct:timetrap(timer:seconds(60)), delete_all_bridges(), UniqueNum = integer_to_binary(erlang:unique_integer()), BridgeTopic = << (atom_to_binary(TestCase))/binary, UniqueNum/binary >>, TestGroup = ?config(test_group, Config0), Config = [{bridge_topic, BridgeTopic} | Config0], {Name, ConfigString, BridgeConfig} = BridgeConfigCb( TestCase, TestGroup, Config ), ok = snabbkaffe:start_trace(), [ {bridge_name, Name}, {bridge_config_string, ConfigString}, {bridge_config, BridgeConfig} | Config ]. end_per_testcase(_Testcase, Config) -> case proplists:get_bool(skip_does_not_apply, Config) of true -> ok; false -> ProxyHost = ?config(proxy_host, Config), ProxyPort = ?config(proxy_port, Config), emqx_common_test_helpers:reset_proxy(ProxyHost, ProxyPort), delete_all_bridges(), %% in CI, apparently this needs more time since the %% machines struggle with all the containers running... emqx_common_test_helpers:call_janitor(60_000), ok = snabbkaffe:stop(), ok end. delete_all_bridges() -> lists:foreach( fun(#{name := Name, type := Type}) -> ok = emqx_bridge:remove(Type, Name) end, emqx_bridge:list() ). %% test helpers parse_and_check(BridgeType, BridgeName, ConfigString) -> {ok, RawConf} = hocon:binary(ConfigString, #{format => map}), hocon_tconf:check_plain(emqx_bridge_schema, RawConf, #{required => false, atom_key => false}), #{<<"bridges">> := #{BridgeType := #{BridgeName := BridgeConfig}}} = RawConf, BridgeConfig. resource_id(Config) -> BridgeType = ?config(bridge_type, Config), BridgeName = ?config(bridge_name, Config), emqx_bridge_resource:resource_id(BridgeType, BridgeName). create_bridge(Config) -> create_bridge(Config, _Overrides = #{}). create_bridge(Config, Overrides) -> BridgeType = ?config(bridge_type, Config), BridgeName = ?config(bridge_name, Config), BridgeConfig0 = ?config(bridge_config, Config), BridgeConfig = emqx_utils_maps:deep_merge(BridgeConfig0, Overrides), ct:pal("creating bridge with config: ~p", [BridgeConfig]), emqx_bridge:create(BridgeType, BridgeName, BridgeConfig). list_bridges_api() -> Params = [], Path = emqx_mgmt_api_test_util:api_path(["bridges"]), AuthHeader = emqx_mgmt_api_test_util:auth_header_(), Opts = #{return_all => true}, ct:pal("listing bridges (via http)"), Res = case emqx_mgmt_api_test_util:request_api(get, Path, "", AuthHeader, Params, Opts) of {ok, {Status, Headers, Body0}} -> {ok, {Status, Headers, emqx_utils_json:decode(Body0, [return_maps])}}; Error -> Error end, ct:pal("list bridge result: ~p", [Res]), Res. create_bridge_api(Config) -> create_bridge_api(Config, _Overrides = #{}). create_bridge_api(Config, Overrides) -> BridgeType = ?config(bridge_type, Config), BridgeName = ?config(bridge_name, Config), BridgeConfig0 = ?config(bridge_config, Config), BridgeConfig = emqx_utils_maps:deep_merge(BridgeConfig0, Overrides), create_bridge_api(BridgeType, BridgeName, BridgeConfig). create_bridge_api(BridgeType, BridgeName, BridgeConfig) -> Params = BridgeConfig#{<<"type">> => BridgeType, <<"name">> => BridgeName}, Path = emqx_mgmt_api_test_util:api_path(["bridges"]), AuthHeader = emqx_mgmt_api_test_util:auth_header_(), Opts = #{return_all => true}, ct:pal("creating bridge (via http): ~p", [Params]), Res = case emqx_mgmt_api_test_util:request_api(post, Path, "", AuthHeader, Params, Opts) of {ok, {Status, Headers, Body0}} -> {ok, {Status, Headers, emqx_utils_json:decode(Body0, [return_maps])}}; Error -> Error end, ct:pal("bridge create result: ~p", [Res]), Res. update_bridge_api(Config) -> update_bridge_api(Config, _Overrides = #{}). update_bridge_api(Config, Overrides) -> BridgeType = ?config(bridge_type, Config), Name = ?config(bridge_name, Config), BridgeConfig0 = ?config(bridge_config, Config), BridgeConfig = emqx_utils_maps:deep_merge(BridgeConfig0, Overrides), BridgeId = emqx_bridge_resource:bridge_id(BridgeType, Name), Params = BridgeConfig#{<<"type">> => BridgeType, <<"name">> => Name}, Path = emqx_mgmt_api_test_util:api_path(["bridges", BridgeId]), AuthHeader = emqx_mgmt_api_test_util:auth_header_(), Opts = #{return_all => true}, ct:pal("updating bridge (via http): ~p", [Params]), Res = case emqx_mgmt_api_test_util:request_api(put, Path, "", AuthHeader, Params, Opts) of {ok, {_Status, _Headers, Body0}} -> {ok, emqx_utils_json:decode(Body0, [return_maps])}; Error -> Error end, ct:pal("bridge update result: ~p", [Res]), Res. delete_bridge_http_api_v1(Opts) -> #{type := Type, name := Name} = Opts, BridgeId = emqx_bridge_resource:bridge_id(Type, Name), Path = emqx_mgmt_api_test_util:api_path(["bridges", BridgeId]), ct:pal("deleting bridge (http v1)"), Res = emqx_bridge_v2_testlib:request(delete, Path, _Params = []), ct:pal("bridge delete (http v1) result:\n ~p", [Res]), Res. op_bridge_api(Op, BridgeType, BridgeName) -> BridgeId = emqx_bridge_resource:bridge_id(BridgeType, BridgeName), Path = emqx_mgmt_api_test_util:api_path(["bridges", BridgeId, Op]), ct:pal("calling bridge ~p (via http): ~p", [BridgeId, Op]), Method = post, Params = [], Res = emqx_bridge_v2_testlib:request(Method, Path, Params), ct:pal("bridge op result: ~p", [Res]), Res. probe_bridge_api(Config) -> probe_bridge_api(Config, _Overrides = #{}). probe_bridge_api(Config, Overrides) -> BridgeType = ?config(bridge_type, Config), BridgeName = ?config(bridge_name, Config), BridgeConfig0 = ?config(bridge_config, Config), BridgeConfig = emqx_utils_maps:deep_merge(BridgeConfig0, Overrides), probe_bridge_api(BridgeType, BridgeName, BridgeConfig). probe_bridge_api(BridgeType, BridgeName, BridgeConfig) -> Params = BridgeConfig#{<<"type">> => BridgeType, <<"name">> => BridgeName}, Path = emqx_mgmt_api_test_util:api_path(["bridges_probe"]), AuthHeader = emqx_mgmt_api_test_util:auth_header_(), Opts = #{return_all => true}, ct:pal("probing bridge (via http): ~p", [Params]), Res = case emqx_mgmt_api_test_util:request_api(post, Path, "", AuthHeader, Params, Opts) of {ok, {{_, 204, _}, _Headers, _Body0} = Res0} -> {ok, Res0}; Error -> Error end, ct:pal("bridge probe result: ~p", [Res]), Res. try_decode_error(Body0) -> case emqx_utils_json:safe_decode(Body0, [return_maps]) of {ok, #{<<"message">> := Msg0} = Body1} -> case emqx_utils_json:safe_decode(Msg0, [return_maps]) of {ok, Msg1} -> Body1#{<<"message">> := Msg1}; {error, _} -> Body1 end; {ok, Body1} -> Body1; {error, _} -> Body0 end. create_rule_and_action_http(BridgeType, RuleTopic, Config) -> create_rule_and_action_http(BridgeType, RuleTopic, Config, _Opts = #{}). create_rule_and_action_http(BridgeType, RuleTopic, Config, Opts) -> BridgeName = ?config(bridge_name, Config), BridgeId = emqx_bridge_resource:bridge_id(BridgeType, BridgeName), SQL = maps:get(sql, Opts, <<"SELECT * FROM \"", RuleTopic/binary, "\"">>), Params = #{ enable => true, sql => SQL, actions => [BridgeId] }, Path = emqx_mgmt_api_test_util:api_path(["rules"]), AuthHeader = emqx_mgmt_api_test_util:auth_header_(), ct:pal("rule action params: ~p", [Params]), case emqx_mgmt_api_test_util:request_api(post, Path, "", AuthHeader, Params) of {ok, Res0} -> Res = #{<<"id">> := RuleId} = emqx_utils_json:decode(Res0, [return_maps]), on_exit(fun() -> ok = emqx_rule_engine:delete_rule(RuleId) end), {ok, Res}; Error -> Error end. make_message(Config, MakeMessageFun) -> BridgeType = ?config(bridge_type, Config), case emqx_bridge_v2:is_bridge_v2_type(BridgeType) of true -> BridgeId = emqx_bridge_v2_testlib:bridge_id(Config), {BridgeId, MakeMessageFun()}; false -> {send_message, MakeMessageFun()} end. %%------------------------------------------------------------------------------ %% Testcases %%------------------------------------------------------------------------------ t_sync_query(Config, MakeMessageFun, IsSuccessCheck, TracePoint) -> ?check_trace( begin ?assertMatch({ok, _}, create_bridge_api(Config)), ResourceId = resource_id(Config), ?retry( _Sleep = 1_000, _Attempts = 20, ?assertEqual({ok, connected}, emqx_resource_manager:health_check(ResourceId)) ), Message = make_message(Config, MakeMessageFun), IsSuccessCheck(emqx_resource:simple_sync_query(ResourceId, Message)), ok end, fun(Trace) -> ResourceId = resource_id(Config), ?assertMatch([#{instance_id := ResourceId}], ?of_kind(TracePoint, Trace)) end ), ok. t_async_query(Config, MakeMessageFun, IsSuccessCheck, TracePoint) -> ReplyFun = fun(Pid, Result) -> Pid ! {result, Result} end, ?check_trace( begin ?assertMatch({ok, _}, create_bridge_api(Config)), ResourceId = resource_id(Config), ?retry( _Sleep = 1_000, _Attempts = 20, ?assertEqual({ok, connected}, emqx_resource_manager:health_check(ResourceId)) ), Message = make_message(Config, MakeMessageFun), ?assertMatch( {ok, {ok, _}}, ?wait_async_action( emqx_resource:query(ResourceId, Message, #{ async_reply_fun => {ReplyFun, [self()]} }), #{?snk_kind := TracePoint, instance_id := ResourceId}, 5_000 ) ), ok end, fun(Trace) -> ResourceId = resource_id(Config), ?assertMatch([#{instance_id := ResourceId}], ?of_kind(TracePoint, Trace)) end ), receive {result, Result} -> IsSuccessCheck(Result) after 5_000 -> throw(timeout) end, ok. t_create_via_http(Config) -> ?check_trace( begin ?assertMatch({ok, _}, create_bridge_api(Config)), %% lightweight matrix testing some configs ?assertMatch( {ok, _}, update_bridge_api( Config ) ), ?assertMatch( {ok, _}, update_bridge_api( Config ) ), ok end, [] ), ok. t_start_stop(Config, StopTracePoint) -> BridgeType = ?config(bridge_type, Config), BridgeName = ?config(bridge_name, Config), BridgeConfig = ?config(bridge_config, Config), t_start_stop(BridgeType, BridgeName, BridgeConfig, StopTracePoint). t_start_stop(BridgeType, BridgeName, BridgeConfig, StopTracePoint) -> ?check_trace( begin %% Check that the bridge probe API doesn't leak atoms. ProbeRes0 = probe_bridge_api( BridgeType, BridgeName, BridgeConfig ), ?assertMatch({ok, {{_, 204, _}, _Headers, _Body}}, ProbeRes0), AtomsBefore = erlang:system_info(atom_count), %% Probe again; shouldn't have created more atoms. ProbeRes1 = probe_bridge_api( BridgeType, BridgeName, BridgeConfig ), ?assertMatch({ok, {{_, 204, _}, _Headers, _Body}}, ProbeRes1), AtomsAfter = erlang:system_info(atom_count), ?assertEqual(AtomsBefore, AtomsAfter), ?assertMatch({ok, _}, emqx_bridge:create(BridgeType, BridgeName, BridgeConfig)), ResourceId = emqx_bridge_resource:resource_id(BridgeType, BridgeName), %% Since the connection process is async, we give it some time to %% stabilize and avoid flakiness. ?retry( _Sleep = 1_000, _Attempts = 20, ?assertEqual({ok, connected}, emqx_resource_manager:health_check(ResourceId)) ), %% `start` bridge to trigger `already_started` ?assertMatch( {ok, {{_, 204, _}, _Headers, []}}, emqx_bridge_testlib:op_bridge_api("start", BridgeType, BridgeName) ), ?assertEqual({ok, connected}, emqx_resource_manager:health_check(ResourceId)), ?assertMatch( {{ok, _}, {ok, _}}, ?wait_async_action( emqx_bridge_testlib:op_bridge_api("stop", BridgeType, BridgeName), #{?snk_kind := StopTracePoint}, 5_000 ) ), ?assertEqual( {error, resource_is_stopped}, emqx_resource_manager:health_check(ResourceId) ), ?assertMatch( {ok, {{_, 204, _}, _Headers, []}}, emqx_bridge_testlib:op_bridge_api("stop", BridgeType, BridgeName) ), ?assertEqual( {error, resource_is_stopped}, emqx_resource_manager:health_check(ResourceId) ), ?assertMatch( {ok, {{_, 204, _}, _Headers, []}}, emqx_bridge_testlib:op_bridge_api("start", BridgeType, BridgeName) ), ?retry( _Sleep = 1_000, _Attempts = 20, ?assertEqual({ok, connected}, emqx_resource_manager:health_check(ResourceId)) ), %% Disable the bridge, which will also stop it. ?assertMatch( {{ok, _}, {ok, _}}, ?wait_async_action( emqx_bridge:disable_enable(disable, BridgeType, BridgeName), #{?snk_kind := StopTracePoint}, 5_000 ) ), ok end, fun(Trace) -> ResourceId = emqx_bridge_resource:resource_id(BridgeType, BridgeName), %% one for each probe, two for real ?assertMatch( [_, _, #{instance_id := ResourceId}, #{instance_id := ResourceId}], ?of_kind(StopTracePoint, Trace) ), ok end ), ok. t_on_get_status(Config) -> t_on_get_status(Config, _Opts = #{}). t_on_get_status(Config, Opts) -> ProxyPort = ?config(proxy_port, Config), ProxyHost = ?config(proxy_host, Config), ProxyName = ?config(proxy_name, Config), FailureStatus = maps:get(failure_status, Opts, disconnected), ?assertMatch({ok, _}, create_bridge(Config)), ResourceId = resource_id(Config), %% Since the connection process is async, we give it some time to %% stabilize and avoid flakiness. ?retry( _Sleep = 1_000, _Attempts = 20, ?assertEqual({ok, connected}, emqx_resource_manager:health_check(ResourceId)) ), emqx_common_test_helpers:with_failure(down, ProxyName, ProxyHost, ProxyPort, fun() -> ct:sleep(500), ?retry( _Interval0 = 200, _Attempts0 = 10, ?assertEqual({ok, FailureStatus}, emqx_resource_manager:health_check(ResourceId)) ) end), %% Check that it recovers itself. ?retry( _Sleep = 1_000, _Attempts = 20, ?assertEqual({ok, connected}, emqx_resource_manager:health_check(ResourceId)) ), ok.