declare user: support --hashing_algorithm, improve mandatory option formatting, more tests

References #641.

Author: michaelklishin

bin/rabbitmqadmin

@@ -109,7 +109,7 @@ DECLARABLE = {
     'vhost':      {'mandatory': ['name'],
                    'optional':  {'tracing': None}},
     'user':       {'mandatory': ['name', ['password', 'password_hash'], 'tags'],
-                   'optional':  {}},
+                   'optional':  {'hashing_algorithm': None}},
     'permission': {'mandatory': ['vhost', 'user', 'configure', 'write', 'read'],
                    'optional':  {}},
     'parameter':  {'mandatory': ['component', 'name', 'value'],
@@ -258,10 +258,22 @@ For more help use the help subcommand:
   rabbitmqadmin help config       # For help with the configuration file
 """
 
+def fmt_required_flag(val):
+    # when one of the options is required, e.g.
+    # password vs. password_hash
+    if type(val) is list:
+        # flag1=... OR flag2=... OR flag3=...
+        return "=... OR ".join(val)
+    else:
+        return val
+
+def fmt_optional_flag(val):
+    return val
+
 def fmt_usage_stanza(root, verb):
     def fmt_args(args):
-        res = " ".join(["{0}=...".format(a) for a in args['mandatory']])
-        opts = " ".join("{0}=...".format(o) for o in args['optional'].keys())
+        res = " ".join(["{0}=...".format(fmt_required_flag(a)) for a in args['mandatory']])
+        opts = " ".join("{0}=...".format(fmt_optional_flag(o)) for o in args['optional'].keys())
         if opts != "":
             res += " [{0}]".format(opts)
         return res
@@ -728,17 +740,20 @@ class Management:
                 upload[k] = optional[k]
         for arg in args:
             assert_usage("=" in arg,
-                         'Argument "{0}" not in format name=value'.format(arg))
+                         'Argument "{0}" not in the name=value format'.format(arg))
             (name, value) = arg.split("=", 1)
+            # flatten the list of mandatory keys
             mandatory_keys = []
             for key in mandatory:
                 if type(key) is list:
                     for subkey in key:
                         mandatory_keys.append(subkey)
                 else:
                     mandatory_keys.append(key)
+
             assert_usage(name in mandatory_keys or name in optional.keys(),
-                         'Argument "{0}" not recognised'.format(name))
+                         'Argument "{0}" is not recognised'.format(name))
+
             if 'json' in obj and name in obj['json']:
                 upload[name] = self.parse_json(value)
             else:
@@ -748,10 +763,10 @@ class Management:
                 a_set = set(m)
                 b_set = set(upload.keys())
                 assert_usage((a_set & b_set),
-                             'mandatory one-of arguments "{0}" required'.format(m))
+                             'one of mandatory arguments "{0}" is required'.format(m))
             else:
                 assert_usage(m in upload.keys(),
-                             'mandatory argument "{0}" required'.format(m))
+                             'mandatory argument "{0}" is required'.format(m))
         if 'vhost' not in mandatory:
             upload['vhost'] = self.options.vhost or self.options.declare_vhost
         uri_args = {}

test/rabbit_mgmt_rabbitmqadmin_SUITE.erl

@@ -196,9 +196,31 @@ users(Config) ->
     {ok, ["guest"]} = run_list(Config, l("users")),
     {error, _, _} = run(Config, ["declare", "user", "name=foo"]),
     {ok, _} = run(Config, ["declare", "user", "name=foo", "password=pass", "tags="]),
-    {ok, _} = run(Config, ["declare", "user", "name=foo", "password_hash=0qUsZVcRBQ1aU+sln631sKiEMSP9AOGHxuz4Rk01Jx4hwr2b", "tags="]),
-    {ok, ["foo", "guest"]} = run_list(Config, l("users")),
+
+    {ok, _} = run(Config, ["declare", "user", "name=with_password_hash1", "password_hash=WAbU0ZIcvjTpxM3Q3SbJhEAM2tQ=",
+                           "tags=management"]),
+    {ok, _} = run(Config, ["declare", "user", "name=with_password_hash2",
+                           "hashing_algorithm=rabbit_password_hashing_sha256", "password_hash=WAbU0ZIcvjTpxM3Q3SbJhEAM2tQ=",
+                           "tags=management"]),
+    {ok, _} = run(Config, ["declare", "user", "name=with_password_hash3",
+                           "hashing_algorithm=rabbit_password_hashing_sha512", "password_hash=WAbU0ZIcvjTpxM3Q3SbJhEAM2tQ=",
+                           "tags=management"]),
+
+    {error, _, _} = run(Config, ["declare", "user", "name=with_password_hash4",
+                                 "hashing_algorithm=rabbit_password_hashing_sha256", "password_hash=not-base64-encoded",
+                                 "tags=management"]),
+
+
+    {ok, ["foo", "guest",
+          "with_password_hash1",
+          "with_password_hash2",
+          "with_password_hash3"]} = run_list(Config, l("users")),
+
     {ok, _} = run(Config, ["delete", "user", "name=foo"]),
+    {ok, _} = run(Config, ["delete", "user", "name=with_password_hash1"]),
+    {ok, _} = run(Config, ["delete", "user", "name=with_password_hash2"]),
+    {ok, _} = run(Config, ["delete", "user", "name=with_password_hash3"]),
+
     {ok, ["guest"]} = run_list(Config, l("users")).
 
 permissions(Config) ->