Move rabbit_ct_hook to rabbit_common

Author: ikavgo

deps/rabbit_common/Makefile

@@ -27,7 +27,6 @@ endef
 
 LOCAL_DEPS = compiler crypto public_key sasl ssl syntax_tools tools xmerl runtime_tools
 DEPS = thoas ranch recon credentials_obfuscation
-TEST_DEPS = rabbitmq_ct_helpers
 
 # Variables and recipes in development.*.mk are meant to be used from
 # any Git clone. They are excluded from the files published to Hex.pm.

deps/rabbit_common/src/rabbit_ct_hook.erl

@@ -0,0 +1,64 @@
+-module(rabbit_ct_hook).
+
+-export([init/2]).
+
+-include_lib("common_test/include/ct.hrl").
+-include_lib("kernel/include/logger.hrl").
+
+init(_, _) ->
+    ct:log(
+      ?LOW_IMPORTANCE,
+      "Configuring logger to send logs to common_test logs"),
+    ok = logger:set_handler_config(cth_log_redirect, level, debug),
+
+    %% Let's use the same format as RabbitMQ itself.
+    ok = logger:set_handler_config(
+           cth_log_redirect, formatter,
+           default_file_formatter(#{})),
+
+    %% We use an addition logger handler for messages tagged with a non-OTP
+    %% domain because by default, `cth_log_redirect' drop them.
+    {ok, LogCfg0} = logger:get_handler_config(cth_log_redirect),
+    LogCfg = maps:remove(id, maps:remove(module, LogCfg0)),
+
+    case catch
+             logger:add_handler(
+               cth_log_redirect_any_domains, cth_log_redirect_any_domains,
+               LogCfg) of
+             ok -> ok;
+             {error, {invalid_handler, _}} ->
+                 ok
+         end,
+
+    ok = logger:remove_handler(default),
+
+    ct:log(
+      ?LOW_IMPORTANCE,
+      "Logger configured to send logs to common_test logs; you should see "
+      "a message below saying so"),
+    ?LOG_INFO("Logger message logged to common_test logs"),
+    {ok, undefined}.
+
+default_file_formatter(Context) ->
+    default_formatter(Context#{output_supports_colors => false}).
+
+
+default_formatter(#{log_levels := #{json := true}} = Context) ->
+    SingleLine = format_msgs_as_single_lines(Context),
+    {rabbit_logger_json_fmt, #{single_line => SingleLine}};
+default_formatter(Context) ->
+    Color = use_colored_logging(Context),
+    SingleLine = format_msgs_as_single_lines(Context),
+    {rabbit_logger_text_fmt, #{use_colors => Color,
+                               single_line => SingleLine}}.
+
+format_msgs_as_single_lines(#{log_levels := #{single_line := true}}) ->
+    true;
+format_msgs_as_single_lines(_) ->
+    false.
+
+use_colored_logging(#{log_levels := #{color := true},
+                      output_supports_colors := true}) ->
+    true;
+use_colored_logging(_) ->
+    false.

deps/rabbitmq_ct_helpers/Makefile

@@ -16,6 +16,7 @@ XREF_IGNORE = [ \
 
 dep_inet_tcp_proxy = git https://github.com/rabbitmq/inet_tcp_proxy master
 
+CT_HOOKS = rabbit_ct_hook
 DEP_EARLY_PLUGINS = rabbit_common/mk/rabbitmq-early-plugin.mk
 DEP_PLUGINS = rabbit_common/mk/rabbitmq-plugin.mk
 

deps/rabbitmq_ct_helpers/src/rabbit_ct_helpers.erl

@@ -7,7 +7,6 @@
 
 -module(rabbit_ct_helpers).
 
--include_lib("kernel/include/logger.hrl").
 -include_lib("common_test/include/ct.hrl").
 
 -deprecated({is_mixed_versions,1,"Use is_mixed_versions/0 instead"}).
@@ -28,7 +27,6 @@
     ensure_rabbitmq_plugins_cmd/1,
     ensure_rabbitmq_queues_cmd/1,
     ensure_rabbitmq_diagnostics_cmd/1,
-    redirect_logger_to_ct_logs/1,
     init_skip_as_error_flag/1,
     start_long_running_testsuite_monitor/1,
     stop_long_running_testsuite_monitor/1,
@@ -153,34 +151,6 @@ run_steps(Config, [Step | Rest]) ->
 run_steps(Config, []) ->
     Config.
 
-redirect_logger_to_ct_logs(Config) ->
-    ct:log(
-      ?LOW_IMPORTANCE,
-      "Configuring logger to send logs to common_test logs"),
-    ok = logger:set_handler_config(cth_log_redirect, level, debug),
-
-    %% Let's use the same format as RabbitMQ itself.
-    ok = logger:set_handler_config(
-      cth_log_redirect, formatter,
-      rabbit_prelaunch_early_logging:default_file_formatter(#{})),
-
-    %% We use an addition logger handler for messages tagged with a non-OTP
-    %% domain because by default, `cth_log_redirect' drop them.
-    {ok, LogCfg0} = logger:get_handler_config(cth_log_redirect),
-    LogCfg = maps:remove(id, maps:remove(module, LogCfg0)),
-    ok = logger:add_handler(
-           cth_log_redirect_any_domains, cth_log_redirect_any_domains,
-           LogCfg),
-
-    ok = logger:remove_handler(default),
-
-    ct:log(
-      ?LOW_IMPORTANCE,
-      "Logger configured to send logs to common_test logs; you should see "
-      "a message below saying so"),
-    ?LOG_INFO("Logger message logged to common_test logs"),
-    Config.
-
 init_skip_as_error_flag(Config) ->
     SkipAsError = case os:getenv("RABBITMQ_CT_SKIP_AS_ERROR") of
                       false -> false;