vantage6 5.0.0a18__tar.gz → 5.0.0a20__tar.gz

{vantage6-5.0.0a18 → vantage6-5.0.0a20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vantage6
-Version: 5.0.0a18
+Version: 5.0.0a20
 Summary: vantage6 command line interface
 Home-page: https://github.com/vantage6/vantage6
 Requires-Python: >=3.10
@@ -26,7 +26,6 @@ Provides-Extra: dev
 [![Discord](https://img.shields.io/discord/643526403207331841)](https://discord.gg/yAyFf6Y)
 [![Research software directory](https://img.shields.io/badge/rsd-vantage6-deepskyblue)](https://research-software-directory.org/software/vantage6)
 
-
 </h3>
 
 <p align="center">
@@ -113,8 +112,12 @@ For example, you can create a new organization by running:
 ```python
 from vantage6.client import Client
 
-client = Client('http://127.0.0.1', 7601, '/api', log_level='debug')
-client.authenticate('dev_admin', 'password')
+client = Client(
+  server_url='http://127.0.0.1:7601/api',
+  auth_url='http://127.0.0.1:8080',
+  log_level='debug'
+)
+client.authenticate()
 client.setup_encryption(None)
 
 client.organization.create(
@@ -179,10 +182,10 @@ And finally there are some images released for algorithm development:
 
 ## :gift_heart: Join the community!
 
-We hope to continue developing, improving, and supporting **vantage6** with the help of 
-the federated learning community. If you are interested in contributing, first of all, 
-thank you! Second, please take a look at our 
-[contributing guidelines](https://docs.vantage6.ai/en/main/devops/contribute.html) 
+We hope to continue developing, improving, and supporting **vantage6** with the help of
+the federated learning community. If you are interested in contributing, first of all,
+thank you! Second, please take a look at our
+[contributing guidelines](https://docs.vantage6.ai/en/main/devops/contribute.html)
 and our [code of conduct](CODE_OF_CONDUCT.md).
 
 <a href="https://github.com/vantage6/vantage6/graphs/contributors">

{vantage6-5.0.0a18 → vantage6-5.0.0a20}/tests_cli/test_node_cli.py

@@ -417,8 +417,7 @@ class NodeCLITest(unittest.TestCase):
     @patch("vantage6.cli.node.common.debug")
     @patch("vantage6.cli.node.common.error")
     @patch("vantage6.cli.node.common.UserClient")
-    @patch("vantage6.cli.node.common.q")
-    def test_client(self, q, client, error, debug, info):
+    def test_client(self, client, error, debug, info):
         ctx = MagicMock(
             config={
                 "server_url": "localhost",

{vantage6-5.0.0a18 → vantage6-5.0.0a20}/tests_cli/test_wizard.py

@@ -29,8 +29,10 @@ class WizardTest(unittest.TestCase):
                     result[name] = None
         return result
 
-    def test_node_wizard(self):
+    @patch("vantage6.cli.configuration_wizard.NodeClient.authenticate")
+    def test_node_wizard(self, authenticate):
         """An error is printed when docker is not running"""
+        authenticate.return_value = None
 
         with patch(f"{module_path}.q") as q:
             q.unsafe_prompt.side_effect = self.prompts
@@ -99,7 +101,6 @@ class WizardTest(unittest.TestCase):
                 "api_path",
                 "uri",
                 "allow_drop_all",
-                "jwt_secret_key",
                 "logging",
                 "vpn_server",
                 "rabbitmq",

vantage6-5.0.0a20/vantage6/cli/__build__

@@ -0,0 +1 @@
+20

{vantage6-5.0.0a18 → vantage6-5.0.0a20}/vantage6/cli/configuration_wizard.py

@@ -1,3 +1,4 @@
+import os
 from pathlib import Path
 
 import questionary as q
@@ -9,6 +10,7 @@ from vantage6.common.globals import (
     NodePolicy,
     Ports,
     DEFAULT_API_PATH,
+    RequiredNodeEnvVars,
 )
 from vantage6.common.client.node_client import NodeClient
 from vantage6.common.context import AppContext
@@ -168,9 +170,14 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
     }
 
     # Check if we can login to the server to retrieve collaboration settings
-    client = NodeClient(config["server_url"], config["port"], config["api_path"])
+    client = NodeClient(
+        instance_name,
+        config["api_key"],
+        server_url=f"{config['server_url']}:{config['port']}{config['api_path']}",
+        auth_url=os.environ.get(RequiredNodeEnvVars.KEYCLOAK_URL.value),
+    )
     try:
-        client.authenticate(config["api_key"])
+        client.authenticate()
     except Exception as e:
         error(f"Could not authenticate with server: {e}")
         error("Please check (1) your API key and (2) if your server is online")
@@ -494,7 +501,7 @@ def algo_store_configuration_questionaire(instance_name: str) -> dict:
     default_v6_server_uri = (
         f"http://localhost:{Ports.DEV_SERVER.value}{DEFAULT_API_PATH}"
     )
-    default_root_username = "root"
+    default_root_username = "admin"
 
     v6_server_uri = q.text(
         "What is the Vantage6 server linked to the algorithm store? "

{vantage6-5.0.0a18 → vantage6-5.0.0a20}/vantage6/cli/dev/create.py

@@ -314,7 +314,6 @@ def create_vserver_config(
     server_config = template.render(
         port=port,
         host_uri=server_url,
-        jwt_secret_key=generate_apikey(),
         user_provided_config=extra_config,
         ui_port=ui_port,
         store_port=store_port,

{vantage6-5.0.0a18 → vantage6-5.0.0a20}/vantage6/cli/node/common/__init__.py

@@ -2,12 +2,12 @@
 Common functions that are used in node CLI commands
 """
 
-import questionary as q
+import os
 import docker
 from colorama import Fore, Style
 
 from vantage6.common import error, info, debug
-from vantage6.common.globals import APPNAME, InstanceType
+from vantage6.common.globals import APPNAME, InstanceType, RequiredNodeEnvVars
 from vantage6.client import UserClient
 
 from vantage6.cli.context.node import NodeContext
@@ -35,12 +35,14 @@ def create_client(ctx: NodeContext) -> UserClient:
     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")
+    return UserClient(
+        server_url=f"{host}:{port}{api_path}",
+        auth_url=os.environ.get(RequiredNodeEnvVars.KEYCLOAK_URL.value),
+        log_level="warn",
+    )
 
 
-def create_client_and_authenticate(
-    ctx: NodeContext, ask_mfa: bool = False
-) -> UserClient:
+def create_client_and_authenticate(ctx: NodeContext) -> UserClient:
     """
     Generate a client and authenticate with the server.
 
@@ -48,8 +50,6 @@ def create_client_and_authenticate(
     ----------
     ctx : NodeContext
         Context of the node loaded from the configuration file
-    ask_mfa : bool, optional
-        Whether to ask for MFA code, by default False
 
     Returns
     -------
@@ -59,14 +59,7 @@ def create_client_and_authenticate(
     client = create_client(ctx)
 
     try:
-        username, password, mfa_code = _get_auth_data()
-    except KeyboardInterrupt:
-        error("Authentication aborted.")
-        exit(1)
-
-    try:
-        client.authenticate(username, password, mfa_code=mfa_code)
-
+        client.authenticate()
     except Exception as exc:
         error("Could not authenticate with server!")
         debug(exc)
@@ -75,21 +68,6 @@ def create_client_and_authenticate(
     return client
 
 
-def _get_auth_data() -> tuple[str, str, str]:
-    """
-    Get authentication data from the user.
-
-    Returns
-    -------
-    tuple[str, str, str]
-        Tuple containing username, password and MFA code
-    """
-    username = q.text("Username:").unsafe_ask()
-    password = q.password("Password:").unsafe_ask()
-    mfa_code = q.text("MFA code:").unsafe_ask()
-    return username, password, mfa_code
-
-
 def select_node(name: str, system_folders: bool) -> tuple[str, str]:
     """
     Let user select node through questionnaire if name is not given.

{vantage6-5.0.0a18 → vantage6-5.0.0a20}/vantage6/cli/node/create_private_key.py

@@ -59,21 +59,13 @@ from vantage6.cli.node.common import select_node, create_client_and_authenticate
     default=False,
     help="Overwrite existing private key if present",
 )
-@click.option(
-    "--mfa",
-    "ask_mfa",
-    flag_value=True,
-    default=False,
-    help="Ask for multi-factor authentication code. Use this if MFA is enabled on the server.",
-)
 def cli_node_create_private_key(
     name: str,
     config: str,
     system_folders: bool,
     upload: bool,
-    organization_name: str,
+    organization_name: str | None,
     overwrite: bool,
-    ask_mfa: bool,
 ) -> None:
     """
     Create and upload a new private key
@@ -97,7 +89,7 @@ def cli_node_create_private_key(
     # Authenticate with the server to obtain organization name if it wasn't
     # provided
     if organization_name is None:
-        client = create_client_and_authenticate(ctx, ask_mfa)
+        client = create_client_and_authenticate(ctx)
         organization_name = client.whoami.organization_name
 
     # create directory where private key goes if it doesn't exist yet

{vantage6-5.0.0a18 → vantage6-5.0.0a20}/vantage6/cli/template/server_config.j2

@@ -25,7 +25,6 @@ logging:
     name: requests_oauthlib.oauth2_session
 port: {{ port }}
 uri: sqlite:///default.sqlite
-jwt_secret_key: {{ jwt_secret_key }}
 dev:
   host_uri: {{ host_uri }}
 server_url: http://localhost:{{ port }}/api

{vantage6-5.0.0a18 → vantage6-5.0.0a20}/vantage6/cli/test/feature_tester.py

@@ -8,22 +8,29 @@ from vantage6.cli.test.common.diagnostic_runner import DiagnosticRunner
 
 
 @click.command()
-@click.option("--host", type=str, default="http://localhost", help="URL of the server")
 @click.option(
-    "--port", type=int, default=Ports.DEV_SERVER.value, help="Port of the server"
+    "--server-url",
+    type=str,
+    default=f"http://localhost:{Ports.DEV_SERVER.value}/api",
+    help="URL of the server",
+)
+@click.option(
+    "--auth-url",
+    type=str,
+    default="http://localhost:8080",
+    help="URL of the authentication server (Keycloak)",
 )
-@click.option("--api-path", type=str, default="/api", help="API path of the server")
 @click.option(
-    "--username",
+    "--auth-realm",
     type=str,
-    default="dev_admin",
-    help="Username of vantage6 user account to create the task with",
+    default="vantage6",
+    help="Realm of the authentication server (Keycloak)",
 )
 @click.option(
-    "--password",
+    "--auth-client",
     type=str,
-    default="password",
-    help="Password of vantage6 user account to create the task with",
+    default="public_client",
+    help="Client ID of the authentication server (Keycloak)",
 )
 @click.option(
     "--collaboration",
@@ -56,25 +63,17 @@ from vantage6.cli.test.common.diagnostic_runner import DiagnosticRunner
     default=None,
     help="Path to the private key for end-to-end encryption",
 )
-@click.option(
-    "--mfa-code",
-    type=str,
-    help="Multi-factor authentication code. Use this if MFA is enabled on the "
-    "server.",
-)
 def cli_test_features(
-    host: str,
-    port: int,
-    api_path: str,
-    username: str,
-    password: str,
+    server_url: str,
+    auth_url: str,
+    auth_realm: str,
+    auth_client: str,
     collaboration: int,
     organizations: list[int] | None,
     all_nodes: bool,
     online_only: bool,
     no_vpn: bool,
     private_key: str | None,
-    mfa_code: str | None,
 ) -> list[dict]:
     """
     Run diagnostic checks on an existing vantage6 network.
@@ -89,8 +88,14 @@ def cli_test_features(
     if all_nodes or not organizations:
         organizations = None
 
-    client = UserClient(host=host, port=port, path=api_path, log_level="critical")
-    client.authenticate(username=username, password=password, mfa_code=mfa_code)
+    client = UserClient(
+        server_url=server_url,
+        auth_url=auth_url,
+        auth_realm=auth_realm,
+        auth_client=auth_client,
+        log_level="critical",
+    )
+    client.authenticate()
     client.setup_encryption(private_key)
     diagnose = DiagnosticRunner(client, collaboration, organizations, online_only)
     res = diagnose(base=True, vpn=not no_vpn)

{vantage6-5.0.0a18 → vantage6-5.0.0a20}/vantage6.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vantage6
-Version: 5.0.0a18
+Version: 5.0.0a20
 Summary: vantage6 command line interface
 Home-page: https://github.com/vantage6/vantage6
 Requires-Python: >=3.10
@@ -26,7 +26,6 @@ Provides-Extra: dev
 [![Discord](https://img.shields.io/discord/643526403207331841)](https://discord.gg/yAyFf6Y)
 [![Research software directory](https://img.shields.io/badge/rsd-vantage6-deepskyblue)](https://research-software-directory.org/software/vantage6)
 
-
 </h3>
 
 <p align="center">
@@ -113,8 +112,12 @@ For example, you can create a new organization by running:
 ```python
 from vantage6.client import Client
 
-client = Client('http://127.0.0.1', 7601, '/api', log_level='debug')
-client.authenticate('dev_admin', 'password')
+client = Client(
+  server_url='http://127.0.0.1:7601/api',
+  auth_url='http://127.0.0.1:8080',
+  log_level='debug'
+)
+client.authenticate()
 client.setup_encryption(None)
 
 client.organization.create(
@@ -179,10 +182,10 @@ And finally there are some images released for algorithm development:
 
 ## :gift_heart: Join the community!
 
-We hope to continue developing, improving, and supporting **vantage6** with the help of 
-the federated learning community. If you are interested in contributing, first of all, 
-thank you! Second, please take a look at our 
-[contributing guidelines](https://docs.vantage6.ai/en/main/devops/contribute.html) 
+We hope to continue developing, improving, and supporting **vantage6** with the help of
+the federated learning community. If you are interested in contributing, first of all,
+thank you! Second, please take a look at our
+[contributing guidelines](https://docs.vantage6.ai/en/main/devops/contribute.html)
 and our [code of conduct](CODE_OF_CONDUCT.md).
 
 <a href="https://github.com/vantage6/vantage6/graphs/contributors">

{vantage6-5.0.0a18 → vantage6-5.0.0a20}/vantage6.egg-info/requires.txt

@@ -9,8 +9,8 @@ questionary==1.10.0
 rich==13.5.2
 schema==0.7.5
 sqlalchemy==2.0.37
-vantage6-common==5.0.0a18
-vantage6-client==5.0.0a18
+vantage6-common==5.0.0a20
+vantage6-client==5.0.0a20
 
 [dev]
 coverage==6.4.4

vantage6-5.0.0a18/vantage6/cli/__build__

@@ -1 +0,0 @@
-18