From 4c6739161dc9e201ab339e78364f083958a6c55b Mon Sep 17 00:00:00 2001 From: zhanghongtong Date: Thu, 29 Jul 2021 15:41:46 +0800 Subject: [PATCH] chore(emqx authz): rename root name for authz conf Signed-off-by: zhanghongtong --- apps/emqx/src/emqx_schema.erl | 4 ++-- apps/emqx_authz/etc/emqx_authz.conf | 2 +- apps/emqx_authz/src/emqx_authz.erl | 2 +- apps/emqx_authz/src/emqx_authz_mysql.erl | 4 ++-- apps/emqx_authz/src/emqx_authz_pgsql.erl | 4 ++-- apps/emqx_authz/src/emqx_authz_schema.erl | 4 ++-- apps/emqx_authz/test/emqx_authz_api_SUITE.erl | 6 +++--- apps/emqx_authz/test/emqx_authz_http_SUITE.erl | 12 +++++++----- apps/emqx_authz/test/emqx_authz_mongo_SUITE.erl | 6 +++--- apps/emqx_authz/test/emqx_authz_mysql_SUITE.erl | 12 +++++++----- apps/emqx_authz/test/emqx_authz_pgsql_SUITE.erl | 12 +++++++----- apps/emqx_authz/test/emqx_authz_redis_SUITE.erl | 12 +++++++----- extension_schemas.config | 2 +- 13 files changed, 45 insertions(+), 37 deletions(-) diff --git a/apps/emqx/src/emqx_schema.erl b/apps/emqx/src/emqx_schema.erl index bf1e4cf51..a317611fa 100644 --- a/apps/emqx/src/emqx_schema.erl +++ b/apps/emqx/src/emqx_schema.erl @@ -244,7 +244,7 @@ fields("auth") -> [ {"enable", t(boolean(), undefined, false)} ]; -fields("authorization") -> +fields("authorization_settings") -> [ {"enable", t(boolean(), undefined, true)} , {"cache", ref("authorization_cache")} , {"deny_action", t(union(ignore, disconnect), undefined, ignore)} @@ -293,7 +293,7 @@ fields("zones") -> fields("zone_settings") -> [ {"mqtt", ref("mqtt")} - , {"authorization", ref("authorization")} + , {"authorization", ref("authorization_settings")} , {"auth", ref("auth")} , {"stats", ref("stats")} , {"flapping_detect", ref("flapping_detect")} diff --git a/apps/emqx_authz/etc/emqx_authz.conf b/apps/emqx_authz/etc/emqx_authz.conf index a9b696b35..8826a94f7 100644 --- a/apps/emqx_authz/etc/emqx_authz.conf +++ b/apps/emqx_authz/etc/emqx_authz.conf @@ -1,4 +1,4 @@ -emqx_authz:{ +authorization:{ rules: [ # { # type: http diff --git a/apps/emqx_authz/src/emqx_authz.erl b/apps/emqx_authz/src/emqx_authz.erl index c420a1d78..4c3268353 100644 --- a/apps/emqx_authz/src/emqx_authz.erl +++ b/apps/emqx_authz/src/emqx_authz.erl @@ -33,7 +33,7 @@ -export([post_config_update/2, pre_config_update/2]). --define(CONF_KEY_PATH, [emqx_authz, rules]). +-define(CONF_KEY_PATH, [authorization, rules]). -spec(register_metrics() -> ok). register_metrics() -> diff --git a/apps/emqx_authz/src/emqx_authz_mysql.erl b/apps/emqx_authz/src/emqx_authz_mysql.erl index e8ec300b3..2ce991eba 100644 --- a/apps/emqx_authz/src/emqx_authz_mysql.erl +++ b/apps/emqx_authz/src/emqx_authz_mysql.erl @@ -47,8 +47,8 @@ parse_query(Sql) -> authorize(Client, PubSub, Topic, #{annotations := #{id := ResourceID, - sql := {SQL, Params} - } + sql := {SQL, Params} + } }) -> case emqx_resource:query(ResourceID, {sql, SQL, replvar(Params, Client)}) of {ok, _Columns, []} -> nomatch; diff --git a/apps/emqx_authz/src/emqx_authz_pgsql.erl b/apps/emqx_authz/src/emqx_authz_pgsql.erl index c94afd885..f3e793763 100644 --- a/apps/emqx_authz/src/emqx_authz_pgsql.erl +++ b/apps/emqx_authz/src/emqx_authz_pgsql.erl @@ -51,8 +51,8 @@ parse_query(Sql) -> authorize(Client, PubSub, Topic, #{annotations := #{id := ResourceID, - sql := {SQL, Params} - } + sql := {SQL, Params} + } }) -> case emqx_resource:query(ResourceID, {sql, SQL, replvar(Params, Client)}) of {ok, _Columns, []} -> nomatch; diff --git a/apps/emqx_authz/src/emqx_authz_schema.erl b/apps/emqx_authz/src/emqx_authz_schema.erl index 94b7ce158..cc109534f 100644 --- a/apps/emqx_authz/src/emqx_authz_schema.erl +++ b/apps/emqx_authz/src/emqx_authz_schema.erl @@ -17,9 +17,9 @@ , fields/1 ]). -structs() -> ["emqx_authz"]. +structs() -> ["authorization"]. -fields("emqx_authz") -> +fields("authorization") -> [ {rules, rules()} ]; fields(http) -> diff --git a/apps/emqx_authz/test/emqx_authz_api_SUITE.erl b/apps/emqx_authz/test/emqx_authz_api_SUITE.erl index 3ae019e36..d8077420c 100644 --- a/apps/emqx_authz/test/emqx_authz_api_SUITE.erl +++ b/apps/emqx_authz/test/emqx_authz_api_SUITE.erl @@ -43,12 +43,12 @@ groups() -> []. init_per_suite(Config) -> + ok = emqx_ct_helpers:start_apps([emqx_authz]), %% important! let emqx_schema include the current app! meck:new(emqx_schema, [non_strict, passthrough, no_history, no_link]), - meck:expect(emqx_schema, includes, fun() -> ["emqx_authz"] end ), + meck:expect(emqx_schema, includes, fun() -> ["authorization"] end ), meck:expect(emqx_schema, extra_schema_fields, fun(FieldName) -> emqx_authz_schema:fields(FieldName) end), - ok = emqx_ct_helpers:start_apps([emqx_authz]), %create_default_app(), Config. @@ -92,7 +92,7 @@ t_api_unit_test(_Config) -> principal := #{'and' := [#{username := <<"^test?">>}, #{clientid := <<"^test?">>}]}, - topics := [<<"%u">>]}] = emqx_config:get([emqx_authz, rules]). + topics := [<<"%u">>]}] = emqx_config:get([authorization, rules]). % t_api(_Config) -> % Rule1 = #{<<"principal">> => diff --git a/apps/emqx_authz/test/emqx_authz_http_SUITE.erl b/apps/emqx_authz/test/emqx_authz_http_SUITE.erl index 0a68dd06a..eaa3ec99f 100644 --- a/apps/emqx_authz/test/emqx_authz_http_SUITE.erl +++ b/apps/emqx_authz/test/emqx_authz_http_SUITE.erl @@ -29,14 +29,16 @@ groups() -> []. init_per_suite(Config) -> - %% important! let emqx_schema include the current app! - meck:new(emqx_schema, [non_strict, passthrough, no_history, no_link]), - meck:expect(emqx_schema, includes, fun() -> ["emqx_authz"] end ), - meck:expect(emqx_schema, extra_schema_fields, fun(FieldName) -> emqx_authz_schema:fields(FieldName) end), + ok = emqx_ct_helpers:start_apps([emqx_authz]), meck:new(emqx_resource, [non_strict, passthrough, no_history, no_link]), meck:expect(emqx_resource, create, fun(_, _, _) -> {ok, meck_data} end ), - ok = emqx_ct_helpers:start_apps([emqx_authz]), + + %% important! let emqx_schema include the current app! + meck:new(emqx_schema, [non_strict, passthrough, no_history, no_link]), + meck:expect(emqx_schema, includes, fun() -> ["authorization"] end ), + meck:expect(emqx_schema, extra_schema_fields, fun(FieldName) -> emqx_authz_schema:fields(FieldName) end), + ok = emqx_config:update([zones, default, authorization, cache, enable], false), ok = emqx_config:update([zones, default, authorization, enable], true), Rules = [#{ <<"config">> => #{ diff --git a/apps/emqx_authz/test/emqx_authz_mongo_SUITE.erl b/apps/emqx_authz/test/emqx_authz_mongo_SUITE.erl index 803979eb6..bf1c3318f 100644 --- a/apps/emqx_authz/test/emqx_authz_mongo_SUITE.erl +++ b/apps/emqx_authz/test/emqx_authz_mongo_SUITE.erl @@ -29,16 +29,16 @@ groups() -> []. init_per_suite(Config) -> + ok = emqx_ct_helpers:start_apps([emqx_authz]), + meck:new(emqx_resource, [non_strict, passthrough, no_history, no_link]), meck:expect(emqx_resource, create, fun(_, _, _) -> {ok, meck_data} end ), %% important! let emqx_schema include the current app! meck:new(emqx_schema, [non_strict, passthrough, no_history, no_link]), - meck:expect(emqx_schema, includes, fun() -> ["emqx_authz"] end ), + meck:expect(emqx_schema, includes, fun() -> ["authorization"] end ), meck:expect(emqx_schema, extra_schema_fields, fun(FieldName) -> emqx_authz_schema:fields(FieldName) end), - ok = emqx_ct_helpers:start_apps([emqx_authz]), - ct:pal("---- emqx_hooks: ~p", [ets:tab2list(emqx_hooks)]), ok = emqx_config:update([zones, default, authorization, cache, enable], false), ok = emqx_config:update([zones, default, authorization, enable], true), Rules = [#{ <<"config">> => #{ diff --git a/apps/emqx_authz/test/emqx_authz_mysql_SUITE.erl b/apps/emqx_authz/test/emqx_authz_mysql_SUITE.erl index 9a57a69f7..e69fcbe21 100644 --- a/apps/emqx_authz/test/emqx_authz_mysql_SUITE.erl +++ b/apps/emqx_authz/test/emqx_authz_mysql_SUITE.erl @@ -29,14 +29,16 @@ groups() -> []. init_per_suite(Config) -> - %% important! let emqx_schema include the current app! - meck:new(emqx_schema, [non_strict, passthrough, no_history, no_link]), - meck:expect(emqx_schema, includes, fun() -> ["emqx_authz"] end ), - meck:expect(emqx_schema, extra_schema_fields, fun(FieldName) -> emqx_authz_schema:fields(FieldName) end), + ok = emqx_ct_helpers:start_apps([emqx_authz]), meck:new(emqx_resource, [non_strict, passthrough, no_history, no_link]), meck:expect(emqx_resource, create, fun(_, _, _) -> {ok, meck_data} end ), - ok = emqx_ct_helpers:start_apps([emqx_authz]), + + %% important! let emqx_schema include the current app! + meck:new(emqx_schema, [non_strict, passthrough, no_history, no_link]), + meck:expect(emqx_schema, includes, fun() -> ["authorization"] end ), + meck:expect(emqx_schema, extra_schema_fields, fun(FieldName) -> emqx_authz_schema:fields(FieldName) end), + ok = emqx_config:update([zones, default, authorization, cache, enable], false), ok = emqx_config:update([zones, default, authorization, enable], true), Rules = [#{ <<"config">> => #{ diff --git a/apps/emqx_authz/test/emqx_authz_pgsql_SUITE.erl b/apps/emqx_authz/test/emqx_authz_pgsql_SUITE.erl index aee01e38b..64ae4302e 100644 --- a/apps/emqx_authz/test/emqx_authz_pgsql_SUITE.erl +++ b/apps/emqx_authz/test/emqx_authz_pgsql_SUITE.erl @@ -29,14 +29,16 @@ groups() -> []. init_per_suite(Config) -> - %% important! let emqx_schema include the current app! - meck:new(emqx_schema, [non_strict, passthrough, no_history, no_link]), - meck:expect(emqx_schema, includes, fun() -> ["emqx_authz"] end ), - meck:expect(emqx_schema, extra_schema_fields, fun(FieldName) -> emqx_authz_schema:fields(FieldName) end), + ok = emqx_ct_helpers:start_apps([emqx_authz]), meck:new(emqx_resource, [non_strict, passthrough, no_history, no_link]), meck:expect(emqx_resource, create, fun(_, _, _) -> {ok, meck_data} end ), - ok = emqx_ct_helpers:start_apps([emqx_authz]), + + %% important! let emqx_schema include the current app! + meck:new(emqx_schema, [non_strict, passthrough, no_history, no_link]), + meck:expect(emqx_schema, includes, fun() -> ["authorization"] end ), + meck:expect(emqx_schema, extra_schema_fields, fun(FieldName) -> emqx_authz_schema:fields(FieldName) end), + ok = emqx_config:update([zones, default, authorization, cache, enable], false), ok = emqx_config:update([zones, default, authorization, enable], true), Rules = [#{ <<"config">> => #{ diff --git a/apps/emqx_authz/test/emqx_authz_redis_SUITE.erl b/apps/emqx_authz/test/emqx_authz_redis_SUITE.erl index 42429624e..f5badd610 100644 --- a/apps/emqx_authz/test/emqx_authz_redis_SUITE.erl +++ b/apps/emqx_authz/test/emqx_authz_redis_SUITE.erl @@ -29,14 +29,16 @@ groups() -> []. init_per_suite(Config) -> - %% important! let emqx_schema include the current app! - meck:new(emqx_schema, [non_strict, passthrough, no_history, no_link]), - meck:expect(emqx_schema, includes, fun() -> ["emqx_authz"] end ), - meck:expect(emqx_schema, extra_schema_fields, fun(FieldName) -> emqx_authz_schema:fields(FieldName) end), + ok = emqx_ct_helpers:start_apps([emqx_authz]), meck:new(emqx_resource, [non_strict, passthrough, no_history, no_link]), meck:expect(emqx_resource, create, fun(_, _, _) -> {ok, meck_data} end ), - ok = emqx_ct_helpers:start_apps([emqx_authz]), + + %% important! let emqx_schema include the current app! + meck:new(emqx_schema, [non_strict, passthrough, no_history, no_link]), + meck:expect(emqx_schema, includes, fun() -> ["authorization"] end ), + meck:expect(emqx_schema, extra_schema_fields, fun(FieldName) -> emqx_authz_schema:fields(FieldName) end), + ok = emqx_config:update([zones, default, authorization, cache, enable], false), ok = emqx_config:update([zones, default, authorization, enable], true), Rules = [#{ <<"config">> => #{ diff --git a/extension_schemas.config b/extension_schemas.config index ee577083b..2eb4f3d08 100644 --- a/extension_schemas.config +++ b/extension_schemas.config @@ -6,7 +6,7 @@ [ {"emqx_data_bridge", emqx_data_bridge_schema} , {"emqx_retainer", emqx_retainer_schema} , {"emqx_authn", emqx_authn_schema} -, {"emqx_authz", emqx_authz_schema} +, {"authorization", emqx_authz_schema} , {"emqx_bridge_mqtt", emqx_bridge_mqtt_schema} , {"emqx_modules", emqx_modules_schema} , {"emqx_management", emqx_management_schema}