For 4.1.6: Definition export: convert proplists recursively before serializing #14793 (backport #14800) (backport #14805)

deps/rabbit/src/rabbit_definitions.erl

@@ -1112,10 +1112,10 @@ runtime_parameter_definition(Param) ->
 
 maybe_map(Value) ->
     %% Not all definitions are maps. `federation-upstream-set` is
-    %% a list of maps, and it should be exported as it has been
-    %% imported
+    %% a list of maps. We also need to recursively convert nested
+    %% proplists to maps (e.g. policy and operator policy definitions).
     try
-        rabbit_data_coercion:to_map(Value)
+        rabbit_data_coercion:to_map_recursive(Value)
     catch
         error:badarg ->
             Value

deps/rabbit/test/definition_import_SUITE.erl

@@ -71,7 +71,12 @@ groups() ->
 
         {roundtrip, [], [
             export_import_round_trip_case1,
-            export_import_round_trip_case2
+            export_import_round_trip_case2,
+            export_import_round_trip_operator_policy,
+            export_import_round_trip_vhost_limits,
+            export_import_round_trip_operator_policy_all_keys,
+            export_import_round_trip_multiple_operator_policies,
+            export_import_round_trip_mixed_parameters
         ]},
 
         {skip_if_unchanged, [], [
@@ -358,6 +363,105 @@ export_import_round_trip_case2(Config) ->
         {skip, "Should not run in mixed version environments"}
     end.
 
+run_if_not_mixed_versions(Fun) ->
+    case rabbit_ct_helpers:is_mixed_versions() of
+        false -> Fun();
+        _ -> {skip, "Should not run in mixed version environments"}
+    end.
+
+export_import_round_trip_operator_policy(Config) ->
+    run_if_not_mixed_versions(fun() ->
+        import_file_case(Config, "case23"),
+        Defs = export(Config),
+        Parameters = maps:get(parameters, Defs, []),
+        [OpPol] = [P || P <- Parameters,
+                        maps:get(<<"component">>, P) =:= <<"operator_policy">>,
+                        maps:get(<<"name">>, P) =:= <<"transient-queue-ttl">>],
+        Value = maps:get(<<"value">>, OpPol),
+        Definition = maps:get(<<"definition">>, Value),
+        ?assert(is_map(Definition)),
+        ?assertEqual(1800000, maps:get(<<"expires">>, Definition)),
+        ?assertEqual(60000, maps:get(<<"message-ttl">>, Definition)),
+        ?assertEqual(1000, maps:get(<<"max-length">>, Definition)),
+        import_parsed(Config, Defs)
+    end).
+
+export_import_round_trip_vhost_limits(Config) ->
+    run_if_not_mixed_versions(fun() ->
+        import_file_case(Config, "case6"),
+        Defs = export(Config),
+        Parameters = maps:get(parameters, Defs, []),
+        VHostLimits = lists:filter(
+            fun(P) ->
+                maps:get(<<"component">>, P, undefined) =:= <<"vhost-limits">>
+            end,
+            Parameters
+        ),
+        ?assertEqual(1, length(VHostLimits)),
+        [Limits] = VHostLimits,
+        Value = maps:get(<<"value">>, Limits),
+        ?assert(is_map(Value)),
+        ?assertEqual(456, maps:get(<<"max-queues">>, Value)),
+        ?assertEqual(123, maps:get(<<"max-connections">>, Value)),
+        import_parsed(Config, Defs)
+    end).
+
+export_import_round_trip_operator_policy_all_keys(Config) ->
+    run_if_not_mixed_versions(fun() ->
+        import_file_case(Config, "case24"),
+        Defs = export(Config),
+        Parameters = maps:get(parameters, Defs, []),
+        [OpPol] = [P || P <- Parameters,
+                        maps:get(<<"component">>, P) =:= <<"operator_policy">>,
+                        maps:get(<<"name">>, P) =:= <<"regulated-queues">>],
+        Value = maps:get(<<"value">>, OpPol),
+        Definition = maps:get(<<"definition">>, Value),
+        ?assert(is_map(Definition)),
+        ?assertEqual(4, maps:size(Definition)),
+        ?assertEqual(3600000, maps:get(<<"expires">>, Definition)),
+        ?assertEqual(300000, maps:get(<<"message-ttl">>, Definition)),
+        ?assertEqual(10000, maps:get(<<"max-length">>, Definition)),
+        ?assertEqual(104857600, maps:get(<<"max-length-bytes">>, Definition)),
+        import_parsed(Config, Defs)
+    end).
+
+export_import_round_trip_multiple_operator_policies(Config) ->
+    run_if_not_mixed_versions(fun() ->
+        import_file_case(Config, "case25"),
+        Defs = export(Config),
+        Parameters = maps:get(parameters, Defs, []),
+        ExpectedPolicies = [<<"transient-queues">>, <<"limited-queues">>, <<"archive-queues">>],
+        lists:foreach(fun(PolicyName) ->
+            [OpPol] = [P || P <- Parameters,
+                            maps:get(<<"component">>, P) =:= <<"operator_policy">>,
+                            maps:get(<<"name">>, P) =:= PolicyName],
+            Value = maps:get(<<"value">>, OpPol),
+            Definition = maps:get(<<"definition">>, Value),
+            ?assert(is_map(Definition)),
+            ?assert(maps:size(Definition) >= 2)
+        end, ExpectedPolicies),
+        import_parsed(Config, Defs)
+    end).
+
+export_import_round_trip_mixed_parameters(Config) ->
+    run_if_not_mixed_versions(fun() ->
+        import_file_case(Config, "case26"),
+        Defs = export(Config),
+        Parameters = maps:get(parameters, Defs, []),
+        [Limits] = [P || P <- Parameters,
+                         maps:get(<<"component">>, P) =:= <<"vhost-limits">>,
+                         maps:get(<<"name">>, P) =:= <<"limits">>],
+        LimitsValue = maps:get(<<"value">>, Limits),
+        ?assert(is_map(LimitsValue)),
+        [OpPol] = [P || P <- Parameters,
+                        maps:get(<<"component">>, P) =:= <<"operator_policy">>,
+                        maps:get(<<"name">>, P) =:= <<"temp-queues">>],
+        OpPolValue = maps:get(<<"value">>, OpPol),
+        OpPolDefinition = maps:get(<<"definition">>, OpPolValue),
+        ?assert(is_map(OpPolDefinition)),
+        import_parsed(Config, Defs)
+    end).
+
 import_on_a_booting_node_using_classic_local_source(Config) ->
     %% see case5.json
     VHost = <<"vhost2">>,

deps/rabbit/test/definition_import_SUITE_data/case23.json

@@ -0,0 +1,48 @@
+{
+  "rabbit_version": "4.2.0",
+  "users": [
+    {
+      "name": "guest",
+      "password_hash": "J+UiUxNQ3I8uPn6Lo2obWcl93VgXgbw4R+xhl3L5zHwkRFZG",
+      "hashing_algorithm": "rabbit_password_hashing_sha256",
+      "tags": "administrator"
+    }
+  ],
+  "vhosts": [
+    {
+      "name": "/"
+    }
+  ],
+  "permissions": [
+    {
+      "user": "guest",
+      "vhost": "/",
+      "configure": ".*",
+      "write": ".*",
+      "read": ".*"
+    }
+  ],
+  "topic_permissions": [],
+  "parameters": [
+    {
+      "value": {
+        "pattern": "^amq\\.",
+        "definition": {
+          "expires": 1800000,
+          "message-ttl": 60000,
+          "max-length": 1000
+        },
+        "priority": 1,
+        "apply-to": "queues"
+      },
+      "vhost": "/",
+      "component": "operator_policy",
+      "name": "transient-queue-ttl"
+    }
+  ],
+  "global_parameters": [],
+  "policies": [],
+  "queues": [],
+  "exchanges": [],
+  "bindings": []
+}

deps/rabbit/test/definition_import_SUITE_data/case24.json

@@ -0,0 +1,49 @@
+{
+  "rabbit_version": "4.2.0",
+  "users": [
+    {
+      "name": "guest",
+      "password_hash": "J+UiUxNQ3I8uPn6Lo2obWcl93VgXgbw4R+xhl3L5zHwkRFZG",
+      "hashing_algorithm": "rabbit_password_hashing_sha256",
+      "tags": "administrator"
+    }
+  ],
+  "vhosts": [
+    {
+      "name": "/"
+    }
+  ],
+  "permissions": [
+    {
+      "user": "guest",
+      "vhost": "/",
+      "configure": ".*",
+      "read": ".*",
+      "write": ".*"
+    }
+  ],
+  "topic_permissions": [],
+  "parameters": [
+    {
+      "value": {
+        "pattern": "^regulated\\.",
+        "definition": {
+          "expires": 3600000,
+          "message-ttl": 300000,
+          "max-length": 10000,
+          "max-length-bytes": 104857600
+        },
+        "priority": 1,
+        "apply-to": "queues"
+      },
+      "vhost": "/",
+      "component": "operator_policy",
+      "name": "regulated-queues"
+    }
+  ],
+  "global_parameters": [],
+  "policies": [],
+  "queues": [],
+  "exchanges": [],
+  "bindings": []
+}

deps/rabbit/test/definition_import_SUITE_data/case25.json

@@ -0,0 +1,77 @@
+{
+  "rabbit_version": "4.2.0",
+  "users": [
+    {
+      "name": "guest",
+      "password_hash": "J+UiUxNQ3I8uPn6Lo2obWcl93VgXgbw4R+xhl3L5zHwkRFZG",
+      "hashing_algorithm": "rabbit_password_hashing_sha256",
+      "tags": "administrator"
+    }
+  ],
+  "vhosts": [
+    {
+      "name": "/"
+    }
+  ],
+  "permissions": [
+    {
+      "user": "guest",
+      "vhost": "/",
+      "configure": ".*",
+      "read": ".*",
+      "write": ".*"
+    }
+  ],
+  "topic_permissions": [],
+  "parameters": [
+    {
+      "value": {
+        "pattern": "^transient\\.",
+        "definition": {
+          "expires": 300000,
+          "message-ttl": 60000
+        },
+        "priority": 10,
+        "apply-to": "queues"
+      },
+      "vhost": "/",
+      "component": "operator_policy",
+      "name": "transient-queues"
+    },
+    {
+      "value": {
+        "pattern": "^limited\\.",
+        "definition": {
+          "max-length": 5000,
+          "max-length-bytes": 10485760
+        },
+        "priority": 5,
+        "apply-to": "queues"
+      },
+      "vhost": "/",
+      "component": "operator_policy",
+      "name": "limited-queues"
+    },
+    {
+      "value": {
+        "pattern": "^archive\\.",
+        "definition": {
+          "expires": 2592000000,
+          "max-length": 100000,
+          "message-ttl": 86400000,
+          "max-length-bytes": 1073741824
+        },
+        "priority": 1,
+        "apply-to": "queues"
+      },
+      "vhost": "/",
+      "component": "operator_policy",
+      "name": "archive-queues"
+    }
+  ],
+  "global_parameters": [],
+  "policies": [],
+  "queues": [],
+  "exchanges": [],
+  "bindings": []
+}

deps/rabbit/test/definition_import_SUITE_data/case26.json

@@ -0,0 +1,56 @@
+{
+  "rabbit_version": "4.2.0",
+  "users": [
+    {
+      "name": "guest",
+      "password_hash": "J+UiUxNQ3I8uPn6Lo2obWcl93VgXgbw4R+xhl3L5zHwkRFZG",
+      "hashing_algorithm": "rabbit_password_hashing_sha256",
+      "tags": "administrator"
+    }
+  ],
+  "vhosts": [
+    {
+      "name": "/"
+    }
+  ],
+  "permissions": [
+    {
+      "user": "guest",
+      "vhost": "/",
+      "configure": ".*",
+      "read": ".*",
+      "write": ".*"
+    }
+  ],
+  "topic_permissions": [],
+  "parameters": [
+    {
+      "value": {
+        "max-connections": 500,
+        "max-queues": 1000
+      },
+      "vhost": "/",
+      "component": "vhost-limits",
+      "name": "limits"
+    },
+    {
+      "value": {
+        "pattern": "^temp\\.",
+        "definition": {
+          "expires": 1800000,
+          "max-length": 2000
+        },
+        "priority": 1,
+        "apply-to": "queues"
+      },
+      "vhost": "/",
+      "component": "operator_policy",
+      "name": "temp-queues"
+    }
+  ],
+  "global_parameters": [],
+  "policies": [],
+  "queues": [],
+  "exchanges": [],
+  "bindings": []
+}