vantage6 4.3.0b5__tar.gz → 4.3.0b6__tar.gz

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vantage6
-Version: 4.3.0b5
+Version: 4.3.0b6
 Summary: vantage6 command line interface
 Home-page: https://github.com/vantage6/vantage6
 Requires-Python: >=3.10
@@ -117,7 +117,9 @@ This repository is home to 6 PyPi packages:
 * [vantage6-algorithm-tools](https://pypi.org/project/vantage6-algorithm-tools) -> _Python tools to facilitate algorithm development_
 * [vantage6-node](https://pypi.org/project/vantage6-node) -> _Node application package_
 * [vantage6-server](https://pypi.org/project/vantage6-server) -> _Server application package_
-* [vantage6-common](https://pypi.org/project/vantage6-common) -> _Server application package_
+* [vantage6-algorithm-store](https://pypi.org/project/vantage6-algorithm-store) -> _Algorithm store application package_
+* [vantage6-common](https://pypi.org/project/vantage6-common) -> _Package with common vantage6 functions_
+* [vantage6-backend-common](https://pypi.org/project/vantage6-backend-common) -> _Package with functions common to central server and algorithm store_
 
 **Note that when using vantage6 you do not install the _server_ and _node_ packages. These are delivered to you in Docker images.**
 

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/tests_cli/test_node_cli.py

@@ -11,6 +11,7 @@ from docker.errors import APIError
 
 from vantage6.cli.globals import APPNAME
 from vantage6.common import STRING_ENCODING
+from vantage6.cli.common.utils import print_log_worker
 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
@@ -19,7 +20,7 @@ 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
 
 
 class NodeCLITest(unittest.TestCase):
@@ -207,7 +208,7 @@ class NodeCLITest(unittest.TestCase):
 
     @patch("docker.DockerClient.volumes")
     @patch("vantage6.cli.node.start.pull_if_newer")
-    @patch("vantage6.cli.node.start.NodeContext")
+    @patch("vantage6.cli.common.decorator.get_context")
     @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):
@@ -248,7 +249,9 @@ class NodeCLITest(unittest.TestCase):
 
     @patch("docker.DockerClient.containers")
     @patch("vantage6.cli.node.stop.check_docker_running", return_value=True)
-    def test_stop(self, check_docker, containers):
+    @patch("vantage6.cli.node.stop.NodeContext")
+    @patch("vantage6.cli.node.stop.delete_volume_if_exists")
+    def test_stop(self, delete_volume, node_context, check_docker, containers):
         container1 = MagicMock()
         container1.name = f"{APPNAME}-iknl-user"
         containers.list.return_value = [container1]
@@ -257,9 +260,7 @@ class NodeCLITest(unittest.TestCase):
 
         result = runner.invoke(cli_node_stop, ["--name", "iknl"])
 
-        self.assertEqual(
-            result.output, "[info ] - Stopped the vantage6-iknl-user Node.\n"
-        )
+        self.assertEqual(result.output, "[info ] - Stopped the iknl Node.\n")
 
         self.assertEqual(result.exit_code, 0)
 

vantage6-4.3.0b6/vantage6/cli/__build__

@@ -0,0 +1 @@
+6

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6/cli/common/decorator.py

@@ -1,16 +1,18 @@
 from functools import wraps
+from pathlib import Path
 import click
 
 from vantage6.common import error
 from vantage6.common.globals import InstanceType
 from vantage6.cli.configuration_wizard import select_configuration_questionaire
-from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
 from vantage6.cli.context import select_context_class, get_context
 
 
-# TODO to make this decorator usable by nodes as well, we should make the
-# default for --user/--system configurable
-def click_insert_context(type_: InstanceType) -> callable:
+def click_insert_context(
+    type_: InstanceType,
+    include_name: bool = False,
+    include_system_folders: bool = False,
+) -> callable:
     """
     Supply the Click function with an additional context parameter. The context
     is passed to the function as the first argument.
@@ -19,6 +21,10 @@ def click_insert_context(type_: InstanceType) -> callable:
     ----------
     type_ : InstanceType
         The type of instance for which the context should be inserted
+    include_name : bool
+        Include the name of the configuration as an argument
+    include_system_folders : bool
+        Include whether or not to use the system folders as an argument
 
     Returns
     -------
@@ -38,19 +44,19 @@ def click_insert_context(type_: InstanceType) -> callable:
             "-c",
             "--config",
             default=None,
-            help="Absolute path to " "configuration-file; overrides --name",
+            help="Path to configuration-file; overrides --name",
         )
         @click.option(
             "--system",
             "system_folders",
             flag_value=True,
-            help="Use system folders instead of user folders. This " "is the default",
+            help="Use system folders instead of user folders. This is the default",
         )
         @click.option(
             "--user",
             "system_folders",
             flag_value=False,
-            default=DEFAULT_SERVER_SYSTEM_FOLDERS,
+            default=False if type_ == InstanceType.NODE else True,
             help="Use user folders instead of system folders",
         )
         @wraps(func)
@@ -85,7 +91,14 @@ def click_insert_context(type_: InstanceType) -> callable:
                         exit(1)
 
                 ctx = get_context(type_, name, system_folders)
-            return func(ctx, *args, **kwargs)
+            extra_args = []
+            if include_name:
+                if not name:
+                    name = Path(config).stem
+                extra_args.append(name)
+            if include_system_folders:
+                extra_args.append(system_folders)
+            return func(ctx, *extra_args, *args, **kwargs)
 
         return decorator
 

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6/cli/common/start.py

@@ -13,7 +13,7 @@ from vantage6.common.context import AppContext
 from vantage6.common.globals import InstanceType, APPNAME, DEFAULT_DOCKER_REGISTRY
 from vantage6.common.docker.addons import check_docker_running, pull_if_newer
 from vantage6.cli.context import AlgorithmStoreContext, ServerContext
-from vantage6.cli.server.common import print_log_worker
+from vantage6.cli.common.utils import print_log_worker
 from vantage6.cli.utils import check_config_name_allowed
 from vantage6.cli.globals import ServerGlobals, AlgoStoreGlobals
 

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6/cli/common/utils.py

@@ -1,11 +1,12 @@
 import questionary as q
-import docker
+from colorama import Fore, Style
 import click
+from typing import Iterable
+import docker
 
-from colorama import Fore, Style
 
 from vantage6.common import warning, error
-from vantage6.common.globals import APPNAME, InstanceType
+from vantage6.common.globals import APPNAME, InstanceType, STRING_ENCODING
 from vantage6.cli.context import select_context_class
 
 
@@ -114,3 +115,23 @@ def get_server_configuration_list(instance_type: InstanceType.SERVER) -> None:
     click.echo("-" * 85)
     if len(f1) + len(f2):
         warning(f"{Fore.RED}Failed imports: {len(f1)+len(f2)}{Style.RESET_ALL}")
+
+
+def print_log_worker(logs_stream: Iterable[bytes]) -> None:
+    """
+    Print the logs from the logs stream.
+
+    Parameters
+    ----------
+    logs_stream : Iterable[bytes]
+        Output of the container.attach() method
+    """
+    for log in logs_stream:
+        try:
+            print(log.decode(STRING_ENCODING), end="")
+        except UnicodeDecodeError:
+            print(
+                "ERROR DECODING LOGS!!! Printing raw bytes. Please check the logs in "
+                "the container."
+            )
+            print(log)

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6/cli/context/node.py

@@ -34,11 +34,18 @@ class NodeContext(AppContext):
     INST_CONFIG_MANAGER = NodeConfigurationManager
 
     def __init__(
-        self, instance_name: str, system_folders: bool = N_FOL, config_file: str = None
+        self,
+        instance_name: str,
+        system_folders: bool = N_FOL,
+        config_file: str = None,
+        print_log_header: bool = True,
     ):
         super().__init__(InstanceType.NODE, instance_name, system_folders, config_file)
         self.log.info("vantage6 version '%s'", __version__)
 
+        if print_log_header:
+            self.log.info(f"vantage6 version '{__version__}'")
+
     @classmethod
     def from_external_config_file(
         cls, path: str, system_folders: bool = N_FOL
@@ -61,7 +68,7 @@ class NodeContext(AppContext):
             Node context object
         """
         return super().from_external_config_file(
-            path, InstanceType.NODE, system_folders
+            Path(path).resolve(), InstanceType.NODE, system_folders
         )
 
     @classmethod

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6/cli/dev/create.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 import csv
-
+import yaml
 import click
 from jinja2 import Environment, FileSystemLoader
 from colorama import Fore, Style
@@ -445,6 +445,28 @@ def create_demo_network(
         keep=False,
         wait=True,
     )
+    info(
+        "Development network was set up successfully! You can now start the "
+        f"server and nodes with {Fore.GREEN}v6 server start-demo-network"
+        f"{Style.RESET_ALL}"
+    )
+    # find user credentials to print. Read from server import file
+    with open(server_import_config, "r") as f:
+        server_import_config = yaml.safe_load(f)
+
+    try:
+        user = server_import_config["organizations"][0]["users"][0]
+        username = user["username"]
+        password = user["password"]
+        info(
+            "You can login with the following credentials:\n"
+            f"Username: {username}\n"
+            f"Password: {password}\n"
+        )
+    except KeyError:
+        # No user found, skip printing credentials
+        pass
+
     return {
         "node_configs": node_config,
         "server_import_config": server_import_config,

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6/cli/node/attach.py

@@ -10,8 +10,9 @@ from vantage6.common import warning, error, info
 from vantage6.common.globals import APPNAME
 from vantage6.common.docker.addons import check_docker_running
 
+from vantage6.cli.common.utils import print_log_worker
 from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
-from vantage6.cli.node.common import find_running_node_names, print_log_worker
+from vantage6.cli.node.common import find_running_node_names
 
 
 @click.command()

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6/cli/node/common/__init__.py

@@ -2,34 +2,18 @@
 Common functions that are used in node CLI commands
 """
 
-from typing import Iterable
-
 import questionary as q
 import docker
 from colorama import Fore, Style
 
 from vantage6.common import error, info, debug
-from vantage6.common.globals import STRING_ENCODING, APPNAME, InstanceType
+from vantage6.common.globals import APPNAME, InstanceType
 from vantage6.client import UserClient
 
 from vantage6.cli.context.node import NodeContext
 from vantage6.cli.configuration_wizard import select_configuration_questionaire
 
 
-#  helper functions
-def print_log_worker(logs_stream: Iterable[bytes]) -> None:
-    """
-    Print the logs from the logs stream.
-
-    Parameters
-    ----------
-    logs_stream : Iterable[bytes]
-        Output of the container.attach() method
-    """
-    for log in logs_stream:
-        print(log.decode(STRING_ENCODING), end="")
-
-
 def create_client(ctx: NodeContext) -> UserClient:
     """
     Create a client instance.

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6/cli/node/start.py

@@ -1,11 +1,9 @@
-import sys
 from pathlib import Path
 from threading import Thread
 import time
 import os.path
 
 import click
-import questionary as q
 import docker
 
 from colorama import Fore, Style
@@ -24,35 +22,15 @@ from vantage6.common.docker.addons import (
     check_docker_running,
 )
 
+from vantage6.cli.common.decorator import click_insert_context
 from vantage6.cli.context.node import NodeContext
-from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
-from vantage6.cli.configuration_wizard import (
-    configuration_wizard,
-    select_configuration_questionaire,
-)
+from vantage6.cli.common.utils import print_log_worker
+from vantage6.cli.node.common import create_client
 from vantage6.cli.utils import check_config_name_allowed
 from vantage6.cli import __version__
-from vantage6.cli.node.common import print_log_worker, create_client
 
 
 @click.command()
-@click.option("-n", "--name", default=None, help="Configuration name")
-@click.option(
-    "-c", "--config", default=None, help="Path to configuration-file; overrides NAME"
-)
-@click.option(
-    "--system",
-    "system_folders",
-    flag_value=True,
-    help="Search for the configuration in the system folders",
-)
-@click.option(
-    "--user",
-    "system_folders",
-    flag_value=False,
-    default=N_FOL,
-    help="Search for the configuration in the user folders. This is " "the default",
-)
 @click.option("-i", "--image", default=None, help="Node Docker image to use")
 @click.option(
     "--keep/--auto-remove",
@@ -75,9 +53,10 @@ from vantage6.cli.node.common import print_log_worker, create_client
     help="Override vantage6 source code in container with the source"
     " code in this path",
 )
+@click_insert_context(InstanceType.NODE, include_name=True, include_system_folders=True)
 def cli_node_start(
+    ctx: NodeContext,
     name: str,
-    config: str,
     system_folders: bool,
     image: str,
     keep: bool,
@@ -93,27 +72,6 @@ def cli_node_start(
     info("Finding Docker daemon")
     docker_client = docker.from_env()
     NodeContext.LOGGING_ENABLED = False
-    if config:
-        name = Path(config).stem
-        ctx = NodeContext(name, system_folders, config)
-
-    else:
-        # in case no name is supplied, ask the user to select one
-        if not name:
-            name = select_configuration_questionaire(InstanceType.NODE, system_folders)
-
-        # check that config exists, if not a questionaire will be invoked
-        if not NodeContext.config_exists(name, system_folders):
-            warning(f"Configuration {Fore.RED}{name}{Style.RESET_ALL} does not exist.")
-
-            if q.confirm("Create this configuration now?").ask():
-                configuration_wizard(InstanceType.NODE, name, system_folders)
-
-            else:
-                error("Config file couldn't be loaded")
-                sys.exit(0)
-
-        ctx = NodeContext(name, system_folders)
 
     # check if config name is allowed docker name, else exit
     check_config_name_allowed(ctx.name)

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6/cli/node/stop.py

@@ -3,10 +3,16 @@ import questionary as q
 import docker
 
 from colorama import Fore, Style
+from vantage6.cli.context import NodeContext
 
 from vantage6.common import warning, error, info
 from vantage6.common.globals import APPNAME
-from vantage6.common.docker.addons import check_docker_running
+from vantage6.common.docker.addons import (
+    check_docker_running,
+    delete_volume_if_exists,
+    get_server_config_name,
+    stop_container,
+)
 from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
 
 from vantage6.cli.node.common import find_running_node_names
@@ -58,30 +64,57 @@ def cli_node_stop(
         )
 
     if all_nodes:
-        for name in running_node_names:
-            container = client.containers.get(name)
-            if force:
-                container.kill()
-            else:
-                container.stop()
-            info(f"Stopped the {Fore.GREEN}{name}{Style.RESET_ALL} Node.")
+        for container_name in running_node_names:
+            _stop_node(client, container_name, force, system_folders)
     else:
         if not name:
-            name = q.select(
+            container_name = q.select(
                 "Select the node you wish to stop:", choices=running_node_names
             ).ask()
         else:
             post_fix = "system" if system_folders else "user"
-            name = f"{APPNAME}-{name}-{post_fix}"
+            container_name = f"{APPNAME}-{name}-{post_fix}"
 
-        if name in running_node_names:
-            container = client.containers.get(name)
-            # Stop the container. Using stop() gives the container 10s to exit
-            # itself, if not then it will be killed
-            if force:
-                container.kill()
-            else:
-                container.stop()
+        if container_name in running_node_names:
+            _stop_node(client, container_name, force, system_folders)
             info(f"Stopped the {Fore.GREEN}{name}{Style.RESET_ALL} Node.")
         else:
-            error(f"{Fore.RED}{name}{Style.RESET_ALL} is not running?")
+            error(f"{Fore.RED}{name}{Style.RESET_ALL} is not running?!")
+
+
+def _stop_node(
+    client: docker.DockerClient, container_name: str, force: bool, system_folders: bool
+) -> None:
+    """
+    Stop a node
+
+    Parameters
+    ----------
+    client : docker.DockerClient
+        Docker client
+    name : str
+        Name of the node container to stop
+    force : bool
+        Whether to force the node to stop
+    system_folders : bool
+        Whether to use system folders or not
+    """
+    container = client.containers.get(container_name)
+    # Stop the container. Using stop() gives the container 10s to exit
+    # itself, if not then it will be killed
+    stop_container(container, force)
+
+    # Also delete volumes. This is done here rather than within the node container when
+    # it is stopped, because at that point the volumes are still in use. Here, the node
+    # has already been stopped
+    scope = "system" if system_folders else "user"
+    config_name = get_server_config_name(container_name, scope)
+    ctx = NodeContext(config_name, system_folders, print_log_header=False)
+    docker_client = docker.from_env()
+    for volume in [
+        ctx.docker_volume_name,
+        ctx.docker_squid_volume_name,
+        ctx.docker_ssh_volume_name,
+        ctx.docker_vpn_volume_name,
+    ]:
+        delete_volume_if_exists(docker_client, volume)

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6/cli/server/attach.py

@@ -12,7 +12,7 @@ from vantage6.common.docker.addons import check_docker_running
 from vantage6.common.globals import APPNAME, InstanceType
 
 from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
-from vantage6.cli.server.common import print_log_worker
+from vantage6.cli.common.utils import print_log_worker
 
 
 @click.command()

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6/cli/server/common/__init__.py

@@ -1,10 +1,8 @@
-from typing import Iterable
-
 from docker.client import DockerClient
 from colorama import Fore, Style
 
 from vantage6.common import error, info
-from vantage6.common.globals import STRING_ENCODING, APPNAME
+from vantage6.common.globals import APPNAME
 from vantage6.common.docker.addons import remove_container, get_container
 from vantage6.common.context import AppContext
 
@@ -49,19 +47,6 @@ def get_server_context(
     return ctx
 
 
-def print_log_worker(logs_stream: Iterable[bytes]) -> None:
-    """
-    Print the logs from the docker container to the terminal.
-
-    Parameters
-    ----------
-    logs_stream : Iterable[bytes]
-        Output of the `container.attach(.)` method
-    """
-    for log in logs_stream:
-        print(log.decode(STRING_ENCODING), end="")
-
-
 def stop_ui(client: DockerClient, ctx: ServerContext) -> None:
     """
     Check if the UI container is running, and if so, stop and remove it.

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6/cli/server/import_.py

@@ -17,7 +17,7 @@ from vantage6.common.globals import (
 from vantage6.cli.context.server import ServerContext
 from vantage6.cli.utils import check_config_name_allowed
 from vantage6.cli.common.decorator import click_insert_context
-from vantage6.cli.server.common import print_log_worker
+from vantage6.cli.common.utils import print_log_worker
 
 
 # TODO this method has a lot of duplicated code from `start`

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vantage6
-Version: 4.3.0b5
+Version: 4.3.0b6
 Summary: vantage6 command line interface
 Home-page: https://github.com/vantage6/vantage6
 Requires-Python: >=3.10
@@ -117,7 +117,9 @@ This repository is home to 6 PyPi packages:
 * [vantage6-algorithm-tools](https://pypi.org/project/vantage6-algorithm-tools) -> _Python tools to facilitate algorithm development_
 * [vantage6-node](https://pypi.org/project/vantage6-node) -> _Node application package_
 * [vantage6-server](https://pypi.org/project/vantage6-server) -> _Server application package_
-* [vantage6-common](https://pypi.org/project/vantage6-common) -> _Server application package_
+* [vantage6-algorithm-store](https://pypi.org/project/vantage6-algorithm-store) -> _Algorithm store application package_
+* [vantage6-common](https://pypi.org/project/vantage6-common) -> _Package with common vantage6 functions_
+* [vantage6-backend-common](https://pypi.org/project/vantage6-backend-common) -> _Package with functions common to central server and algorithm store_
 
 **Note that when using vantage6 you do not install the _server_ and _node_ packages. These are delivered to you in Docker images.**
 

{vantage6-4.3.0b5 → vantage6-4.3.0b6}/vantage6.egg-info/requires.txt

@@ -8,8 +8,8 @@ questionary==1.10.0
 rich==13.5.2
 schema==0.7.5
 SQLAlchemy==1.4.46
-vantage6-common==4.3.0b5
-vantage6-client==4.3.0b5
+vantage6-common==4.3.0b6
+vantage6-client==4.3.0b6
 
 [dev]
 coverage==6.4.4

vantage6-4.3.0b5/vantage6/cli/__build__

@@ -1 +0,0 @@
-5