vantage6 4.0.2__py3-none-any.whl → 4.1.0b0__py3-none-any.whl

tests_cli/test_node_cli.py

@@ -11,17 +11,16 @@ from docker.errors import APIError
 
 from vantage6.cli.globals import APPNAME
 from vantage6.common import STRING_ENCODING
-from vantage6.cli.node import (
-    cli_node_list,
-    cli_node_new_configuration,
-    cli_node_files,
-    cli_node_start,
-    cli_node_stop,
-    cli_node_attach,
-    cli_node_create_private_key,
-    cli_node_clean,
-    _print_log_worker,
-    _create_client_and_authenticate,
+from vantage6.cli.node.list import cli_node_list
+from vantage6.cli.node.new import cli_node_new_configuration
+from vantage6.cli.node.files import cli_node_files
+from vantage6.cli.node.start import cli_node_start
+from vantage6.cli.node.stop import cli_node_stop
+from vantage6.cli.node.attach import cli_node_attach
+from vantage6.cli.node.create_private_key import cli_node_create_private_key
+from vantage6.cli.node.clean import cli_node_clean
+from vantage6.cli.node.common import (
+    create_client_and_authenticate, print_log_worker
 )
 
 
@@ -86,9 +85,9 @@ class NodeCLITest(unittest.TestCase):
             "-----------------------------------------------------\n"
         )
 
-    @patch("vantage6.cli.node.configuration_wizard")
-    @patch("vantage6.cli.node.check_config_writeable")
-    @patch("vantage6.cli.node.NodeContext")
+    @patch("vantage6.cli.node.new.configuration_wizard")
+    @patch("vantage6.cli.node.new.check_config_writeable")
+    @patch("vantage6.cli.node.common.NodeContext")
     def test_new_config(self, context, permissions, wizard):
         """No error produced when creating new configuration."""
         context.config_exists.return_value = False
@@ -106,7 +105,7 @@ class NodeCLITest(unittest.TestCase):
         # check OK exit code
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.node.configuration_wizard")
+    @patch("vantage6.cli.node.new.configuration_wizard")
     def test_new_config_replace_whitespace_in_name(self, _):
         """Whitespaces are replaced in the name."""
 
@@ -120,7 +119,7 @@ class NodeCLITest(unittest.TestCase):
             "[info ] - Replaced spaces from configuration name: some-name"
         )
 
-    @patch("vantage6.cli.node.NodeContext")
+    @patch("vantage6.cli.node.new.NodeContext")
     def test_new_config_already_exists(self, context):
         """No duplicate configurations are allowed."""
 
@@ -137,8 +136,8 @@ class NodeCLITest(unittest.TestCase):
         # check non-zero exit code
         self.assertEqual(result.exit_code, 1)
 
-    @patch("vantage6.cli.node.check_config_writeable")
-    @patch("vantage6.cli.node.NodeContext")
+    @patch("vantage6.cli.node.new.check_config_writeable")
+    @patch("vantage6.cli.node.common.NodeContext")
     def test_new_write_permissions(self, context, permissions):
         """User needs write permissions."""
 
@@ -156,12 +155,13 @@ class NodeCLITest(unittest.TestCase):
         # check non-zero exit code
         self.assertEqual(result.exit_code, 1)
 
-    @patch("vantage6.cli.node.NodeContext")
-    @patch("vantage6.cli.node.select_configuration_questionaire")
-    def test_files(self, select_config, context):
+    @patch("vantage6.cli.node.common.NodeContext")
+    @patch("vantage6.cli.node.files.NodeContext")
+    @patch("vantage6.cli.node.common.select_configuration_questionaire")
+    def test_files(self, select_config, context, common_context):
         """No errors produced when retrieving filepaths."""
 
-        context.config_exists.return_value = True
+        common_context.config_exists.return_value = True
         context.return_value = MagicMock(
             config_file="/file.yaml",
             log_file="/log.log",
@@ -180,7 +180,7 @@ class NodeCLITest(unittest.TestCase):
         # check status code is OK
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.node.NodeContext")
+    @patch("vantage6.cli.node.common.NodeContext")
     def test_files_non_existing_config(self, context):
         """An error is produced when a non existing config is used."""
 
@@ -196,10 +196,10 @@ class NodeCLITest(unittest.TestCase):
         self.assertNotEqual(result.exit_code, 0)
 
     @patch("docker.DockerClient.volumes")
-    @patch("vantage6.cli.node.pull_if_newer")
-    @patch("vantage6.cli.node.NodeContext")
+    @patch("vantage6.cli.node.start.pull_if_newer")
+    @patch("vantage6.cli.node.start.NodeContext")
     @patch("docker.DockerClient.containers")
-    @patch("vantage6.cli.node.check_docker_running", return_value=True)
+    @patch("vantage6.cli.node.start.check_docker_running", return_value=True)
     def test_start(self, check_docker, client, context, pull, volumes):
 
         # client.containers = MagicMock(name="docker.DockerClient.containers")
@@ -231,7 +231,7 @@ class NodeCLITest(unittest.TestCase):
         self.assertEqual(result.exit_code, 0)
 
     @patch("docker.DockerClient.containers")
-    @patch("vantage6.cli.node.check_docker_running",
+    @patch("vantage6.cli.node.stop.check_docker_running",
            return_value=True)
     def test_stop(self, check_docker, containers):
 
@@ -250,10 +250,10 @@ class NodeCLITest(unittest.TestCase):
 
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.node.time")
-    @patch("vantage6.cli.node._print_log_worker")
+    @patch("vantage6.cli.node.attach.time")
+    @patch("vantage6.cli.node.attach.print_log_worker")
     @patch("docker.DockerClient.containers")
-    @patch("vantage6.cli.node.check_docker_running", return_value=True)
+    @patch("vantage6.cli.node.attach.check_docker_running", return_value=True)
     def test_attach(self, check_docker, containers, log_worker, time_):
         """Attach docker logs without errors."""
         container1 = MagicMock()
@@ -270,13 +270,13 @@ class NodeCLITest(unittest.TestCase):
             result.output,
             "[info ] - Closing log file. Keyboard Interrupt.\n"
             "[info ] - Note that your node is still running! Shut it down "
-            "with 'vnode stop'\n"
+            "with 'v6 node stop'\n"
         )
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.node.q")
+    @patch("vantage6.cli.node.clean.q")
     @patch("docker.DockerClient.volumes")
-    @patch("vantage6.cli.node.check_docker_running", return_value=True)
+    @patch("vantage6.cli.node.clean.check_docker_running", return_value=True)
     def test_clean(self, check_docker, volumes, q):
         """Clean Docker volumes without errors."""
         volume1 = MagicMock()
@@ -293,10 +293,12 @@ class NodeCLITest(unittest.TestCase):
         # check exit code
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.node._create_client_and_authenticate")
-    @patch("vantage6.cli.node.NodeContext")
-    def test_create_private_key(self, context, client):
-        context.config_exists.return_value = True
+    @patch(
+        "vantage6.cli.node.create_private_key.create_client_and_authenticate")
+    @patch("vantage6.cli.node.common.NodeContext")
+    @patch("vantage6.cli.node.create_private_key.NodeContext")
+    def test_create_private_key(self, context, common_context, client):
+        common_context.config_exists.return_value = True
         context.return_value.type_data_folder.return_value = Path(".")
         client.return_value = MagicMock(
             whoami=MagicMock(organization_name="Test")
@@ -307,16 +309,19 @@ class NodeCLITest(unittest.TestCase):
         result = runner.invoke(cli_node_create_private_key,
                                ["--name", "application"])
 
+        self.assertEqual(result.exit_code, 0)
+
         # remove the private key file again
         os.remove("privkey_Test.pem")
 
-        self.assertEqual(result.exit_code, 0)
-
-    @patch("vantage6.cli.node.RSACryptor")
-    @patch("vantage6.cli.node._create_client_and_authenticate")
-    @patch("vantage6.cli.node.NodeContext")
-    def test_create_private_key_overwite(self, context, client, cryptor):
-        context.config_exists.return_value = True
+    @patch("vantage6.cli.node.create_private_key.RSACryptor")
+    @patch(
+        "vantage6.cli.node.create_private_key.create_client_and_authenticate")
+    @patch("vantage6.cli.node.common.NodeContext")
+    @patch("vantage6.cli.node.create_private_key.NodeContext")
+    def test_create_private_key_overwite(self, context, common_context, client,
+                                         cryptor):
+        common_context.config_exists.return_value = True
         context.return_value.type_data_folder.return_value = Path(".")
         client.return_value = MagicMock(
             whoami=MagicMock(organization_name="Test")
@@ -356,7 +361,7 @@ class NodeCLITest(unittest.TestCase):
 
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.node.NodeContext")
+    @patch("vantage6.cli.node.common.NodeContext")
     def test_create_private_key_config_not_found(self, context):
         context.config_exists.return_value = False
 
@@ -366,7 +371,7 @@ class NodeCLITest(unittest.TestCase):
 
         self.assertEqual(result.exit_code, 1)
 
-    @patch("vantage6.cli.node.q")
+    @patch("vantage6.cli.node.clean.q")
     @patch("docker.DockerClient.volumes")
     @patch("vantage6.common.docker.addons.check_docker_running")
     def test_clean_docker_error(self, check_docker, volumes, q):
@@ -385,19 +390,19 @@ class NodeCLITest(unittest.TestCase):
         # check exit code
         self.assertEqual(result.exit_code, 1)
 
-    def test__print_log_worker(self):
+    def test_print_log_worker(self):
         stream = BytesIO("Hello!".encode(STRING_ENCODING))
         temp_stdout = StringIO()
         with contextlib.redirect_stdout(temp_stdout):
-            _print_log_worker(stream)
+            print_log_worker(stream)
         output = temp_stdout.getvalue().strip()
         self.assertEqual(output, "Hello!")
 
-    @patch("vantage6.cli.node.info")
-    @patch("vantage6.cli.node.debug")
-    @patch("vantage6.cli.node.error")
-    @patch("vantage6.cli.node.UserClient")
-    @patch("vantage6.cli.node.q")
+    @patch("vantage6.cli.node.common.info")
+    @patch("vantage6.cli.node.common.debug")
+    @patch("vantage6.cli.node.common.error")
+    @patch("vantage6.cli.node.common.UserClient")
+    @patch("vantage6.cli.node.common.q")
     def test_client(self, q, client, error, debug, info):
 
         ctx = MagicMock(
@@ -410,14 +415,14 @@ class NodeCLITest(unittest.TestCase):
 
         # should not trigger an exception
         try:
-            _create_client_and_authenticate(ctx)
+            create_client_and_authenticate(ctx)
         except Exception:
             self.fail("Raised an exception!")
 
         # client raises exception
         client.side_effect = Exception("Boom!")
         with self.assertRaises(Exception):
-            _create_client_and_authenticate(ctx)
+            create_client_and_authenticate(ctx)
 
     # TODO this function has been moved to the common package. A test should
     # be added there instead of here

tests_cli/test_server_cli.py

@@ -5,26 +5,24 @@ from pathlib import Path
 from click.testing import CliRunner
 
 from vantage6.cli.globals import APPNAME
-from vantage6.cli.server import (
-    cli_server_start,
-    cli_server_configuration_list,
-    cli_server_files,
-    cli_server_import,
-    cli_server_new,
-    cli_server_stop,
-    cli_server_attach
-)
+from vantage6.cli.server.start import cli_server_start
+from vantage6.cli.server.list import cli_server_configuration_list
+from vantage6.cli.server.files import cli_server_files
+from vantage6.cli.server.import_ import cli_server_import
+from vantage6.cli.server.new import cli_server_new
+from vantage6.cli.server.stop import cli_server_stop
+from vantage6.cli.server.attach import cli_server_attach
 
 
 class ServerCLITest(unittest.TestCase):
 
-    @patch("vantage6.cli.server.NetworkManager")
-    @patch("vantage6.cli.server.docker.types.Mount")
+    @patch("vantage6.cli.server.start.NetworkManager")
+    @patch("vantage6.cli.server.start.docker.types.Mount")
     @patch("os.makedirs")
-    @patch("vantage6.cli.server.pull_if_newer")
-    @patch("vantage6.cli.server.ServerContext")
-    @patch("vantage6.cli.server.docker.from_env")
-    @patch("vantage6.cli.server.check_docker_running", return_value=True)
+    @patch("vantage6.cli.server.start.pull_if_newer")
+    @patch("vantage6.cli.server.common.ServerContext")
+    @patch("vantage6.cli.server.start.docker.from_env")
+    @patch("vantage6.cli.server.start.check_docker_running", return_value=True)
     def test_start(self, docker_check, containers, context,
                    pull, os_makedirs, mount, network_manager):
         """Start server without errors"""
@@ -52,9 +50,9 @@ class ServerCLITest(unittest.TestCase):
 
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.server.ServerContext")
+    @patch("vantage6.cli.server.common.ServerContext")
     @patch("docker.DockerClient.containers")
-    @patch("vantage6.cli.server.check_docker_running", return_value=True)
+    @patch("vantage6.cli.server.list.check_docker_running", return_value=True)
     def test_configuration_list(self, docker_check, containers, context):
         """Configuration list without errors."""
         container1 = MagicMock()
@@ -71,7 +69,7 @@ class ServerCLITest(unittest.TestCase):
         self.assertEqual(result.exit_code, 0)
         self.assertIsNone(result.exception)
 
-    @patch("vantage6.cli.server.ServerContext")
+    @patch("vantage6.cli.server.common.ServerContext")
     def test_files(self, context):
         """Configuration files without errors."""
 
@@ -88,10 +86,11 @@ class ServerCLITest(unittest.TestCase):
         self.assertEqual(result.exit_code, 0)
 
     @patch("docker.DockerClient.containers")
-    @patch("vantage6.cli.server._print_log_worker")
-    @patch("vantage6.cli.server.click.Path")
-    @patch("vantage6.cli.server.check_docker_running", return_value=True)
-    @patch("vantage6.cli.server.ServerContext")
+    @patch("vantage6.cli.server.import_.print_log_worker")
+    @patch("vantage6.cli.server.import_.click.Path")
+    @patch("vantage6.cli.server.import_.check_docker_running",
+           return_value=True)
+    @patch("vantage6.cli.server.common.ServerContext")
     def test_import(self, context, docker_check, click_path, log, containers):
         """Import entities without errors."""
         click_path.return_value = MagicMock()
@@ -111,9 +110,9 @@ class ServerCLITest(unittest.TestCase):
         self.assertIsNone(result.exception)
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.server.configuration_wizard")
-    @patch("vantage6.cli.server.check_config_writeable")
-    @patch("vantage6.cli.server.ServerContext")
+    @patch("vantage6.cli.server.new.configuration_wizard")
+    @patch("vantage6.cli.server.new.check_config_writeable")
+    @patch("vantage6.cli.server.new.ServerContext")
     def test_new(self, context, permissions, wizard):
         """New configuration without errors."""
 
@@ -127,9 +126,9 @@ class ServerCLITest(unittest.TestCase):
         self.assertIsNone(result.exception)
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.server.ServerContext")
-    @patch("vantage6.cli.server.docker.from_env")
-    @patch("vantage6.cli.server.check_docker_running", return_value=True)
+    @patch("vantage6.cli.server.stop.ServerContext")
+    @patch("vantage6.cli.server.stop.docker.from_env")
+    @patch("vantage6.cli.server.stop.check_docker_running", return_value=True)
     def test_stop(self, docker_check, containers, context):
         """Stop server without errors."""
 
@@ -150,9 +149,10 @@ class ServerCLITest(unittest.TestCase):
         self.assertIsNone(result.exception)
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.server.time.sleep")
+    @patch("vantage6.cli.server.attach.time.sleep")
     @patch("docker.DockerClient.containers")
-    @patch("vantage6.cli.server.check_docker_running", return_value=True)
+    @patch("vantage6.cli.server.attach.check_docker_running",
+           return_value=True)
     def test_attach(self, docker_check, containers, sleep):
         """Attach log to the console without errors."""
         container1 = MagicMock()

vantage6/cli/_version.py

@@ -7,7 +7,7 @@ with open(os.path.join(here, '__build__')) as fp:
     __build__ = json.load(fp)
 
 # Module version
-version_info = (4, 0, 2, 'final', __build__, 0)
+version_info = (4, 1, 0, 'beta', __build__, 0)
 
 # Module version stage suffix map
 _specifier_ = {'alpha': 'a', 'beta': 'b', 'candidate': 'rc', 'final': ''}

vantage6/cli/cli.py

@@ -0,0 +1,102 @@
+import click
+
+from vantage6.cli.server.attach import cli_server_attach
+from vantage6.cli.server.files import cli_server_files
+from vantage6.cli.server.import_ import cli_server_import
+from vantage6.cli.server.list import cli_server_configuration_list
+from vantage6.cli.server.new import cli_server_new
+from vantage6.cli.server.shell import cli_server_shell
+from vantage6.cli.server.start import cli_server_start
+from vantage6.cli.server.stop import cli_server_stop
+from vantage6.cli.server.version import cli_server_version
+from vantage6.cli.node.attach import cli_node_attach
+from vantage6.cli.node.clean import cli_node_clean
+from vantage6.cli.node.create_private_key import cli_node_create_private_key
+from vantage6.cli.node.files import cli_node_files
+from vantage6.cli.node.list import cli_node_list
+from vantage6.cli.node.new import cli_node_new_configuration
+from vantage6.cli.node.remove import cli_node_remove
+from vantage6.cli.node.set_api_key import cli_node_set_api_key
+from vantage6.cli.node.start import cli_node_start
+from vantage6.cli.node.stop import cli_node_stop
+from vantage6.cli.node.version import cli_node_version
+from vantage6.cli.dev.create import create_demo_network
+from vantage6.cli.dev.remove import remove_demo_network
+from vantage6.cli.dev.start import start_demo_network
+from vantage6.cli.dev.stop import stop_demo_network
+
+
+# Define the server group
+@click.group(name='server')
+def cli_server() -> None:
+    """
+    Manage your vantage6 server instances.
+    """
+
+
+# Define the commands for the server group
+cli_server.add_command(cli_server_attach, name='attach')
+cli_server.add_command(cli_server_files, name='files')
+cli_server.add_command(cli_server_import, name='import')
+cli_server.add_command(cli_server_configuration_list, name='list')
+cli_server.add_command(cli_server_new, name='new')
+cli_server.add_command(cli_server_shell, name='shell')
+cli_server.add_command(cli_server_start, name='start')
+cli_server.add_command(cli_server_stop, name='stop')
+cli_server.add_command(cli_server_version, name='version')
+
+
+# Define the node group
+@click.group(name="node")
+def cli_node() -> None:
+    """
+    Manage your vantage6 node instances.
+    """
+
+
+# Define the commands for the node group
+cli_node.add_command(cli_node_attach, name="attach")
+cli_node.add_command(cli_node_clean, name="clean")
+cli_node.add_command(cli_node_create_private_key, name="create-private-key")
+cli_node.add_command(cli_node_files, name="files")
+cli_node.add_command(cli_node_list, name="list")
+cli_node.add_command(cli_node_new_configuration, name="new")
+cli_node.add_command(cli_node_remove, name="remove")
+cli_node.add_command(cli_node_set_api_key, name="set-api-key")
+cli_node.add_command(cli_node_start, name="start")
+cli_node.add_command(cli_node_stop, name="stop")
+cli_node.add_command(cli_node_version, name="version")
+
+
+# Define the dev group
+@click.group(name="dev")
+def cli_dev() -> None:
+    """
+    Quickly manage a test network with a server and several nodes.
+
+    These commands are helpful for local testing of your vantage6 environment.
+    """
+
+
+# Define the commands for the dev group
+cli_dev.add_command(create_demo_network, name="create-demo-network")
+cli_dev.add_command(remove_demo_network, name="remove-demo-network")
+cli_dev.add_command(start_demo_network, name="start-demo-network")
+cli_dev.add_command(stop_demo_network, name="stop-demo-network")
+
+
+# Define the overall group
+@click.group(name='cli')
+def cli_complete() -> None:
+    """
+    The `v6` command line interface allows you to manage your vantage6
+    infrastructure.
+
+    It provides a number of subcommands to help you with this task.
+    """
+
+
+# Add the subcommands to the overall group
+cli_complete.add_command(cli_node)
+cli_complete.add_command(cli_server)
+cli_complete.add_command(cli_dev)