refactor(rule): remove CLIs for rules

We will have new CLIs based on HTTP API in the future.
This commit is contained in:
Shawn 2021-09-22 15:52:55 +08:00
parent 5d89b8d33b
commit b055464f6b
2 changed files with 0 additions and 477 deletions

View File

@ -1,387 +0,0 @@
%%--------------------------------------------------------------------
%% Copyright (c) 2020-2021 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_rule_engine_cli).
-include("rule_engine.hrl").
-export([ load/0
, commands/0
, unload/0
]).
-export([ rules/1
, actions/1
, resources/1
, resource_types/1
]).
-import(proplists, [get_value/2]).
-define(OPTSPEC_RESOURCE_TYPE,
[{type, $t, "type", {atom, undefined}, "Resource Type"}]).
-define(OPTSPEC_ACTION_TYPE,
[ {eventype, $k, "eventype", {atom, undefined}, "Event Type"}
]).
-define(OPTSPEC_RESOURCES_CREATE,
[ {type, undefined, undefined, atom, "Resource Type"}
, {id, $i, "id", {binary, <<"">>}, "The resource id. A random resource id will be used if not provided"}
, {config, $c, "config", {binary, <<"{}">>}, "Config"}
, {descr, $d, "descr", {binary, <<"">>}, "Description"}
]).
-define(OPTSPEC_RESOURCES_UPDATE,
[ {id, undefined, undefined, binary, "The resource id"}
, {config, $c, "config", {binary, undefined}, "Config"}
, {description, $d, "descr", {binary, undefined}, "Description"}
]).
-define(OPTSPEC_RULES_CREATE,
[ {sql, undefined, undefined, binary, "Filter Condition SQL"}
, {actions, undefined, undefined, binary, "Action List in JSON format: [{\"name\": <action_name>, \"params\": {<key>: <value>}}]"}
, {id, $i, "id", {binary, <<"">>}, "The rule id. A random rule id will be used if not provided"}
, {enabled, $e, "enabled", {atom, true}, "'true' or 'false' to enable or disable the rule"}
, {on_action_failed, $g, "on_action_failed", {atom, continue}, "'continue' or 'stop' when an action in the rule fails"}
, {descr, $d, "descr", {binary, <<"">>}, "Description"}
]).
-define(OPTSPEC_RULES_UPDATE,
[ {id, undefined, undefined, binary, "Rule ID"}
, {sql, $s, "sql", {binary, undefined}, "Filter Condition SQL"}
, {actions, $a, "actions", {binary, undefined}, "Action List in JSON format: [{\"name\": <action_name>, \"params\": {<key>: <value>}}]"}
, {enabled, $e, "enabled", {atom, undefined}, "'true' or 'false' to enable or disable the rule"}
, {on_action_failed, $g, "on_action_failed", {atom, undefined}, "'continue' or 'stop' when an action in the rule fails"}
, {descr, $d, "descr", {binary, undefined}, "Description"}
]).
%%-----------------------------------------------------------------------------
%% Load/Unload Commands
%%-----------------------------------------------------------------------------
-spec(load() -> ok).
load() ->
lists:foreach(
fun({Cmd, Func}) ->
emqx_ctl:register_command(Cmd, {?MODULE, Func}, []);
(Cmd) ->
emqx_ctl:register_command(Cmd, {?MODULE, Cmd}, [])
end, commands()).
-spec(commands() -> list(atom())).
commands() ->
[rules, {'rule-actions', actions}, resources, {'resource-types', resource_types}].
-spec(unload() -> ok).
unload() ->
lists:foreach(
fun({Cmd, _Func}) ->
emqx_ctl:unregister_command(Cmd);
(Cmd) ->
emqx_ctl:unregister_command(Cmd)
end, commands()).
%%-----------------------------------------------------------------------------
%% 'rules' command
%%-----------------------------------------------------------------------------
-dialyzer([{nowarn_function, [rules/1]}]).
rules(["list"]) ->
print_all(emqx_rule_registry:get_rules_ordered_by_ts());
rules(["show", RuleId]) ->
print_with(fun emqx_rule_registry:get_rule/1, list_to_binary(RuleId));
rules(["create" | Params]) ->
with_opts(fun({Opts, _}) ->
case emqx_rule_engine:create_rule(make_rule(Opts)) of
{ok, #rule{id = RuleId}} ->
emqx_ctl:print("Rule ~s created~n", [RuleId]);
{error, Reason} ->
emqx_ctl:print("Invalid options: ~0p~n", [Reason])
end
end, Params, ?OPTSPEC_RULES_CREATE, {?FUNCTION_NAME, create});
rules(["update" | Params]) ->
with_opts(fun({Opts, _}) ->
case emqx_rule_engine:update_rule(make_updated_rule(Opts)) of
{ok, #rule{id = RuleId}} ->
emqx_ctl:print("Rule ~s updated~n", [RuleId]);
{error, Reason} ->
emqx_ctl:print("Invalid options: ~0p~n", [Reason])
end
end, Params, ?OPTSPEC_RULES_UPDATE, {?FUNCTION_NAME, update});
rules(["delete", RuleId]) ->
ok = emqx_rule_engine:delete_rule(list_to_binary(RuleId)),
emqx_ctl:print("ok~n");
rules(_Usage) ->
emqx_ctl:usage([{"rules list", "List all rules"},
{"rules show <RuleId>", "Show a rule"},
{"rules create", "Create a rule"},
{"rules delete <RuleId>", "Delete a rule"}
]).
%%-----------------------------------------------------------------------------
%% 'rule-actions' command
%%-----------------------------------------------------------------------------
actions(["list"]) ->
print_all(get_actions());
actions(["show", ActionId]) ->
print_with(fun emqx_rule_registry:find_action/1,
?RAISE(list_to_existing_atom(ActionId), {not_found, ActionId}));
actions(_Usage) ->
emqx_ctl:usage([{"rule-actions list", "List actions"},
{"rule-actions show <ActionId>", "Show a rule action"}
]).
%%------------------------------------------------------------------------------
%% 'resources' command
%%------------------------------------------------------------------------------
resources(["create" | Params]) ->
with_opts(fun({Opts, _}) ->
case emqx_rule_engine:create_resource(make_resource(Opts)) of
{ok, #resource{id = ResId}} ->
emqx_ctl:print("Resource ~s created~n", [ResId]);
{error, Reason} ->
emqx_ctl:print("Invalid options: ~0p~n", [Reason])
end
end, Params, ?OPTSPEC_RESOURCES_CREATE, {?FUNCTION_NAME, create});
resources(["update" | Params]) ->
with_opts(fun({Opts, _}) ->
Id = proplists:get_value(id, Opts),
Maps = make_updated_resource(Opts),
case emqx_rule_engine:update_resource(Id, Maps) of
ok ->
emqx_ctl:print("Resource update successfully~n");
{error, Reason} ->
emqx_ctl:print("Resource update failed: ~0p~n", [Reason])
end
end, Params, ?OPTSPEC_RESOURCES_UPDATE, {?FUNCTION_NAME, update});
resources(["test" | Params]) ->
with_opts(fun({Opts, _}) ->
case emqx_rule_engine:test_resource(make_resource(Opts)) of
ok ->
emqx_ctl:print("Test creating resource successfully (dry-run)~n");
{error, Reason} ->
emqx_ctl:print("Test creating resource failed: ~0p~n", [Reason])
end
end, Params, ?OPTSPEC_RESOURCES_CREATE, {?FUNCTION_NAME, test});
resources(["list"]) ->
print_all(emqx_rule_registry:get_resources());
resources(["list" | Params]) ->
with_opts(fun({Opts, _}) ->
print_all(emqx_rule_registry:get_resources_by_type(
get_value(type, Opts)))
end, Params, ?OPTSPEC_RESOURCE_TYPE, {?FUNCTION_NAME, list});
resources(["show", ResourceId]) ->
print_with(fun emqx_rule_registry:find_resource/1, list_to_binary(ResourceId));
resources(["delete", ResourceId]) ->
case emqx_rule_engine:delete_resource(list_to_binary(ResourceId)) of
ok -> emqx_ctl:print("ok~n");
{error, not_found} -> emqx_ctl:print("ok~n");
{error, Reason} ->
emqx_ctl:print("Cannot delete resource as ~0p~n", [Reason])
end;
resources(_Usage) ->
emqx_ctl:usage([{"resources create", "Create a resource"},
{"resources list [-t <ResourceType>]", "List resources"},
{"resources show <ResourceId>", "Show a resource"},
{"resources delete <ResourceId>", "Delete a resource"},
{"resources update <ResourceId> [-c <config>] [-d <description>]", "Update a resource"}
]).
%%------------------------------------------------------------------------------
%% 'resource-types' command
%%------------------------------------------------------------------------------
resource_types(["list"]) ->
print_all(emqx_rule_registry:get_resource_types());
resource_types(["show", Name]) ->
print_with(fun emqx_rule_registry:find_resource_type/1, list_to_atom(Name));
resource_types(_Usage) ->
emqx_ctl:usage([{"resource-types list", "List all resource-types"},
{"resource-types show <Type>", "Show a resource-type"}
]).
%%------------------------------------------------------------------------------
%% Internal functions
%%------------------------------------------------------------------------------
print(Data) ->
emqx_ctl:print(untilde(format(Data))).
print_all(DataList) ->
lists:map(fun(Data) ->
print(Data)
end, DataList).
print_with(FindFun, Key) ->
case FindFun(Key) of
{ok, R} ->
print(R);
not_found ->
emqx_ctl:print("Cannot found ~s~n", [Key])
end.
format(#rule{id = Id,
for = Hook,
rawsql = Sql,
actions = Actions,
on_action_failed = OnFailed,
enabled = Enabled,
description = Descr}) ->
lists:flatten(io_lib:format("rule(id='~s', for='~0p', rawsql='~s', actions=~0p, on_action_failed='~s', metrics=~0p, enabled='~s', description='~s')~n", [Id, Hook, rmlf(Sql), printable_actions(Actions), OnFailed, get_rule_metrics(Id), Enabled, Descr]));
format(#action{hidden = true}) ->
ok;
format(#action{name = Name,
for = Hook,
app = App,
types = Types,
title = #{en := Title},
description = #{en := Descr}}) ->
lists:flatten(io_lib:format("action(name='~s', app='~s', for='~s', types=~0p, title ='~s', description='~s')~n", [Name, App, Hook, Types, Title, Descr]));
format(#resource{id = Id,
type = Type,
config = Config,
description = Descr}) ->
Status =
[begin
{ok, St} = rpc:call(Node, emqx_rule_engine, get_resource_status, [Id]),
maps:put(node, Node, St)
end || Node <- [node()| nodes()]],
lists:flatten(io_lib:format("resource(id='~s', type='~s', config=~0p, status=~0p, description='~s')~n", [Id, Type, Config, Status, Descr]));
format(#resource_type{name = Name,
provider = Provider,
title = #{en := Title},
description = #{en := Descr}}) ->
lists:flatten(io_lib:format("resource_type(name='~s', provider='~s', title ='~s', description='~s')~n", [Name, Provider, Title, Descr])).
make_rule(Opts) ->
Actions = get_value(actions, Opts),
may_with_opt(
#{rawsql => get_value(sql, Opts),
enabled => get_value(enabled, Opts),
actions => parse_actions(emqx_json:decode(Actions, [return_maps])),
on_action_failed => on_failed(get_value(on_action_failed, Opts)),
description => get_value(descr, Opts)}, id, <<"">>, Opts).
make_updated_rule(Opts) ->
KeyNameParsers = [{sql, rawsql, fun(SQL) -> SQL end},
enabled,
{actions, actions, fun(Actions) ->
parse_actions(emqx_json:decode(Actions, [return_maps]))
end},
on_action_failed,
{descr, description, fun(Descr) -> Descr end}],
lists:foldl(fun
({Key, Name, Parser}, ParamsAcc) ->
case get_value(Key, Opts) of
undefined -> ParamsAcc;
Val -> ParamsAcc#{Name => Parser(Val)}
end;
(Key, ParamsAcc) ->
case get_value(Key, Opts) of
undefined -> ParamsAcc;
Val -> ParamsAcc#{Key => Val}
end
end, #{id => get_value(id, Opts)}, KeyNameParsers).
make_resource(Opts) ->
Config = get_value(config, Opts),
may_with_opt(
#{type => get_value(type, Opts),
config => ?RAISE(emqx_json:decode(Config, [return_maps]), {invalid_config, Config}),
description => get_value(descr, Opts)}, id, <<"">>, Opts).
make_updated_resource(Opts) ->
P1 = case proplists:get_value(description, Opts) of
undefined -> #{};
Value -> #{<<"description">> => Value}
end,
P2 = case proplists:get_value(config, Opts) of
undefined -> #{};
Map -> #{<<"config">> => ?RAISE((emqx_json:decode(Map, [return_maps])), {invalid_config, Map})}
end,
maps:merge(P1, P2).
printable_actions(Actions) when is_list(Actions) ->
emqx_json:encode([#{id => Id, name => Name, params => Args,
metrics => get_action_metrics(Id),
fallbacks => printable_actions(Fallbacks)}
|| #action_instance{id = Id, name = Name, args = Args, fallbacks = Fallbacks} <- Actions]).
may_with_opt(Params, OptName, DefaultVal, Options) when is_map(Params) ->
case get_value(OptName, Options) of
DefaultVal -> Params;
Val -> Params#{OptName => Val}
end.
with_opts(Action, RawParams, OptSpecList, {CmdObject, CmdName}) ->
case getopt:parse_and_check(OptSpecList, RawParams) of
{ok, Params} ->
Action(Params);
{error, Reason} ->
getopt:usage(OptSpecList,
io_lib:format("emqx_ctl ~s ~s", [CmdObject, CmdName]), standard_io),
emqx_ctl:print("~0p~n", [Reason])
end.
parse_actions(Actions) ->
?RAISE([parse_action(Action) || Action <- Actions],
{invalid_action_params, {_EXCLASS_,_EXCPTION_,_ST_}}).
parse_action(Action) ->
ActName = maps:get(<<"name">>, Action),
#{name => ?RAISE(binary_to_existing_atom(ActName, utf8), {action_not_found, ActName}),
args => maps:get(<<"params">>, Action, #{}),
fallbacks => parse_actions(maps:get(<<"fallbacks">>, Action, []))}.
get_actions() ->
emqx_rule_registry:get_actions().
get_rule_metrics(Id) ->
[maps:put(node, Node, rpc:call(Node, emqx_rule_metrics, get_rule_metrics, [Id]))
|| Node <- [node()| nodes()]].
get_action_metrics(Id) ->
[maps:put(node, Node, rpc:call(Node, emqx_rule_metrics, get_action_metrics, [Id]))
|| Node <- [node()| nodes()]].
on_failed(continue) -> continue;
on_failed(stop) -> stop;
on_failed(OnFailed) -> error({invalid_on_failed, OnFailed}).
rmlf(Str) ->
re:replace(Str, "\n", "", [global]).
untilde(Str) ->
re:replace(Str, "~", "&&", [{return, list}, global]).

View File

@ -508,96 +508,6 @@ t_show_resource_type_api(_Config) ->
?assertEqual(built_in, maps:get(name, RShow)),
ok.
%%------------------------------------------------------------------------------
%% Test cases for rule engine cli
%%------------------------------------------------------------------------------
t_rules_cli(_Config) ->
mock_print(),
RCreate = emqx_rule_engine_cli:rules(["create",
"select * from \"t1\" where topic='t1'",
"[{\"name\":\"inspect\", \"params\": {\"arg1\": 1}}]",
"-d", "Debug Rule"]),
%ct:pal("Result : ~p", [RCreate]),
?assertMatch({match, _}, re:run(RCreate, "created")),
RuleId = re:replace(re:replace(RCreate, "Rule\s", "", [{return, list}]), "\screated\n", "", [{return, list}]),
RList = emqx_rule_engine_cli:rules(["list"]),
?assertMatch({match, _}, re:run(RList, RuleId)),
%ct:pal("RList : ~p", [RList]),
%ct:pal("table action params: ~p", [ets:tab2list(emqx_action_instance_params)]),
RShow = emqx_rule_engine_cli:rules(["show", RuleId]),
?assertMatch({match, _}, re:run(RShow, RuleId)),
%ct:pal("RShow : ~p", [RShow]),
RUpdate = emqx_rule_engine_cli:rules(["update",
RuleId,
"-s", "select * from \"t2\""]),
?assertMatch({match, _}, re:run(RUpdate, "updated")),
RDelete = emqx_rule_engine_cli:rules(["delete", RuleId]),
?assertEqual("ok~n", RDelete),
%ct:pal("RDelete : ~p", [RDelete]),
%ct:pal("table action params after deleted: ~p", [ets:tab2list(emqx_action_instance_params)]),
RShow2 = emqx_rule_engine_cli:rules(["show", RuleId]),
?assertMatch({match, _}, re:run(RShow2, "Cannot found")),
%ct:pal("RShow2 : ~p", [RShow2]),
unmock_print(),
ok.
t_actions_cli(_Config) ->
mock_print(),
RList = emqx_rule_engine_cli:actions(["list"]),
?assertMatch({match, _}, re:run(RList, "inspect")),
%ct:pal("RList : ~p", [RList]),
RShow = emqx_rule_engine_cli:actions(["show", "inspect"]),
?assertMatch({match, _}, re:run(RShow, "inspect")),
%ct:pal("RShow : ~p", [RShow]),
unmock_print(),
ok.
t_resources_cli(_Config) ->
mock_print(),
RCreate = emqx_rule_engine_cli:resources(["create", "built_in", "{\"a\" : 1}", "-d", "test resource"]),
ResId = re:replace(re:replace(RCreate, "Resource\s", "", [{return, list}]), "\screated\n", "", [{return, list}]),
RList = emqx_rule_engine_cli:resources(["list"]),
?assertMatch({match, _}, re:run(RList, "test resource")),
%ct:pal("RList : ~p", [RList]),
RListT = emqx_rule_engine_cli:resources(["list", "-t", "built_in"]),
?assertMatch({match, _}, re:run(RListT, "test resource")),
%ct:pal("RListT : ~p", [RListT]),
RShow = emqx_rule_engine_cli:resources(["show", ResId]),
?assertMatch({match, _}, re:run(RShow, "test resource")),
%ct:pal("RShow : ~p", [RShow]),
RDelete = emqx_rule_engine_cli:resources(["delete", ResId]),
?assertEqual("ok~n", RDelete),
RShow2 = emqx_rule_engine_cli:resources(["show", ResId]),
?assertMatch({match, _}, re:run(RShow2, "Cannot found")),
%ct:pal("RShow2 : ~p", [RShow2]),
unmock_print(),
ok.
t_resource_types_cli(_Config) ->
mock_print(),
RList = emqx_rule_engine_cli:resource_types(["list"]),
?assertMatch({match, _}, re:run(RList, "built_in")),
%ct:pal("RList : ~p", [RList]),
RShow = emqx_rule_engine_cli:resource_types(["show", "inspect"]),
?assertMatch({match, _}, re:run(RShow, "inspect")),
%ct:pal("RShow : ~p", [RShow]),
unmock_print(),
ok.
%%------------------------------------------------------------------------------
%% Test cases for rule funcs
%%------------------------------------------------------------------------------