vantage6 4.1.3__tar.gz → 4.2.0rc2__tar.gz

{vantage6-4.1.3 → vantage6-4.2.0rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vantage6
-Version: 4.1.3
+Version: 4.2.0rc2
 Summary: vantage6 command line interface
 Home-page: https://github.com/vantage6/vantage6
 Requires-Python: >=3.10

{vantage6-4.1.3 → vantage6-4.2.0rc2}/setup.py

@@ -40,8 +40,9 @@ setup(
         'copier==8.3.0',
         'docker==6.1.2',
         'ipython==8.10.0',
-        'jinja2==3.1.2',
+        'jinja2==3.1.3',
         'questionary==1.10.0',
+        'rich==13.5.2',
         'schema==0.7.5',
         'SQLAlchemy==1.4.46',
         f'vantage6-common == {version_ns["__version__"]}',

{vantage6-4.1.3 → vantage6-4.2.0rc2}/tests_cli/test_node_cli.py

@@ -214,7 +214,7 @@ class NodeCLITest(unittest.TestCase):
             log_dir=Path("logs"),
             config_dir=Path("configs"),
             databases=[{
-                "label": "some-label",
+                "label": "some_label",
                 "uri": "data.csv",
                 "type": "csv"
             }]

{vantage6-4.1.3 → vantage6-4.2.0rc2}/tests_cli/test_server_cli.py

@@ -126,23 +126,14 @@ class ServerCLITest(unittest.TestCase):
         self.assertIsNone(result.exception)
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.server.stop.ServerContext")
     @patch("vantage6.cli.server.stop.docker.from_env")
-    @patch("vantage6.cli.server.stop.check_docker_running", return_value=True)
-    def test_stop(self, docker_check, containers, context):
+    def test_stop(self, containers):
         """Stop server without errors."""
 
         container1 = MagicMock()
         container1.name = f"{APPNAME}-iknl-system-server"
         containers.containers.list.return_value = [container1]
 
-        ctx = MagicMock(
-            config={
-                'rabbitmq_uri': None
-            }
-        )
-        context.return_value = ctx
-
         runner = CliRunner()
         result = runner.invoke(cli_server_stop, ["--name", "iknl"])
 
@@ -151,9 +142,7 @@ class ServerCLITest(unittest.TestCase):
 
     @patch("vantage6.cli.server.attach.time.sleep")
     @patch("docker.DockerClient.containers")
-    @patch("vantage6.cli.server.attach.check_docker_running",
-           return_value=True)
-    def test_attach(self, docker_check, containers, sleep):
+    def test_attach(self, containers, sleep):
         """Attach log to the console without errors."""
         container1 = MagicMock()
         container1.name = f"{APPNAME}-iknl-system-server"

vantage6-4.2.0rc2/vantage6/cli/__build__

@@ -0,0 +1 @@
+2

{vantage6-4.1.3 → vantage6-4.2.0rc2}/vantage6/cli/_version.py

@@ -7,7 +7,7 @@ with open(os.path.join(here, '__build__')) as fp:
     __build__ = json.load(fp)
 
 # Module version
-version_info = (4, 1, 3, 'final', __build__, 0)
+version_info = (4, 2, 0, 'candidate', __build__, 0)
 
 # Module version stage suffix map
 _specifier_ = {'alpha': 'a', 'beta': 'b', 'candidate': 'rc', 'final': ''}

{vantage6-4.1.3 → vantage6-4.2.0rc2}/vantage6/cli/cli.py

@@ -5,6 +5,7 @@ from vantage6.cli.server.files import cli_server_files
 from vantage6.cli.server.import_ import cli_server_import
 from vantage6.cli.server.list import cli_server_configuration_list
 from vantage6.cli.server.new import cli_server_new
+from vantage6.cli.server.remove import cli_server_remove
 from vantage6.cli.server.shell import cli_server_shell
 from vantage6.cli.server.start import cli_server_start
 from vantage6.cli.server.stop import cli_server_stop
@@ -26,6 +27,8 @@ 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
 
 
 # Define the server group
@@ -42,6 +45,7 @@ cli_server.add_command(cli_server_files, name='files')
 cli_server.add_command(cli_server_import, name='import')
 cli_server.add_command(cli_server_configuration_list, name='list')
 cli_server.add_command(cli_server_new, name='new')
+cli_server.add_command(cli_server_remove, name='remove')
 cli_server.add_command(cli_server_shell, name='shell')
 cli_server.add_command(cli_server_start, name='start')
 cli_server.add_command(cli_server_stop, name='stop')
@@ -100,6 +104,19 @@ cli_algorithm.add_command(cli_algorithm_create, name="create")
 cli_algorithm.add_command(cli_algorithm_update, name="update")
 
 
+# Define the test group
+@click.group(name="test")
+def cli_test() -> None:
+    """
+    Execute tests on your vantage6 infrastructure.
+    """
+
+
+# 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")
+
+
 # Define the overall group
 @click.group(name='cli')
 def cli_complete() -> None:
@@ -116,3 +133,4 @@ cli_complete.add_command(cli_node)
 cli_complete.add_command(cli_server)
 cli_complete.add_command(cli_dev)
 cli_complete.add_command(cli_algorithm)
+cli_complete.add_command(cli_test)

{vantage6-4.1.3 → vantage6-4.2.0rc2}/vantage6/cli/dev/create.py

@@ -69,7 +69,8 @@ def create_node_config_file(server_url: str, port: int, config: dict,
     port : int
         Port of the dummy server.
     config : dict
-        Configuration dictionary containing org_id, api_key and node name.
+        Configuration dictionary containing org_id, api_key, node name and
+        additional user_defined_config.
     server_name : str
         Configuration name of the dummy server.
     """
@@ -103,7 +104,8 @@ def create_node_config_file(server_url: str, port: int, config: dict,
         },
         "port": port,
         "server_url": server_url,
-        "task_dir": str(path_to_data_dir)
+        "task_dir": str(path_to_data_dir),
+        "user_provided_config": config['user_defined_config']
     })
 
     try:
@@ -117,9 +119,31 @@ def create_node_config_file(server_url: str, port: int, config: dict,
          f"{Style.RESET_ALL}")
 
 
-def generate_node_configs(num_nodes: int, server_url: str, port: int,
-                          server_name: str) \
-        -> list[dict]:
+def _read_extra_config_file(extra_config_file: Path | None) -> str:
+    """Reads extra configuration file.
+
+    Parameters
+    ----------
+    extra_config_file : Path | None
+        Path to file with additional configuration.
+
+    Returns
+    -------
+    str
+        Extra configuration file content
+    """
+    if extra_config_file:
+        # read the YAML file as string, so it can be appended to the
+        # configuration easily
+        with open(extra_config_file, 'r', encoding='utf-8') as f:
+            return f.read()
+    return ''
+
+
+def generate_node_configs(
+    num_nodes: int, server_url: str, port: int, server_name: str,
+    extra_node_config: Path | None
+) -> list[dict]:
     """Generates ``num_nodes`` node configuration files.
 
     Parameters
@@ -132,6 +156,8 @@ def generate_node_configs(num_nodes: int, server_url: str, port: int,
         Port of the dummy server.
     server_name : str
         Configuration name of the dummy server.
+    extra_node_config : Path | None
+        Path to file with additional node configuration.
 
     Returns
     -------
@@ -139,11 +165,13 @@ def generate_node_configs(num_nodes: int, server_url: str, port: int,
         List of dictionaries containing node configurations.
     """
     configs = []
+    extra_config = _read_extra_config_file(extra_node_config)
     for i in range(num_nodes):
         config = {
             'org_id': i + 1,
             'api_key': generate_apikey(),
-            'node_name': f"{server_name}_node_{i + 1}"
+            'node_name': f"{server_name}_node_{i + 1}",
+            "user_defined_config": extra_config
         }
         create_node_config_file(server_url, port, config, server_name)
         configs.append(config)
@@ -211,7 +239,9 @@ def create_vserver_import_config(node_configs: list[dict], server_name: str) \
     return full_path
 
 
-def create_vserver_config(server_name: str, port: int) -> Path:
+def create_vserver_config(
+    server_name: str, port: int, extra_config_file: Path
+) -> Path:
     """Creates server configuration file (YAML).
 
     Parameters
@@ -220,6 +250,8 @@ def create_vserver_config(server_name: str, port: int) -> Path:
         Server name.
     port : int
         Server port.
+    extra_config_file : Path
+        Path to file with additional server configuration.
 
     Returns
     -------
@@ -229,10 +261,14 @@ def create_vserver_config(server_name: str, port: int) -> Path:
     environment = Environment(
         loader=FileSystemLoader(PACKAGE_FOLDER / APPNAME / "cli" / "template"),
         trim_blocks=True, lstrip_blocks=True, autoescape=True)
+
+    extra_config = _read_extra_config_file(extra_config_file)
+
     template = environment.get_template("server_config.j2")
     server_config = template.render(
         port=port,
-        jwt_secret_key=generate_apikey()
+        jwt_secret_key=generate_apikey(),
+        user_provided_config=extra_config
     )
     folders = ServerContext.instance_folders(
         instance_type='server', instance_name=server_name,
@@ -257,8 +293,10 @@ def create_vserver_config(server_name: str, port: int) -> Path:
     return full_path
 
 
-def demo_network(num_nodes: int, server_url: str, server_port: int,
-                 server_name: str) -> tuple[list[dict], Path, Path]:
+def demo_network(
+    num_nodes: int, server_url: str, server_port: int, server_name: str,
+    extra_server_config: Path, extra_node_config: Path
+) -> tuple[list[dict], Path, Path]:
     """Generates the demo network.
 
     Parameters
@@ -271,6 +309,10 @@ def demo_network(num_nodes: int, server_url: str, server_port: int,
         Port of the dummy server.
     server_name : str
         Server name.
+    extra_server_config : Path
+        Path to file with additional server configuration.
+    extra_node_config : Path
+        Path to file with additional node configuration.
 
     Returns
     -------
@@ -278,10 +320,11 @@ def demo_network(num_nodes: int, server_url: str, server_port: int,
         Tuple containing node, server import and server configurations.
     """
     node_configs = generate_node_configs(num_nodes, server_url, server_port,
-                                         server_name)
+                                         server_name, extra_node_config)
     server_import_config = create_vserver_import_config(node_configs,
                                                         server_name)
-    server_config = create_vserver_config(server_name, server_port)
+    server_config = create_vserver_config(server_name, server_port,
+                                          extra_server_config)
     return (node_configs, server_import_config, server_config)
 
 
@@ -298,10 +341,18 @@ def demo_network(num_nodes: int, server_url: str, server_port: int,
 @click.option('-i', '--image', type=str, default=None,
               help='Server docker image to use when setting up resources for '
               'the development server')
+@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 create_demo_network(
     click_ctx: click.Context, name: str, num_nodes: int, server_url: str,
-    server_port: int, image: str = None
+    server_port: int, image: str = None, extra_server_config: Path = None,
+    extra_node_config: Path = None
 ) -> dict:
     """Creates a demo network.
 
@@ -312,7 +363,10 @@ def create_demo_network(
     """
     server_name = prompt_config_name(name)
     if not ServerContext.config_exists(server_name):
-        demo = demo_network(num_nodes, server_url, server_port, server_name)
+        demo = demo_network(
+            num_nodes, server_url, server_port, server_name,
+            extra_server_config, extra_node_config
+        )
         info(f"Created {Fore.GREEN}{len(demo[0])}{Style.RESET_ALL} node "
              f"configuration(s), attaching them to {Fore.GREEN}{server_name}"
              f"{Style.RESET_ALL}.")

{vantage6-4.1.3 → vantage6-4.2.0rc2}/vantage6/cli/dev/remove.py

@@ -8,15 +8,16 @@ 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.server.remove import cli_server_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:
+@click.pass_context
+def remove_demo_network(
+    click_ctx: click.Context, ctx: ServerContext
+) -> None:
     """ Remove all related demo network files and folders.
 
     Select a server configuration to remove that server and the nodes attached
@@ -26,7 +27,7 @@ def remove_demo_network(ctx: ServerContext, force: bool) -> None:
     # remove the server
     for handler in itertools.chain(ctx.log.handlers, ctx.log.root.handlers):
         handler.close()
-    vserver_remove(ctx, ctx.name, True, force)
+    click_ctx.invoke(cli_server_remove, ctx=ctx, force=True)
 
     # removing the server import config
     info("Deleting demo import config file")
@@ -41,8 +42,6 @@ def remove_demo_network(ctx: ServerContext, force: bool) -> None:
     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)

{vantage6-4.1.3 → vantage6-4.2.0rc2}/vantage6/cli/globals.py

@@ -36,3 +36,6 @@ DEFAULT_UI_PORT = 5001
 
 # Location of repository to create new algorithm templates from
 ALGORITHM_TEMPLATE_REPO = "gh:vantage6/v6-algorithm-template.git"
+
+# image to use for diagnostics in `v6 test` commands
+DIAGNOSTICS_IMAGE = "harbor2.vantage6.ai/algorithms/diagnostic"