Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move code out of __init__ files #352

Merged
merged 2 commits into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/make_release.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
#!/usr/bin/env python
from __future__ import annotations

import argparse
from pathlib import Path

Expand Down
2 changes: 1 addition & 1 deletion diracx-cli/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ dependencies = [
"gitpython",
"pydantic>=2.10",
"rich",
"typer",
"typer>=0.12.4",
"pyyaml",
]
dynamic = ["version"]
Expand Down
137 changes: 3 additions & 134 deletions diracx-cli/src/diracx/cli/__init__.py
Original file line number Diff line number Diff line change
@@ -1,144 +1,13 @@
import asyncio
import json
import os
from datetime import datetime, timedelta, timezone
from typing import Annotated, Optional
from __future__ import annotations

import typer

from diracx.client.aio import DiracClient
from diracx.client.models import DeviceFlowErrorResponse
from diracx.core.extensions import select_from_extension
from diracx.core.preferences import get_diracx_preferences
from diracx.core.utils import read_credentials, write_credentials

from .utils import AsyncTyper

app = AsyncTyper()


async def installation_metadata():
async with DiracClient() as api:
return await api.well_known.installation_metadata()


def vo_callback(vo: str | None) -> str:
metadata = asyncio.run(installation_metadata())
vos = list(metadata.virtual_organizations)
if not vo:
raise typer.BadParameter(
f"VO must be specified, available options are: {' '.join(vos)}"
)
if vo not in vos:
raise typer.BadParameter(
f"Unknown VO {vo}, available options are: {' '.join(vos)}"
)
return vo


@app.async_command()
async def login(
vo: Annotated[
Optional[str],
typer.Argument(callback=vo_callback, help="Virtual Organization name"),
] = None,
group: Optional[str] = typer.Option(
None,
help="Group name within the VO. If not provided, the default group for the VO will be used.",
),
property: Optional[list[str]] = typer.Option(
None,
help=(
"List of properties to add to the default properties of the group. "
"If not provided, default properties of the group will be used."
),
),
):
"""Login to the DIRAC system using the device flow.

- If only VO is provided: Uses the default group and its properties for the VO.

- If VO and group are provided: Uses the specified group and its properties for the VO.

- If VO and properties are provided: Uses the default group and combines its properties with the
provided properties.
from .auth import app

- If VO, group, and properties are provided: Uses the specified group and combines its properties with the
provided properties.
"""
scopes = [f"vo:{vo}"]
if group:
scopes.append(f"group:{group}")
if property:
scopes += [f"property:{p}" for p in property]

print(f"Logging in with scopes: {scopes}")
async with DiracClient() as api:
data = await api.auth.initiate_device_flow(
client_id=api.client_id,
scope=" ".join(scopes),
)
print("Now go to:", data.verification_uri_complete)
expires = datetime.now(tz=timezone.utc) + timedelta(
seconds=data.expires_in - 30
)
while expires > datetime.now(tz=timezone.utc):
print(".", end="", flush=True)
response = await api.auth.token(device_code=data.device_code, client_id=api.client_id) # type: ignore
if isinstance(response, DeviceFlowErrorResponse):
if response.error == "authorization_pending":
# TODO: Setting more than 5 seconds results in an error
# Related to keep-alive disconnects from uvicon (--timeout-keep-alive)
await asyncio.sleep(2)
continue
raise RuntimeError(f"Device flow failed with {response}")
break
else:
raise RuntimeError("Device authorization flow expired")

# Save credentials
write_credentials(response)
credentials_path = get_diracx_preferences().credentials_path
print(f"Saved credentials to {credentials_path}")
print("\nLogin successful!")


@app.async_command()
async def whoami():
async with DiracClient() as api:
user_info = await api.auth.userinfo()
# TODO: Add a RICH output format
print(json.dumps(user_info.as_dict(), indent=2))


@app.async_command()
async def logout():
async with DiracClient() as api:
credentials_path = get_diracx_preferences().credentials_path
if credentials_path.exists():
credentials = read_credentials(credentials_path)

# Revoke refresh token
try:
await api.auth.revoke_refresh_token(credentials.refresh_token)
except Exception as e:
print(f"Error revoking the refresh token {e!r}")
pass

# Remove credentials
credentials_path.unlink(missing_ok=True)
print(f"Removed credentials from {credentials_path}")
print("\nLogout successful!")


@app.callback()
def callback(output_format: Optional[str] = None):
if output_format is not None:
os.environ["DIRACX_OUTPUT_FORMAT"] = output_format
__all__ = ("app",)


# Load all the sub commands

cli_names = set(
[entry_point.name for entry_point in select_from_extension(group="diracx.cli")]
)
Expand Down
2 changes: 2 additions & 0 deletions diracx-cli/src/diracx/cli/__main__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
from __future__ import annotations

Check warning on line 1 in diracx-cli/src/diracx/cli/__main__.py

View check run for this annotation

Codecov / codecov/patch

diracx-cli/src/diracx/cli/__main__.py#L1

Added line #L1 was not covered by tests

from . import app

if __name__ == "__main__":
Expand Down
140 changes: 140 additions & 0 deletions diracx-cli/src/diracx/cli/auth.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
from __future__ import annotations

__all__ = ("app",)

import asyncio
import json
import os
from datetime import datetime, timedelta, timezone
from typing import Annotated, Optional

import typer

from diracx.client.aio import DiracClient
from diracx.client.models import DeviceFlowErrorResponse
from diracx.core.preferences import get_diracx_preferences
from diracx.core.utils import read_credentials, write_credentials

from .utils import AsyncTyper

app = AsyncTyper()


async def installation_metadata():
async with DiracClient() as api:
return await api.well_known.installation_metadata()

Check warning on line 25 in diracx-cli/src/diracx/cli/auth.py

View check run for this annotation

Codecov / codecov/patch

diracx-cli/src/diracx/cli/auth.py#L24-L25

Added lines #L24 - L25 were not covered by tests


def vo_callback(vo: str | None) -> str:
metadata = asyncio.run(installation_metadata())
vos = list(metadata.virtual_organizations)
if not vo:
raise typer.BadParameter(

Check warning on line 32 in diracx-cli/src/diracx/cli/auth.py

View check run for this annotation

Codecov / codecov/patch

diracx-cli/src/diracx/cli/auth.py#L29-L32

Added lines #L29 - L32 were not covered by tests
f"VO must be specified, available options are: {' '.join(vos)}"
)
if vo not in vos:
raise typer.BadParameter(

Check warning on line 36 in diracx-cli/src/diracx/cli/auth.py

View check run for this annotation

Codecov / codecov/patch

diracx-cli/src/diracx/cli/auth.py#L35-L36

Added lines #L35 - L36 were not covered by tests
f"Unknown VO {vo}, available options are: {' '.join(vos)}"
)
return vo

Check warning on line 39 in diracx-cli/src/diracx/cli/auth.py

View check run for this annotation

Codecov / codecov/patch

diracx-cli/src/diracx/cli/auth.py#L39

Added line #L39 was not covered by tests


@app.async_command()
async def login(
vo: Annotated[
Optional[str],
typer.Argument(callback=vo_callback, help="Virtual Organization name"),
] = None,
group: Optional[str] = typer.Option(
None,
help="Group name within the VO. If not provided, the default group for the VO will be used.",
),
property: Optional[list[str]] = typer.Option(
None,
help=(
"List of properties to add to the default properties of the group. "
"If not provided, default properties of the group will be used."
),
),
):
"""Login to the DIRAC system using the device flow.

- If only VO is provided: Uses the default group and its properties for the VO.

- If VO and group are provided: Uses the specified group and its properties for the VO.

- If VO and properties are provided: Uses the default group and combines its properties with the
provided properties.

- If VO, group, and properties are provided: Uses the specified group and combines its properties with the
provided properties.
"""
scopes = [f"vo:{vo}"]
if group:
scopes.append(f"group:{group}")

Check warning on line 74 in diracx-cli/src/diracx/cli/auth.py

View check run for this annotation

Codecov / codecov/patch

diracx-cli/src/diracx/cli/auth.py#L74

Added line #L74 was not covered by tests
if property:
scopes += [f"property:{p}" for p in property]

Check warning on line 76 in diracx-cli/src/diracx/cli/auth.py

View check run for this annotation

Codecov / codecov/patch

diracx-cli/src/diracx/cli/auth.py#L76

Added line #L76 was not covered by tests

print(f"Logging in with scopes: {scopes}")
async with DiracClient() as api:
data = await api.auth.initiate_device_flow(
client_id=api.client_id,
scope=" ".join(scopes),
)
print("Now go to:", data.verification_uri_complete)
expires = datetime.now(tz=timezone.utc) + timedelta(
seconds=data.expires_in - 30
)
while expires > datetime.now(tz=timezone.utc):
print(".", end="", flush=True)
response = await api.auth.token(device_code=data.device_code, client_id=api.client_id) # type: ignore
if isinstance(response, DeviceFlowErrorResponse):
if response.error == "authorization_pending":
# TODO: Setting more than 5 seconds results in an error
# Related to keep-alive disconnects from uvicon (--timeout-keep-alive)
await asyncio.sleep(2)
continue
raise RuntimeError(f"Device flow failed with {response}")

Check warning on line 97 in diracx-cli/src/diracx/cli/auth.py

View check run for this annotation

Codecov / codecov/patch

diracx-cli/src/diracx/cli/auth.py#L97

Added line #L97 was not covered by tests
break
else:
raise RuntimeError("Device authorization flow expired")

Check warning on line 100 in diracx-cli/src/diracx/cli/auth.py

View check run for this annotation

Codecov / codecov/patch

diracx-cli/src/diracx/cli/auth.py#L100

Added line #L100 was not covered by tests

# Save credentials
write_credentials(response)
credentials_path = get_diracx_preferences().credentials_path
print(f"Saved credentials to {credentials_path}")
print("\nLogin successful!")


@app.async_command()
async def whoami():
async with DiracClient() as api:
user_info = await api.auth.userinfo()

Check warning on line 112 in diracx-cli/src/diracx/cli/auth.py

View check run for this annotation

Codecov / codecov/patch

diracx-cli/src/diracx/cli/auth.py#L111-L112

Added lines #L111 - L112 were not covered by tests
# TODO: Add a RICH output format
print(json.dumps(user_info.as_dict(), indent=2))

Check warning on line 114 in diracx-cli/src/diracx/cli/auth.py

View check run for this annotation

Codecov / codecov/patch

diracx-cli/src/diracx/cli/auth.py#L114

Added line #L114 was not covered by tests


@app.async_command()
async def logout():
async with DiracClient() as api:
credentials_path = get_diracx_preferences().credentials_path
if credentials_path.exists():
credentials = read_credentials(credentials_path)

# Revoke refresh token
try:
await api.auth.revoke_refresh_token(credentials.refresh_token)
except Exception as e:
print(f"Error revoking the refresh token {e!r}")
pass

# Remove credentials
credentials_path.unlink(missing_ok=True)
print(f"Removed credentials from {credentials_path}")
print("\nLogout successful!")


@app.callback()
def callback(output_format: Optional[str] = None):
if output_format is not None:
os.environ["DIRACX_OUTPUT_FORMAT"] = output_format

Check warning on line 140 in diracx-cli/src/diracx/cli/auth.py

View check run for this annotation

Codecov / codecov/patch

diracx-cli/src/diracx/cli/auth.py#L140

Added line #L140 was not covered by tests
1 change: 1 addition & 0 deletions diracx-cli/src/diracx/cli/config.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Can't using PEP-604 with typer: https://github.com/tiangolo/typer/issues/348
# from __future__ import annotations
from __future__ import annotations

__all__ = ("dump",)

Expand Down
Loading
Loading