Merge pull request #15109 from rabbitmq/mergify/bp/v4.2.x/pr-15105

Introduce rabbit_data_coercion:to_boolean/1 (backport #15105)

Author: michaelklishin

deps/rabbit_common/src/rabbit_data_coercion.erl

@@ -7,7 +7,7 @@
 
 -module(rabbit_data_coercion).
 
--export([to_binary/1, to_list/1, to_atom/1, to_integer/1, to_proplist/1, to_map/1, to_map_recursive/1]).
+-export([to_binary/1, to_list/1, to_atom/1, to_integer/1, to_boolean/1, to_proplist/1, to_map/1, to_map_recursive/1]).
 -export([to_atom/2, atomize_keys/1, to_list_of_binaries/1]).
 -export([to_utf8_binary/1, to_unicode_charlist/1]).
 -export([as_list/1]).
@@ -56,6 +56,11 @@ to_integer(Val) when is_integer(Val) -> Val;
 to_integer(Val) when is_list(Val)    -> list_to_integer(Val);
 to_integer(Val) when is_binary(Val)  -> binary_to_integer(Val).
 
+-spec to_boolean(Val :: boolean() | list() | binary()) -> boolean().
+to_boolean(Val) when is_boolean(Val) -> Val;
+to_boolean(Val) when is_list(Val)    -> list_to_boolean(string:lowercase(Val));
+to_boolean(Val) when is_binary(Val)  -> list_to_boolean(string:lowercase(binary_to_list(Val))).
+
 -spec to_proplist(Val :: map() | list()) -> list().
 to_proplist(Val) when is_list(Val) -> Val;
 to_proplist(Val) when is_map(Val) -> maps:to_list(Val).
@@ -160,3 +165,6 @@ is_proplist_element(Atom) when is_atom(Atom) ->
     true;
 is_proplist_element(_) ->
     false.
+
+list_to_boolean("true")  -> true;
+list_to_boolean("false") -> false.

deps/rabbit_common/test/unit_SUITE.erl

@@ -50,6 +50,7 @@ groups() ->
             data_coercion_to_map_recursive_property,
             data_coercion_atomize_keys_proplist,
             data_coercion_atomize_keys_map,
+            data_coercion_to_boolean,
             pget,
             deep_pget,
             encrypt_decrypt,
@@ -287,6 +288,25 @@ data_coercion_atomize_keys_proplist(_Config) ->
     B = rabbit_data_coercion:atomize_keys([{a, 1}, {"b", 2}, {<<"c">>, 3}]),
     ?assertEqual(lists:usort(A), lists:usort(B)).
 
+data_coercion_to_boolean(_Config) ->
+    %% For booleans, this is an identity function
+    ?assertEqual(true, rabbit_data_coercion:to_boolean(true)),
+    ?assertEqual(false, rabbit_data_coercion:to_boolean(false)),
+    %% Strings (lists) are converted regardless of their case
+    ?assertEqual(true, rabbit_data_coercion:to_boolean("true")),
+    ?assertEqual(true, rabbit_data_coercion:to_boolean("TRUE")),
+    ?assertEqual(true, rabbit_data_coercion:to_boolean("True")),
+    ?assertEqual(false, rabbit_data_coercion:to_boolean("false")),
+    ?assertEqual(false, rabbit_data_coercion:to_boolean("FALSE")),
+    ?assertEqual(false, rabbit_data_coercion:to_boolean("False")),
+    %% Binaries are also converted regardless of their case
+    ?assertEqual(true, rabbit_data_coercion:to_boolean(<<"true">>)),
+    ?assertEqual(true, rabbit_data_coercion:to_boolean(<<"TRUE">>)),
+    ?assertEqual(true, rabbit_data_coercion:to_boolean(<<"True">>)),
+    ?assertEqual(false, rabbit_data_coercion:to_boolean(<<"false">>)),
+    ?assertEqual(false, rabbit_data_coercion:to_boolean(<<"FALSE">>)),
+    ?assertEqual(false, rabbit_data_coercion:to_boolean(<<"False">>)).
+
 data_coercion_to_list(_Config) ->
     ?assertEqual([{a, 1}], rabbit_data_coercion:to_list([{a, 1}])),
     ?assertEqual([{a, 1}], rabbit_data_coercion:to_list(#{a => 1})).