chore(webhook): remove needless files

This commit is contained in:
JianBo He 2021-03-01 16:59:53 +08:00 committed by Shawn
parent 4aca2c294f
commit 319d44d1bf
2 changed files with 0 additions and 551 deletions

View File

@ -1,142 +0,0 @@
%%--------------------------------------------------------------------
%% Copyright (c) 2020 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(prop_webhook_confs).
-include_lib("proper/include/proper.hrl").
-import(emqx_ct_proper_types,
[ url/0
, nof/1
]).
-define(ALL(Vars, Types, Exprs),
?SETUP(fun() ->
State = do_setup(),
fun() -> do_teardown(State) end
end, ?FORALL(Vars, Types, Exprs))).
%%--------------------------------------------------------------------
%% Properties
%%--------------------------------------------------------------------
prop_confs() ->
Schema = cuttlefish_schema:files(filelib:wildcard(code:priv_dir(emqx_web_hook) ++ "/*.schema")),
?ALL({Url, Confs0}, {url(), confs()},
begin
Confs = [{"web.hook.api.url", Url}|Confs0],
Envs = cuttlefish_generator:map(Schema, cuttlefish_conf_file(Confs)),
assert_confs(Confs, Envs),
set_application_envs(Envs),
{ok, _} = application:ensure_all_started(emqx_web_hook),
application:stop(emqx_web_hook),
unset_application_envs(Envs),
true
end).
%%--------------------------------------------------------------------
%% Helpers
%%--------------------------------------------------------------------
do_setup() ->
application:set_env(kernel, logger_level, error),
emqx_ct_helpers:start_apps([], fun set_special_cfgs/1),
ok.
do_teardown(_) ->
emqx_ct_helpers:stop_apps([]),
ok.
set_special_cfgs(_) ->
application:set_env(emqx, plugins_loaded_file, undefined),
application:set_env(emqx, modules_loaded_file, undefined),
ok.
assert_confs([{"web.hook.api.url", Url}|More], Envs) ->
%% Assert!
Url = deep_get_env("emqx_web_hook.url", Envs),
assert_confs(More, Envs);
assert_confs([{"web.hook.rule." ++ HookName0, Spec}|More], Envs) ->
HookName = re:replace(HookName0, "\\.[0-9]", "", [{return, list}]),
Rules = deep_get_env("emqx_web_hook.rules", Envs),
%% Assert!
Spec = proplists:get_value(HookName, Rules),
assert_confs(More, Envs);
assert_confs([_|More], Envs) ->
assert_confs(More, Envs);
assert_confs([], _) ->
true.
deep_get_env(Path, Envs) ->
lists:foldl(
fun(_K, undefiend) -> undefiend;
(K, Acc) -> proplists:get_value(binary_to_atom(K, utf8), Acc)
end, Envs, re:split(Path, "\\.")).
set_application_envs(Envs) ->
application:set_env(Envs).
unset_application_envs(Envs) ->
lists:foreach(fun({App, Es}) ->
lists:foreach(fun({K, _}) ->
application:unset_env(App, K)
end, Es) end, Envs).
cuttlefish_conf_file(Ls) when is_list(Ls) ->
[cuttlefish_conf_option(K,V) || {K, V} <- Ls].
cuttlefish_conf_option(K, V)
when is_list(K) ->
{re:split(K, "[.]", [{return, list}]), V}.
%%--------------------------------------------------------------------
%% Generators
%%--------------------------------------------------------------------
confs() ->
nof([{"web.hook.encode_payload", oneof(["base64", "base62"])},
{"web.hook.rule.client.connect.1", rule_spec()},
{"web.hook.rule.client.connack.1", rule_spec()},
{"web.hook.rule.client.connected.1", rule_spec()},
{"web.hook.rule.client.disconnected.1", rule_spec()},
{"web.hook.rule.client.subscribe.1", rule_spec()},
{"web.hook.rule.client.unsubscribe.1", rule_spec()},
{"web.hook.rule.session.subscribed.1", rule_spec()},
{"web.hook.rule.session.unsubscribed.1", rule_spec()},
{"web.hook.rule.session.terminated.1", rule_spec()},
{"web.hook.rule.message.publish.1", rule_spec()},
{"web.hook.rule.message.delivered.1", rule_spec()},
{"web.hook.rule.message.acked.1", rule_spec()}
]).
rule_spec() ->
?LET(Action, action_names(),
begin
binary_to_list(emqx_json:encode(#{action => Action}))
end).
action_names() ->
oneof([on_client_connect, on_client_connack, on_client_connected,
on_client_connected, on_client_disconnected, on_client_subscribe, on_client_unsubscribe,
on_session_subscribed, on_session_unsubscribed, on_session_terminated,
on_message_publish, on_message_delivered, on_message_acked]).

View File

@ -1,409 +0,0 @@
%%--------------------------------------------------------------------
%% Copyright (c) 2020 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(prop_webhook_hooks).
-include_lib("proper/include/proper.hrl").
-import(emqx_ct_proper_types,
[ conninfo/0
, clientinfo/0
, sessioninfo/0
, message/0
, connack_return_code/0
, topictab/0
, topic/0
, subopts/0
]).
-define(ALL(Vars, Types, Exprs),
?SETUP(fun() ->
State = do_setup(),
fun() -> do_teardown(State) end
end, ?FORALL(Vars, Types, Exprs))).
%%--------------------------------------------------------------------
%% Properties
%%--------------------------------------------------------------------
prop_client_connect() ->
?ALL({ConnInfo, ConnProps, Env},
{conninfo(), conn_properties(), empty_env()},
begin
ok = emqx_web_hook:on_client_connect(ConnInfo, ConnProps, Env),
Body = receive_http_request_body(),
Body = emqx_json:encode(
#{action => client_connect,
node => stringfy(node()),
clientid => maps:get(clientid, ConnInfo),
username => maybe(maps:get(username, ConnInfo)),
ipaddress => peer2addr(maps:get(peername, ConnInfo)),
keepalive => maps:get(keepalive, ConnInfo),
proto_ver => maps:get(proto_ver, ConnInfo)
}),
true
end).
prop_client_connack() ->
?ALL({ConnInfo, Rc, AckProps, Env},
{conninfo(), connack_return_code(), ack_properties(), empty_env()},
begin
ok = emqx_web_hook:on_client_connack(ConnInfo, Rc, AckProps, Env),
Body = receive_http_request_body(),
Body = emqx_json:encode(
#{action => client_connack,
node => stringfy(node()),
clientid => maps:get(clientid, ConnInfo),
username => maybe(maps:get(username, ConnInfo)),
ipaddress => peer2addr(maps:get(peername, ConnInfo)),
keepalive => maps:get(keepalive, ConnInfo),
proto_ver => maps:get(proto_ver, ConnInfo),
conn_ack => Rc
}),
true
end).
prop_client_connected() ->
?ALL({ClientInfo, ConnInfo, Env},
{clientinfo(), conninfo(), empty_env()},
begin
ok = emqx_web_hook:on_client_connected(ClientInfo, ConnInfo, Env),
Body = receive_http_request_body(),
Body = emqx_json:encode(
#{action => client_connected,
node => stringfy(node()),
clientid => maps:get(clientid, ClientInfo),
username => maybe(maps:get(username, ClientInfo)),
ipaddress => peer2addr(maps:get(peerhost, ClientInfo)),
keepalive => maps:get(keepalive, ConnInfo),
proto_ver => maps:get(proto_ver, ConnInfo),
connected_at => maps:get(connected_at, ConnInfo)
}),
true
end).
prop_client_disconnected() ->
?ALL({ClientInfo, Reason, ConnInfo, Env},
{clientinfo(), shutdown_reason(), disconnected_conninfo(), empty_env()},
begin
ok = emqx_web_hook:on_client_disconnected(ClientInfo, Reason, ConnInfo, Env),
Body = receive_http_request_body(),
Body = emqx_json:encode(
#{action => client_disconnected,
node => stringfy(node()),
clientid => maps:get(clientid, ClientInfo),
username => maybe(maps:get(username, ClientInfo)),
disconnected_at => maps:get(disconnected_at, ConnInfo),
reason => stringfy(Reason)
}),
true
end).
prop_client_subscribe() ->
?ALL({ClientInfo, SubProps, TopicTab, Env},
{clientinfo(), sub_properties(), topictab(), topic_filter_env()},
begin
ok = emqx_web_hook:on_client_subscribe(ClientInfo, SubProps, TopicTab, Env),
Matched = filter_topictab(TopicTab, Env),
lists:foreach(fun({Topic, Opts}) ->
Body = receive_http_request_body(),
Body = emqx_json:encode(
#{action => client_subscribe,
node => stringfy(node()),
clientid => maps:get(clientid, ClientInfo),
username => maybe(maps:get(username, ClientInfo)),
topic => Topic,
opts => Opts})
end, Matched),
true
end).
prop_client_unsubscribe() ->
?ALL({ClientInfo, SubProps, TopicTab, Env},
{clientinfo(), unsub_properties(), topictab(), topic_filter_env()},
begin
ok = emqx_web_hook:on_client_unsubscribe(ClientInfo, SubProps, TopicTab, Env),
Matched = filter_topictab(TopicTab, Env),
lists:foreach(fun({Topic, Opts}) ->
Body = receive_http_request_body(),
Body = emqx_json:encode(
#{action => client_unsubscribe,
node => stringfy(node()),
clientid => maps:get(clientid, ClientInfo),
username => maybe(maps:get(username, ClientInfo)),
topic => Topic,
opts => Opts})
end, Matched),
true
end).
prop_session_subscribed() ->
?ALL({ClientInfo, Topic, SubOpts, Env},
{clientinfo(), topic(), subopts(), topic_filter_env()},
begin
ok = emqx_web_hook:on_session_subscribed(ClientInfo, Topic, SubOpts, Env),
filter_topic_match(Topic, Env) andalso begin
Body = receive_http_request_body(),
Body1 = emqx_json:encode(
#{action => session_subscribed,
node => stringfy(node()),
clientid => maps:get(clientid, ClientInfo),
username => maybe(maps:get(username, ClientInfo)),
topic => Topic,
opts => SubOpts
}),
Body = Body1
end,
true
end).
prop_session_unsubscribed() ->
?ALL({ClientInfo, Topic, SubOpts, Env},
{clientinfo(), topic(), subopts(), empty_env()},
begin
ok = emqx_web_hook:on_session_unsubscribed(ClientInfo, Topic, SubOpts, Env),
filter_topic_match(Topic, Env) andalso begin
Body = receive_http_request_body(),
Body = emqx_json:encode(
#{action => session_unsubscribed,
node => stringfy(node()),
clientid => maps:get(clientid, ClientInfo),
username => maybe(maps:get(username, ClientInfo)),
topic => Topic
})
end,
true
end).
prop_session_terminated() ->
?ALL({ClientInfo, Reason, SessInfo, Env},
{clientinfo(), shutdown_reason(), sessioninfo(), empty_env()},
begin
ok = emqx_web_hook:on_session_terminated(ClientInfo, Reason, SessInfo, Env),
Body = receive_http_request_body(),
Body = emqx_json:encode(
#{action => session_terminated,
node => stringfy(node()),
clientid => maps:get(clientid, ClientInfo),
username => maybe(maps:get(username, ClientInfo)),
reason => stringfy(Reason)
}),
true
end).
prop_message_publish() ->
?ALL({Msg, Env, Encode}, {message(), topic_filter_env(), payload_encode()},
begin
application:set_env(emqx_web_hook, encode_payload, Encode),
{ok, Msg} = emqx_web_hook:on_message_publish(Msg, Env),
application:unset_env(emqx_web_hook, encode_payload),
(not emqx_message:is_sys(Msg))
andalso filter_topic_match(emqx_message:topic(Msg), Env)
andalso begin
Body = receive_http_request_body(),
Body = emqx_json:encode(
#{action => message_publish,
node => stringfy(node()),
from_client_id => emqx_message:from(Msg),
from_username => maybe(emqx_message:get_header(username, Msg)),
topic => emqx_message:topic(Msg),
qos => emqx_message:qos(Msg),
retain => emqx_message:get_flag(retain, Msg),
payload => encode(emqx_message:payload(Msg), Encode),
ts => emqx_message:timestamp(Msg)
})
end,
true
end).
prop_message_delivered() ->
?ALL({ClientInfo, Msg, Env, Encode}, {clientinfo(), message(), topic_filter_env(), payload_encode()},
begin
application:set_env(emqx_web_hook, encode_payload, Encode),
ok = emqx_web_hook:on_message_delivered(ClientInfo, Msg, Env),
application:unset_env(emqx_web_hook, encode_payload),
(not emqx_message:is_sys(Msg))
andalso filter_topic_match(emqx_message:topic(Msg), Env)
andalso begin
Body = receive_http_request_body(),
Body = emqx_json:encode(
#{action => message_delivered,
node => stringfy(node()),
clientid => maps:get(clientid, ClientInfo),
username => maybe(maps:get(username, ClientInfo)),
from_client_id => emqx_message:from(Msg),
from_username => maybe(emqx_message:get_header(username, Msg)),
topic => emqx_message:topic(Msg),
qos => emqx_message:qos(Msg),
retain => emqx_message:get_flag(retain, Msg),
payload => encode(emqx_message:payload(Msg), Encode),
ts => emqx_message:timestamp(Msg)
})
end,
true
end).
prop_message_acked() ->
?ALL({ClientInfo, Msg, Env, Encode}, {clientinfo(), message(), empty_env(), payload_encode()},
begin
application:set_env(emqx_web_hook, encode_payload, Encode),
ok = emqx_web_hook:on_message_acked(ClientInfo, Msg, Env),
application:unset_env(emqx_web_hook, encode_payload),
(not emqx_message:is_sys(Msg))
andalso filter_topic_match(emqx_message:topic(Msg), Env)
andalso begin
Body = receive_http_request_body(),
Body = emqx_json:encode(
#{action => message_acked,
node => stringfy(node()),
clientid => maps:get(clientid, ClientInfo),
username => maybe(maps:get(username, ClientInfo)),
from_client_id => emqx_message:from(Msg),
from_username => maybe(emqx_message:get_header(username, Msg)),
topic => emqx_message:topic(Msg),
qos => emqx_message:qos(Msg),
retain => emqx_message:get_flag(retain, Msg),
payload => encode(emqx_message:payload(Msg), Encode),
ts => emqx_message:timestamp(Msg)
})
end,
true
end).
%%--------------------------------------------------------------------
%% Helper
%%--------------------------------------------------------------------
do_setup() ->
%% Pre-defined envs
application:set_env(emqx_web_hook, path, "path"),
application:set_env(emqx_web_hook, headers, []),
meck:new(ehttpc_pool, [passthrough, no_history]),
meck:expect(ehttpc_pool, pick_worker, fun(_, _) -> ok end),
Self = self(),
meck:new(ehttpc, [passthrough, no_history]),
meck:expect(ehttpc, request,
fun(_ClientId, Method, {Path, Headers, Body}) ->
Self ! {Method, Path, Headers, Body}, {ok, ok, ok}
end),
meck:new(emqx_metrics, [passthrough, no_history]),
meck:expect(emqx_metrics, inc, fun(_) -> ok end),
ok.
do_teardown(_) ->
meck:unload(ehttpc_pool),
meck:unload(ehttpc),
meck:unload(emqx_metrics).
maybe(undefined) -> null;
maybe(T) -> T.
peer2addr({Host, _}) ->
list_to_binary(inet:ntoa(Host));
peer2addr(Host) ->
list_to_binary(inet:ntoa(Host)).
ensure_to_binary(Atom) when is_atom(Atom) -> atom_to_binary(Atom, utf8);
ensure_to_binary(Bin) when is_binary(Bin) -> Bin.
stringfy({shutdown, Reason}) ->
stringfy(Reason);
stringfy(Term) when is_atom(Term); is_binary(Term) ->
Term;
stringfy(Term) ->
unicode:characters_to_binary(io_lib:format("~0p", [Term])).
receive_http_request_body() ->
receive
{post, _, _, Body} ->
Body
after 100 ->
exit(waiting_message_timeout)
end.
receive_http_request_bodys() ->
receive_http_request_bodys_([]).
receive_http_request_bodys_(Acc) ->
receive
{post, _, _, Body} ->
receive_http_request_bodys_([Body|Acc])
after 1000 ->
lists:reverse(Acc)
end.
filter_topictab(TopicTab, {undefined}) ->
TopicTab;
filter_topictab(TopicTab, {TopicFilter}) ->
lists:filter(fun({Topic, _}) -> emqx_topic:match(Topic, TopicFilter) end, TopicTab).
filter_topic_match(_Topic, {undefined}) ->
true;
filter_topic_match(Topic, {TopicFilter}) ->
emqx_topic:match(Topic, TopicFilter).
encode(Bin, base64) ->
base64:encode(Bin);
encode(Bin, base62) ->
emqx_base62:encode(Bin);
encode(Bin, _) ->
Bin.
%%--------------------------------------------------------------------
%% Generators
%%--------------------------------------------------------------------
conn_properties() ->
#{}.
ack_properties() ->
#{}.
sub_properties() ->
#{}.
unsub_properties() ->
#{}.
shutdown_reason() ->
oneof([any(), {shutdown, atom()}]).
empty_env() ->
{undefined}.
topic_filter_env() ->
oneof([{<<"#">>}, {undefined}, {topic()}]).
payload_encode() ->
oneof([base62, base64, undefined]).
http_code() ->
oneof([socket_closed_remotely, others]).
disconnected_conninfo() ->
?LET(Info, conninfo(),
begin
Info#{disconnected_at => erlang:system_time(millisecond)}
end).