Rework virtual host-specific definition export

michaelklishin · michaelklishin · commit 48a16600aad0 · 2024-11-27T11:42:09.000-05:00
1. Add more metadata, see #12835 2. Include DQT Closes #12835
diff --git a/deps/rabbitmq_management/src/rabbit_mgmt_wm_definitions.erl b/deps/rabbitmq_management/src/rabbit_mgmt_wm_definitions.erl
@@ -58,30 +58,39 @@ all_definitions(ReqData, Context) ->
     Vsn = rabbit:base_product_version(),
     ProductName = rabbit:product_name(),
     ProductVersion = rabbit:product_version(),
-    rabbit_mgmt_util:reply(
-      [{rabbit_version, rabbit_data_coercion:to_binary(Vsn)},
-       {rabbitmq_version, rabbit_data_coercion:to_binary(Vsn)},
-       {product_name, rabbit_data_coercion:to_binary(ProductName)},
-       {product_version, rabbit_data_coercion:to_binary(ProductVersion)}] ++
-      retain_whitelisted(
-        [{users,             rabbit_mgmt_wm_users:users(all)},
-         {vhosts,            rabbit_mgmt_wm_vhosts:basic()},
-         {permissions,       rabbit_mgmt_wm_permissions:permissions()},
-         {topic_permissions, rabbit_mgmt_wm_topic_permissions:topic_permissions()},
-         {parameters,        rabbit_mgmt_wm_parameters:basic(ReqData)},
-         {global_parameters, rabbit_mgmt_wm_global_parameters:basic()},
-         {policies,          rabbit_mgmt_wm_policies:basic(ReqData)},
-         {queues,            Qs},
-         {exchanges,         Xs},
-         {bindings,          Bs}]),
-      case rabbit_mgmt_util:qs_val(<<"download">>, ReqData) of
-          undefined -> ReqData;
-          Filename  -> rabbit_mgmt_util:set_resp_header(
-                         <<"Content-Disposition">>,
-                         "attachment; filename=" ++
-                             binary_to_list(Filename), ReqData)
-      end,
-      Context).
+
+    Contents = [
+        {users,             rabbit_mgmt_wm_users:users(all)},
+        {vhosts,            rabbit_mgmt_wm_vhosts:basic()},
+        {permissions,       rabbit_mgmt_wm_permissions:permissions()},
+        {topic_permissions, rabbit_mgmt_wm_topic_permissions:topic_permissions()},
+        {parameters,        rabbit_mgmt_wm_parameters:basic(ReqData)},
+        {global_parameters, rabbit_mgmt_wm_global_parameters:basic()},
+        {policies,          rabbit_mgmt_wm_policies:basic(ReqData)},
+        {queues,            Qs},
+        {exchanges,         Xs},
+        {bindings,          Bs}
+    ],
+
+    TopLevelDefsAndMetadata = [
+        {rabbit_version, rabbit_data_coercion:to_binary(Vsn)},
+        {rabbitmq_version, rabbit_data_coercion:to_binary(Vsn)},
+        {product_name, rabbit_data_coercion:to_binary(ProductName)},
+        {product_version, rabbit_data_coercion:to_binary(ProductVersion)},
+        {rabbitmq_definition_format, <<"cluster">>},
+        {original_cluster_name, rabbit_nodes:cluster_name()},
+        {explanation, rabbit_data_coercion:to_binary(io_lib:format("Definitions of cluster '~ts'", [rabbit_nodes:cluster_name()]))}
+    ],
+    Result = TopLevelDefsAndMetadata ++ retain_whitelisted(Contents),
+    ReqData1 = case rabbit_mgmt_util:qs_val(<<"download">>, ReqData) of
+                   undefined -> ReqData;
+                   Filename  -> rabbit_mgmt_util:set_resp_header(
+                       <<"Content-Disposition">>,
+                       "attachment; filename=" ++
+                       binary_to_list(Filename), ReqData)
+               end,
+
+    rabbit_mgmt_util:reply(Result, ReqData1, Context).
 
 accept_json(ReqData0, Context) ->
     BodySizeLimit = application:get_env(rabbitmq_management, max_http_body_size, ?MANAGEMENT_DEFAULT_HTTP_MAX_BODY_SIZE),
@@ -94,7 +103,10 @@ accept_json(ReqData0, Context) ->
             accept(Body, ReqData, Context)
     end.
 
-vhost_definitions(ReqData, VHost, Context) ->
+vhost_definitions(ReqData, VHostName, Context) ->
+    %% the existence of this virtual host is verified in the called, 'to_json/2'
+    VHost = rabbit_vhost:lookup(VHostName),
+
     %% rabbit_mgmt_wm_<>:basic/1 filters by VHost if it is available.
     %% TODO: should we stop stripping virtual host? Such files cannot be imported on boot, for example.
     Xs = [strip_vhost(X) || X <- rabbit_mgmt_wm_exchanges:basic(ReqData),
@@ -105,25 +117,41 @@ vhost_definitions(ReqData, VHost, Context) ->
     %% TODO: should we stop stripping virtual host? Such files cannot be imported on boot, for example.
     Bs = [strip_vhost(B) || B <- rabbit_mgmt_wm_bindings:basic(ReqData),
                             export_binding(B, QNames)],
-    {ok, Vsn} = application:get_key(rabbit, vsn),
     Parameters = [strip_vhost(
                     rabbit_mgmt_format:parameter(P))
-                  || P <- rabbit_runtime_parameters:list(VHost)],
-    rabbit_mgmt_util:reply(
-      [{rabbit_version, rabbit_data_coercion:to_binary(Vsn)}] ++
-          retain_whitelisted(
-            [{parameters,  Parameters},
-             {policies,    [strip_vhost(P) || P <- rabbit_mgmt_wm_policies:basic(ReqData)]},
-             {queues,      Qs},
-             {exchanges,   Xs},
-             {bindings,    Bs}]),
-      case rabbit_mgmt_util:qs_val(<<"download">>, ReqData) of
-          undefined -> ReqData;
-          Filename  ->
-              HeaderVal = "attachment; filename=" ++ binary_to_list(Filename),
-              rabbit_mgmt_util:set_resp_header(<<"Content-Disposition">>, HeaderVal, ReqData)
-      end,
-      Context).
+                  || P <- rabbit_runtime_parameters:list(VHostName)],
+    Contents = [
+        {parameters,  Parameters},
+        {policies,    [strip_vhost(P) || P <- rabbit_mgmt_wm_policies:basic(ReqData)]},
+        {queues,      Qs},
+        {exchanges,   Xs},
+        {bindings,    Bs}
+    ],
+
+    Vsn = rabbit:base_product_version(),
+    ProductName = rabbit:product_name(),
+    ProductVersion = rabbit:product_version(),
+
+    TopLevelDefsAndMetadata = [
+        {rabbit_version, rabbit_data_coercion:to_binary(Vsn)},
+        {rabbitmq_version, rabbit_data_coercion:to_binary(Vsn)},
+        {product_name, rabbit_data_coercion:to_binary(ProductName)},
+        {product_version, rabbit_data_coercion:to_binary(ProductVersion)},
+        {rabbitmq_definition_format, <<"single_virtual_host">>},
+        {original_vhost_name, VHostName},
+        {explanation, rabbit_data_coercion:to_binary(io_lib:format("Definitions of virtual host '~ts'", [VHostName]))},
+        {description, vhost:get_description(VHost)},
+        {default_queue_type, rabbit_queue_type:short_alias_of(rabbit_vhost:default_queue_type(VHostName))}
+    ],
+    Result = TopLevelDefsAndMetadata ++ retain_whitelisted(Contents),
+
+    ReqData1 = case rabbit_mgmt_util:qs_val(<<"download">>, ReqData) of
+                   undefined -> ReqData;
+                   Filename  ->
+                       HeaderVal = "attachment; filename=" ++ binary_to_list(Filename),
+                       rabbit_mgmt_util:set_resp_header(<<"Content-Disposition">>, HeaderVal, ReqData)
+               end,
+    rabbit_mgmt_util:reply(Result, ReqData1, Context).
 
 accept_multipart(ReqData0, Context) ->
     {Parts, ReqData} = get_all_parts(ReqData0),
diff --git a/deps/rabbitmq_management/test/rabbit_mgmt_http_SUITE.erl b/deps/rabbitmq_management/test/rabbit_mgmt_http_SUITE.erl
@@ -92,7 +92,8 @@ definitions_group1_tests() ->
 definitions_group2_tests() ->
     [
         definitions_default_queue_type_test,
-        definitions_vhost_metadata_test
+        definitions_vhost_metadata_test,
+        definitions_file_metadata_test
     ].
 
 definitions_group3_tests() ->
@@ -2087,7 +2088,7 @@ long_definitions_vhosts(long_definitions_multipart_test) ->
 definitions_vhost_metadata_test(Config) ->
     register_parameters_and_policy_validator(Config),
 
-    VHostName = <<"definitions-vhost-metadata-test">>,
+    VHostName = rabbit_data_coercion:to_binary(?FUNCTION_NAME),
     Desc = <<"Created by definitions_vhost_metadata_test">>,
     DQT = <<"quorum">>,
     Tags = [<<"one">>, <<"tag-two">>],
@@ -2098,19 +2099,19 @@ definitions_vhost_metadata_test(Config) ->
     },
 
     %% Create a test vhost
-    http_put(Config, "/vhosts/definitions-vhost-metadata-test", Metadata, {group, '2xx'}),
+    http_put(Config, io_lib:format("/vhosts/~ts", [VHostName]), Metadata, {group, '2xx'}),
     PermArgs = [{configure, <<".*">>}, {write, <<".*">>}, {read, <<".*">>}],
-    http_put(Config, "/permissions/definitions-vhost-metadata-test/guest", PermArgs, {group, '2xx'}),
+    http_put(Config, io_lib:format("/permissions/~ts/guest", [VHostName]), PermArgs, {group, '2xx'}),
 
     %% Get the definitions
     Definitions = http_get(Config, "/definitions", ?OK),
+    ct:pal("Exported definitions:~n~tp~tn", [Definitions]),
 
     %% Check if vhost definition is correct
     VHosts = maps:get(vhosts, Definitions),
     {value, VH} = lists:search(fun(VH) ->
                                     maps:get(name, VH) =:= VHostName
                                 end, VHosts),
-    ct:pal("VHost: ~p", [VH]),
     ?assertEqual(#{
         name => VHostName,
         description => Desc,
@@ -2123,7 +2124,41 @@ definitions_vhost_metadata_test(Config) ->
     http_post(Config, "/definitions", Definitions, {group, '2xx'}),
 
     %% Remove the test vhost
-    http_delete(Config, "/vhosts/definitions-vhost-metadata-test", {group, '2xx'}),
+    http_delete(Config, io_lib:format("/vhosts/~ts", [VHostName]), {group, '2xx'}),
+    ok.
+
+definitions_file_metadata_test(Config) ->
+    register_parameters_and_policy_validator(Config),
+
+    VHostName = rabbit_data_coercion:to_binary(?FUNCTION_NAME),
+    Desc = <<"Created by definitions_vhost_metadata_test">>,
+    DQT = <<"quorum">>,
+    Tags = [<<"tag-one">>, <<"tag-two">>],
+    Metadata = #{
+        description => Desc,
+        default_queue_type => DQT,
+        tags => Tags
+    },
+
+    http_put(Config, io_lib:format("/vhosts/~ts", [VHostName]), Metadata, {group, '2xx'}),
+    PermArgs = [{configure, <<".*">>}, {write, <<".*">>}, {read, <<".*">>}],
+    http_put(Config, io_lib:format("/permissions/~ts/guest", [VHostName]), PermArgs, {group, '2xx'}),
+
+    AllDefinitions = http_get(Config, "/definitions", ?OK),
+    %% verify definitions file metadata
+    ?assertEqual(<<"cluster">>, maps:get(rabbitmq_definition_format, AllDefinitions)),
+    ?assert(is_binary(maps:get(original_cluster_name, AllDefinitions))),
+
+    %% Post the definitions back
+    http_post(Config, "/definitions", AllDefinitions, {group, '2xx'}),
+
+    VHDefinitions = http_get(Config, io_lib:format("/definitions/~ts", [VHostName]), ?OK),
+    %% verify definitions file metadata
+    ?assertEqual(<<"single_virtual_host">>, maps:get(rabbitmq_definition_format, VHDefinitions)),
+    ?assertEqual(VHostName, (maps:get(original_vhost_name, VHDefinitions))),
+
+    %% Remove the test vhost
+    http_delete(Config, io_lib:format("/vhosts/~ts", [VHostName]), {group, '2xx'}),
     ok.
 
 definitions_default_queue_type_test(Config) ->
