doc: Documenting the database

Author: Robin-Van-de-Merghel

diracx-cli/src/diracx/cli/internal/config.py

@@ -190,6 +190,10 @@ def set_user_as_pilot_user(
     sub: Annotated[str, typer.Option()],
     pilot_preferred_username: Annotated[str, typer.Option()],
 ):
+    """Set a user as a pilot.
+
+    *Warning*: This requires an existing VO, and also a group and a pilot dedicated to the pilot.
+    """
     config_repo = TypeAdapter(ConfigSourceUrl).validate_python(config_repo)
     if config_repo.scheme != "git+file" or config_repo.path is None:
         raise NotImplementedError("Only git+file:// URLs are supported")
@@ -200,45 +204,52 @@ def set_user_as_pilot_user(
 
     # The VO has to exist
     if vo not in config.Registry:
-        typer.echo(f"ERROR: Virtual Organization {vo} does not exist", err=True)
+        typer.secho(
+            f"ERROR: Virtual Organization {vo} does not exist", err=True, fg="red"
+        )
         raise typer.Exit(1)
 
     # The sub has to exist
     if sub not in config.Registry[vo].Users:
-        typer.echo(
+        typer.secho(
             f"ERROR: User {sub} does not exist. You have to create it first before setting it as a pilot user",
             err=True,
+            fg="red",
         )
         raise typer.Exit(1)
 
     # The preferred_username has to match the sub
     if not config.Registry[vo].Users[sub].PreferedUsername == pilot_preferred_username:
-        typer.echo(
-            f"ERROR: User {sub} does not match pilot_preferred_username {pilot_preferred_username}"
+        typer.secho(
+            f"ERROR: User {sub} does not match pilot_preferred_username {pilot_preferred_username}",
+            err=True,
+            fg="red",
         )
         raise typer.Exit(1)
 
     # The pilot group has to exist
     groups = config.Registry[vo].Groups
     if pilot_group not in groups:
-        typer.echo(
+        typer.secho(
             (
                 f"ERROR: Group {pilot_group} does not exist."
                 "You have to create it first before setting it as a pilot group"
             ),
             err=True,
+            fg="red",
         )
         raise typer.Exit(1)
 
     # The sub has to be in the pilot group
     group_users = groups[pilot_group].Users
     if sub not in group_users:
-        typer.echo(
+        typer.secho(
             (
                 f"ERROR: User {sub} is not set into the pilot group."
                 "You have to add it before setting this group as a pilot group"
             ),
             err=True,
+            fg="red",
         )
         raise typer.Exit(1)
 
@@ -251,7 +262,7 @@ def set_user_as_pilot_user(
     pilot = config.Operations[vo].Pilot
 
     if pilot is None:
-        typer.echo("Pilot operation must not be None", err=True)
+        typer.secho("Pilot operation must not be None", err=True, fg="red")
         raise typer.Exit(1)
 
     pilot["GenericPilotGroup"] = pilot_group
@@ -262,8 +273,8 @@ def set_user_as_pilot_user(
         config=config,
         message=f"Setting user {sub} ({pilot_preferred_username}) as {vo}'s pilot user in group {pilot_group}",
     )
-    typer.echo(f"Successfully set user as pilot to {config_repo}")
-    typer.echo(f"New config :\n{config}")
+    typer.secho(f"Successfully set user as pilot to {config_repo}", fg="green")
+    typer.secho(f"New config :\n{config}", fg="green")
 
 
 def update_config_and_commit(repo_path: Path, config: Config, message: str):

diracx-cli/tests/test_internal.py

@@ -222,3 +222,64 @@ def test_add_user(cs_repo, vo, user_group):
     assert sub in config.Registry[vo].Users
     for group in user_group or [TEST_USER_GROUP]:
         assert config.Registry[vo].Groups[group].Users == {sub}
+
+
+def test_add_pilot_user(cs_repo):
+
+    sub = "lhcb:rvandeme"
+
+    pilot_group = "pilot_group"
+    pilot_user = "pilot_user"
+
+    config = ConfigSource.create_from_url(backend_url=cs_repo).read_config()
+
+    # Add a second group to it
+    result = runner.invoke(
+        app,
+        [
+            "internal",
+            "add-group",
+            cs_repo,
+            f"--vo={TEST_VO}",
+            f"--group={pilot_group}",
+            "--properties",
+            "GenericPilot",
+        ],
+    )
+    assert result.exit_code == 0, result.output
+
+    # Add a user to it
+    result = runner.invoke(
+        app,
+        [
+            "internal",
+            "add-user",
+            cs_repo,
+            f"--vo={TEST_VO}",
+            f"--sub={sub}",
+            f"--preferred-username={pilot_user}",
+            f"--group={pilot_group}",
+        ],
+    )
+    assert result.exit_code == 0, result.output
+
+    # Set this user as a pilot
+    result = runner.invoke(
+        app,
+        [
+            "internal",
+            "set-user-as-pilot-user",
+            cs_repo,
+            f"--vo={TEST_VO}",
+            f"--sub={sub}",
+            f"--pilot-preferred-username={pilot_user}",
+            f"--pilot-group={pilot_group}",
+        ],
+    )
+    assert result.exit_code == 0, result.output
+
+    config = ConfigSource.create_from_url(backend_url=cs_repo).read_config()
+
+    # User pilot exists, same for pilot group
+    assert config.Operations[TEST_VO].Pilot["GenericPilotUser"] == pilot_user
+    assert config.Operations[TEST_VO].Pilot["GenericPilotGroup"] == pilot_group

diracx-core/src/diracx/core/exceptions.py

@@ -130,10 +130,10 @@ def __init__(
         self,
         data: dict[str, str],
         detail: str | None = None,
-        pilots_that_does_not_exist: set = set(),
+        non_existing_pilots: set = set(),
     ):
         super().__init__(data, detail)
-        self.pilots_that_does_not_exist = pilots_that_does_not_exist
+        self.non_existing_pilots = non_existing_pilots
 
 
 class PilotAlreadyExistsError(GenericError):