Skip to content
This repository was archived by the owner on Nov 17, 2020. It is now read-only.

rabbit_env: Add $RABBITMQ_{PRODUCT_NAME,PRODUCT_VERSION,MOTD_FILE} #356

Merged
merged 1 commit into from
Feb 20, 2020
Merged

rabbit_env: Add $RABBITMQ_{PRODUCT_NAME,PRODUCT_VERSION,MOTD_FILE} #356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 126 additions & 1 deletion src/rabbit_env.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,15 @@
"RABBITMQ_LOGS",
"RABBITMQ_MNESIA_BASE",
"RABBITMQ_MNESIA_DIR",
"RABBITMQ_MOTD_FILE",
"RABBITMQ_NODE_IP_ADDRESS",
"RABBITMQ_NODE_PORT",
"RABBITMQ_NODENAME",
"RABBITMQ_PID_FILE",
"RABBITMQ_PLUGINS_DIR",
"RABBITMQ_PLUGINS_EXPAND_DIR",
"RABBITMQ_PRODUCT_NAME",
"RABBITMQ_PRODUCT_VERSION",
"RABBITMQ_QUORUM_DIR",
"RABBITMQ_UPGRADE_LOG",
"RABBITMQ_USE_LONGNAME",
Expand Down Expand Up @@ -137,7 +140,10 @@ get_context_after_reloading_env(Context) ->
fun maybe_stop_dist_for_remote_query/1,
fun amqp_ipaddr/1,
fun amqp_tcp_port/1,
fun erlang_dist_tcp_port/1
fun erlang_dist_tcp_port/1,
fun product_name/1,
fun product_version/1,
fun motd_file/1
],

run_context_steps(Context, Steps).
Expand Down Expand Up @@ -1220,6 +1226,125 @@ output_supports_colors(#{os_type := {unix, _}} = Context) ->
output_supports_colors(#{os_type := {win32, _}} = Context) ->
update_context(Context, output_supports_colors, false, default).

%% -------------------------------------------------------------------
%%
%% RABBITMQ_PRODUCT_NAME
%% Override the product name
%% Default: unset (i.e. "RabbitMQ")
%%
%% RABBITMQ_PRODUCT_VERSION
%% Override the product version
%% Default: unset (i.e. `rabbit` application version).
%%
%% RABBITMQ_MOTD_FILE
%% Indicate a filename containing a "message of the day" to add to
%% the banners, both the logged and the printed ones.
%% Default: (Unix) ${SYS_PREFIX}/etc/rabbitmq/motd
%% (Windows) ${RABBITMQ_BASE}\motd.txt

product_name(#{from_remote_node := Remote} = Context) ->
case get_prefixed_env_var("RABBITMQ_PRODUCT_NAME") of
false when Remote =:= offline ->
update_context(Context, product_name, undefined, default);
false ->
product_name_from_node(Context);
Value ->
update_context(Context, product_name, Value, environment)
end;
product_name(Context) ->
product_name_from_env(Context).

product_name_from_env(Context) ->
case get_prefixed_env_var("RABBITMQ_PRODUCT_NAME") of
false ->
update_context(Context, product_name, undefined, default);
Value ->
update_context(Context, product_name, Value, environment)
end.

product_name_from_node(#{from_remote_node := Remote} = Context) ->
Ret = (catch query_remote(Remote, rabbit, product_name, [])),
case Ret of
{badrpc, nodedown} ->
update_context(Context, product_name, undefined, default);
{query, _, _} ->
update_context(Context, product_name, undefined, default);
Value ->
update_context(Context, product_name, Value, remote_node)
end.

product_version(#{from_remote_node := Remote} = Context) ->
case get_prefixed_env_var("RABBITMQ_PRODUCT_VERSION") of
false when Remote =:= offline ->
update_context(Context, product_version, undefined, default);
false ->
product_version_from_node(Context);
Value ->
update_context(Context, product_version, Value, environment)
end;
product_version(Context) ->
product_version_from_env(Context).

product_version_from_env(Context) ->
case get_prefixed_env_var("RABBITMQ_PRODUCT_VERSION") of
false ->
update_context(Context, product_version, undefined, default);
Value ->
update_context(Context, product_version, Value, environment)
end.

product_version_from_node(#{from_remote_node := Remote} = Context) ->
Ret = (catch query_remote(Remote, rabbit, product_version, [])),
case Ret of
{badrpc, _} ->
update_context(Context, product_version, undefined, default);
{query, _, _} ->
update_context(Context, product_version, undefined, default);
Value ->
update_context(Context, product_version, Value, remote_node)
end.

motd_file(#{from_remote_node := Remote} = Context) ->
case get_prefixed_env_var("RABBITMQ_MOTD_FILE") of
false when Remote =:= offline ->
update_context(Context, motd_file, undefined, default);
false ->
motd_file_from_node(Context);
Value ->
File = normalize_path(Value),
update_context(Context, motd_file, File, environment)
end;
motd_file(Context) ->
motd_file_from_env(Context).

motd_file_from_env(Context) ->
case get_prefixed_env_var("RABBITMQ_MOTD_FILE") of
false ->
File = get_default_motd_file(Context),
update_context(Context, motd_file, File, default);
Value ->
File = normalize_path(Value),
update_context(Context, motd_file, File, environment)
end.

get_default_motd_file(#{os_type := {unix, _},
config_base_dir := ConfigBaseDir}) ->
filename:join(ConfigBaseDir, "motd");
get_default_motd_file(#{os_type := {win32, _},
config_base_dir := ConfigBaseDir}) ->
filename:join(ConfigBaseDir, "motd.txt").

motd_file_from_node(#{from_remote_node := Remote} = Context) ->
Ret = (catch query_remote(Remote, rabbit, motd_file, [])),
case Ret of
{badrpc, _} ->
update_context(Context, motd_file, undefined, default);
{query, _, _} ->
update_context(Context, motd_file, undefined, default);
File ->
update_context(Context, motd_file, File, remote_node)
end.

%% -------------------------------------------------------------------
%% Loading of rabbitmq-env.conf.
%% -------------------------------------------------------------------
Expand Down
54 changes: 54 additions & 0 deletions test/rabbit_env_SUITE.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,15 @@
check_RABBITMQ_LOGS/1,
check_RABBITMQ_MNESIA_BASE/1,
check_RABBITMQ_MNESIA_DIR/1,
check_RABBITMQ_MOTD_FILE/1,
check_RABBITMQ_NODE_IP_ADDRESS/1,
check_RABBITMQ_NODE_PORT/1,
check_RABBITMQ_NODENAME/1,
check_RABBITMQ_PID_FILE/1,
check_RABBITMQ_PLUGINS_DIR/1,
check_RABBITMQ_PLUGINS_EXPAND_DIR/1,
check_RABBITMQ_PRODUCT_NAME/1,
check_RABBITMQ_PRODUCT_VERSION/1,
check_RABBITMQ_QUORUM_DIR/1,
check_RABBITMQ_UPGRADE_LOG/1,
check_RABBITMQ_USE_LOGNAME/1,
Expand Down Expand Up @@ -78,12 +81,15 @@ all() ->
check_RABBITMQ_LOGS,
check_RABBITMQ_MNESIA_BASE,
check_RABBITMQ_MNESIA_DIR,
check_RABBITMQ_MOTD_FILE,
check_RABBITMQ_NODE_IP_ADDRESS,
check_RABBITMQ_NODE_PORT,
check_RABBITMQ_NODENAME,
check_RABBITMQ_PID_FILE,
check_RABBITMQ_PLUGINS_DIR,
check_RABBITMQ_PLUGINS_EXPAND_DIR,
check_RABBITMQ_PRODUCT_NAME,
check_RABBITMQ_PRODUCT_VERSION,
check_RABBITMQ_QUORUM_DIR,
check_RABBITMQ_UPGRADE_LOG,
check_RABBITMQ_USE_LOGNAME,
Expand Down Expand Up @@ -168,13 +174,16 @@ check_default_values(_) ->
main_log_file => default,
mnesia_base_dir => default,
mnesia_dir => default,
motd_file => default,
nodename => default,
nodename_type => default,
os_type => environment,
output_supports_colors => default,
pid_file => default,
plugins_expand_dir => default,
plugins_path => default,
product_name => default,
product_version => default,
quorum_queue_dir => default,
rabbitmq_home => default,
upgrade_log_file => default
Expand Down Expand Up @@ -204,6 +213,7 @@ check_default_values(_) ->
main_log_file => "/var/log/rabbitmq/" ++ NodeS ++ ".log",
mnesia_base_dir => "/var/lib/rabbitmq/mnesia",
mnesia_dir => "/var/lib/rabbitmq/mnesia/" ++ NodeS,
motd_file => "/etc/rabbitmq/motd",
nodename => Node,
nodename_type => shortnames,
os_type => {unix, undefined},
Expand All @@ -212,6 +222,8 @@ check_default_values(_) ->
plugins_expand_dir =>
"/var/lib/rabbitmq/mnesia/" ++ NodeS ++ "-plugins-expand",
plugins_path => maps:get(plugins_path, UnixContext),
product_name => undefined,
product_version => undefined,
quorum_queue_dir =>
"/var/lib/rabbitmq/mnesia/" ++ NodeS ++ "/quorum",
rabbitmq_home => maps:get(rabbitmq_home, UnixContext),
Expand Down Expand Up @@ -247,6 +259,7 @@ check_default_values(_) ->
main_log_file => "%APPDATA%/RabbitMQ/log/" ++ NodeS ++ ".log",
mnesia_base_dir => "%APPDATA%/RabbitMQ/db",
mnesia_dir => "%APPDATA%/RabbitMQ/db/" ++ NodeS ++ "-mnesia",
motd_file => "%APPDATA%/RabbitMQ/motd.txt",
nodename => Node,
nodename_type => shortnames,
os_type => {win32, undefined},
Expand All @@ -255,6 +268,8 @@ check_default_values(_) ->
plugins_expand_dir =>
"%APPDATA%/RabbitMQ/db/" ++ NodeS ++ "-plugins-expand",
plugins_path => maps:get(plugins_path, Win32Context),
product_name => undefined,
product_version => undefined,
quorum_queue_dir =>
"%APPDATA%/RabbitMQ/db/" ++ NodeS ++ "-mnesia/quorum",
rabbitmq_base => "%APPDATA%/RabbitMQ",
Expand Down Expand Up @@ -365,13 +380,16 @@ check_values_from_reachable_remote_node(Config) ->
main_log_file => default,
mnesia_base_dir => default,
mnesia_dir => remote_node,
motd_file => default,
nodename => environment,
nodename_type => default,
os_type => environment,
output_supports_colors => default,
pid_file => default,
plugins_expand_dir => default,
plugins_path => remote_node,
product_name => default,
product_version => default,
quorum_queue_dir => default,
rabbitmq_home => default,
upgrade_log_file => default
Expand Down Expand Up @@ -401,13 +419,16 @@ check_values_from_reachable_remote_node(Config) ->
main_log_file => "/var/log/rabbitmq/" ++ NodeS ++ ".log",
mnesia_base_dir => undefined,
mnesia_dir => MnesiaDir,
motd_file => undefined,
nodename => Node,
nodename_type => shortnames,
os_type => {unix, undefined},
output_supports_colors => true,
pid_file => undefined,
plugins_expand_dir => undefined,
plugins_path => PluginsDir,
product_name => undefined,
product_version => undefined,
quorum_queue_dir => MnesiaDir ++ "/quorum",
rabbitmq_home => maps:get(rabbitmq_home, UnixContext),
split_nodename => rabbit_nodes_common:parts(Node),
Expand Down Expand Up @@ -474,13 +495,16 @@ check_values_from_offline_remote_node(_) ->
main_log_file => default,
mnesia_base_dir => default,
mnesia_dir => default,
motd_file => default,
nodename => environment,
nodename_type => default,
os_type => environment,
output_supports_colors => default,
pid_file => default,
plugins_expand_dir => default,
plugins_path => default,
product_name => default,
product_version => default,
quorum_queue_dir => default,
rabbitmq_home => default,
upgrade_log_file => default
Expand Down Expand Up @@ -510,13 +534,16 @@ check_values_from_offline_remote_node(_) ->
main_log_file => "/var/log/rabbitmq/" ++ NodeS ++ ".log",
mnesia_base_dir => undefined,
mnesia_dir => undefined,
motd_file => undefined,
nodename => Node,
nodename_type => shortnames,
os_type => {unix, undefined},
output_supports_colors => true,
pid_file => undefined,
plugins_expand_dir => undefined,
plugins_path => undefined,
product_name => undefined,
product_version => undefined,
quorum_queue_dir => undefined,
rabbitmq_home => maps:get(rabbitmq_home, UnixContext),
split_nodename => rabbit_nodes_common:parts(Node),
Expand Down Expand Up @@ -849,6 +876,33 @@ check_RABBITMQ_PLUGINS_EXPAND_DIR(_) ->
Value1, Value1,
Value2, Value2).

check_RABBITMQ_PRODUCT_NAME(_) ->
Value1 = random_string(),
Value2 = random_string(),
check_prefixed_variable("RABBITMQ_PRODUCT_NAME",
product_name,
'_',
Value1, Value1,
Value2, Value2).

check_RABBITMQ_PRODUCT_VERSION(_) ->
Value1 = random_string(),
Value2 = random_string(),
check_prefixed_variable("RABBITMQ_PRODUCT_VERSION",
product_version,
'_',
Value1, Value1,
Value2, Value2).

check_RABBITMQ_MOTD_FILE(_) ->
Value1 = random_string(),
Value2 = random_string(),
check_prefixed_variable("RABBITMQ_MOTD_FILE",
motd_file,
'_',
Value1, Value1,
Value2, Value2).

check_RABBITMQ_QUORUM_DIR(_) ->
Value1 = random_string(),
Value2 = random_string(),
Expand Down