Merge pull request #7122 from rabbitmq/mergify/bp/v3.10.x/pr-7114

michaelklishin · web-flow · commit ca3100d8ebf6 · 2023-02-01T21:42:47.000-05:00
Add rabbitmq_cli dialyze to bazel (backport #7066) (backport #7114)
diff --git a/MODULE.bazel b/MODULE.bazel
@@ -31,7 +31,7 @@ bazel_dep(
 
 bazel_dep(
     name = "rules_erlang",
-    version = "3.9.1",
+    version = "3.9.2",
 )
 
 erlang_config = use_extension(
diff --git a/WORKSPACE b/WORKSPACE
@@ -4,7 +4,7 @@ load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository", "new_git_r
 git_repository(
     name = "rules_erlang",
     remote = "https://github.com/rabbitmq/rules_erlang.git",
-    tag = "3.9.1",
+    tag = "3.9.2",
 )
 
 load("@rules_erlang//:internal_deps.bzl", "rules_erlang_internal_deps")
diff --git a/deps/rabbit_common/src/rabbit_misc.erl b/deps/rabbit_common/src/rabbit_misc.erl
@@ -229,7 +229,7 @@
 -spec pset(term(), term(), [term()]) -> [term()].
 -spec format_message_queue(any(), priority_queue:q()) -> term().
 -spec os_cmd(string()) -> string().
--spec is_os_process_alive(non_neg_integer()) -> boolean().
+-spec is_os_process_alive(non_neg_integer() | string()) -> boolean().
 -spec gb_sets_difference(gb_sets:set(), gb_sets:set()) -> gb_sets:set().
 -spec version() -> string().
 -spec otp_release() -> string().
diff --git a/deps/rabbitmq_cli/BUILD.bazel b/deps/rabbitmq_cli/BUILD.bazel
@@ -1,10 +1,11 @@
 load("@bazel_skylib//rules:select_file.bzl", "select_file")
+load("@rules_erlang//:dialyze.bzl", "dialyze", "plt")
 load(":rabbitmqctl.bzl", "rabbitmqctl")
 load(":rabbitmqctl_check_formatted.bzl", "rabbitmqctl_check_formatted_test")
 load(":rabbitmqctl_test.bzl", "rabbitmqctl_test")
 load("//:rabbitmq_home.bzl", "rabbitmq_home")
 load("//:rabbitmq_run.bzl", "rabbitmq_run")
-load("//:rabbitmq.bzl", "STARTS_BACKGROUND_BROKER_TAG")
+load("//:rabbitmq.bzl", "RABBITMQ_DIALYZER_OPTS", "STARTS_BACKGROUND_BROKER_TAG")
 
 # Note: All the various rabbitmq-* scripts are just copies of rabbitmqctl
 rabbitmqctl(
@@ -71,6 +72,22 @@ test_suite(
     tests = ["check_formatted"],
 )
 
+plt(
+    name = "deps_plt",
+    libs = [":elixir"],
+    deps = [
+        ":elixir",
+        "//deps/rabbit:erlang_app",
+        "//deps/rabbit_common:erlang_app",
+    ],
+)
+
+dialyze(
+    dialyzer_opts = RABBITMQ_DIALYZER_OPTS,
+    libs = [":elixir"],
+    plt = ":deps_plt",
+)
+
 rabbitmqctl_test(
     name = "tests",
     size = "large",
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/auto_complete.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/auto_complete.ex
@@ -10,6 +10,8 @@ defmodule RabbitMQ.CLI.AutoComplete do
   # Use the same jaro distance limit as in Elixir's "did you mean?"
   @jaro_distance_limit 0.77
 
+  @dialyzer :no_unused
+
   @spec complete(String.t(), [String.t()]) :: [String.t()]
   def complete(_, []) do
     []
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/command_behaviour.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/command_behaviour.ex
@@ -47,7 +47,7 @@ defmodule RabbitMQ.CLI.CommandBehaviour do
   @callback printer() :: atom()
   @callback scopes() :: [atom()] | nil
   @callback description() :: String.t()
-  @callback help_section() :: String.t() | {:plugin, atom()}
+  @callback help_section() :: String.t() | atom() | {:plugin, atom()}
   @callback usage_additional() ::
               String.t()
               | [String.t()]
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/core/code_path.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/core/code_path.ex
@@ -15,7 +15,7 @@ defmodule RabbitMQ.CLI.Core.CodePath do
       val ->
         with {:ok, plugins_dir} <- val do
           String.split(to_string(plugins_dir), Platform.path_separator())
-          |> Enum.map(&add_directory_plugins_to_load_path/1)
+          |> Enum.each(&add_directory_plugins_to_load_path/1)
 
           :ok
         end
@@ -99,11 +99,11 @@ defmodule RabbitMQ.CLI.Core.CodePath do
       _ ->
         case Application.load(:rabbit) do
           :ok ->
-            Code.ensure_loaded(:rabbit_plugins)
+            _ = Code.ensure_loaded(:rabbit_plugins)
             :ok
 
           {:error, {:already_loaded, :rabbit}} ->
-            Code.ensure_loaded(:rabbit_plugins)
+            _ = Code.ensure_loaded(:rabbit_plugins)
             :ok
 
           {:error, err} ->
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/core/command_modules.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/core/command_modules.ex
@@ -59,7 +59,7 @@ defmodule RabbitMQ.CLI.Core.CommandModules do
   end
 
   def plugin_modules(opts) do
-    require_rabbit(opts)
+    _ = require_rabbit(opts)
 
     enabled_plugins =
       try do
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/core/helpers.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/core/helpers.ex
@@ -130,7 +130,7 @@ defmodule RabbitMQ.CLI.Core.Helpers do
   end
 
   def apply_if_exported(mod, fun, args, default) do
-    Code.ensure_loaded(mod)
+    _ = Code.ensure_loaded(mod)
 
     case function_exported?(mod, fun, length(args)) do
       true -> apply(mod, fun, args)
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/core/input.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/core/input.ex
@@ -26,7 +26,7 @@ defmodule RabbitMQ.CLI.Core.Input do
   end
 
   def consume_multiline_string() do
-    val = IO.read(:stdio, :all)
+    val = IO.read(:stdio, :eof)
 
     case val do
       :eof -> :eof
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/core/memory.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/core/memory.ex
@@ -90,7 +90,7 @@ defmodule RabbitMQ.CLI.Core.Memory do
   end
 
   def parse_watermark(n) when is_bitstring(n) do
-    case IU.parse(n) do
+    case IU.parse(to_charlist(n)) do
       {:ok, parsed} -> parsed
       err -> err
     end
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/core/networking.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/core/networking.ex
@@ -22,7 +22,7 @@ defmodule RabbitMQ.CLI.Core.Networking do
     end
   end
 
-  @spec address_family(String.t() | atom()) :: boolean()
+  @spec valid_address_family?(String.t() | atom()) :: boolean()
   def valid_address_family?(value) when is_atom(value) do
     valid_address_family?(to_string(value))
   end
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/core/parser.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/core/parser.ex
@@ -8,6 +8,8 @@ defmodule RabbitMQ.CLI.Core.Parser do
   alias RabbitMQ.CLI.{CommandBehaviour, FormatterBehaviour}
   alias RabbitMQ.CLI.Core.{CommandModules, Config, Helpers}
 
+  @dialyzer [:no_unused, :no_return]
+
   def default_switches() do
     [
       node: :string,
@@ -96,13 +98,13 @@ defmodule RabbitMQ.CLI.Core.Parser do
         ## This is an optimisation for pluggable command discovery.
         ## Most of the time a command will be from rabbitmqctl application
         ## so there is not point in scanning plugins for potential commands
-        CommandModules.load_core(options)
+        _ = CommandModules.load_core(options)
         core_commands = CommandModules.module_map_core()
 
         command =
           case core_commands[cmd_name] do
             nil ->
-              CommandModules.load(options)
+              _ = CommandModules.load(options)
               module_map = CommandModules.module_map()
 
               module_map[cmd_name] ||
@@ -240,11 +242,12 @@ defmodule RabbitMQ.CLI.Core.Parser do
   end
 
   defp assert_no_conflict(command, command_fields, formatter_fields, err) do
-    merge_if_different(
-      formatter_fields,
-      command_fields,
-      {:command_invalid, {command, {err, formatter_fields, command_fields}}}
-    )
+    _ =
+      merge_if_different(
+        formatter_fields,
+        command_fields,
+        {:command_invalid, {command, {err, formatter_fields, command_fields}}}
+      )
 
     :ok
   end
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/exec_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/exec_command.ex
@@ -30,7 +30,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ExecCommand do
 
   def validate([string], _) do
     try do
-      Code.compile_string(string)
+      _ = Code.compile_string(string)
       :ok
     rescue
       ex in SyntaxError ->
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/export_definitions_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/export_definitions_command.ex
@@ -41,7 +41,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ExportDefinitionsCommand do
   def validate([path], _) do
     dir = Path.dirname(path)
 
-    case File.exists?(dir, raw: true) do
+    case File.exists?(dir, [:raw]) do
       true -> :ok
       false -> {:validation_failure, {:bad_argument, "Directory #{dir} does not exist"}}
     end
@@ -76,7 +76,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ExportDefinitionsCommand do
         body = serialise(result, format)
         abs_path = Path.absname(path)
 
-        File.rm(abs_path)
+        _ = File.rm(abs_path)
 
         case File.write(abs_path, body) do
           # no output
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/forget_cluster_node_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/forget_cluster_node_command.ex
@@ -38,7 +38,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ForgetClusterNodeCommand do
     Stream.concat([
       become(node_name, opts),
       RabbitMQ.CLI.Core.Helpers.defer(fn ->
-        :rabbit_event.start_link()
+        _ = :rabbit_event.start_link()
         :rabbit_mnesia.forget_cluster_node(to_atom(node_to_remove), true)
       end)
     ])
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/help_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/help_command.ex
@@ -28,7 +28,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.HelpCommand do
   end
 
   def run([command_name | _], opts) do
-    CommandModules.load(opts)
+    _ = CommandModules.load(opts)
 
     module_map = CommandModules.module_map(opts)
 
@@ -54,7 +54,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.HelpCommand do
   end
 
   def run([], opts) do
-    CommandModules.load(opts)
+    _ = CommandModules.load(opts)
 
     case opts[:list_commands] do
       true ->
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/import_definitions_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/import_definitions_command.ex
@@ -31,7 +31,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ImportDefinitionsCommand do
   end
 
   def validate([path], _) do
-    case File.exists?(path, raw: true) do
+    case File.exists?(path, [:raw]) do
       true -> :ok
       false -> {:validation_failure, {:bad_argument, "File #{path} does not exist"}}
     end
@@ -42,7 +42,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ImportDefinitionsCommand do
   use RabbitMQ.CLI.Core.RequiresRabbitAppRunning
 
   def run([], %{node: node_name, format: format, timeout: timeout}) do
-    case IO.read(:stdio, :all) do
+    case IO.read(:stdio, :eof) do
       :eof ->
         {:error, :not_enough_args}
 
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_channels_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_channels_command.ex
@@ -38,7 +38,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ListChannelsCommand do
   use RabbitMQ.CLI.Core.RequiresRabbitAppRunning
 
   def run([], opts) do
-    run(~w(pid user consumer_count messages_unacknowledged), opts)
+    run(~w(pid user consumer_count messages_unacknowledged) |> Enum.map(&to_charlist/1), opts)
   end
 
   def run([_ | _] = args, %{node: node_name, timeout: timeout}) do
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/wait_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/wait_command.ex
@@ -207,10 +207,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.WaitCommand do
   end
 
   defp wait_for_application(node_name, :rabbit_and_plugins) do
-    case :rabbit.await_startup(node_name) do
-      {:badrpc, err} -> {:error, {:badrpc, err}}
-      other -> other
-    end
+    :rabbit.await_startup(node_name)
   end
 
   defp wait_for_erlang_distribution(pid, node_name, timeout) do
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/info_keys.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/info_keys.ex
@@ -9,7 +9,7 @@ defmodule RabbitMQ.CLI.Ctl.InfoKeys do
   alias RabbitMQ.CLI.Core.DataCoercion
 
   # internal to requested keys
-  @type info_keys :: Erlang.proplist()
+  @type info_keys :: [atom | tuple]
   # requested to internal keys
   @type aliases :: keyword(atom)
 
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/rpc_stream.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/rpc_stream.ex
@@ -26,7 +26,10 @@ defmodule RabbitMQ.CLI.Ctl.RpcStream do
   def receive_list_items_with_fun(node, mfas, timeout, info_keys, chunks_init, response_fun) do
     pid = Kernel.self()
     ref = Kernel.make_ref()
-    for {m, f, a} <- mfas, do: init_items_stream(node, m, f, a, timeout, pid, ref)
+
+    Enum.each(mfas, fn {m, f, a} ->
+      init_items_stream(node, m, f, a, timeout, pid, ref)
+    end)
 
     Stream.unfold(
       {chunks_init, :continue},
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/diagnostics/commands/erlang_cookie_sources_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/diagnostics/commands/erlang_cookie_sources_command.ex
@@ -48,7 +48,7 @@ defmodule RabbitMQ.CLI.Diagnostics.Commands.ErlangCookieSourcesCommand do
       os_env_cookie_set: System.get_env("RABBITMQ_ERLANG_COOKIE") != nil,
       os_env_cookie_value_length: String.length(System.get_env("RABBITMQ_ERLANG_COOKIE") || ""),
       switch_cookie_set: switch_cookie != nil,
-      switch_cookie_value_length: String.length(to_string(switch_cookie) || ""),
+      switch_cookie_value_length: String.length(to_string(switch_cookie)),
       effective_user: System.get_env("USER"),
       home_dir: home_dir,
       cookie_file_path: cookie_file_path,
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/diagnostics/commands/observer_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/diagnostics/commands/observer_command.ex
@@ -17,6 +17,7 @@ defmodule RabbitMQ.CLI.Diagnostics.Commands.ObserverCommand do
 
   use RabbitMQ.CLI.Core.AcceptsNoPositionalArguments
 
+  @dialyzer {:nowarn_function, run: 2}
   def run([], %{node: node_name, interval: interval}) do
     case :observer_cli.start(node_name, [{:interval, interval * 1000}]) do
       # See zhongwencool/observer_cli#54
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/formatters/report.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/formatters/report.ex
@@ -9,6 +9,7 @@ defmodule RabbitMQ.CLI.Formatters.Report do
   alias RabbitMQ.CLI.Core.{Output, Config}
 
   @behaviour RabbitMQ.CLI.FormatterBehaviour
+  @dialyzer {:nowarn_function, format_output: 2}
   def format_output(_, _) do
     raise "format_output is not implemented for report formatter"
   end
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/formatters/string_per_line.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/formatters/string_per_line.ex
@@ -17,7 +17,7 @@ defmodule RabbitMQ.CLI.Formatters.StringPerLine do
   @behaviour RabbitMQ.CLI.FormatterBehaviour
 
   def format_output(output, _) do
-    Enum.map(output, fn el -> Helpers.string_or_inspect(el) end)
+    Enum.map(output, fn el -> Helpers.string_or_inspect(el) end) |> Enum.join()
   end
 
   def format_stream(stream, options) do
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/plugins/plugins_helpers.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/plugins/plugins_helpers.ex
@@ -79,7 +79,7 @@ defmodule RabbitMQ.CLI.Plugins.Helpers do
 
   def set_enabled_plugins(plugins, opts) do
     plugin_atoms = :lists.usort(for plugin <- plugins, do: to_atom(plugin))
-    require_rabbit_and_plugins(opts)
+    _ = require_rabbit_and_plugins(opts)
     {:ok, plugins_file} = enabled_plugins_file(opts)
     write_enabled_plugins(plugin_atoms, plugins_file, opts)
   end
@@ -223,7 +223,7 @@ defmodule RabbitMQ.CLI.Plugins.Helpers do
   defp add_all_to_path(plugins_directories) do
     directories = String.split(to_string(plugins_directories), path_separator())
 
-    Enum.map(directories, fn directory ->
+    Enum.each(directories, fn directory ->
       with {:ok, subdirs} <- File.ls(directory) do
         for subdir <- subdirs do
           Path.join([directory, subdir, "ebin"])
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/queues/commands/peek_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/queues/commands/peek_command.ex
@@ -27,7 +27,6 @@ defmodule RabbitMQ.CLI.Queues.Commands.PeekCommand do
       case Integer.parse(raw_pos) do
         {n, _} -> n
         :error -> :error
-        _ -> :error
       end
 
     invalid_pos = {:validation_failure, "position value must be a positive integer"}
diff --git a/deps/rabbitmq_cli/lib/rabbitmqctl.ex b/deps/rabbitmq_cli/lib/rabbitmqctl.ex
diff --git a/deps/rabbitmq_cli/rabbitmqctl.bzl b/deps/rabbitmq_cli/rabbitmqctl.bzl
diff --git a/deps/rabbitmq_cli/rabbitmqctl_test.bzl b/deps/rabbitmq_cli/rabbitmqctl_test.bzl

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ bazel_dep(`
`31`	`31`
`32`	`32`	`bazel_dep(`
`33`	`33`	`name = "rules_erlang",`
`34`		`- version = "3.9.1",`
	`34`	`+ version = "3.9.2",`
`35`	`35`	`)`
`36`	`36`
`37`	`37`	`erlang_config = use_extension(`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository", "new_git_r`
`4`	`4`	`git_repository(`
`5`	`5`	`name = "rules_erlang",`
`6`	`6`	`remote = "https://github.com/rabbitmq/rules_erlang.git",`
`7`		`- tag = "3.9.1",`
	`7`	`+ tag = "3.9.2",`
`8`	`8`	`)`
`9`	`9`
`10`	`10`	`load("@rules_erlang//:internal_deps.bzl", "rules_erlang_internal_deps")`