Aliases in behaviour. List plugins command

Author: Daniil Fedotov

Makefile

@@ -5,5 +5,6 @@ all:
 tests: all
 	mix test
 plugins: all
+	rm rabbitmq-plugins
 	ln -s rabbitmqctl rabbitmq-plugins
 

lib/rabbit_common/records.ex

@@ -18,4 +18,5 @@ defmodule RabbitCommon.Records do
   import Record, only: [defrecord: 2, extract: 2]
 
   defrecord :amqqueue, extract(:amqqueue, from_lib: "rabbit_common/include/rabbit.hrl")
+  defrecord :plugin, extract(:plugin, from_lib: "rabbit_common/include/rabbit.hrl")
 end

lib/rabbitmq/cli/command_behaviour.ex

@@ -22,4 +22,5 @@ defmodule RabbitMQ.CLI.CommandBehaviour do
   @callback banner(List.t, Map.t) :: String.t
   @callback run(List.t, Map.t) :: any 
   @callback switches() :: Keyword.t
+  @callback aliases() :: Keyword.t
 end

lib/rabbitmq/cli/ctl/command_modules.ex

@@ -15,6 +15,8 @@
 
 
 defmodule RabbitMQ.CLI.Ctl.CommandModules do
+  @commands_ns ~r/RabbitMQ.CLI.(.*).Commands/
+
   def module_map do
     case Application.get_env(:rabbitmqctl, :commands) do
       nil -> load;
@@ -41,28 +43,32 @@ defmodule RabbitMQ.CLI.Ctl.CommandModules do
   end
 
   defp load_commands(scope) do
-    modules = loadable_modules()
-    modules
-    |> Enum.filter(fn(path) ->
-                     to_string(path) =~ ~r/RabbitMQ.CLI.*.Commands/
+    ctl_and_plugin_modules
+    |> Enum.filter(fn(mod) ->
+                     to_string(mod) =~ @commands_ns
+                     and
+                     implements_command_behaviour?(mod)
+                     and
+                     command_in_scope(mod, scope)
                    end)
-    |> Enum.map(fn(path) ->
-                  Path.rootname(path, '.beam')
-                  |> String.to_atom
-                  |> Code.ensure_loaded
-                end)
-    |> Enum.filter_map(fn({res, _}) -> res == :module end,
-                       fn({_, mod}) -> command_tuple(mod) end)
-    |> Enum.filter(fn({_, cmd}) -> command_in_scope(cmd, scope) end)
+    |> Enum.map(&command_tuple/1)
     |> Map.new
   end
 
-  defp loadable_modules do
-    :code.get_path()
-    |> Enum.flat_map(fn(path) ->
-         {:ok, modules} = :erl_prim_loader.list_dir(path)
-         modules
-       end)
+  defp ctl_and_plugin_modules do
+    # No plugins so far
+    applications = [:rabbitmqctl]
+    applications
+    |> Enum.flat_map(fn(app) -> Application.spec(app, :modules) end)
+  end
+
+
+  defp implements_command_behaviour?(nil) do
+    false
+  end
+  defp implements_command_behaviour?(module) do
+    Enum.member?(module.module_info(:attributes)[:behaviour] || [],
+                 RabbitMQ.CLI.CommandBehaviour)
   end
 
   defp command_tuple(cmd) do
@@ -107,8 +113,20 @@ defmodule RabbitMQ.CLI.Ctl.CommandModules do
     false
   end
   defp command_in_scope(cmd, scope) do
-    cmd
-    |> to_string
-    |> String.contains?("RabbitMQ.CLI.#{scope}.Commands")
+    Enum.member?(command_scopes(cmd), scope)
+  end
+
+  defp command_scopes(cmd) do
+    case :erlang.function_exported(cmd, :scopes, 0) do
+      true  ->
+        cmd.scopes()
+      false ->
+        @commands_ns
+        |> Regex.run(to_string(cmd), capture: :all_but_first)
+        |> List.first
+        |> to_snake_case
+        |> String.to_atom
+        |> List.wrap
+    end
   end
 end

lib/rabbitmq/cli/ctl/commands/add_user_command.ex

@@ -23,6 +23,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.AddUserCommand do
   def merge_defaults(args, opts), do: {args, opts}
 
   def switches(), do: []
+  def aliases(), do: []
 
   def validate(args, _) when length(args) < 2 do
     {:validation_failure, :not_enough_args}

lib/rabbitmq/cli/ctl/commands/add_vhost_command.ex

@@ -25,6 +25,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.AddVhostCommand do
   def merge_defaults(args, opts), do: {args, opts}
 
   def switches(), do: []
+  def aliases(), do: []
   def run([vhost], %{node: node_name}) do
     :rabbit_misc.rpc_call(node_name, :rabbit_vhost, :add, [vhost])
   end

lib/rabbitmq/cli/ctl/commands/authenticate_user_command.ex

@@ -23,6 +23,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.AuthenticateUserCommand do
   def validate([_,_], _), do: :ok
   def merge_defaults(args, opts), do: {args, opts}
   def switches(), do: []
+  def aliases(), do: []
 
   def run([user, password], %{node: node_name}) do
     :rabbit_misc.rpc_call(node_name,

lib/rabbitmq/cli/ctl/commands/cancel_sync_queue_command.ex

@@ -23,6 +23,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.CancelSyncQueueCommand do
   def flags, do: [:vhost]
 
   def switches, do: []
+  def aliases, do: []
 
   def usage, do: "cancel_sync_queue [-p <vhost>] queue"
 

lib/rabbitmq/cli/ctl/commands/change_password_command.ex

@@ -21,6 +21,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ChangePasswordCommand do
   def merge_defaults(args, opts), do: {args, opts}
 
   def switches(), do: []
+  def aliases(), do: []
 
   def validate(args, _) when length(args) < 2, do: {:validation_failure, :not_enough_args}
   def validate([_|_] = args, _) when length(args) > 2, do: {:validation_failure, :too_many_args}

lib/rabbitmq/cli/ctl/commands/clear_parameter_command.ex

@@ -19,6 +19,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ClearParameterCommand do
   @flags [:vhost]
 
   def switches(), do: []
+  def aliases(), do: []
   def merge_defaults(args, opts) do
     default_opts = Map.merge(opts, %{vhost: "/"})
     {args, default_opts}