vantage6 4.2.1__py3-none-any.whl → 4.3.0b3__py3-none-any.whl

tests_cli/test_example.py

@@ -2,7 +2,6 @@ import unittest
 
 
 class ExampleTest(unittest.TestCase):
-
     def test_example(self):
         self.assertTrue(True)
         self.assertFalse(False)

tests_cli/test_node_cli.py

@@ -19,13 +19,10 @@ 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
-)
+from vantage6.cli.node.common import create_client_and_authenticate, print_log_worker
 
 
 class NodeCLITest(unittest.TestCase):
-
     @classmethod
     def setUpClass(cls):
         logging.getLogger("docker.utils.config").setLevel(logging.WARNING)
@@ -34,7 +31,7 @@ class NodeCLITest(unittest.TestCase):
     @patch("docker.DockerClient.ping")
     def test_list_docker_not_running(self, docker_ping):
         """An error is printed when docker is not running"""
-        docker_ping.side_effect = Exception('Boom!')
+        docker_ping.side_effect = Exception("Boom!")
 
         runner = CliRunner()
         result = runner.invoke(cli_node_list, [])
@@ -42,7 +39,7 @@ class NodeCLITest(unittest.TestCase):
         # check exit code
         self.assertEqual(result.exit_code, 1)
 
-    @patch("vantage6.cli.context.NodeContext.available_configurations")
+    @patch("vantage6.cli.context.node.NodeContext.available_configurations")
     @patch("docker.DockerClient.ping")
     @patch("docker.DockerClient.containers")
     def test_list(self, containers, docker_ping, available_configurations):
@@ -82,7 +79,7 @@ class NodeCLITest(unittest.TestCase):
             "-----------------------------------------------------\n"
             "iknl                     Not running     System \n"
             "iknl                     Running         User   \n"
-            "-----------------------------------------------------\n"
+            "-----------------------------------------------------\n",
         )
 
     @patch("vantage6.cli.node.new.configuration_wizard")
@@ -95,9 +92,13 @@ class NodeCLITest(unittest.TestCase):
         wizard.return_value = "/some/file/path"
 
         runner = CliRunner()
-        result = runner.invoke(cli_node_new_configuration, [
-            "--name", "some-name",
-        ])
+        result = runner.invoke(
+            cli_node_new_configuration,
+            [
+                "--name",
+                "some-name",
+            ],
+        )
 
         # check that info message is produced
         self.assertEqual(result.output[:7], "[info ]")
@@ -110,13 +111,17 @@ class NodeCLITest(unittest.TestCase):
         """Whitespaces are replaced in the name."""
 
         runner = CliRunner()
-        result = runner.invoke(cli_node_new_configuration, [
-            "--name", "some name",
-        ])
+        result = runner.invoke(
+            cli_node_new_configuration,
+            [
+                "--name",
+                "some name",
+            ],
+        )
 
         self.assertEqual(
             result.output[:60],
-            "[info ] - Replaced spaces from configuration name: some-name"
+            "[info ] - Replaced spaces from configuration name: some-name",
         )
 
     @patch("vantage6.cli.node.new.NodeContext")
@@ -126,9 +131,13 @@ class NodeCLITest(unittest.TestCase):
         context.config_exists.return_value = True
 
         runner = CliRunner()
-        result = runner.invoke(cli_node_new_configuration, [
-            "--name", "some-name",
-        ])
+        result = runner.invoke(
+            cli_node_new_configuration,
+            [
+                "--name",
+                "some-name",
+            ],
+        )
 
         # check that error is produced
         self.assertEqual(result.output[:7], "[error]")
@@ -145,9 +154,13 @@ class NodeCLITest(unittest.TestCase):
         permissions.return_value = False
 
         runner = CliRunner()
-        result = runner.invoke(cli_node_new_configuration, [
-            "--name", "some-name",
-        ])
+        result = runner.invoke(
+            cli_node_new_configuration,
+            [
+                "--name",
+                "some-name",
+            ],
+        )
 
         # check that error is produced
         self.assertEqual(result.output[:7], "[error]")
@@ -163,12 +176,9 @@ class NodeCLITest(unittest.TestCase):
 
         common_context.config_exists.return_value = True
         context.return_value = MagicMock(
-            config_file="/file.yaml",
-            log_file="/log.log",
-            data_dir="/dir"
+            config_file="/file.yaml", log_file="/log.log", data_dir="/dir"
         )
-        context.return_value.databases.items.return_value = \
-            [["label", "/file.db"]]
+        context.return_value.databases.items.return_value = [["label", "/file.db"]]
         select_config.return_value = "iknl"
 
         runner = CliRunner()
@@ -187,7 +197,7 @@ class NodeCLITest(unittest.TestCase):
         context.config_exists.return_value = False
 
         runner = CliRunner()
-        result = runner.invoke(cli_node_files, ['--name', 'non-existing'])
+        result = runner.invoke(cli_node_files, ["--name", "non-existing"])
 
         # Check that error is produced
         self.assertEqual(result.output[:7], "[error]")
@@ -201,7 +211,6 @@ class NodeCLITest(unittest.TestCase):
     @patch("docker.DockerClient.containers")
     @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")
         client.list.return_value = []
         volume = MagicMock()
@@ -213,39 +222,43 @@ class NodeCLITest(unittest.TestCase):
             data_dir=Path("data"),
             log_dir=Path("logs"),
             config_dir=Path("configs"),
-            databases=[{
-                "label": "some_label",
-                "uri": "data.csv",
-                "type": "csv"
-            }]
+            databases=[{"label": "some_label", "uri": "data.csv", "type": "csv"}],
         )
+
+        # cli_node_start() tests for truth value of a set-like object derived
+        # from ctx.config.get('node_extra_env', {}). Default MagicMock() will
+        # evaluate to True, empty dict to False. False signifies no overwritten
+        # env vars, hence no error.
+        def config_get_side_effect(key, default=None):
+            if key == "node_extra_env":
+                return {}
+            return MagicMock()
+
+        ctx.config.get.side_effect = config_get_side_effect
         ctx.get_data_file.return_value = "data.csv"
-        ctx.name = 'some-name'
+        ctx.name = "some-name"
         context.return_value = ctx
 
         runner = CliRunner()
 
         with runner.isolated_filesystem():
-            result = runner.invoke(cli_node_start, ['--name', 'some-name'])
+            result = runner.invoke(cli_node_start, ["--name", "some-name"])
 
         self.assertEqual(result.exit_code, 0)
 
     @patch("docker.DockerClient.containers")
-    @patch("vantage6.cli.node.stop.check_docker_running",
-           return_value=True)
+    @patch("vantage6.cli.node.stop.check_docker_running", return_value=True)
     def test_stop(self, check_docker, containers):
-
         container1 = MagicMock()
         container1.name = f"{APPNAME}-iknl-user"
         containers.list.return_value = [container1]
 
         runner = CliRunner()
 
-        result = runner.invoke(cli_node_stop, ['--name', 'iknl'])
+        result = runner.invoke(cli_node_stop, ["--name", "iknl"])
 
         self.assertEqual(
-            result.output,
-            "[info ] - Stopped the vantage6-iknl-user Node.\n"
+            result.output, "[info ] - Stopped the vantage6-iknl-user Node.\n"
         )
 
         self.assertEqual(result.exit_code, 0)
@@ -264,13 +277,13 @@ class NodeCLITest(unittest.TestCase):
         time_.sleep.side_effect = KeyboardInterrupt()
 
         runner = CliRunner()
-        result = runner.invoke(cli_node_attach, ['--name', 'iknl'])
+        result = runner.invoke(cli_node_attach, ["--name", "iknl"])
 
         self.assertEqual(
             result.output,
             "[info ] - Closing log file. Keyboard Interrupt.\n"
             "[info ] - Note that your node is still running! Shut it down "
-            "with 'v6 node stop'\n"
+            "with 'v6 node stop'\n",
         )
         self.assertEqual(result.exit_code, 0)
 
@@ -293,21 +306,17 @@ class NodeCLITest(unittest.TestCase):
         # check exit code
         self.assertEqual(result.exit_code, 0)
 
-    @patch(
-        "vantage6.cli.node.create_private_key.create_client_and_authenticate")
+    @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")
-        )
+        client.return_value = MagicMock(whoami=MagicMock(organization_name="Test"))
         # client.whoami.organization_name = "Test"
         runner = CliRunner()
 
-        result = runner.invoke(cli_node_create_private_key,
-                               ["--name", "application"])
+        result = runner.invoke(cli_node_create_private_key, ["--name", "application"])
 
         self.assertEqual(result.exit_code, 0)
 
@@ -315,18 +324,16 @@ class NodeCLITest(unittest.TestCase):
         os.remove("privkey_Test.pem")
 
     @patch("vantage6.cli.node.create_private_key.RSACryptor")
-    @patch(
-        "vantage6.cli.node.create_private_key.create_client_and_authenticate")
+    @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):
+    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")
-        )
-        cryptor.create_public_key_bytes.return_value = b''
+        client.return_value = MagicMock(whoami=MagicMock(organization_name="Test"))
+        cryptor.create_public_key_bytes.return_value = b""
         # client.whoami.organization_name = "Test"
 
         runner = CliRunner()
@@ -336,13 +343,10 @@ class NodeCLITest(unittest.TestCase):
             with open("privkey_iknl.pem", "w") as f:
                 f.write("does-not-matter")
 
-            result = runner.invoke(cli_node_create_private_key, [
-                "--name",
-                "application",
-                "--overwrite",
-                "--organization-name",
-                "iknl"
-            ])
+            result = runner.invoke(
+                cli_node_create_private_key,
+                ["--name", "application", "--overwrite", "--organization-name", "iknl"],
+            )
         self.assertEqual(result.exit_code, 0)
 
         # do not overwrite
@@ -350,12 +354,10 @@ class NodeCLITest(unittest.TestCase):
             with open("privkey_iknl.pem", "w") as f:
                 f.write("does-not-matter")
 
-            result = runner.invoke(cli_node_create_private_key, [
-                "--name",
-                "application",
-                "--organization-name",
-                "iknl"
-            ])
+            result = runner.invoke(
+                cli_node_create_private_key,
+                ["--name", "application", "--organization-name", "iknl"],
+            )
 
             # print(result.output)
 
@@ -366,8 +368,7 @@ class NodeCLITest(unittest.TestCase):
         context.config_exists.return_value = False
 
         runner = CliRunner()
-        result = runner.invoke(cli_node_create_private_key,
-                               ["--name", "application"])
+        result = runner.invoke(cli_node_create_private_key, ["--name", "application"])
 
         self.assertEqual(result.exit_code, 1)
 
@@ -375,7 +376,6 @@ class NodeCLITest(unittest.TestCase):
     @patch("docker.DockerClient.volumes")
     @patch("vantage6.common.docker.addons.check_docker_running")
     def test_clean_docker_error(self, check_docker, volumes, q):
-
         volume1 = MagicMock()
         volume1.name = "some-name-tmpvol"
         volume1.remove.side_effect = APIError("Testing")
@@ -404,13 +404,8 @@ class NodeCLITest(unittest.TestCase):
     @patch("vantage6.cli.node.common.UserClient")
     @patch("vantage6.cli.node.common.q")
     def test_client(self, q, client, error, debug, info):
-
         ctx = MagicMock(
-            config={
-                "server_url": "localhost",
-                "port": 5000,
-                "api_path": ""
-            }
+            config={"server_url": "localhost", "port": 5000, "api_path": ""}
         )
 
         # should not trigger an exception

tests_cli/test_server_cli.py

@@ -4,7 +4,7 @@ from unittest.mock import MagicMock, patch
 from pathlib import Path
 from click.testing import CliRunner
 
-from vantage6.cli.globals import APPNAME
+from vantage6.common.globals import APPNAME, InstanceType
 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
@@ -15,16 +15,23 @@ from vantage6.cli.server.attach import cli_server_attach
 
 
 class ServerCLITest(unittest.TestCase):
-
     @patch("vantage6.cli.server.start.NetworkManager")
     @patch("vantage6.cli.server.start.docker.types.Mount")
     @patch("os.makedirs")
-    @patch("vantage6.cli.server.start.pull_if_newer")
+    @patch("vantage6.cli.common.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):
+    @patch("vantage6.cli.common.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"""
         container1 = MagicMock()
         container1.containers.name = f"{APPNAME}-iknl-system"
@@ -34,15 +41,12 @@ class ServerCLITest(unittest.TestCase):
         # mount.types.Mount.return_value = MagicMock()
 
         ctx = MagicMock(
-            config={
-                'uri': 'sqlite:///file.db',
-                'port': 9999
-            },
+            config={"uri": "sqlite:///file.db", "port": 9999},
             config_file="/config.yaml",
-            data_dir=Path(".")
+            data_dir=Path("."),
         )
         ctx.config_exists.return_value = True
-        ctx.name = 'not-running'
+        ctx.name = "not-running"
         context.return_value = ctx
 
         runner = CliRunner()
@@ -74,8 +78,7 @@ class ServerCLITest(unittest.TestCase):
         """Configuration files without errors."""
 
         ctx = context.return_value = MagicMock(
-            log_file="/log_file.log",
-            config_file="/iknl.yaml"
+            log_file="/log_file.log", config_file="/iknl.yaml"
         )
         ctx.get_database_uri.return_value = "sqlite:///test.db"
 
@@ -88,24 +91,21 @@ class ServerCLITest(unittest.TestCase):
     @patch("docker.DockerClient.containers")
     @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.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()
 
         ctx = MagicMock()
-        ctx.name = 'some-name'
+        ctx.name = "some-name"
         context.return_value = ctx
 
         runner = CliRunner()
         with runner.isolated_filesystem():
             with open("some.yaml", "w") as fp:
                 fp.write("does-not-matter")
-            result = runner.invoke(cli_server_import, [
-                "--name", "iknl", "some.yaml"
-            ])
+            result = runner.invoke(cli_server_import, ["--name", "iknl", "some.yaml"])
 
         self.assertIsNone(result.exception)
         self.assertEqual(result.exit_code, 0)
@@ -131,7 +131,7 @@ class ServerCLITest(unittest.TestCase):
         """Stop server without errors."""
 
         container1 = MagicMock()
-        container1.name = f"{APPNAME}-iknl-system-server"
+        container1.name = f"{APPNAME}-iknl-system-{InstanceType.SERVER}"
         containers.containers.list.return_value = [container1]
 
         runner = CliRunner()
@@ -145,7 +145,7 @@ class ServerCLITest(unittest.TestCase):
     def test_attach(self, containers, sleep):
         """Attach log to the console without errors."""
         container1 = MagicMock()
-        container1.name = f"{APPNAME}-iknl-system-server"
+        container1.name = f"{APPNAME}-iknl-system-{InstanceType.SERVER}"
         containers.list.return_value = [container1]
 
         sleep.side_effect = KeyboardInterrupt("Boom!")

tests_cli/test_wizard.py

@@ -7,14 +7,14 @@ from vantage6.cli.configuration_wizard import (
     node_configuration_questionaire,
     server_configuration_questionaire,
     configuration_wizard,
-    select_configuration_questionaire
+    select_configuration_questionaire,
 )
+from vantage6.common.globals import InstanceType
 
 module_path = "vantage6.cli.configuration_wizard"
 
 
 class WizardTest(unittest.TestCase):
-
     @staticmethod
     def prompts(*args, **kwargs):
         result = {}
@@ -39,30 +39,46 @@ class WizardTest(unittest.TestCase):
                 False,  # don't enable two-factor authentication
                 True,  # add VPN server
                 False,  # don't abort if no server connection is made to pull
-                        # collaboration settings
-                True  # Enable encryption
+                # collaboration settings
+                True,  # Enable encryption
             ]
             dirs = MagicMock(data="/")
             config = node_configuration_questionaire(dirs, "iknl")
 
-        keys = ["api_key", "server_url", "port", "api_path", "task_dir",
-                "databases", "logging", "encryption", "vpn_subnet"]
+        keys = [
+            "api_key",
+            "server_url",
+            "port",
+            "api_path",
+            "task_dir",
+            "databases",
+            "logging",
+            "encryption",
+            "vpn_subnet",
+        ]
         for key in keys:
             self.assertIn(key, config)
 
     def test_server_wizard(self):
-
         with patch(f"{module_path}.q") as q:
             q.prompt.side_effect = self.prompts
-            q.confirm.return_value.ask.side_effect = [
-                True, True, True, True, True
-            ]
+            q.confirm.return_value.ask.side_effect = [True, True, True, True, True]
 
             config = server_configuration_questionaire("vantage6")
 
-            keys = ["description", "ip", "port", "api_path", "uri",
-                    "allow_drop_all", "jwt_secret_key", "logging",
-                    "vpn_server", "rabbitmq", "two_factor_auth"]
+            keys = [
+                "description",
+                "ip",
+                "port",
+                "api_path",
+                "uri",
+                "allow_drop_all",
+                "jwt_secret_key",
+                "logging",
+                "vpn_server",
+                "rabbitmq",
+                "two_factor_auth",
+            ]
 
             for key in keys:
                 self.assertIn(key, config)
@@ -71,31 +87,27 @@ class WizardTest(unittest.TestCase):
     @patch(f"{module_path}.server_configuration_questionaire")
     @patch(f"{module_path}.ServerConfigurationManager")
     @patch(f"{module_path}.NodeConfigurationManager")
-    @patch(f"{module_path}.NodeContext")
-    def test_configuration_wizard_interface(self, context, node_m, server_m,
-                                            server_q, node_q):
-        context.instance_folders.return_value = {
-            "config": "/some/path/"
-        }
-
-        file_ = configuration_wizard("node", "vtg6", False)
-        self.assertEqual(Path("/some/path/vtg6.yaml"), file_)
+    @patch("vantage6.cli.configuration_wizard.AppContext")
+    def test_configuration_wizard_interface(
+        self, context, node_m, server_m, server_q, node_q
+    ):
+        context.instance_folders.return_value = {"config": "/some/path/"}
 
-        file_ = configuration_wizard("server", "vtg6", True)
+        file_ = configuration_wizard(InstanceType.NODE, "vtg6", False)
         self.assertEqual(Path("/some/path/vtg6.yaml"), file_)
 
-    @patch(f"{module_path}.NodeContext")
-    @patch(f"{module_path}.ServerContext")
-    def test_select_configuration(self, server_c, node_c):
+        file_ = configuration_wizard(InstanceType.SERVER, "vtg6", True)
+        self.assertEqual(Path("/some/path/vtg6.yaml"), file_)
 
+    @patch("vantage6.cli.configuration_wizard.AppContext.available_configurations")
+    def test_select_configuration(self, available_configurations):
         config = MagicMock()
         config.name = "vtg6"
 
-        server_c.available_configurations.return_value = [[config], []]
-        node_c.available_configurations.return_value = [[config], []]
+        available_configurations.return_value = [[config], []]
 
         with patch(f"{module_path}.q") as q:
             q.select.return_value.ask.return_value = "vtg6"
-            name = select_configuration_questionaire("node", True)
+            name = select_configuration_questionaire(InstanceType.NODE, True)
 
         self.assertEqual(name, "vtg6")

vantage6/cli/__build__

@@ -1 +1 @@
-0
+3

vantage6/cli/_version.py

@@ -3,18 +3,21 @@ import json
 
 here = os.path.abspath(os.path.dirname(__file__))
 
-with open(os.path.join(here, '__build__')) as fp:
+with open(os.path.join(here, "__build__")) as fp:
     __build__ = json.load(fp)
 
 # Module version
-version_info = (4, 2, 1, 'final', __build__, 0)
+version_info = (4, 3, 0, "beta", __build__, 0)
 
 # Module version stage suffix map
-_specifier_ = {'alpha': 'a', 'beta': 'b', 'candidate': 'rc', 'final': ''}
-version = f'{version_info[0]}.{version_info[1]}.{version_info[2]}'
-pre_release = '' if version_info[3] == 'final' else \
-    _specifier_[version_info[3]]+str(version_info[4])
-post_release = '' if not version_info[5] else f'.post{version_info[5]}'
+_specifier_ = {"alpha": "a", "beta": "b", "candidate": "rc", "final": ""}
+version = f"{version_info[0]}.{version_info[1]}.{version_info[2]}"
+pre_release = (
+    ""
+    if version_info[3] == "final"
+    else _specifier_[version_info[3]] + str(version_info[4])
+)
+post_release = "" if not version_info[5] else f".post{version_info[5]}"
 
 # Module version accessible using thomas.__version__
-__version__ = f'{version}{pre_release}{post_release}'
+__version__ = f"{version}{pre_release}{post_release}"

vantage6/cli/algorithm/create.py

@@ -10,13 +10,18 @@ from vantage6.cli.utils import info
 
 
 @click.command()
-@click.option('-n', '--name', default=None, type=str,
-              help="Name for your new algorithm")
-@click.option('-d', '--dir', 'directory', default=None, type=str,
-              help="Directory to put the algorithm into")
-def cli_algorithm_create(
-    name: str, directory: str
-) -> dict:
+@click.option(
+    "-n", "--name", default=None, type=str, help="Name for your new algorithm"
+)
+@click.option(
+    "-d",
+    "--dir",
+    "directory",
+    default=None,
+    type=str,
+    help="Directory to put the algorithm into",
+)
+def cli_algorithm_create(name: str, directory: str) -> dict:
     """Creates a personalized template for a new algorithm
 
     By answering a number of questions, a template will be created that will
@@ -34,14 +39,9 @@ def cli_algorithm_create(
     if not directory:
         default_dir = str(Path(os.getcwd()) / name)
         directory = q.text(
-            "Directory to put the algorithm in:",
-            default=default_dir
+            "Directory to put the algorithm in:", default=default_dir
         ).ask()
 
-    run_copy(
-        ALGORITHM_TEMPLATE_REPO,
-        directory,
-        data={'algorithm_name': name}
-    )
+    run_copy(ALGORITHM_TEMPLATE_REPO, directory, data={"algorithm_name": name})
     info("Template created!")
     info(f"You can find your new algorithm in: {directory}")