added new command, unit tests and updated core test to work with commands that name starts with other command names

Author: Brian Flores

SoftLayer/CLI/environment.py

@@ -138,7 +138,8 @@ def list_commands(self, *path):
 
                 # offset is used to exclude the path that the caller requested.
                 offset = len(path_str) + 1 if path_str else 0
-                commands.append(command[offset:])
+                if ':' not in command[offset:]:
+                    commands.append(command[offset:])
 
         return sorted(commands)
 

SoftLayer/CLI/routes.py

@@ -331,19 +331,17 @@
      'SoftLayer.CLI.securitygroup.interface:remove'),
     ('securitygroup:event-log', 'SoftLayer.CLI.securitygroup.event_log:get_by_request_id'),
 
-    ('sshkey', 'SoftLayer.CLI.sshkey'),
-    ('sshkey:add', 'SoftLayer.CLI.sshkey.add:cli'),
-    ('sshkey:remove', 'SoftLayer.CLI.sshkey.remove:cli'),
-    ('sshkey:edit', 'SoftLayer.CLI.sshkey.edit:cli'),
-    ('sshkey:list', 'SoftLayer.CLI.sshkey.list:cli'),
-    ('sshkey:print', 'SoftLayer.CLI.sshkey.print:cli'),
-
-    ('ssl', 'SoftLayer.CLI.ssl'),
-    ('ssl:add', 'SoftLayer.CLI.ssl.add:cli'),
-    ('ssl:download', 'SoftLayer.CLI.ssl.download:cli'),
-    ('ssl:edit', 'SoftLayer.CLI.ssl.edit:cli'),
-    ('ssl:list', 'SoftLayer.CLI.ssl.list:cli'),
-    ('ssl:remove', 'SoftLayer.CLI.ssl.remove:cli'),
+    ('security', 'SoftLayer.CLI.security'),
+    ('security:sshkey-add', 'SoftLayer.CLI.security.sshkey_add:cli'),
+    ('security:sshkey-remove', 'SoftLayer.CLI.security.sshkey_remove:cli'),
+    ('security:sshkey-edit', 'SoftLayer.CLI.security.sshkey_edit:cli'),
+    ('security:sshkey-list', 'SoftLayer.CLI.security.sshkey_list:cli'),
+    ('security:sshkey-print', 'SoftLayer.CLI.security.sshkey_print:cli'),
+    ('security:cert-add', 'SoftLayer.CLI.security.cert_add:cli'),
+    ('security:cert-download', 'SoftLayer.CLI.security.cert_download:cli'),
+    ('security:cert-edit', 'SoftLayer.CLI.security.cert_edit:cli'),
+    ('security:cert-list', 'SoftLayer.CLI.security.cert_list:cli'),
+    ('security:cert-remove', 'SoftLayer.CLI.security.cert_remove:cli'),
 
     ('subnet', 'SoftLayer.CLI.subnet'),
     ('subnet:cancel', 'SoftLayer.CLI.subnet.cancel:cli'),

SoftLayer/CLI/security/__init__.py

@@ -0,0 +1,2 @@
+"""SSH Keys and SSL Certificates."""
+# :license: MIT, see LICENSE for more details.

SoftLayer/CLI/ssl/add.py renamed to SoftLayer/CLI/security/cert_add.py

@@ -0,0 +1,44 @@
+.. _cli_security:
+
+SSH Keys and SSL Certificates
+========
+
+.. click:: SoftLayer.CLI.security.sshkey_add:cli
+    :prog: security sshkey-add
+    :show-nested:
+
+.. click:: SoftLayer.CLI.security.sshkey_remove:cli
+    :prog: security sshkey-remove
+    :show-nested:
+
+.. click:: SoftLayer.CLI.security.sshkey_edit:cli
+    :prog: security sshkey-edit
+    :show-nested:
+
+.. click:: SoftLayer.CLI.security.sshkey_list:cli
+    :prog: security sshkey-list
+    :show-nested:
+
+.. click:: SoftLayer.CLI.security.sshkey_print:cli
+    :prog: security sshkey-print
+    :show-nested:
+
+.. click:: SoftLayer.CLI.security.cert_add:cli
+    :prog: security cert-add
+    :show-nested:
+
+.. click:: SoftLayer.CLI.security.cert_download:cli
+    :prog: security cert-download
+    :show-nested:
+
+.. click:: SoftLayer.CLI.security.cert_edit:cli
+    :prog: security cert-edit
+    :show-nested:
+
+.. click:: SoftLayer.CLI.security.cert_list:cli
+    :prog: security cert-list
+    :show-nested:
+
+.. click:: SoftLayer.CLI.security.cert_remove:cli
+    :prog: security cert-remove
+    :show-nested:

SoftLayer/CLI/ssl/download.py renamed to SoftLayer/CLI/security/cert_download.py

@@ -1,5 +1,5 @@
 """
-    SoftLayer.tests.CLI.modules.sshkey_tests
+    SoftLayer.tests.CLI.modules.security_tests
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     :license: MIT, see LICENSE for more details.
@@ -15,27 +15,27 @@
 from SoftLayer import testing
 
 
-class SshKeyTests(testing.TestCase):
-    def test_add_without_key_errors(self):
-        result = self.run_command(['sshkey', 'add', 'key1'])
+class SecurityTests(testing.TestCase):
+    def test_add_sshkey_without_key_errors(self):
+        result = self.run_command(['security', 'sshkey-add', 'key1'])
 
         self.assertEqual(result.exit_code, 2)
         self.assertIsInstance(result.exception, exceptions.ArgumentError)
 
-    def test_add_with_key_file_and_key_argument_errors(self):
+    def test_add_sshkey_with_key_file_and_key_argument_errors(self):
         path = os.path.join(testing.FIXTURE_PATH, 'id_rsa.pub')
-        result = self.run_command(['sshkey', 'add', 'key1',
+        result = self.run_command(['security', 'sshkey-add', 'key1',
                                    '--key=some_key',
                                    '--in-file=%s' % path])
 
         self.assertEqual(result.exit_code, 2)
         self.assertIsInstance(result.exception, exceptions.ArgumentError)
 
-    def test_add_by_option(self):
+    def test_add_sshkey_by_option(self):
         service = self.client['Security_Ssh_Key']
         mock_key = service.getObject()['key']
 
-        result = self.run_command(['sshkey', 'add', 'key1',
+        result = self.run_command(['security', 'sshkey-add', 'key1',
                                    '--key=%s' % mock_key,
                                    '--note=my key'])
 
@@ -47,10 +47,10 @@ def test_add_by_option(self):
                                        'key': mock_key,
                                        'label': 'key1'},))
 
-    def test_add_by_file(self):
+    def test_add_sshkey_by_file(self):
         path = os.path.join(testing.FIXTURE_PATH, 'id_rsa.pub')
 
-        result = self.run_command(['sshkey', 'add', 'key1',
+        result = self.run_command(['security', 'sshkey-add', 'key1',
                                    '--in-file=%s' % path])
 
         self.assert_no_fail(result)
@@ -63,22 +63,22 @@ def test_add_by_file(self):
                                        'key': mock_key,
                                        'label': 'key1'},))
 
-    def test_remove_key(self):
-        result = self.run_command(['--really', 'sshkey', 'remove', '1234'])
+    def test_remove_sshkey_key(self):
+        result = self.run_command(['--really', 'security', 'sshkey-remove', '1234'])
 
         self.assert_no_fail(result)
         self.assert_called_with('SoftLayer_Security_Ssh_Key', 'deleteObject',
                                 identifier=1234)
 
     @mock.patch('SoftLayer.CLI.formatting.no_going_back')
-    def test_remove_key_fail(self, ngb_mock):
+    def test_remove_sshkey_fail(self, ngb_mock):
         ngb_mock.return_value = False
-        result = self.run_command(['sshkey', 'remove', '1234'])
+        result = self.run_command(['security', 'sshkey-remove', '1234'])
 
         self.assertEqual(result.exit_code, 2)
 
-    def test_edit_key(self):
-        result = self.run_command(['sshkey', 'edit', '1234',
+    def test_edit_sshkey(self):
+        result = self.run_command(['security', 'sshkey-edit', '1234',
                                    '--label=key1', '--note=my key'])
 
         self.assert_no_fail(result)
@@ -87,17 +87,17 @@ def test_edit_key(self):
                                        'label': 'key1'},),
                                 identifier=1234)
 
-    def test_edit_key_fail(self):
+    def test_edit_sshkey_fail(self):
         fixture = self.set_mock('SoftLayer_Security_Ssh_Key', 'editObject')
         fixture.return_value = False
 
-        result = self.run_command(['sshkey', 'edit', '1234',
+        result = self.run_command(['security', 'sshkey-edit', '1234',
                                    '--label=key1', '--note=my key'])
 
         self.assertEqual(result.exit_code, 2)
 
-    def test_list_keys(self):
-        result = self.run_command(['sshkey', 'list'])
+    def test_list_sshkeys(self):
+        result = self.run_command(['security', 'sshkey-list'])
 
         self.assert_no_fail(result)
         self.assertEqual(json.loads(result.output),
@@ -110,21 +110,45 @@ def test_list_keys(self):
                            'id': '101',
                            'label': 'Test 2'}])
 
-    def test_print_key(self):
-        result = self.run_command(['sshkey', 'print', '1234'])
+    def test_print_sshkey(self):
+        result = self.run_command(['security', 'sshkey-print', '1234'])
 
         self.assert_no_fail(result)
         self.assertEqual(json.loads(result.output),
                          {'id': 1234, 'label': 'label', 'notes': 'notes'})
 
-    def test_print_key_file(self):
+    def test_print_sshkey_file(self):
         if sys.platform.startswith("win"):
             self.skipTest("Test doesn't work in Windows")
         with tempfile.NamedTemporaryFile() as sshkey_file:
             service = self.client['Security_Ssh_Key']
             mock_key = service.getObject()['key']
-            result = self.run_command(['sshkey', 'print', '1234',
+            result = self.run_command(['security', 'sshkey-print', '1234',
                                        '--out-file=%s' % sshkey_file.name])
 
             self.assert_no_fail(result)
             self.assertEqual(mock_key, sshkey_file.read().decode("utf-8"))
+
+    def test_list_certficates(self):
+        result = self.run_command(['security', 'cert-list', '--status', 'all'])
+        self.assert_no_fail(result)
+        self.assertEqual(json.loads(result.output), [
+            {
+                "id": 1234,
+                "common_name": "cert",
+                "days_until_expire": 0,
+                "notes": None
+            }
+        ])
+
+    @mock.patch('SoftLayer.CLI.formatting.no_going_back')
+    def test_remove_certficate(self, confirm_mock):
+        confirm_mock.return_value = True
+        result = self.run_command(['security', 'cert-remove', '123456'])
+        self.assert_no_fail(result)
+        self.assertEqual(result.exit_code, 0)
+
+    def test_download_certficate(self):
+        result = self.run_command(['security', 'cert-download', '123456'])
+        self.assert_no_fail(result)
+        self.assertEqual(result.exit_code, 0)