Merge pull request #10355 from rabbitmq/fix-logging_SUITE-after-move-of-rabbitmq_prelaunch-to-deps

Fix failures in `logging_SUITE` after the move of `rabbitmq_prelaunch`

Author: dumbbell

.gitignore

@@ -36,6 +36,7 @@
 !/deps/rabbitmq_peer_discovery_consul/
 !/deps/rabbitmq_peer_discovery_etcd/
 !/deps/rabbitmq_peer_discovery_k8s/
+!/deps/rabbitmq_prelaunch/
 !/deps/rabbitmq_prometheus/
 !/deps/rabbitmq_random_exchange/
 !/deps/rabbitmq_recent_history_exchange/

deps/rabbit/test/logging_SUITE.erl

@@ -107,9 +107,12 @@ groups() ->
 
 init_per_suite(Config) ->
     rabbit_ct_helpers:log_environment(),
-    rabbit_ct_helpers:run_setup_steps(Config).
+    Config1 = rabbit_ct_helpers:run_setup_steps(Config),
+    meck_rabbit_logger_std_h(),
+    Config1.
 
 end_per_suite(Config) ->
+    unmeck_rabbit_logger_std_h(),
     Config.
 
 init_per_group(syslog_output, Config) ->
@@ -186,6 +189,23 @@ end_per_testcase(Testcase, Config) ->
               end,
     rabbit_ct_helpers:testcase_finished(Config1, Testcase).
 
+meck_rabbit_logger_std_h() ->
+    ok = meck:new(rabbit_logger_std_h, [no_link, passthrough]),
+    ok = meck:expect(
+           rabbit_logger_std_h, io_put_chars,
+           fun(DEVICE, DATA) ->
+                   %% We log to Common Test log as well.
+                   %% This is the file we use to check
+                   %% the message made it to
+                   %% stdout/stderr.
+                   ct:log("~ts", [DATA]),
+                   io:put_chars(DEVICE, DATA)
+           end).
+
+unmeck_rabbit_logger_std_h() ->
+    ?assert(meck:validate(rabbit_logger_std_h)),
+    ok = meck:unload(rabbit_logger_std_h).
+
 remove_all_handlers() ->
     _ = [logger:remove_handler(Id)
          || #{id := Id} <- logger:get_handler_config()].

deps/rabbitmq_prelaunch/src/rabbit_logger_std_h.erl

@@ -20,19 +20,9 @@
 -module(rabbit_logger_std_h).
 
 -ifdef(TEST).
--define(io_put_chars(DEVICE, DATA), begin
-                                        %% We log to Common Test log as well.
-                                        %% This is the file we use to check
-                                        %% the message made it to
-                                        %% stdout/stderr.
-                                        ct:log("~ts", [DATA]),
-                                        io:put_chars(DEVICE, DATA)
-                                    end).
-
 -export([parse_date_spec/1, parse_day_of_week/2, parse_day_of_month/2, parse_hour/2, parse_minute/2]).
--else.
--define(io_put_chars(DEVICE, DATA), io:put_chars(DEVICE, DATA)).
 -endif.
+
 -define(file_write(DEVICE, DATA), file:write(DEVICE, DATA)).
 -define(file_datasync(DEVICE), file:datasync(DEVICE)).
 
@@ -50,6 +40,9 @@
 -export([log/2, adding_handler/1, removing_handler/1, changing_config/3,
          filter_config/1]).
 
+%% Internal export to allow the use of meck.
+-export([io_put_chars/2]).
+
 -define(DEFAULT_CALL_TIMEOUT, 5000).
 
 %%%===================================================================
@@ -524,22 +517,40 @@ ensure_file(#{inode:=INode0,file_name:=FileName,modes:=Modes}=State) ->
             State#{last_check=>timestamp()};
         _ ->
             close_log_file(State),
-            case file:open(FileName,Modes) of
-                {ok,Fd} ->
-                    {ok,#file_info{inode=INode}} =
-                        file:read_file_info(FileName,[raw]),
-                    State#{fd=>Fd,inode=>INode,
-                           last_check=>timestamp(),
-                           synced=>true,sync_res=>ok};
-                Error ->
-                    exit({could_not_reopen_file,Error})
-            end
+            {ok, Fd} = ensure_open(FileName, Modes),
+            {ok,#file_info{inode=INode}} =
+                file:read_file_info(FileName,[raw]),
+            State#{fd=>Fd,inode=>INode,
+                   last_check=>timestamp(),
+                   synced=>true,sync_res=>ok}
     end;
 ensure_file(State) ->
     State.
 
+ensure_open(Filename, Modes) ->
+    case filelib:ensure_dir(Filename) of
+        ok ->
+            case file:open(Filename, Modes) of
+                {ok, Fd} ->
+                    {ok, Fd};
+                Error ->
+                    exit({could_not_reopen_file,Error})
+            end;
+        Error ->
+            exit({could_not_create_dir_for_file,Error})
+    end.
+
+write_to_dev(Bin,#{dev:=standard_io}=State) ->
+    try
+        ?MODULE:io_put_chars(user, Bin)
+    catch _E:_R ->
+            ?MODULE:io_put_chars(
+              standard_error, "Failed to write log message to stdout, trying stderr\n"),
+            ?MODULE:io_put_chars(standard_error, Bin)
+    end,
+    State;
 write_to_dev(Bin,#{dev:=DevName}=State) ->
-    ?io_put_chars(DevName, Bin),
+    ?MODULE:io_put_chars(DevName, Bin),
     State;
 write_to_dev(Bin, State) ->
     State1 = #{fd:=Fd} = maybe_ensure_file(State),
@@ -548,6 +559,9 @@ write_to_dev(Bin, State) ->
     maybe_notify_error(write,Result,State2),
     State2#{synced=>false,write_res=>Result}.
 
+io_put_chars(DevName, Bin) ->
+    io:put_chars(DevName, Bin).
+
 sync_dev(#{synced:=false}=State) ->
     State1 = #{fd:=Fd} = maybe_ensure_file(State),
     Result = ?file_datasync(Fd),

deps/rabbitmq_prelaunch/src/rabbit_prelaunch_early_logging.erl

@@ -25,10 +25,9 @@
 -export([filter_log_event/2]).
 -export([filter_discarded_message/2]).
 
--ifdef(TEST).
+%% For internal testing purpose only.
 -export([levels/0,
          determine_prefix/1]).
--endif.
 
 -define(CONFIGURED_KEY, {?MODULE, configured}).