Add tests for list_keys verb (#123)

* Add tests for list_keys verb

Also ensure list_keys properly handles a non-existent keystore.

Signed-off-by: Kyle Fazzari <kyle@canonical.com>

* Use api instead of commands for non-list_keys verbs

Signed-off-by: Kyle Fazzari <kyle@canonical.com>

* Flip import order for flake8

Signed-off-by: Kyle Fazzari <kyle@canonical.com>

* Make sure error message is common between platforms

Signed-off-by: Kyle Fazzari <kyle@canonical.com>

sros2/sros2/verb/list_keys.py

@@ -18,6 +18,8 @@ except ImportError:
     def DirectoriesCompleter():
         return None
 
+import sys
+
 from sros2.api import list_keys
 from sros2.verb import VerbExtension
 
@@ -30,5 +32,9 @@ class ListKeysVerb(VerbExtension):
         arg.completer = DirectoriesCompleter()
 
     def main(self, *, args):
-        success = list_keys(args.ROOT)
-        return 0 if success else 1
+        try:
+            if list_keys(args.ROOT):
+                return 0
+        except FileNotFoundError as e:
+            print('No such file or directory: {!r}'.format(e.filename), file=sys.stderr)
+        return 1

sros2/test/sros2/commands/security/verbs/test_list_keys.py

+# Copyright 2019 Canonical Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import tempfile
+
+from ros2cli import cli
+from sros2.api import create_key, create_keystore
+
+
+def test_list_keys(capsys):
+    with tempfile.TemporaryDirectory() as keystore_dir:
+        with capsys.disabled():
+            # First, create the keystore
+            assert create_keystore(keystore_dir)
+
+            # Now using that keystore, create a keypair
+            assert create_key(keystore_dir, '/test_node')
+
+        # Now verify that the key we just created is included in the list
+        assert cli.main(argv=['security', 'list_keys', keystore_dir]) == 0
+        assert capsys.readouterr().out.strip() == 'test_node'
+
+
+def test_list_keys_no_keys(capsys):
+    with tempfile.TemporaryDirectory() as keystore_dir:
+        with capsys.disabled():
+            # First, create the keystore
+            assert create_keystore(keystore_dir)
+
+        # Now verify that empty keystore we just created contains no keys
+        assert cli.main(argv=['security', 'list_keys', keystore_dir]) == 0
+        assert len(capsys.readouterr().out.strip()) == 0
+
+
+def test_list_keys_uninitialized_keystore(capsys):
+    with tempfile.TemporaryDirectory() as keystore_dir:
+        # Verify that list_keys properly handles an uninitialized keystore
+        assert cli.main(argv=['security', 'list_keys', keystore_dir]) == 0
+        assert len(capsys.readouterr().out.strip()) == 0
+
+
+def test_list_keys_no_keystore(capsys):
+    # Verify that list_keys properly handles a non-existent keystore
+    keystore = os.path.join(tempfile.gettempdir(), 'non-existent')
+    assert cli.main(argv=['security', 'list_keys', keystore]) != 0
+    assert capsys.readouterr().err.strip() == 'No such file or directory: {!r}'.format(keystore)