library/ceph_key.py: rewrite for generate_ceph_cmd()

Also code lint with flake8

Signed-off-by: Wong Hoi Sing Edison <hswong3i@pantarei-design.com>

diff --git a/library/ceph_key.py b/library/ceph_key.py
index 7325dc33b167dca22753067144182d64e2a7acf9..423bd6417af11706c7c2e1eaaa4a706a95c64f26 100644 (file)
--- a/library/ceph_key.py
+++ b/library/ceph_key.py
@@ -19,9 +19,15 @@ __metaclass__ = type
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import is_containerized, container_exec, fatal
+    from ansible.module_utils.ca_common import generate_ceph_cmd, \
+                                               is_containerized, \
+                                               container_exec, \
+                                               fatal
 except ImportError:
-    from module_utils.ca_common import is_containerized, container_exec, fatal
+    from module_utils.ca_common import generate_ceph_cmd, \
+                                       is_containerized, \
+                                       container_exec, \
+                                       fatal
 import datetime
 import json
 import os
@@ -250,34 +256,6 @@ def generate_caps(_type, caps):
     return caps_cli
 
 
-def generate_ceph_cmd(cluster, args, user, user_key_path, container_image=None):
-    '''
-    Generate 'ceph' command line to execute
-    '''
-
-    if container_image:
-        binary = 'ceph'
-        cmd = container_exec(
-            binary, container_image)
-    else:
-        binary = ['ceph']
-        cmd = binary
-
-    base_cmd = [
-        '-n',
-        user,
-        '-k',
-        user_key_path,
-        '--cluster',
-        cluster,
-        'auth',
-    ]
-
-    cmd.extend(base_cmd + args)
-
-    return cmd
-
-
 def generate_ceph_authtool_cmd(cluster, name, secret, caps, dest, container_image=None):  # noqa E501
     '''
     Generate 'ceph-authtool' command line to execute
@@ -306,7 +284,7 @@ def generate_ceph_authtool_cmd(cluster, name, secret, caps, dest, container_imag
     return cmd
 
 
-def create_key(module, result, cluster, user, user_key_path, name, secret, caps, import_key, dest, container_image=None):  # noqa E501
+def create_key(module, result, cluster, user, user_key, name, secret, caps, import_key, dest, container_image=None):  # noqa E501
     '''
     Create a CephX key
     '''
@@ -326,13 +304,17 @@ def create_key(module, result, cluster, user, user_key_path, name, secret, caps,
         cluster, name, secret, caps, dest, container_image))
 
     if import_key or user != 'client.admin':
-        cmd_list.append(generate_ceph_cmd(
-            cluster, args, user, user_key_path, container_image))
+        cmd_list.append(generate_ceph_cmd(sub_cmd=['auth'],
+                                          args=args,
+                                          cluster=cluster,
+                                          user=user,
+                                          user_key=user_key,
+                                          container_image=container_image))
 
     return cmd_list
 
 
-def delete_key(cluster, user, user_key_path, name, container_image=None):
+def delete_key(cluster, user, user_key, name, container_image=None):
     '''
     Delete a CephX key
     '''
@@ -344,13 +326,17 @@ def delete_key(cluster, user, user_key_path, name, container_image=None):
         name,
     ]
 
-    cmd_list.append(generate_ceph_cmd(
-        cluster, args, user, user_key_path, container_image))
+    cmd_list.append(generate_ceph_cmd(sub_cmd=['auth'],
+                                      args=args,
+                                      cluster=cluster,
+                                      user=user,
+                                      user_key=user_key,
+                                      container_image=container_image))
 
     return cmd_list
 
 
-def get_key(cluster, user, user_key_path, name, dest, container_image=None):
+def get_key(cluster, user, user_key, name, dest, container_image=None):
     '''
     Get a CephX key (write on the filesystem)
     '''
@@ -364,13 +350,17 @@ def get_key(cluster, user, user_key_path, name, dest, container_image=None):
         dest,
     ]
 
-    cmd_list.append(generate_ceph_cmd(
-        cluster, args, user, user_key_path, container_image))
+    cmd_list.append(generate_ceph_cmd(sub_cmd=['auth'],
+                                      args=args,
+                                      cluster=cluster,
+                                      user=user,
+                                      user_key=user_key,
+                                      container_image=container_image))
 
     return cmd_list
 
 
-def info_key(cluster, name, user, user_key_path, output_format, container_image=None):  # noqa E501
+def info_key(cluster, name, user, user_key, output_format, container_image=None):  # noqa E501
     '''
     Get information about a CephX key
     '''
@@ -384,13 +374,17 @@ def info_key(cluster, name, user, user_key_path, output_format, container_image=
         output_format,
     ]
 
-    cmd_list.append(generate_ceph_cmd(
-        cluster, args, user, user_key_path, container_image))
+    cmd_list.append(generate_ceph_cmd(sub_cmd=['auth'],
+                                      args=args,
+                                      cluster=cluster,
+                                      user=user,
+                                      user_key=user_key,
+                                      container_image=container_image))
 
     return cmd_list
 
 
-def list_keys(cluster, user, user_key_path, container_image=None):
+def list_keys(cluster, user, user_key, container_image=None):
     '''
     List all CephX keys
     '''
@@ -403,8 +397,12 @@ def list_keys(cluster, user, user_key_path, container_image=None):
         'json',
     ]
 
-    cmd_list.append(generate_ceph_cmd(
-        cluster, args, user, user_key_path, container_image))
+    cmd_list.append(generate_ceph_cmd(sub_cmd=['auth'],
+                                      args=args,
+                                      cluster=cluster,
+                                      user=user,
+                                      user_key=user_key,
+                                      container_image=container_image))
 
     return cmd_list
 
@@ -481,15 +479,15 @@ def run_module():
     module_args = dict(
         cluster=dict(type='str', required=False, default='ceph'),
         name=dict(type='str', required=False),
-        state=dict(type='str', required=False, default='present', choices=['present', 'update', 'absent',
-                                                                           'list', 'info', 'fetch_initial_keys', 'generate_secret']),
+        state=dict(type='str', required=False, default='present', choices=['present', 'update', 'absent',  # noqa E501
+                                                                           'list', 'info', 'fetch_initial_keys', 'generate_secret']),  # noqa E501
         caps=dict(type='dict', required=False, default=None),
         secret=dict(type='str', required=False, default=None, no_log=True),
         import_key=dict(type='bool', required=False, default=True),
         dest=dict(type='str', required=False, default='/etc/ceph/'),
         user=dict(type='str', required=False, default='client.admin'),
         user_key=dict(type='str', required=False, default=None),
-        output_format=dict(type='str', required=False, default='json', choices=['json', 'plain', 'xml', 'yaml'])
+        output_format=dict(type='str', required=False, default='json', choices=['json', 'plain', 'xml', 'yaml'])  # noqa E501
     )
 
     module = AnsibleModule(
@@ -610,7 +608,7 @@ def run_module():
     elif state == "absent":
         if key_exist == 0:
             rc, cmd, out, err = exec_commands(
-                module, delete_key(cluster, user, user_key_path, name, container_image))
+                module, delete_key(cluster, user, user_key_path, name, container_image))  # noqa E501
             if rc == 0:
                 changed = True
         else:

diff --git a/tests/library/test_ceph_key.py b/tests/library/test_ceph_key.py
index bbeeecbc9b2e078d32725ec43ead31754d0cba8f..5b3d10391d9b2f4c5b29307785a1228bab1e4e04 100644 (file)
--- a/tests/library/test_ceph_key.py
+++ b/tests/library/test_ceph_key.py
@@ -50,7 +50,7 @@ class TestCephKeyModule(object):
         fake_cluster = "fake"
         fake_args = ['arg']
         fake_user = "fake-user"
-        fake_key = "/tmp/my-key"
+        fake_user_key = "/tmp/my-key"
         expected_command_list = [
             'ceph',
             '-n',
@@ -63,14 +63,18 @@ class TestCephKeyModule(object):
             'arg'
         ]
         result = ceph_key.generate_ceph_cmd(
-            fake_cluster, fake_args, fake_user, fake_key)
+            sub_cmd=['auth'],
+            args=fake_args,
+            cluster=fake_cluster,
+            user=fake_user,
+            user_key=fake_user_key)
         assert result == expected_command_list
 
     def test_generate_ceph_cmd_list_container(self):
         fake_cluster = "fake"
         fake_args = ['arg']
         fake_user = "fake-user"
-        fake_key = "/tmp/my-key"
+        fake_user_key = "/tmp/my-key"
         fake_container_image = "quay.ceph.io/ceph-ci/daemon:latest-luminous"
         expected_command_list = ['docker',
                                  'run',
@@ -90,7 +94,12 @@ class TestCephKeyModule(object):
                                  'auth',
                                  'arg']
         result = ceph_key.generate_ceph_cmd(
-            fake_cluster, fake_args, fake_user, fake_key, fake_container_image)
+            sub_cmd=['auth'],
+            args=fake_args,
+            cluster=fake_cluster,
+            user=fake_user,
+            user_key=fake_user_key,
+            container_image=fake_container_image)
         assert result == expected_command_list
 
     def test_generate_ceph_authtool_cmd_non_container_no_auid(self):