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

vantage6/cli/server/stop.py

@@ -0,0 +1,158 @@
+import itertools
+
+import click
+import questionary as q
+import docker
+from colorama import (Fore, Style)
+from docker.client import DockerClient
+
+from vantage6.common import info, warning, error
+from vantage6.common.docker.addons import (
+    check_docker_running, remove_container,
+    get_server_config_name, get_container, get_num_nonempty_networks,
+    get_network, delete_network, remove_container_if_exists
+)
+from vantage6.common.globals import APPNAME
+from vantage6.cli.rabbitmq import split_rabbitmq_uri
+
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
+from vantage6.cli.context import ServerContext
+from vantage6.cli.utils import remove_file
+from vantage6.cli.server.common import get_server_context, stop_ui
+
+
+@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('--all', 'all_servers', flag_value=True, help="Stop all servers")
+def cli_server_stop(name: str, system_folders: bool, all_servers: bool):
+    """
+    Stop one or all running server(s).
+    """
+    check_docker_running()
+    client = docker.from_env()
+
+    running_servers = client.containers.list(
+        filters={"label": f"{APPNAME}-type=server"})
+
+    if not running_servers:
+        warning("No servers are currently running.")
+        return
+
+    running_server_names = [server.name for server in running_servers]
+
+    if all_servers:
+        for container_name in running_server_names:
+            _stop_server_containers(client, container_name, system_folders)
+        return
+
+    # make sure we have a configuration name to work with
+    if not name:
+        container_name = q.select("Select the server you wish to stop:",
+                                  choices=running_server_names).ask()
+    else:
+        post_fix = "system" if system_folders else "user"
+        container_name = f"{APPNAME}-{name}-{post_fix}-server"
+
+    if container_name not in running_server_names:
+        error(f"{Fore.RED}{name}{Style.RESET_ALL} is not running!")
+        return
+
+    _stop_server_containers(client, container_name, system_folders)
+
+
+def _stop_server_containers(client: DockerClient, container_name: str,
+                            system_folders: bool) -> None:
+    """
+    Given a server's name, kill its docker container and related (RabbitMQ)
+    containers.
+
+    Parameters
+    ----------
+    client : DockerClient
+        Docker client
+    container_name : str
+        Name of the server to stop
+    system_folders : bool
+        Wether to use system folders or not
+    """
+    # kill the server
+    remove_container_if_exists(client, name=container_name)
+    info(f"Stopped the {Fore.GREEN}{container_name}{Style.RESET_ALL} server.")
+
+    # find the configuration name from the docker container name
+    # server name is formatted as f"{APPNAME}-{self.name}-{self.scope}-server"
+    scope = "system" if system_folders else "user"
+    config_name = get_server_config_name(container_name, scope)
+
+    ctx = get_server_context(config_name, system_folders)
+
+    # kill the UI container (if it exists)
+    stop_ui(client, ctx)
+
+    # delete the server network
+    network_name = f"{APPNAME}-{ctx.name}-{ctx.scope}-network"
+    network = get_network(client, name=network_name)
+    delete_network(network, kill_containers=False)
+
+    # kill RabbitMQ if it exists and no other servers are using to it (i.e. it
+    # is not in other docker networks with other containers)
+    rabbit_uri = ctx.config.get('rabbitmq', {}).get('uri')
+    if rabbit_uri:
+        rabbit_container_name = split_rabbitmq_uri(
+            rabbit_uri=rabbit_uri)['host']
+        rabbit_container = get_container(client, name=rabbit_container_name)
+        if rabbit_container and \
+                get_num_nonempty_networks(rabbit_container) == 0:
+            remove_container(rabbit_container, kill=True)
+            info(f"Stopped the {Fore.GREEN}{rabbit_container_name}"
+                 f"{Style.RESET_ALL} container.")
+
+
+# TODO this should be refactored into its own module and get a click command
+# attached
+@click.pass_context
+def vserver_remove(
+    click_ctx: click.Context, ctx: ServerContext, name: str,
+    system_folders: bool, force: bool
+) -> None:
+    """
+    Function to remove a server.
+
+    Parameters
+    ----------
+    ctx : ServerContext
+        Server context object
+    name : str
+        Name of the server to remove
+    system_folders : bool
+        Whether to use system folders or not
+    force : bool
+        Whether to ask for confirmation before removing or not
+    """
+    check_docker_running()
+
+    # first stop server
+    click_ctx.invoke(
+        cli_server_stop, name=name, system_folders=system_folders,
+        all_servers=False
+    )
+
+    if not force:
+        if not q.confirm(
+            "This server will be deleted permanently including its "
+            "configuration. Are you sure?", default=False
+        ).ask():
+            info("Server will not be deleted")
+            exit(0)
+
+    # now remove the folders...
+    info(f"Removing configuration file {ctx.config_file}")
+    remove_file(ctx.config_file, 'configuration')
+
+    info(f"Removing log file {ctx.log_file}")
+    for handler in itertools.chain(ctx.log.handlers, ctx.log.root.handlers):
+        handler.close()
+    remove_file(ctx.log_file, 'log')

vantage6/cli/server/version.py

@@ -0,0 +1,46 @@
+import click
+import questionary as q
+import docker
+
+from vantage6.common import error
+from vantage6.common.docker.addons import check_docker_running
+from vantage6.common.globals import APPNAME
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
+from vantage6.cli import __version__
+
+
+@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)
+def cli_server_version(name: str, system_folders: bool) -> None:
+    """
+    Print the version of the vantage6 server.
+    """
+    check_docker_running()
+    client = docker.from_env()
+
+    running_servers = client.containers.list(
+        filters={"label": f"{APPNAME}-type=server"})
+    running_server_names = [server.name for server in running_servers]
+
+    if not name:
+        if not running_server_names:
+            error("No servers are running! You can only check the version for "
+                  "servers that are running")
+            exit(1)
+        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}"
+
+    if name in running_server_names:
+        container = client.containers.get(name)
+        version = container.exec_run(cmd='vserver-local version',
+                                     stdout=True)
+        click.echo({"server": version.output.decode('utf-8'),
+                    "cli": __version__})
+    else:
+        error(f"Server {name} is not running! Cannot provide version...")

{vantage6-4.0.2.dist-info → vantage6-4.1.0b0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vantage6
-Version: 4.0.2
+Version: 4.1.0b0
 Summary: vantage6 command line interface
 Home-page: https://github.com/vantage6/vantage6
 Requires-Python: >=3.10
@@ -13,8 +13,8 @@ Requires-Dist: jinja2 ==3.1.2
 Requires-Dist: questionary ==1.10.0
 Requires-Dist: schema ==0.7.5
 Requires-Dist: SQLAlchemy ==1.4.46
-Requires-Dist: vantage6-common ==4.0.2
-Requires-Dist: vantage6-client ==4.0.2
+Requires-Dist: vantage6-common ==4.1.0b0
+Requires-Dist: vantage6-client ==4.1.0b0
 Provides-Extra: dev
 Requires-Dist: coverage ==6.4.4 ; extra == 'dev'
 
@@ -67,10 +67,11 @@ These docker images are used by the _vantage6 CLI_ package, which can be install
 
 `pip install vantage6`
 
-This will install the CLI which enables you to use the commands:
+This will install the CLI which enables you to use (among others) the commands
+to manage your nodes and servers:
 
-* `vnode CMD [OPTIONS]`
-* `vserver CMD [OPTIONS]`
+* `v6 node CMD [OPTIONS]`
+* `v6 server CMD [OPTIONS]`
 
 You can find more (user) documentation at [Gitbook (docs.vantage6.ai)](https://docs.vantage6.ai). If you have any questions, suggestions or just want to chat about federated learning: join our [Dircord (https://discord.gg/yAyFf6Y)](https://discord.gg/yAyFf6Y) channel.
 

vantage6-4.1.0b0.dist-info/RECORD

@@ -0,0 +1,52 @@
+tests_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests_cli/test_example.py,sha256=TV8JA52UR-Yh1WeVwx8g8ngA9ZTiRCwsJkUKxsXUXMg,147
+tests_cli/test_node_cli.py,sha256=LtnGjHbCJq95eH3vVIeSbVvbX1_DMgP0mVLRqcdP4ss,15454
+tests_cli/test_server_cli.py,sha256=AYI6NQpI76OxIOHvWx87B1E-q3hgc6Dh4efD82LYuOA,6202
+tests_cli/test_wizard.py,sha256=dRrOScN79z8nKGNWmn6tPAVfnDOmCsGckiDJMKufhms,3580
+vantage6/cli/__build__,sha256=X-zrZv_IbzjZUnhsbWlsecLbwjndTpG0ZynXOif7V-k,1
+vantage6/cli/__init__.py,sha256=dEbhLHe9VfU3otY3CQkMVrj39uPGWjqzAvHW2B2Flgs,62
+vantage6/cli/_version.py,sha256=zLeITsnn0rsnz3i-X-GBvMrFwOkMmN6DaNzDlBLS8L4,683
+vantage6/cli/cli.py,sha256=QK2Te28CWBKrI9tLuB9qCOm5Wr4TA8VzWJ6chSF8Phk,3796
+vantage6/cli/configuration_manager.py,sha256=4EHlOW16nfIiplzA0sw9udc4-VLKcmdKgWzzFa5Nw7A,3841
+vantage6/cli/configuration_wizard.py,sha256=c8L4xm9_HYjAkyTmRmLDMwzTDqdKdgnBZy915TAIfRI,11569
+vantage6/cli/context.py,sha256=Q8d-PYq_hBB8chXv1qlI9jYfVVIv2X6BOC-PGmWgptw,13183
+vantage6/cli/globals.py,sha256=5mo7pv45gXhDtG7phSYdK_D9_LPFuBM8bVABgt-J-BY,778
+vantage6/cli/utils.py,sha256=Lx1xYKXDBeHjJpXGkVAhidy79P-zV3TOQYfa2nMbvSs,2353
+vantage6/cli/dev/create.py,sha256=orkcbMcdQg5OQsmi3EuBGzMsuWsG73dx0SqbWW_TeDc,11256
+vantage6/cli/dev/remove.py,sha256=qNqZwAaTIqdjkHIcr1pjTMSqlTDmcaPz87NkSMhT-ws,2362
+vantage6/cli/dev/start.py,sha256=IJbXzezMx4MK7rO9nx3AvidEZfdUL5mX0gA7AlwETLU,1629
+vantage6/cli/dev/stop.py,sha256=XDvjyxxU4gVnC9sKHxYMLYPmDwRq_4lnpXE9imO614Q,993
+vantage6/cli/node/attach.py,sha256=n7mJaDJq7tngMVigXe0_JBAdueV_5YEz8FmVOvAF-PU,2152
+vantage6/cli/node/clean.py,sha256=1C0bTEuc6UO-GBIWUsp9YgO_sK5O5Mg-zZYnsCmd2OE,1088
+vantage6/cli/node/create_private_key.py,sha256=U0kuXmB-POneJzB8rxQ9AHRaqrmp_S54isRkG2a7rhg,4988
+vantage6/cli/node/files.py,sha256=ELpTvGKiPsfSH8kiYrnHfM4Fb8AES8uJF3L2sGQJ27c,1331
+vantage6/cli/node/list.py,sha256=b8ht09bvzVFiQx909r8zeTruCWC2uLyrNVeiipCjgAI,1707
+vantage6/cli/node/new.py,sha256=01sp9005TidvHA_awuaahBHV1-LImspStLTYhruek_A,1858
+vantage6/cli/node/remove.py,sha256=kLMK2Xsfgwrb3FuqRc9cKCadc8p0P3dLTLt9wN1_sBg,3564
+vantage6/cli/node/set_api_key.py,sha256=cJXWe1G5m2LTlyhBX85KFlCcL7voO-YNHUvhnsrwHhE,1796
+vantage6/cli/node/start.py,sha256=qcXjSV_3E4tpVr_gkzptC-fNZyJqRp5mQLsFCTrtPsw,11878
+vantage6/cli/node/stop.py,sha256=08SWafKBpCY_pnMopRkcIcHNaBoxqRHmlDSfQDzWjuQ,2704
+vantage6/cli/node/version.py,sha256=HD0iCf2VGZK8HVYfNcMpDAQdxYQ--5ff10XYCsX7Hf4,1843
+vantage6/cli/node/common/__init__.py,sha256=nUDpIehzfX9Zd3tL2Wa9nP5940SH27gcXGRiCHcxjrA,3166
+vantage6/cli/rabbitmq/__init__.py,sha256=0cuoLZ3V1199PKI-Ew37leZmh77SOAYa8CKMLUUBgBs,737
+vantage6/cli/rabbitmq/definitions.py,sha256=aGFdwxzi7R28uaDS60iW3a-JCkV2F5w_T3oede0kWds,536
+vantage6/cli/rabbitmq/queue_manager.py,sha256=CG2Lx5RCpf2AjzaCvj9vrwrqJOlWbEqf89auX2iuXcU,7613
+vantage6/cli/rabbitmq/rabbitmq.config,sha256=LYAQAEoXaF472XeJDYXc9JfWSETIzPRIR2W-JB2i7fU,136
+vantage6/cli/server/attach.py,sha256=TKibcEhqeMrTX3MQ5OkKlkqBs2pSSsZDh_yiaAoNOpw,1930
+vantage6/cli/server/files.py,sha256=owBO6lj_ucHY00MxJUOOdacz4NbdOqp-vrfkVrGjPUE,481
+vantage6/cli/server/import_.py,sha256=Up3IAK3c9jyFpr7y9_zl4HNViFj6jT9OLh_S6v6t5Hs,4611
+vantage6/cli/server/list.py,sha256=p5SRRGsz6G83Hc53eYoySWi32egm7jie_lo1gkS0NCk,1734
+vantage6/cli/server/new.py,sha256=ZHnjWlEKXOMdu6WYHDcrD62Qc2au-YuYIv2SW2KXS7M,1913
+vantage6/cli/server/shell.py,sha256=SRw-CrD_ro9DRfqCI6IlifJk_UDr6EIke5ypN4-85yo,1384
+vantage6/cli/server/start.py,sha256=ywhKaw-ryJQW2k6byZmr8Dz40CylpKrgToxP85HlNUA,10761
+vantage6/cli/server/stop.py,sha256=Lij7NSiVcgPWyQFB4-p-P2zbkdWOZAk08LKHZhYqxU0,5446
+vantage6/cli/server/version.py,sha256=upvy6VdO3XGfovEW-2Ybc0c0niM2ieCOrz1SlsBrqkw,1743
+vantage6/cli/server/common/__init__.py,sha256=kUcDOfGuNvf8j7g5er9D_7z8IHRk53QBQ2E0NcZ_1iE,4818
+vantage6/cli/template/node_config.j2,sha256=-IyUquZl4jRxb5DRBWvEbZFwz2lFtHG_1reZoSkeees,495
+vantage6/cli/template/server_config.j2,sha256=d6O_K-VzJC3GHbCGVbXRWB4jTEzJHPz1VC7t3U8e0Tc,367
+vantage6/cli/template/server_import_config.j2,sha256=PRB0ym_FYjx9vhkmY9C0xzlv_85Y5kBfWdUYs089bNQ,1844
+vantage6-4.1.0b0.dist-info/METADATA,sha256=cJN7zX4mviFvksp0LkDuxnVS7vMTAs56O09T21niepU,5910
+vantage6-4.1.0b0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+vantage6-4.1.0b0.dist-info/entry_points.txt,sha256=YFBvwjxoeAGxYyPC-YevEgOBBYRGaXkS6jiOGGCLNy0,157
+vantage6-4.1.0b0.dist-info/top_level.txt,sha256=CYDIBS8jEfFq5YCs_Fuit54K9-3wdosZppTrsymIoUk,19
+vantage6-4.1.0b0.dist-info/RECORD,,

vantage6-4.1.0b0.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+v6 = vantage6.cli.cli:cli_complete
+vdev = vantage6.cli.cli:cli_dev
+vnode = vantage6.cli.cli:cli_node
+vserver = vantage6.cli.cli:cli_server