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

vantage6/cli/{dev.py → dev/create.py}

@@ -1,37 +1,18 @@
-"""
-This module contains the CLI commands for generating dummy server and node
-instance(s). The following commands are available:
-
-    * vdev create-demo-network
-    * vdev remove-demo-network
-    * vdev start-demo-network
-    * vdev stop-demo-network
-"""
-import click
+from pathlib import Path
 import csv
-import subprocess
-import itertools
 
-from pathlib import Path
+import click
 from jinja2 import Environment, FileSystemLoader
 from colorama import Fore, Style
-from shutil import rmtree
 
 from vantage6.common.globals import APPNAME
 from vantage6.common import info, error, generate_apikey
 
 from vantage6.cli.globals import PACKAGE_FOLDER
 from vantage6.cli.context import ServerContext, NodeContext
-from vantage6.cli.server import (
-    click_insert_context,
-    vserver_import,
-    vserver_start,
-    vserver_stop,
-    vserver_remove,
-    get_server_context
-)
-from vantage6.cli.node import vnode_stop
-from vantage6.cli.utils import prompt_config_name, remove_file
+from vantage6.cli.server.common import get_server_context
+from vantage6.cli.server.import_ import cli_server_import
+from vantage6.cli.utils import prompt_config_name
 
 
 def create_dummy_data(node_name: str, dev_folder: Path) -> Path:
@@ -172,9 +153,9 @@ def generate_node_configs(num_nodes: int, server_url: str, port: int,
 
 def create_vserver_import_config(node_configs: list[dict], server_name: str) \
         -> Path:
-    """Creates vserver configuration import file (YAML).
+    """Create server configuration import file (YAML).
 
-    Utilized by the ``vserver import`` command.
+    Utilized by the ``v6 server import`` command.
 
     Parameters
     ----------
@@ -231,7 +212,7 @@ def create_vserver_import_config(node_configs: list[dict], server_name: str) \
 
 
 def create_vserver_config(server_name: str, port: int) -> Path:
-    """Creates vserver configuration file (YAML).
+    """Creates server configuration file (YAML).
 
     Parameters
     ----------
@@ -304,15 +285,7 @@ def demo_network(num_nodes: int, server_url: str, server_port: int,
     return (node_configs, server_import_config, server_config)
 
 
-@click.group(name="dev")
-def cli_dev() -> None:
-    """
-    The `vdev` commands can be used to quickly manage a network with a server
-    and several nodes for local testing.
-    """
-
-
-@cli_dev.command(name="create-demo-network")
+@click.command()
 @click.option('-n', '--name', default=None, type=str,
               help="Name for your development setup")
 @click.option('--num-nodes', type=int, default=3,
@@ -325,8 +298,11 @@ def cli_dev() -> None:
 @click.option('-i', '--image', type=str, default=None,
               help='Server docker image to use when setting up resources for '
               'the development server')
-def create_demo_network(name: str, num_nodes: int, server_url: str,
-                        server_port: int, image: str = None) -> dict:
+@click.pass_context
+def create_demo_network(
+    click_ctx: click.Context, name: str, num_nodes: int, server_url: str,
+    server_port: int, image: str = None
+) -> dict:
     """Creates a demo network.
 
     Creates server instance as well as its import configuration file. Server
@@ -346,121 +322,12 @@ def create_demo_network(name: str, num_nodes: int, server_url: str,
         exit(1)
     (node_config, server_import_config, server_config) = demo
     ctx = get_server_context(server_name, True)
-    vserver_import(ctx, server_import_config, False, image, '', False, True)
+    click_ctx.invoke(
+        cli_server_import, ctx=ctx, file=server_import_config, drop_all=False,
+        image=image, mount_src='', keep=False, wait=True
+    )
     return {
         "node_configs": node_config,
         "server_import_config": server_import_config,
         "server_config": server_config
     }
-
-
-@cli_dev.command(name="start-demo-network")
-@click_insert_context
-@click.option('--server-image', type=str, default=None,
-              help='Server Docker image to use')
-@click.option('--node-image', type=str, default=None,
-              help='Node Docker image to use')
-def start_demo_network(
-    ctx: ServerContext, server_image: str, node_image: str
-) -> None:
-    """Starts running a demo-network.
-
-    Select a server configuration to run its demo network. You should choose a
-    server configuration that you created earlier for a demo network. If you
-    have not created a demo network, you can run `vdev create-demo-network` to
-    create one.
-    """
-    # run the server
-    vserver_start(
-        ctx=ctx,
-        ip=None,
-        port=None,
-        image=server_image,
-        start_ui=False,
-        ui_port=None,
-        start_rabbitmq=False,
-        rabbitmq_image=None,
-        keep=True,
-        mount_src='',
-        attach=False
-    )
-
-    # run all nodes that belong to this server
-    configs, _ = NodeContext.available_configurations(system_folders=False)
-    node_names = [
-        config.name for config in configs if f'{ctx.name}_node_' in config.name
-    ]
-    for name in node_names:
-        cmd = ["vnode", "start", "--name", name]
-        if node_image:
-            cmd.extend(["--image", node_image])
-        subprocess.run(cmd)
-
-
-@cli_dev.command(name="stop-demo-network")
-@click_insert_context
-def stop_demo_network(ctx: ServerContext) -> None:
-    """ Stops a demo network's server and nodes.
-
-    Select a server configuration to stop that server and the nodes attached
-    to it.
-    """
-    # stop the server
-    vserver_stop(name=ctx.name, system_folders=True, all_servers=False)
-
-    # stop the nodes
-    configs, _ = NodeContext.available_configurations(False)
-    node_names = [
-        config.name for config in configs if f'{ctx.name}_node_' in config.name
-    ]
-    for name in node_names:
-        vnode_stop(name, system_folders=False, all_nodes=False, force=False)
-
-
-@cli_dev.command(name="remove-demo-network")
-@click_insert_context
-@click.option('-f', "--force", type=bool, flag_value=True,
-              help='Don\'t ask for confirmation')
-def remove_demo_network(ctx: ServerContext, force: bool) -> None:
-    """ Remove all related demo network files and folders.
-
-    Select a server configuration to remove that server and the nodes attached
-    to it.
-    """
-
-    # remove the server
-    for handler in itertools.chain(ctx.log.handlers, ctx.log.root.handlers):
-        handler.close()
-    vserver_remove(ctx, ctx.name, True, force)
-
-    # removing the server import config
-    info("Deleting demo import config file")
-    server_configs = ServerContext.instance_folders("server", ctx.name,
-                                                    system_folders=False)
-    import_config_to_del = Path(server_configs['dev']) / f"{ctx.name}.yaml"
-    remove_file(import_config_to_del, 'import_configuration')
-
-    # also remove the server folder
-    server_configs = ServerContext.instance_folders("server", ctx.name,
-                                                    system_folders=True)
-    server_folder = server_configs['data']
-    if server_folder.is_dir():
-        rmtree(server_folder)
-    # TODO BvB 2023-07-31 can it happen that the server folder is not a
-    # directory? What then?
-
-    # remove the nodes
-    configs, _ = NodeContext.available_configurations(system_folders=False)
-    node_names = [
-        config.name for config in configs if f'{ctx.name}_node_' in config.name
-    ]
-    for name in node_names:
-        node_ctx = NodeContext(name, False)
-        for handler in itertools.chain(node_ctx.log.handlers,
-                                       node_ctx.log.root.handlers):
-            handler.close()
-        subprocess.run(["vnode", "remove", "-n", name, "--user", "--force"])
-
-    # remove data files attached to the network
-    data_dirs_nodes = NodeContext.instance_folders('node', '', False)['dev']
-    rmtree(Path(data_dirs_nodes / ctx.name))

vantage6/cli/dev/remove.py

@@ -0,0 +1,63 @@
+import subprocess
+import itertools
+from shutil import rmtree
+from pathlib import Path
+
+import click
+
+from vantage6.common import info
+from vantage6.cli.context import ServerContext, NodeContext
+from vantage6.cli.server.common import click_insert_context
+from vantage6.cli.server.stop import vserver_remove
+from vantage6.cli.utils import remove_file
+
+
+@click.command()
+@click_insert_context
+@click.option('-f', "--force", type=bool, flag_value=True,
+              help='Don\'t ask for confirmation')
+def remove_demo_network(ctx: ServerContext, force: bool) -> None:
+    """ Remove all related demo network files and folders.
+
+    Select a server configuration to remove that server and the nodes attached
+    to it.
+    """
+
+    # remove the server
+    for handler in itertools.chain(ctx.log.handlers, ctx.log.root.handlers):
+        handler.close()
+    vserver_remove(ctx, ctx.name, True, force)
+
+    # removing the server import config
+    info("Deleting demo import config file")
+    server_configs = ServerContext.instance_folders("server", ctx.name,
+                                                    system_folders=False)
+    import_config_to_del = Path(server_configs['dev']) / f"{ctx.name}.yaml"
+    remove_file(import_config_to_del, 'import_configuration')
+
+    # also remove the server folder
+    server_configs = ServerContext.instance_folders("server", ctx.name,
+                                                    system_folders=True)
+    server_folder = server_configs['data']
+    if server_folder.is_dir():
+        rmtree(server_folder)
+    # TODO BvB 2023-07-31 can it happen that the server folder is not a
+    # directory? What then?
+
+    # remove the nodes
+    configs, _ = NodeContext.available_configurations(system_folders=False)
+    node_names = [
+        config.name for config in configs if f'{ctx.name}_node_' in config.name
+    ]
+    for name in node_names:
+        node_ctx = NodeContext(name, False)
+        for handler in itertools.chain(node_ctx.log.handlers,
+                                       node_ctx.log.root.handlers):
+            handler.close()
+        subprocess.run(
+            ["v6", "node", "remove", "-n", name, "--user", "--force"]
+        )
+
+    # remove data files attached to the network
+    data_dirs_nodes = NodeContext.instance_folders('node', '', False)['dev']
+    rmtree(Path(data_dirs_nodes / ctx.name))

vantage6/cli/dev/start.py

@@ -0,0 +1,52 @@
+import subprocess
+import click
+
+from vantage6.cli.context import ServerContext, NodeContext
+from vantage6.cli.server.common import click_insert_context
+from vantage6.cli.server.start import cli_server_start
+
+
+@click.command()
+@click_insert_context
+@click.option('--server-image', type=str, default=None,
+              help='Server Docker image to use')
+@click.option('--node-image', type=str, default=None,
+              help='Node Docker image to use')
+@click.pass_context
+def start_demo_network(
+    click_ctx: click.Context, ctx: ServerContext, server_image: str,
+    node_image: str
+) -> None:
+    """Starts running a demo-network.
+
+    Select a server configuration to run its demo network. You should choose a
+    server configuration that you created earlier for a demo network. If you
+    have not created a demo network, you can run `vdev create-demo-network` to
+    create one.
+    """
+    # run the server
+    click_ctx.invoke(
+        cli_server_start,
+        ctx=ctx,
+        ip=None,
+        port=None,
+        image=server_image,
+        start_ui=False,
+        ui_port=None,
+        start_rabbitmq=False,
+        rabbitmq_image=None,
+        keep=True,
+        mount_src='',
+        attach=False
+    )
+
+    # run all nodes that belong to this server
+    configs, _ = NodeContext.available_configurations(system_folders=False)
+    node_names = [
+        config.name for config in configs if f'{ctx.name}_node_' in config.name
+    ]
+    for name in node_names:
+        cmd = ["v6", "node", "start", "--name", name]
+        if node_image:
+            cmd.extend(["--image", node_image])
+        subprocess.run(cmd)

vantage6/cli/dev/stop.py

@@ -0,0 +1,30 @@
+import click
+
+from vantage6.cli.context import ServerContext, NodeContext
+from vantage6.cli.server.common import click_insert_context
+from vantage6.cli.server.stop import cli_server_stop
+from vantage6.cli.node.stop import cli_node_stop
+
+
+@click.command()
+@click_insert_context
+@click.pass_context
+def stop_demo_network(click_ctx: click.Context, ctx: ServerContext) -> None:
+    """ Stops a demo network's server and nodes.
+
+    Select a server configuration to stop that server and the nodes attached
+    to it.
+    """
+    # stop the server
+    click_ctx.invoke(
+        cli_server_stop, name=ctx.name, system_folders=True, all_servers=False
+    )
+
+    # stop the nodes
+    configs, _ = NodeContext.available_configurations(False)
+    node_names = [
+        config.name for config in configs if f'{ctx.name}_node_' in config.name
+    ]
+    for name in node_names:
+        click_ctx.invoke(cli_node_stop, name=name, system_folders=False,
+                         all_nodes=False, force=False)

vantage6/cli/node/attach.py

@@ -0,0 +1,58 @@
+import time
+from threading import Thread
+import click
+import questionary as q
+import docker
+
+from colorama import Fore, Style
+
+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.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
+from vantage6.cli.node.common import find_running_node_names, print_log_worker
+
+
+@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")
+def cli_node_attach(name: str, system_folders: bool) -> None:
+    """
+    Show the node logs in the current console.
+    """
+    check_docker_running()
+    client = docker.from_env()
+
+    running_node_names = find_running_node_names(client)
+
+    if not running_node_names:
+        warning("No nodes are currently running. Cannot show any logs!")
+        return
+
+    if not name:
+        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)
+        logs = container.attach(stream=True, logs=True)
+        Thread(target=print_log_worker, args=(logs,), daemon=True).start()
+        while True:
+            try:
+                time.sleep(1)
+            except KeyboardInterrupt:
+                info("Closing log file. Keyboard Interrupt.")
+                info("Note that your node is still running! Shut it down with "
+                     f"'{Fore.RED}v6 node stop{Style.RESET_ALL}'")
+                exit(0)
+    else:
+        error(f"{Fore.RED}{name}{Style.RESET_ALL} was not running!?")

vantage6/cli/node/clean.py

@@ -0,0 +1,40 @@
+import click
+import questionary as q
+import docker
+
+from colorama import Fore, Style
+
+from vantage6.common import error, info, debug
+from vantage6.common.docker.addons import check_docker_running
+
+
+@click.command()
+def cli_node_clean() -> None:
+    """
+    Erase temporary Docker volumes.
+    """
+    check_docker_running()
+    client = docker.from_env()
+
+    # retrieve all volumes
+    volumes = client.volumes.list()
+    candidates = []
+    msg = "This would remove the following volumes: "
+    for volume in volumes:
+        if volume.name[-6:] == "tmpvol":
+            candidates.append(volume)
+            msg += volume.name + ","
+    info(msg)
+
+    confirm = q.confirm("Are you sure?")
+    if confirm.ask():
+        for volume in candidates:
+            try:
+                volume.remove()
+                # info(volume.name)
+            except docker.errors.APIError as e:
+                error(f"Failed to remove volume {Fore.RED}'{volume.name}'"
+                      f"{Style.RESET_ALL}. Is it still in use?")
+                debug(e)
+                exit(1)
+    info("Done!")

vantage6/cli/node/common/__init__.py

@@ -0,0 +1,124 @@
+"""
+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
+from vantage6.client import UserClient
+
+from vantage6.cli.context 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.
+
+    Parameters
+    ----------
+    ctx : NodeContext
+        Context of the node loaded from the configuration file
+    Returns
+    -------
+    UserClient
+        vantage6 client
+    """
+    host = ctx.config['server_url']
+    # if the server is run locally, we need to use localhost here instead of
+    # the host address of docker
+    if host in ['http://host.docker.internal', 'http://172.17.0.1']:
+        host = 'http://localhost'
+    port = ctx.config['port']
+    api_path = ctx.config['api_path']
+    info(f"Connecting to server at '{host}:{port}{api_path}'")
+    return UserClient(host, port, api_path, log_level='warn')
+
+
+def create_client_and_authenticate(ctx: NodeContext) -> UserClient:
+    """
+    Generate a client and authenticate with the server.
+
+    Parameters
+    ----------
+    ctx : NodeContext
+        Context of the node loaded from the configuration file
+
+    Returns
+    -------
+    UserClient
+        vantage6 client
+    """
+    client = create_client(ctx)
+
+    username = q.text("Username:").ask()
+    password = q.password("Password:").ask()
+
+    try:
+        client.authenticate(username, password)
+
+    except Exception as exc:
+        error("Could not authenticate with server!")
+        debug(exc)
+        exit(1)
+
+    return client
+
+
+def select_node(name: str, system_folders: bool) -> tuple[str, str]:
+    """
+    Let user select node through questionnaire if name is not given.
+
+    Returns
+    -------
+    str
+        Name of the configuration file
+    """
+    name = name if name else \
+        select_configuration_questionaire("node", system_folders)
+
+    # raise error if config could not be found
+    if not NodeContext.config_exists(name, system_folders):
+        error(
+            f"The configuration {Fore.RED}{name}{Style.RESET_ALL} could "
+            f"not be found."
+        )
+        exit(1)
+    return name
+
+
+def find_running_node_names(client: docker.DockerClient) -> list[str]:
+    """
+    Returns a list of names of running nodes.
+
+    Parameters
+    ----------
+    client : docker.DockerClient
+        Docker client instance
+
+    Returns
+    -------
+    list[str]
+        List of names of running nodes
+    """
+    running_nodes = client.containers.list(
+        filters={"label": f"{APPNAME}-type=node"})
+    return [node.name for node in running_nodes]