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

vantage6/cli/node/stop.py

@@ -14,18 +14,30 @@ from vantage6.cli.node.common import find_running_node_names
 
 @click.command()
 @click.option("-n", "--name", default=None, help="Configuration name")
-@click.option('--system', 'system_folders', flag_value=True,
-              help="Search for configuration in system folders instead of "
-                   "user folders")
-@click.option('--user', 'system_folders', flag_value=False, default=N_FOL,
-              help="Search for configuration in the user folders instead of "
-                   "system folders. This is the default.")
-@click.option('--all', 'all_nodes', flag_value=True,
-              help="Stop all running nodes")
-@click.option('--force', 'force', flag_value=True,
-              help="Kill nodes instantly; don't wait for them to shut down")
-def cli_node_stop(name: str, system_folders: bool, all_nodes: bool,
-                  force: bool) -> None:
+@click.option(
+    "--system",
+    "system_folders",
+    flag_value=True,
+    help="Search for configuration in system folders instead of " "user folders",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    default=N_FOL,
+    help="Search for configuration in the user folders instead of "
+    "system folders. This is the default.",
+)
+@click.option("--all", "all_nodes", flag_value=True, help="Stop all running nodes")
+@click.option(
+    "--force",
+    "force",
+    flag_value=True,
+    help="Kill nodes instantly; don't wait for them to shut down",
+)
+def cli_node_stop(
+    name: str, system_folders: bool, all_nodes: bool, force: bool
+) -> None:
     """
     Stop one or all running nodes.
     """
@@ -39,9 +51,11 @@ def cli_node_stop(name: str, system_folders: bool, all_nodes: bool,
         return
 
     if force:
-        warning('Forcing the node to stop will not terminate helper '
-                'containers, neither will it remove routing rules made on the '
-                'host!')
+        warning(
+            "Forcing the node to stop will not terminate helper "
+            "containers, neither will it remove routing rules made on the "
+            "host!"
+        )
 
     if all_nodes:
         for name in running_node_names:
@@ -53,10 +67,10 @@ def cli_node_stop(name: str, system_folders: bool, all_nodes: bool,
             info(f"Stopped the {Fore.GREEN}{name}{Style.RESET_ALL} Node.")
     else:
         if not name:
-            name = q.select("Select the node you wish to stop:",
-                            choices=running_node_names).ask()
+            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}"
 

vantage6/cli/node/version.py

@@ -12,12 +12,20 @@ from vantage6.cli.node.common import find_running_node_names
 
 @click.command()
 @click.option("-n", "--name", default=None, help="Configuration name")
-@click.option('--system', 'system_folders', flag_value=True,
-              help="Search for configuration in system folders rather than "
-                   "user folders")
-@click.option('--user', 'system_folders', flag_value=False, default=N_FOL,
-              help="Search for configuration in user folders rather than "
-                   "system folders. This is the default")
+@click.option(
+    "--system",
+    "system_folders",
+    flag_value=True,
+    help="Search for configuration in system folders rather than " "user folders",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    default=N_FOL,
+    help="Search for configuration in user folders rather than "
+    "system folders. This is the default",
+)
 def cli_node_version(name: str, system_folders: bool) -> None:
     """
     Returns current version of a vantage6 node.
@@ -29,19 +37,21 @@ def cli_node_version(name: str, system_folders: bool) -> None:
 
     if not name:
         if not running_node_names:
-            error("No nodes are running! You can only check the version for "
-                  "nodes that are running")
+            error(
+                "No nodes are running! You can only check the version for "
+                "nodes that are running"
+            )
             exit(1)
-        name = q.select("Select the node you wish to inspect:",
-                        choices=running_node_names).ask()
+        name = q.select(
+            "Select the node you wish to inspect:", choices=running_node_names
+        ).ask()
     else:
         post_fix = "system" if system_folders else "user"
         name = f"{APPNAME}-{name}-{post_fix}"
 
     if name in running_node_names:
         container = client.containers.get(name)
-        version = container.exec_run(cmd='vnode-local version', stdout=True)
-        click.echo(
-            {"node": version.output.decode('utf-8'), "cli": __version__})
+        version = container.exec_run(cmd="vnode-local version", stdout=True)
+        click.echo({"node": version.output.decode("utf-8"), "cli": __version__})
     else:
         error(f"Node {name} is not running! Cannot provide version...")

vantage6/cli/rabbitmq/__init__.py

@@ -15,14 +15,14 @@ def split_rabbitmq_uri(rabbit_uri: str) -> dict:
     dict[str]
         The vhost defined in the RabbitMQ URI
     """
-    (user_details, location_details) = rabbit_uri.split('@', 1)
-    (user, password) = user_details.split('/')[-1].split(':', 1)
-    (host, remainder) = location_details.split(':', 1)
-    port, vhost = remainder.split('/', 1)
+    (user_details, location_details) = rabbit_uri.split("@", 1)
+    (user, password) = user_details.split("/")[-1].split(":", 1)
+    (host, remainder) = location_details.split(":", 1)
+    port, vhost = remainder.split("/", 1)
     return {
-        'user': user,
-        'password': password,
-        'host': host,
-        'port': port,
-        'vhost': vhost,
+        "user": user,
+        "password": password,
+        "host": host,
+        "port": port,
+        "vhost": vhost,
     }

vantage6/cli/rabbitmq/definitions.py

@@ -1,30 +1,26 @@
 RABBITMQ_DEFINITIONS = {
-  "rabbit_version": "3.6.6",
-  "users": [
-   {
-    "name": "{{username}}",
-    "password_hash": "{{password}}",
-    "hashing_algorithm": "rabbit_password_hashing_sha256",
-    "tags": "administrator"
-   }
-  ],
-  "vhosts": [
-   {
-    "name": "{{vhost_name}}"
-   }
-  ],
-  "permissions": [
-   {
-    "user": "{{username}}",
-    "vhost": "{{vhost_name}}",
-    "configure": ".*",
-    "write": ".*",
-    "read": ".*"
-   }
-  ],
-  "parameters": [],
-  "policies": [],
-  "queues": [],
-  "exchanges": [],
-  "bindings": []
+    "rabbit_version": "3.6.6",
+    "users": [
+        {
+            "name": "{{username}}",
+            "password_hash": "{{password}}",
+            "hashing_algorithm": "rabbit_password_hashing_sha256",
+            "tags": "administrator",
+        }
+    ],
+    "vhosts": [{"name": "{{vhost_name}}"}],
+    "permissions": [
+        {
+            "user": "{{username}}",
+            "vhost": "{{vhost_name}}",
+            "configure": ".*",
+            "write": ".*",
+            "read": ".*",
+        }
+    ],
+    "parameters": [],
+    "policies": [],
+    "queues": [],
+    "exchanges": [],
+    "bindings": [],
 }

vantage6/cli/rabbitmq/queue_manager.py

@@ -12,14 +12,14 @@ from vantage6.common.globals import APPNAME
 from vantage6.common import debug, info, error
 from vantage6.common.docker.addons import get_container
 from vantage6.common.docker.network_manager import NetworkManager
-from vantage6.cli.context import ServerContext
+from vantage6.cli.context.server import ServerContext
 from vantage6.cli.rabbitmq.definitions import RABBITMQ_DEFINITIONS
 from vantage6.cli.globals import RABBIT_TIMEOUT
 from vantage6.cli.rabbitmq import split_rabbitmq_uri
 
-DEFAULT_RABBIT_IMAGE = 'harbor2.vantage6.ai/infrastructure/rabbitmq'
-RABBIT_CONFIG = 'rabbitmq.config'
-RABBIT_DIR = 'rabbitmq'
+DEFAULT_RABBIT_IMAGE = "harbor2.vantage6.ai/infrastructure/rabbitmq"
+RABBIT_CONFIG = "rabbitmq.config"
+RABBIT_DIR = "rabbitmq"
 
 
 class RabbitMQManager:
@@ -36,17 +36,19 @@ class RabbitMQManager:
         Docker image to use for RabbitMQ container. By default, the image
         harbor2.vantage6.ai/infrastructure/rabbitmq is used.
     """
-    def __init__(self, ctx: ServerContext, network_mgr: NetworkManager,
-                 image: str = None) -> None:
+
+    def __init__(
+        self, ctx: ServerContext, network_mgr: NetworkManager, image: str = None
+    ) -> None:
         self.ctx = ctx
-        self.queue_uri = self.ctx.config['rabbitmq'].get('uri')
+        self.queue_uri = self.ctx.config["rabbitmq"].get("uri")
         rabbit_splitted = split_rabbitmq_uri(self.queue_uri)
-        self.rabbit_user = rabbit_splitted['user']
-        self.rabbit_pass = rabbit_splitted['password']
-        self.vhost = rabbit_splitted['vhost']
-        self.port = rabbit_splitted['port']
-        self.host = rabbit_splitted['host']
-        self.definitions_file = Path(self.ctx.data_dir / 'definitions.json')
+        self.rabbit_user = rabbit_splitted["user"]
+        self.rabbit_pass = rabbit_splitted["password"]
+        self.vhost = rabbit_splitted["vhost"]
+        self.port = rabbit_splitted["port"]
+        self.host = rabbit_splitted["host"]
+        self.definitions_file = Path(self.ctx.data_dir / "definitions.json")
         self.network_mgr = network_mgr
 
         self.docker = docker.from_env()
@@ -64,19 +66,16 @@ class RabbitMQManager:
         # same for 15672 in container to 8080 on host
         # TODO check if these ports are not already used on the host
         ports = {
-            f'{self.port}/tcp': self.port,
+            f"{self.port}/tcp": self.port,
             # TODO this is for the management tool, do we keep this? Not used
             # at the moment..
-            '15672/tcp': 8080
+            "15672/tcp": 8080,
         }
 
         # check if a RabbitMQ container is already running
-        self.rabbit_container = get_container(
-            docker_client=self.docker, name=self.host
-        )
+        self.rabbit_container = get_container(docker_client=self.docker, name=self.host)
         if self.rabbit_container:
-            info("RabbitMQ is already running! Linking the server to that "
-                 "queue")
+            info("RabbitMQ is already running! Linking the server to that " "queue")
             if not self.network_mgr.contains(self.rabbit_container):
                 self.network_mgr.connect(self.rabbit_container)
             return
@@ -93,14 +92,14 @@ class RabbitMQManager:
             labels={
                 f"{APPNAME}-type": "rabbitmq",
             },
-            network=self.network_mgr.network_name
+            network=self.network_mgr.network_name,
         )
 
         # Wait until RabbitMQ is up before continuing with other stuff
         self._wait_for_startup()
 
     def _wait_for_startup(self) -> None:
-        """ Wait until RabbitMQ has been initialized """
+        """Wait until RabbitMQ has been initialized"""
         interval = 10
         attempts = int((RABBIT_TIMEOUT + interval) / interval)
         is_running = False
@@ -144,12 +143,11 @@ class RabbitMQManager:
         rabbit_definitions = self._get_rabbitmq_definitions()
 
         # write the RabbitMQ definition to file(s)
-        with open(self.definitions_file, 'w') as f:
+        with open(self.definitions_file, "w") as f:
             json.dump(rabbit_definitions, f, indent=2)
 
         # write RabbitMQ config to file
-        rabbit_conf = \
-            Path(__file__).parent.resolve() / RABBIT_CONFIG
+        rabbit_conf = Path(__file__).parent.resolve() / RABBIT_CONFIG
         shutil.copyfile(rabbit_conf, self.ctx.data_dir / RABBIT_CONFIG)
 
         # check if a directory for persistent RabbitMQ storage exists,
@@ -160,14 +158,12 @@ class RabbitMQManager:
 
         return {
             self.definitions_file: {
-                'bind': '/etc/rabbitmq/definitions.json', 'mode': 'ro'
+                "bind": "/etc/rabbitmq/definitions.json",
+                "mode": "ro",
             },
-            self.ctx.data_dir / RABBIT_CONFIG: {
-                'bind': '/etc/rabbitmq/rabbitmq.config', 'mode': 'ro'
-            },
-            rabbit_data_dir: {
-                'bind': '/var/lib/rabbitmq', 'mode': 'rw'
-            }
+            self.ctx.data_dir
+            / RABBIT_CONFIG: {"bind": "/etc/rabbitmq/rabbitmq.config", "mode": "ro"},
+            rabbit_data_dir: {"bind": "/var/lib/rabbitmq", "mode": "rw"},
         }
 
     def _get_rabbitmq_definitions(self) -> dict:
@@ -181,12 +177,13 @@ class RabbitMQManager:
             startup of RabbitMQ
         """
         rabbit_definitions = RABBITMQ_DEFINITIONS
-        rabbit_definitions['users'][0]['name'] = self.rabbit_user
-        rabbit_definitions['permissions'][0]['user'] = self.rabbit_user
-        rabbit_definitions['users'][0]['password_hash'] = \
-            self._get_hashed_pw(self.rabbit_pass)
-        rabbit_definitions['vhosts'][0]['name'] = self.vhost
-        rabbit_definitions['permissions'][0]['vhost'] = self.vhost
+        rabbit_definitions["users"][0]["name"] = self.rabbit_user
+        rabbit_definitions["permissions"][0]["user"] = self.rabbit_user
+        rabbit_definitions["users"][0]["password_hash"] = self._get_hashed_pw(
+            self.rabbit_pass
+        )
+        rabbit_definitions["vhosts"][0]["name"] = self.vhost
+        rabbit_definitions["permissions"][0]["vhost"] = self.vhost
         return rabbit_definitions
 
     def _get_hashed_pw(self, pw: str) -> str:
@@ -208,7 +205,7 @@ class RabbitMQManager:
         salt = os.urandom(4)
 
         # Concatenate that with the UTF-8 representation of the password
-        tmp0 = salt + pw.encode('utf-8')
+        tmp0 = salt + pw.encode("utf-8")
 
         # Take the SHA256 hash and get the bytes back
         tmp1 = hashlib.sha256(tmp0).digest()
@@ -218,4 +215,4 @@ class RabbitMQManager:
 
         # convert to base64 encoding:
         pass_hash = base64.b64encode(salted_hash)
-        return pass_hash.decode('utf-8')
+        return pass_hash.decode("utf-8")

vantage6/cli/server/attach.py

@@ -5,11 +5,11 @@ import click
 import questionary as q
 import docker
 
-from colorama import (Fore, Style)
+from colorama import Fore, Style
 
 from vantage6.common import info, error
 from vantage6.common.docker.addons import check_docker_running
-from vantage6.common.globals import APPNAME
+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
@@ -17,9 +17,10 @@ from vantage6.cli.server.common import print_log_worker
 
 @click.command()
 @click.option("-n", "--name", default=None, help="configuration name")
-@click.option('--system', 'system_folders', flag_value=True)
-@click.option('--user', 'system_folders', flag_value=False,
-              default=DEFAULT_SERVER_SYSTEM_FOLDERS)
+@click.option("--system", "system_folders", flag_value=True)
+@click.option(
+    "--user", "system_folders", flag_value=False, default=DEFAULT_SERVER_SYSTEM_FOLDERS
+)
 def cli_server_attach(name: str, system_folders: bool) -> None:
     """
     Show the server logs in the current console.
@@ -28,15 +29,17 @@ def cli_server_attach(name: str, system_folders: bool) -> None:
     client = docker.from_env()
 
     running_servers = client.containers.list(
-        filters={"label": f"{APPNAME}-type=server"})
+        filters={"label": f"{APPNAME}-type={InstanceType.SERVER}"}
+    )
     running_server_names = [node.name for node in running_servers]
 
     if not name:
-        name = q.select("Select the server you wish to inspect:",
-                        choices=running_server_names).ask()
+        name = q.select(
+            "Select the server you wish to inspect:", choices=running_server_names
+        ).ask()
     else:
         post_fix = "system" if system_folders else "user"
-        name = f"{APPNAME}-{name}-{post_fix}-server"
+        name = f"{APPNAME}-{name}-{post_fix}-{InstanceType.SERVER}"
 
     if name in running_server_names:
         container = client.containers.get(name)
@@ -47,8 +50,10 @@ def cli_server_attach(name: str, system_folders: bool) -> None:
                 time.sleep(1)
             except KeyboardInterrupt:
                 info("Closing log file. Keyboard Interrupt.")
-                info("Note that your server is still running! Shut it down "
-                     f"with {Fore.RED}v6 server stop{Style.RESET_ALL}")
+                info(
+                    "Note that your server is still running! Shut it down "
+                    f"with {Fore.RED}v6 server stop{Style.RESET_ALL}"
+                )
                 exit(0)
     else:
         error(f"{Fore.RED}{name}{Style.RESET_ALL} was not running!?")

vantage6/cli/server/common/__init__.py

@@ -6,11 +6,11 @@ import click
 from colorama import Fore, Style
 
 from vantage6.common import error, info
-from vantage6.common.globals import STRING_ENCODING, APPNAME
+from vantage6.common.globals import STRING_ENCODING, APPNAME, InstanceType
 from vantage6.common.docker.addons import remove_container, get_container
 
 from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
-from vantage6.cli.context import ServerContext
+from vantage6.cli.context.server import ServerContext
 from vantage6.cli.configuration_wizard import select_configuration_questionaire
 
 
@@ -29,19 +29,33 @@ def click_insert_context(func: callable) -> callable:
     Callable
         Click function with context
     """
-    @click.option('-n', '--name', default=None,
-                  help="Name of the configuration you want to use.")
-    @click.option('-c', '--config', default=None,
-                  help='Absolute 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')
-    @click.option('--user', 'system_folders', flag_value=False,
-                  default=DEFAULT_SERVER_SYSTEM_FOLDERS,
-                  help='Use user folders instead of system folders')
+
+    @click.option(
+        "-n", "--name", default=None, help="Name of the configuration you want to use."
+    )
+    @click.option(
+        "-c",
+        "--config",
+        default=None,
+        help="Absolute 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",
+    )
+    @click.option(
+        "--user",
+        "system_folders",
+        flag_value=False,
+        default=DEFAULT_SERVER_SYSTEM_FOLDERS,
+        help="Use user folders instead of system folders",
+    )
     @wraps(func)
-    def func_with_context(name: str, config: str, system_folders: bool, *args,
-                          **kwargs) -> callable:
+    def func_with_context(
+        name: str, config: str, system_folders: bool, *args, **kwargs
+    ) -> callable:
         """
         Decorator function that adds the context to the function.
 
@@ -52,14 +66,11 @@ def click_insert_context(func: callable) -> callable:
         """
         # path to configuration file always overrides name
         if config:
-            ctx = ServerContext.from_external_config_file(
-                config,
-                system_folders
-            )
-        elif 'ctx' in kwargs:
+            ctx = ServerContext.from_external_config_file(config, system_folders)
+        elif "ctx" in kwargs:
             # if ctx is already in kwargs (typically when one click command
             # calls another internally), use that existing ctx
-            ctx = kwargs.pop('ctx')
+            ctx = kwargs.pop("ctx")
         else:
             # in case no name, ctx or config file is supplied, ask the user to
             # select an existing config by name
@@ -67,7 +78,7 @@ def click_insert_context(func: callable) -> callable:
                 try:
                     # select configuration if none supplied
                     name = select_configuration_questionaire(
-                        "server", system_folders
+                        InstanceType.SERVER, system_folders
                     )
                 except Exception:
                     error("No configurations could be found!")
@@ -79,8 +90,7 @@ def click_insert_context(func: callable) -> callable:
     return func_with_context
 
 
-def get_server_context(name: str, system_folders: bool) \
-        -> ServerContext:
+def get_server_context(name: str, system_folders: bool) -> ServerContext:
     """
     Load the server context from the configuration file.
 
@@ -142,5 +152,7 @@ def stop_ui(client: DockerClient, ctx: ServerContext) -> None:
     ui_container = get_container(client, name=ui_container_name)
     if ui_container:
         remove_container(ui_container, kill=True)
-        info(f"Stopped the {Fore.GREEN}{ui_container_name}"
-             f"{Style.RESET_ALL} User Interface container.")
+        info(
+            f"Stopped the {Fore.GREEN}{ui_container_name}"
+            f"{Style.RESET_ALL} User Interface container."
+        )

vantage6/cli/server/files.py

@@ -1,7 +1,7 @@
 import click
 
 from vantage6.common import info
-from vantage6.cli.context import ServerContext
+from vantage6.cli.context.server import ServerContext
 from vantage6.cli.server.common import click_insert_context