vantage6 5.0.0a7__py3-none-any.whl → 5.0.0a9__py3-none-any.whl

tests_cli/test_node_cli.py

@@ -295,29 +295,12 @@ class NodeCLITest(unittest.TestCase):
             result = runner.invoke(cli_node_restart, ["--name", "iknl"])
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.node.attach.time")
-    @patch("vantage6.cli.node.attach.print_log_worker")
-    @patch("docker.DockerClient.containers")
-    @patch("vantage6.cli.node.attach.check_docker_running", return_value=True)
-    def test_attach(self, check_docker, containers, log_worker, time_):
+    @patch("vantage6.cli.node.attach.attach_logs")
+    def test_attach(self, attach_logs):
         """Attach docker logs without errors."""
-        container1 = MagicMock()
-        container1.name = f"{APPNAME}-iknl-user"
-        containers.list.return_value = [container1]
-
-        log_worker.return_value = ""
-        time_.sleep.side_effect = KeyboardInterrupt()
-
         runner = CliRunner()
-        result = runner.invoke(cli_node_attach, ["--name", "iknl"])
-
-        self.assertEqual(
-            result.output,
-            "[info ] - Closing log file. Keyboard Interrupt.\n"
-            "[info ] - Note that your node is still running! Shut it down "
-            "with 'v6 node stop'\n",
-        )
-        self.assertEqual(result.exit_code, 0)
+        runner.invoke(cli_node_attach)
+        attach_logs.assert_called_once_with("app=node")
 
     @patch("vantage6.cli.node.clean.q")
     @patch("docker.DockerClient.volumes")

tests_cli/test_server_cli.py

@@ -5,6 +5,7 @@ from pathlib import Path
 from click.testing import CliRunner
 
 from vantage6.common.globals import APPNAME, InstanceType
+from vantage6.cli.common.utils import attach_logs
 from vantage6.cli.server.start import cli_server_start
 from vantage6.cli.server.list import cli_server_configuration_list
 from vantage6.cli.server.files import cli_server_files
@@ -141,18 +142,38 @@ class ServerCLITest(unittest.TestCase):
         self.assertIsNone(result.exception)
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.server.attach.time.sleep")
-    @patch("docker.DockerClient.containers")
-    def test_attach(self, containers, sleep):
-        """Attach log to the console without errors."""
-        container1 = MagicMock()
-        container1.name = f"{APPNAME}-iknl-system-{InstanceType.SERVER}"
-        containers.list.return_value = [container1]
-
-        sleep.side_effect = KeyboardInterrupt("Boom!")
-
+    @patch("vantage6.cli.server.attach.attach_logs")
+    def test_attach(self, attach_logs):
+        """Attach logs to the console without errors."""
         runner = CliRunner()
-        result = runner.invoke(cli_server_attach, ["--name", "iknl"])
+        result = runner.invoke(cli_server_attach)
 
         self.assertIsNone(result.exception)
         self.assertEqual(result.exit_code, 0)
+        attach_logs.assert_called_once_with(
+            "app=vantage6-server", "component=vantage6-server"
+        )
+
+    @patch("vantage6.cli.common.utils.Popen")
+    def test_attach_logs(self, mock_popen):
+        # Mock the Popen instance and its methods
+        mock_process = mock_popen.return_value
+        mock_process.wait.return_value = None
+
+        # Call the function with a sample label
+        attach_logs("app=node", "env=dev")
+
+        # Construct the expected command
+        expected_command = [
+            "devspace",
+            "logs",
+            "--follow",
+            "--label-selector",
+            "app=node,env=dev",
+        ]
+
+        # Verify that Popen was called with the expected command
+        mock_popen.assert_called_once_with(expected_command, stdout=None, stderr=None)
+
+        # Verify that wait was called on the process
+        mock_process.wait.assert_called_once()

vantage6/cli/__build__

@@ -1 +1 @@
-7
+9

vantage6/cli/algostore/attach.py

@@ -1,49 +1,13 @@
 import click
-import docker
-import questionary as q
 
-from colorama import Fore, Style
-
-from vantage6.common import error
-from vantage6.common.docker.addons import check_docker_running
-from vantage6.common.globals import APPNAME, InstanceType
-from vantage6.cli.common.start import attach_logs
-from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
+from vantage6.common import info
+from vantage6.cli.common.utils import attach_logs
 
 
 @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_algo_store_attach(name: str, system_folders: bool) -> None:
+def cli_algo_store_attach() -> None:
     """
-    Show the server logs in the current console.
+    Show the store logs in the current console.
     """
-    check_docker_running()
-    client = docker.from_env()
-
-    running_servers = client.containers.list(
-        filters={"label": f"{APPNAME}-type={InstanceType.ALGORITHM_STORE}"}
-    )
-    running_server_names = [container.name for container in running_servers]
-
-    if not name:
-        try:
-            name = q.select(
-                "Select the algorithm store you wish to attach:",
-                choices=running_server_names,
-            ).unsafe_ask()
-        except KeyboardInterrupt:
-            error("Aborted by user!")
-            return
-    else:
-        post_fix = "system" if system_folders else "user"
-        name = f"{APPNAME}-{name}-{post_fix}-{InstanceType.ALGORITHM_STORE}"
-
-    if name in running_server_names:
-        container = client.containers.get(name)
-        attach_logs(container, InstanceType.ALGORITHM_STORE)
-    else:
-        error(f"{Fore.RED}{name}{Style.RESET_ALL} is not running!")
+    info("Attaching to store logs...")
+    attach_logs("app=store", "component=store-server")

vantage6/cli/cli.py

@@ -22,14 +22,11 @@ from vantage6.cli.node.set_api_key import cli_node_set_api_key
 from vantage6.cli.node.start import cli_node_start
 from vantage6.cli.node.stop import cli_node_stop
 from vantage6.cli.node.version import cli_node_version
-from vantage6.cli.dev.create import create_demo_network
-from vantage6.cli.dev.remove import remove_demo_network
-from vantage6.cli.dev.start import start_demo_network
-from vantage6.cli.dev.stop import stop_demo_network
 from vantage6.cli.algorithm.create import cli_algorithm_create
 from vantage6.cli.algorithm.update import cli_algorithm_update
 from vantage6.cli.test.feature_tester import cli_test_features
-from vantage6.cli.test.integration_test import cli_test_integration
+
+# from vantage6.cli.test.integration_test import cli_test_integration
 from vantage6.cli.algostore.attach import cli_algo_store_attach
 from vantage6.cli.algostore.new import cli_algo_store_new
 from vantage6.cli.algostore.start import cli_algo_store_start
@@ -93,11 +90,7 @@ def cli_dev() -> None:
     """
 
 
-# Define the commands for the dev group
-cli_dev.add_command(create_demo_network, name="create-demo-network")
-cli_dev.add_command(remove_demo_network, name="remove-demo-network")
-cli_dev.add_command(start_demo_network, name="start-demo-network")
-cli_dev.add_command(stop_demo_network, name="stop-demo-network")
+# TODO add commands for the dev group
 
 
 # Define the algorithm group
@@ -123,7 +116,7 @@ def cli_test() -> None:
 
 # Define the commands for the test group
 cli_test.add_command(cli_test_features, name="feature-test")
-cli_test.add_command(cli_test_integration, name="integration-test")
+# cli_test.add_command(cli_test_integration, name="integration-test")
 
 
 # Define the algorithm-store group

vantage6/cli/common/utils.py

@@ -3,6 +3,7 @@ from colorama import Fore, Style
 import click
 from typing import Iterable
 import docker
+from subprocess import Popen
 
 
 from vantage6.common import warning, error
@@ -158,3 +159,17 @@ def get_name_from_container_name(container_name: str) -> str:
     # Container name is structured as: f"{APPNAME}-{name}-{post_fix}"
     # Take into account that name can contain '-'
     return "-".join(container_name.split("-")[1:-1])
+
+
+def attach_logs(*labels: list[str]) -> None:
+    """
+    Attach to the logs of the given labels.
+
+    Parameters
+    ----------
+    labels : list[str]
+        The labels to attach to
+    """
+    command = ["devspace", "logs", "--follow", "--label-selector", ",".join(labels)]
+    process = Popen(command, stdout=None, stderr=None)
+    process.wait()

vantage6/cli/node/attach.py

@@ -1,74 +1,13 @@
-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.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
+from vantage6.common import info
+from vantage6.cli.common.utils import attach_logs
 
 
 @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:
+def cli_node_attach() -> 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:
-        try:
-            name = q.select(
-                "Select the node you wish to attach:", choices=running_node_names
-            ).unsafe_ask()
-        except KeyboardInterrupt:
-            error("Aborted by user!")
-            return
-    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!?")
+    info("Attaching to node logs...")
+    attach_logs("app=node")

vantage6/cli/server/attach.py

@@ -1,63 +1,13 @@
-import time
-from threading import Thread
-
 import click
-import questionary as q
-import docker
-
-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, InstanceType
 
-from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
-from vantage6.cli.common.utils import print_log_worker
+from vantage6.common import info
+from vantage6.cli.common.utils import attach_logs
 
 
 @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_attach(name: str, system_folders: bool) -> None:
+def cli_server_attach() -> None:
     """
     Show the server logs in the current console.
     """
-    check_docker_running()
-    client = docker.from_env()
-
-    running_servers = client.containers.list(
-        filters={"label": f"{APPNAME}-type={InstanceType.SERVER}"}
-    )
-    running_server_names = [node.name for node in running_servers]
-
-    if not name:
-        try:
-            name = q.select(
-                "Select the server you wish to attach:", choices=running_server_names
-            ).unsafe_ask()
-        except KeyboardInterrupt:
-            error("Aborted by user!")
-            return
-    else:
-        post_fix = "system" if system_folders else "user"
-        name = f"{APPNAME}-{name}-{post_fix}-{InstanceType.SERVER}"
-
-    if name in running_server_names:
-        container = client.containers.get(name)
-        logs = container.attach(stream=True, logs=True, stdout=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 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!?")
+    info("Attaching to server logs...")
+    attach_logs("app=vantage6-server", "component=vantage6-server")

vantage6/cli/test/common/diagnostic_runner.py

@@ -97,9 +97,7 @@ class DiagnosticRunner:
             name="test",
             description="Basic Diagnostic test",
             image=DIAGNOSTICS_IMAGE,
-            input_={
-                "method": "base_features",
-            },
+            method="base_features",
             organizations=self.organization_ids,
             databases=[{"label": "default"}],
         )
@@ -123,8 +121,8 @@ class DiagnosticRunner:
             name="test",
             description="VPN Diagnostic test",
             image=DIAGNOSTICS_IMAGE,
+            method="vpn_features",
             input_={
-                "method": "vpn_features",
                 "kwargs": {"other_nodes": self.organization_ids},
             },
             organizations=self.organization_ids,

vantage6/cli/test/integration_test.py

@@ -1,122 +1,122 @@
-from pathlib import Path
-import click
+# from pathlib import Path
+# import click
 
-from vantage6.common.globals import Ports
-from vantage6.cli.utils import info
-from vantage6.cli.dev.create import create_demo_network
-from vantage6.cli.dev.start import start_demo_network
-from vantage6.cli.dev.stop import stop_demo_network
-from vantage6.cli.dev.remove import remove_demo_network
-from vantage6.cli.utils import prompt_config_name, check_config_name_allowed
-from vantage6.cli.test.feature_tester import cli_test_features
+# from vantage6.common.globals import Ports
+# from vantage6.cli.utils import info
+# from vantage6.cli.dev.create import create_demo_network
+# from vantage6.cli.dev.start import start_demo_network
+# from vantage6.cli.dev.stop import stop_demo_network
+# from vantage6.cli.dev.remove import remove_demo_network
+# from vantage6.cli.utils import prompt_config_name, check_config_name_allowed
+# from vantage6.cli.test.feature_tester import cli_test_features
 
 
-@click.command()
-@click.option(
-    "-n", "--name", default=None, type=str, help="Name for your development setup"
-)
-@click.option(
-    "--server-url",
-    type=str,
-    default="http://host.docker.internal",
-    help="Server URL to point to. If you are using Docker Desktop, "
-    "the default http://host.docker.internal should not be changed.",
-)
-@click.option(
-    "-i", "--image", type=str, default=None, help="Server Docker image to use"
-)
-@click.option(
-    "--keep",
-    type=bool,
-    default=False,
-    help="Keep the dev network after finishing the test",
-)
-@click.option(
-    "--extra-server-config",
-    type=click.Path(exists=True),
-    default=None,
-    help="YAML File with additional server "
-    "configuration. This will be appended to the server "
-    "configuration file",
-)
-@click.option(
-    "--extra-node-config",
-    type=click.Path("rb"),
-    default=None,
-    help="YAML File with additional node configuration. This will be"
-    " appended to each of the node configuration files",
-)
-@click.pass_context
-def cli_test_integration(
-    click_ctx: click.Context,
-    name: str,
-    server_url: str,
-    image: str,
-    keep: bool = False,
-    extra_server_config: Path = None,
-    extra_node_config: Path = None,
-) -> list[dict]:
-    """
-    Create dev network and run diagnostic checks on it.
+# @click.command()
+# @click.option(
+#     "-n", "--name", default=None, type=str, help="Name for your development setup"
+# )
+# @click.option(
+#     "--server-url",
+#     type=str,
+#     default="http://host.docker.internal",
+#     help="Server URL to point to. If you are using Docker Desktop, "
+#     "the default http://host.docker.internal should not be changed.",
+# )
+# @click.option(
+#     "-i", "--image", type=str, default=None, help="Server Docker image to use"
+# )
+# @click.option(
+#     "--keep",
+#     type=bool,
+#     default=False,
+#     help="Keep the dev network after finishing the test",
+# )
+# @click.option(
+#     "--extra-server-config",
+#     type=click.Path(exists=True),
+#     default=None,
+#     help="YAML File with additional server "
+#     "configuration. This will be appended to the server "
+#     "configuration file",
+# )
+# @click.option(
+#     "--extra-node-config",
+#     type=click.Path("rb"),
+#     default=None,
+#     help="YAML File with additional node configuration. This will be"
+#     " appended to each of the node configuration files",
+# )
+# @click.pass_context
+# def cli_test_integration(
+#     click_ctx: click.Context,
+#     name: str,
+#     server_url: str,
+#     image: str,
+#     keep: bool = False,
+#     extra_server_config: Path = None,
+#     extra_node_config: Path = None,
+# ) -> list[dict]:
+#     """
+#     Create dev network and run diagnostic checks on it.
 
-    This is a full integration test of the vantage6 network. It will create
-    a test server with some nodes using the `vdev` commands, and then run the
-    v6-diagnostics algorithm to test all functionality.
-    """
-    # get name for the development setup - if not given - and check if it is
-    # allowed
-    name = prompt_config_name(name)
-    check_config_name_allowed(name)
+#     This is a full integration test of the vantage6 network. It will create
+#     a test server with some nodes using the `vdev` commands, and then run the
+#     v6-diagnostics algorithm to test all functionality.
+#     """
+#     # get name for the development setup - if not given - and check if it is
+#     # allowed
+#     name = prompt_config_name(name)
+#     check_config_name_allowed(name)
 
-    # create server & node configurations and create test resources (
-    # collaborations, organizations, etc)
-    click_ctx.invoke(
-        create_demo_network,
-        name=name,
-        num_nodes=3,
-        server_url=server_url,
-        server_port=Ports.DEV_SERVER.value,
-        image=image,
-        extra_server_config=extra_server_config,
-        extra_node_config=extra_node_config,
-    )
+#     # create server & node configurations and create test resources (
+#     # collaborations, organizations, etc)
+#     click_ctx.invoke(
+#         create_demo_network,
+#         name=name,
+#         num_nodes=3,
+#         server_url=server_url,
+#         server_port=Ports.DEV_SERVER.value,
+#         image=image,
+#         extra_server_config=extra_server_config,
+#         extra_node_config=extra_node_config,
+#     )
 
-    # start the server and nodes
-    click_ctx.invoke(
-        start_demo_network,
-        name=name,
-        server_image=image,
-        node_image=image,
-    )
+#     # start the server and nodes
+#     click_ctx.invoke(
+#         start_demo_network,
+#         name=name,
+#         server_image=image,
+#         node_image=image,
+#     )
 
-    # run the diagnostic tests
-    # TODO the username and password should be coordinated with the vdev
-    # command - at present it spits out this username/password combination by
-    # default but both should be defined in the same place
-    # TODO VPN testing is always excluded - allow to include it with a flag
-    # when vdev commands can handle extra config parameters
-    diagnose_results = click_ctx.invoke(
-        cli_test_features,
-        host="http://localhost",
-        port=Ports.DEV_SERVER.value,
-        api_path="/api",
-        username="dev_admin",
-        password="password",
-        collaboration=1,
-        organizations=None,
-        all_nodes=True,
-        online_only=False,
-        no_vpn=True,
-    )
+#     # run the diagnostic tests
+#     # TODO the username and password should be coordinated with the vdev
+#     # command - at present it spits out this username/password combination by
+#     # default but both should be defined in the same place
+#     # TODO VPN testing is always excluded - allow to include it with a flag
+#     # when vdev commands can handle extra config parameters
+#     diagnose_results = click_ctx.invoke(
+#         cli_test_features,
+#         host="http://localhost",
+#         port=Ports.DEV_SERVER.value,
+#         api_path="/api",
+#         username="dev_admin",
+#         password="password",
+#         collaboration=1,
+#         organizations=None,
+#         all_nodes=True,
+#         online_only=False,
+#         no_vpn=True,
+#     )
 
-    # clean up the test resources
-    click_ctx.invoke(stop_demo_network, name=name)
-    if not keep:
-        click_ctx.invoke(remove_demo_network, name=name)
-    else:
-        info(
-            f"Keeping the demo network {name}. You can start it with `v6 dev "
-            "start-demo-network`"
-        )
+#     # clean up the test resources
+#     click_ctx.invoke(stop_demo_network, name=name)
+#     if not keep:
+#         click_ctx.invoke(remove_demo_network, name=name)
+#     else:
+#         info(
+#             f"Keeping the demo network {name}. You can start it with `v6 dev "
+#             "start-demo-network`"
+#         )
 
-    return diagnose_results
+#     return diagnose_results

{vantage6-5.0.0a7.dist-info → vantage6-5.0.0a9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vantage6
-Version: 5.0.0a7
+Version: 5.0.0a9
 Summary: vantage6 command line interface
 Home-page: https://github.com/vantage6/vantage6
 Requires-Python: >=3.10
@@ -16,8 +16,8 @@ Requires-Dist: questionary==1.10.0
 Requires-Dist: rich==13.5.2
 Requires-Dist: schema==0.7.5
 Requires-Dist: sqlalchemy==2.0.37
-Requires-Dist: vantage6-common==5.0.0a7
-Requires-Dist: vantage6-client==5.0.0a7
+Requires-Dist: vantage6-common==5.0.0a9
+Requires-Dist: vantage6-client==5.0.0a9
 Provides-Extra: dev
 Requires-Dist: coverage==6.4.4; extra == "dev"
 Requires-Dist: black; extra == "dev"