feat: add create-invite CLI command

This commit is contained in:
Johan Lundberg 2026-02-18 11:27:36 +01:00
parent 0c3157ea3a
commit bcddf5d1c8
No known key found for this signature in database
GPG key ID: A6C152738D03C7D1
2 changed files with 94 additions and 0 deletions

41
src/porchlight/cli.py Normal file
View file

@ -0,0 +1,41 @@
import asyncio
from pathlib import Path
from typing import Annotated, Optional
import typer
from porchlight.config import Settings
from porchlight.invite.service import MagicLinkService
from porchlight.store.sqlite.db import open_db
from porchlight.store.sqlite.repositories import SQLiteMagicLinkRepository
PACKAGE_DIR = Path(__file__).resolve().parent
MIGRATIONS_DIR = PACKAGE_DIR / "store" / "sqlite" / "migrations"
app = typer.Typer()
async def _create_invite(settings: Settings, username: str, ttl: int, note: str | None) -> str:
"""Create an invite link and return the full registration URL."""
async with open_db(settings.sqlite_path, MIGRATIONS_DIR) as db:
repo = SQLiteMagicLinkRepository(db)
service = MagicLinkService(repo, ttl=ttl)
link = await service.create(username=username, created_by="cli", note=note)
return f"{settings.issuer}/register/{link.token}"
@app.command()
def create_invite(
username: str,
ttl: Annotated[Optional[int], typer.Option(help="Link expiration in seconds")] = None,
note: Annotated[Optional[str], typer.Option(help="Optional note stored with the link")] = None,
) -> None:
"""Generate a magic link registration URL for a new user."""
settings = Settings()
effective_ttl = ttl if ttl is not None else settings.invite_ttl
url = asyncio.run(_create_invite(settings, username, effective_ttl, note))
typer.echo(url)
def main() -> None:
app()

53
tests/test_cli.py Normal file
View file

@ -0,0 +1,53 @@
import os
import tempfile
from typer.testing import CliRunner
from porchlight.cli import app
runner = CliRunner()
def test_create_invite_prints_registration_url() -> None:
"""create-invite should print a URL containing /register/."""
with tempfile.TemporaryDirectory() as tmpdir:
db_path = os.path.join(tmpdir, "test.db")
result = runner.invoke(
app,
["testuser"],
env={"OIDC_OP_ISSUER": "https://example.com", "OIDC_OP_SQLITE_PATH": db_path},
)
assert result.exit_code == 0, result.output
assert "https://example.com/register/" in result.output
def test_create_invite_with_note() -> None:
"""create-invite with --note should work."""
with tempfile.TemporaryDirectory() as tmpdir:
db_path = os.path.join(tmpdir, "test.db")
result = runner.invoke(
app,
["testuser", "--note", "Welcome aboard"],
env={"OIDC_OP_ISSUER": "https://example.com", "OIDC_OP_SQLITE_PATH": db_path},
)
assert result.exit_code == 0, result.output
assert "https://example.com/register/" in result.output
def test_create_invite_with_custom_ttl() -> None:
"""create-invite with --ttl should use the custom TTL."""
with tempfile.TemporaryDirectory() as tmpdir:
db_path = os.path.join(tmpdir, "test.db")
result = runner.invoke(
app,
["testuser", "--ttl", "3600"],
env={"OIDC_OP_ISSUER": "https://example.com", "OIDC_OP_SQLITE_PATH": db_path},
)
assert result.exit_code == 0, result.output
assert "https://example.com/register/" in result.output
def test_create_invite_missing_username_shows_error() -> None:
"""create-invite without a username should show an error."""
result = runner.invoke(app, [])
assert result.exit_code != 0