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

vantage6/cli/server/import_.py

@@ -4,6 +4,7 @@ from threading import Thread
 import click
 import docker
 from sqlalchemy.engine.url import make_url
+from vantage6.cli.globals import ServerGlobals
 
 from vantage6.common import info, warning
 from vantage6.common.docker.addons import check_docker_running
@@ -11,28 +12,44 @@ from vantage6.common.globals import (
     APPNAME,
     DEFAULT_DOCKER_REGISTRY,
     DEFAULT_SERVER_IMAGE,
+    InstanceType,
 )
-from vantage6.cli.context import ServerContext
+from vantage6.cli.context.server import ServerContext
 from vantage6.cli.utils import check_config_name_allowed
 from vantage6.cli.server.common import click_insert_context, print_log_worker
 
 
 # TODO this method has a lot of duplicated code from `start`
 @click.command()
-@click.argument('file', type=click.Path(exists=True))
-@click.option('--drop-all', is_flag=True, default=False,
-              help="Drop all existing data before importing")
-@click.option('-i', '--image', default=None, help="Node Docker image to use")
-@click.option('--mount-src', default='',
-              help="Override vantage6 source code in container with the source"
-                   " code in this path")
-@click.option('--keep/--auto-remove', default=False,
-              help="Keep image after finishing. Useful for debugging")
-@click.option('--wait', default=False, help="Wait for the import to finish")
+@click.argument("file", type=click.Path(exists=True))
+@click.option(
+    "--drop-all",
+    is_flag=True,
+    default=False,
+    help="Drop all existing data before importing",
+)
+@click.option("-i", "--image", default=None, help="Node Docker image to use")
+@click.option(
+    "--mount-src",
+    default="",
+    help="Override vantage6 source code in container with the source"
+    " code in this path",
+)
+@click.option(
+    "--keep/--auto-remove",
+    default=False,
+    help="Keep image after finishing. Useful for debugging",
+)
+@click.option("--wait", default=False, help="Wait for the import to finish")
 @click_insert_context
 def cli_server_import(
-    ctx: ServerContext, file: str, drop_all: bool, image: str, mount_src: str,
-    keep: bool, wait: bool
+    ctx: ServerContext,
+    file: str,
+    drop_all: bool,
+    image: str,
+    mount_src: str,
+    keep: bool,
+    wait: bool,
 ) -> None:
     """
     Import vantage6 resources into a server instance.
@@ -56,31 +73,26 @@ def cli_server_import(
     # pull latest Docker image
     if image is None:
         image = ctx.config.get(
-            "image",
-            f"{DEFAULT_DOCKER_REGISTRY}/{DEFAULT_SERVER_IMAGE}"
+            "image", f"{DEFAULT_DOCKER_REGISTRY}/{DEFAULT_SERVER_IMAGE}"
         )
     info(f"Pulling latest server image '{image}'.")
     try:
         docker_client.images.pull(image)
     except Exception as e:
-        warning(' ... Getting latest node image failed:')
+        warning(" ... Getting latest node image failed:")
         warning(f"     {e}")
     else:
         info(" ... success!")
 
     info("Creating mounts")
     mounts = [
-        docker.types.Mount(
-            "/mnt/config.yaml", str(ctx.config_file), type="bind"
-        ),
-        docker.types.Mount(
-            "/mnt/import.yaml", str(file), type="bind"
-        )
+        docker.types.Mount("/mnt/config.yaml", str(ctx.config_file), type="bind"),
+        docker.types.Mount("/mnt/import.yaml", str(file), type="bind"),
     ]
 
     # FIXME: code duplication with cli_server_start()
     # try to mount database
-    uri = ctx.config['uri']
+    uri = ctx.config["uri"]
     url = make_url(uri)
     environment_vars = None
 
@@ -89,7 +101,7 @@ def cli_server_import(
         mounts.append(docker.types.Mount("/vantage6", mount_src, type="bind"))
 
     # If host is None, we're dealing with a file-based DB, like SQLite
-    if (url.host is None):
+    if url.host is None:
         db_path = url.database
 
         if not os.path.isabs(db_path):
@@ -101,22 +113,21 @@ def cli_server_import(
         os.makedirs(dirname, exist_ok=True)
 
         # we're mounting the entire folder that contains the database
-        mounts.append(docker.types.Mount(
-            "/mnt/database/", dirname, type="bind"
-        ))
+        mounts.append(docker.types.Mount("/mnt/database/", dirname, type="bind"))
 
         environment_vars = {
-            "VANTAGE6_DB_URI": f"sqlite:////mnt/database/{basename}"
+            ServerGlobals.DB_URI_ENV_VAR: f"sqlite:////mnt/database/{basename}"
         }
 
     else:
-        warning(f"Database could not be transferred, make sure {url.host} "
-                "is reachable from the Docker container")
+        warning(
+            f"Database could not be transferred, make sure {url.host} "
+            "is reachable from the Docker container"
+        )
         info("Consider using the docker-compose method to start a server")
 
     drop_all_ = "--drop-all" if drop_all else ""
-    cmd = (f'vserver-local import -c /mnt/config.yaml {drop_all_} '
-           '/mnt/import.yaml')
+    cmd = f"vserver-local import -c /mnt/config.yaml {drop_all_} " "/mnt/import.yaml"
 
     info(cmd)
 
@@ -126,13 +137,10 @@ def cli_server_import(
         command=cmd,
         mounts=mounts,
         detach=True,
-        labels={
-            f"{APPNAME}-type": "server",
-            "name": ctx.config_file_name
-        },
+        labels={f"{APPNAME}-type": InstanceType.SERVER, "name": ctx.config_file_name},
         environment=environment_vars,
         auto_remove=not keep,
-        tty=True
+        tty=True,
     )
     logs = container.logs(stream=True, stdout=True)
     Thread(target=print_log_worker, args=(logs,), daemon=False).start()

vantage6/cli/server/list.py

@@ -1,12 +1,12 @@
 import click
 import docker
 
-from colorama import (Fore, Style)
+from colorama import Fore, Style
 
 from vantage6.common import warning
 from vantage6.common.docker.addons import check_docker_running
-from vantage6.common.globals import APPNAME
-from vantage6.cli.context import ServerContext
+from vantage6.common.globals import APPNAME, InstanceType
+from vantage6.cli.context.server import ServerContext
 
 
 @click.command()
@@ -18,18 +18,16 @@ def cli_server_configuration_list() -> None:
     client = docker.from_env()
 
     running_server = client.containers.list(
-        filters={"label": f"{APPNAME}-type=server"})
+        filters={"label": f"{APPNAME}-type={InstanceType.SERVER}"}
+    )
     running_node_names = []
     for node in running_server:
         running_node_names.append(node.name)
 
-    header = \
-        "\nName"+(21*" ") + \
-        "Status"+(10*" ") + \
-        "System/User"
+    header = "\nName" + (21 * " ") + "Status" + (10 * " ") + "System/User"
 
     click.echo(header)
-    click.echo("-"*len(header))
+    click.echo("-" * len(header))
 
     running = Fore.GREEN + "Running" + Style.RESET_ALL
     stopped = Fore.RED + "Not running" + Style.RESET_ALL
@@ -37,24 +35,25 @@ def cli_server_configuration_list() -> None:
     # system folders
     configs, f1 = ServerContext.available_configurations(system_folders=True)
     for config in configs:
-        status = running if f"{APPNAME}-{config.name}-system-server" in \
-            running_node_names else stopped
-        click.echo(
-            f"{config.name:25}"
-            f"{status:25} System "
+        status = (
+            running
+            if f"{APPNAME}-{config.name}-system-{InstanceType.SERVER}"
+            in running_node_names
+            else stopped
         )
+        click.echo(f"{config.name:25}" f"{status:25} System ")
 
     # user folders
     configs, f2 = ServerContext.available_configurations(system_folders=False)
     for config in configs:
-        status = running if f"{APPNAME}-{config.name}-user-server" in \
-            running_node_names else stopped
-        click.echo(
-            f"{config.name:25}"
-            f"{status:25} User   "
+        status = (
+            running
+            if f"{APPNAME}-{config.name}-user-{InstanceType.SERVER}"
+            in running_node_names
+            else stopped
         )
+        click.echo(f"{config.name:25}" f"{status:25} User   ")
 
-    click.echo("-"*85)
-    if len(f1)+len(f2):
-        warning(
-             f"{Fore.RED}Failed imports: {len(f1)+len(f2)}{Style.RESET_ALL}")
+    click.echo("-" * 85)
+    if len(f1) + len(f2):
+        warning(f"{Fore.RED}Failed imports: {len(f1)+len(f2)}{Style.RESET_ALL}")

vantage6/cli/server/new.py

@@ -1,19 +1,22 @@
 import click
-from colorama import (Fore, Style)
+from colorama import Fore, Style
 
 from vantage6.common import info, error, check_config_writeable
 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 configuration_wizard
 from vantage6.cli.utils import check_config_name_allowed, prompt_config_name
+from vantage6.common.globals import InstanceType
 
 
 @click.command()
-@click.option('-n', '--name', default=None,
-              help="name of the configuration you want to use.")
-@click.option('--system', 'system_folders', flag_value=True)
-@click.option('--user', 'system_folders', flag_value=False,
-              default=DEFAULT_SERVER_SYSTEM_FOLDERS)
+@click.option(
+    "-n", "--name", default=None, help="name of the configuration you want to use."
+)
+@click.option("--system", "system_folders", flag_value=True)
+@click.option(
+    "--user", "system_folders", flag_value=False, default=DEFAULT_SERVER_SYSTEM_FOLDERS
+)
 def cli_server_new(name: str, system_folders: bool) -> None:
     """
     Create a new server configuration.
@@ -26,8 +29,7 @@ def cli_server_new(name: str, system_folders: bool) -> None:
     # check that this config does not exist
     try:
         if ServerContext.config_exists(name, system_folders):
-            error(f"Configuration {Fore.RED}{name}{Style.RESET_ALL} already "
-                  "exists!")
+            error(f"Configuration {Fore.RED}{name}{Style.RESET_ALL} already " "exists!")
             exit(1)
     except Exception as e:
         error(e)
@@ -36,15 +38,19 @@ def cli_server_new(name: str, system_folders: bool) -> None:
     # Check that we can write in this folder
     if not check_config_writeable(system_folders):
         error("Your user does not have write access to all folders. Exiting")
-        info(f"Create a new server using '{Fore.GREEN}v6 server new "
-             f"--user{Style.RESET_ALL}' instead!")
+        info(
+            f"Create a new server using '{Fore.GREEN}v6 server new "
+            f"--user{Style.RESET_ALL}' instead!"
+        )
         exit(1)
 
     # create config in ctx location
-    cfg_file = configuration_wizard("server", name, system_folders)
+    cfg_file = configuration_wizard(InstanceType.SERVER, name, system_folders)
     info(f"New configuration created: {Fore.GREEN}{cfg_file}{Style.RESET_ALL}")
 
     # info(f"root user created.")
     flag = "" if system_folders else "--user"
-    info(f"You can start the server by running {Fore.GREEN}v6 server start "
-         f"{flag}{Style.RESET_ALL}")
+    info(
+        f"You can start the server by running {Fore.GREEN}v6 server start "
+        f"{flag}{Style.RESET_ALL}"
+    )

vantage6/cli/server/remove.py

@@ -11,7 +11,7 @@ from vantage6.cli.utils import remove_file
 
 @click.command()
 @click_insert_context
-@click.option('-f', '--force', 'force', flag_value=True)
+@click.option("-f", "--force", "force", flag_value=True)
 def cli_server_remove(ctx: ServerContext, force: bool) -> None:
     """
     Function to remove a server.
@@ -28,14 +28,15 @@ def cli_server_remove(ctx: ServerContext, force: bool) -> None:
     if not force:
         if not q.confirm(
             "This server will be deleted permanently including its "
-            "configuration. Are you sure?", default=False
+            "configuration. Are you sure?",
+            default=False,
         ).ask():
             info("Server will not be deleted")
             exit(0)
 
     # now remove the folders...
-    remove_file(ctx.config_file, 'configuration')
+    remove_file(ctx.config_file, "configuration")
 
     for handler in itertools.chain(ctx.log.handlers, ctx.log.root.handlers):
         handler.close()
-    remove_file(ctx.log_file, 'log')
+    remove_file(ctx.log_file, "log")

vantage6/cli/server/shell.py

@@ -2,12 +2,12 @@ import subprocess
 
 import click
 import docker
-from colorama import (Fore, Style)
+from colorama import Fore, Style
 
 from vantage6.common import info, error, debug as debug_msg
 from vantage6.common.docker.addons import check_docker_running
-from vantage6.common.globals import APPNAME
-from vantage6.cli.context import ServerContext
+from vantage6.common.globals import APPNAME, InstanceType
+from vantage6.cli.context.server import ServerContext
 from vantage6.cli.server.common import click_insert_context
 
 
@@ -28,15 +28,26 @@ def cli_server_shell(ctx: ServerContext) -> None:
     docker_client = docker.from_env()
 
     running_servers = docker_client.containers.list(
-        filters={"label": f"{APPNAME}-type=server"})
+        filters={"label": f"{APPNAME}-type={InstanceType.SERVER}"}
+    )
 
     if ctx.docker_container_name not in [s.name for s in running_servers]:
         error(f"Server {Fore.RED}{ctx.name}{Style.RESET_ALL} is not running?")
         return
 
     try:
-        subprocess.run(['docker', 'exec', '-it', ctx.docker_container_name,
-                        'vserver-local', 'shell', '-c', '/mnt/config.yaml'])
+        subprocess.run(
+            [
+                "docker",
+                "exec",
+                "-it",
+                ctx.docker_container_name,
+                "vserver-local",
+                "shell",
+                "-c",
+                "/mnt/config.yaml",
+            ]
+        )
     except Exception as e:
         info("Failed to start subprocess...")
         debug_msg(e)