esgvoc 2.0.2__py3-none-any.whl

esgvoc/cli/offline.py

@@ -0,0 +1,269 @@
+"""
+Offline mode management CLI commands.
+
+This module provides CLI commands for managing offline mode settings
+for universe and project components.
+"""
+
+import typer
+from rich.console import Console
+from rich.table import Table
+
+from esgvoc.core.service import config_manager
+
+
+app = typer.Typer()
+console = Console()
+
+
+@app.command()
+def show(
+    component: str = typer.Argument(
+        None,
+        help="Component to show offline status for (universe or project name). Shows all if not specified."
+    ),
+    config: str = typer.Option(
+        None,
+        "--config",
+        "-c",
+        help="Configuration name to use"
+    )
+):
+    """Show offline mode status for components."""
+    try:
+        if config:
+            settings = config_manager.get_config(config)
+        else:
+            settings = config_manager.get_active_config()
+
+        if component:
+            # Show specific component
+            if component == "universe":
+                if settings.universe.offline_mode:
+                    console.print(f"[green]Universe is in offline mode[/green]")
+                else:
+                    console.print(f"[yellow]Universe is in online mode[/yellow]")
+            elif component in settings.projects:
+                project = settings.projects[component]
+                if project.offline_mode:
+                    console.print(f"[green]Project '{component}' is in offline mode[/green]")
+                else:
+                    console.print(f"[yellow]Project '{component}' is in online mode[/yellow]")
+            else:
+                console.print(f"[red]Component '{component}' not found[/red]")
+                raise typer.Exit(1)
+        else:
+            # Show all components
+            table = Table(title="Offline Mode Status")
+            table.add_column("Component", style="cyan")
+            table.add_column("Type", style="magenta")
+            table.add_column("Offline Mode", style="bold")
+
+            # Universe
+            status = "[green]✓ Enabled[/green]" if settings.universe.offline_mode else "[yellow]✗ Disabled[/yellow]"
+            table.add_row("Universe", "Universe", status)
+
+            # Projects
+            for project_name, project in settings.projects.items():
+                status = "[green]✓ Enabled[/green]" if project.offline_mode else "[yellow]✗ Disabled[/yellow]"
+                table.add_row(project_name, "Project", status)
+
+            console.print(table)
+
+    except Exception as e:
+        console.print(f"[red]Error: {str(e)}[/red]")
+        raise typer.Exit(1)
+
+
+@app.command()
+def enable(
+    component: str = typer.Argument(
+        None,
+        help="Component to enable offline mode for (universe or project name). If not specified, enables for all components."
+    ),
+    config: str = typer.Option(
+        None,
+        "--config",
+        "-c",
+        help="Configuration name to use"
+    )
+):
+    """Enable offline mode for a component or all components if none specified."""
+    try:
+        if config:
+            settings = config_manager.get_config(config)
+        else:
+            settings = config_manager.get_active_config()
+
+        if component is None:
+            # Enable for all components
+            settings.universe.offline_mode = True
+            for project in settings.projects.values():
+                project.offline_mode = True
+            console.print(f"[green]✓ Enabled offline mode for all components[/green]")
+        elif component == "universe":
+            settings.universe.offline_mode = True
+            console.print(f"[green]✓ Enabled offline mode for universe[/green]")
+        elif component in settings.projects:
+            settings.projects[component].offline_mode = True
+            console.print(f"[green]✓ Enabled offline mode for project '{component}'[/green]")
+        else:
+            console.print(f"[red]Component '{component}' not found[/red]")
+            raise typer.Exit(1)
+
+        # Save the updated settings
+        if config:
+            # Use the correct format for saving
+            data = {
+                "universe": settings.universe.model_dump(),
+                "projects": [p.model_dump() for p in settings.projects.values()],
+            }
+            config_manager.save_config(data, config)
+        else:
+            config_manager.save_active_config(settings)
+        console.print(f"[blue]Configuration saved[/blue]")
+
+    except Exception as e:
+        console.print(f"[red]Error: {str(e)}[/red]")
+        raise typer.Exit(1)
+
+
+@app.command()
+def disable(
+    component: str = typer.Argument(
+        None,
+        help="Component to disable offline mode for (universe or project name). If not specified, disables for all components."
+    ),
+    config: str = typer.Option(
+        None,
+        "--config",
+        "-c",
+        help="Configuration name to use"
+    )
+):
+    """Disable offline mode for a component or all components if none specified."""
+    try:
+        if config:
+            settings = config_manager.get_config(config)
+        else:
+            settings = config_manager.get_active_config()
+
+        if component is None:
+            # Disable for all components
+            settings.universe.offline_mode = False
+            for project in settings.projects.values():
+                project.offline_mode = False
+            console.print(f"[yellow]✓ Disabled offline mode for all components[/yellow]")
+        elif component == "universe":
+            settings.universe.offline_mode = False
+            console.print(f"[yellow]✓ Disabled offline mode for universe[/yellow]")
+        elif component in settings.projects:
+            settings.projects[component].offline_mode = False
+            console.print(f"[yellow]✓ Disabled offline mode for project '{component}'[/yellow]")
+        else:
+            console.print(f"[red]Component '{component}' not found[/red]")
+            raise typer.Exit(1)
+
+        # Save the updated settings
+        if config:
+            # Use the correct format for saving
+            data = {
+                "universe": settings.universe.model_dump(),
+                "projects": [p.model_dump() for p in settings.projects.values()],
+            }
+            config_manager.save_config(data, config)
+        else:
+            config_manager.save_active_config(settings)
+        console.print(f"[blue]Configuration saved[/blue]")
+
+    except Exception as e:
+        console.print(f"[red]Error: {str(e)}[/red]")
+        raise typer.Exit(1)
+
+
+@app.command()
+def enable_all(
+    config: str = typer.Option(
+        None,
+        "--config",
+        "-c",
+        help="Configuration name to use"
+    )
+):
+    """Enable offline mode for all components."""
+    try:
+        if config:
+            settings = config_manager.get_config(config)
+        else:
+            settings = config_manager.get_active_config()
+
+        # Enable for universe
+        settings.universe.offline_mode = True
+
+        # Enable for all projects
+        for project in settings.projects.values():
+            project.offline_mode = True
+
+        # Save the updated settings
+        if config:
+            # Use the correct format for saving
+            data = {
+                "universe": settings.universe.model_dump(),
+                "projects": [p.model_dump() for p in settings.projects.values()],
+            }
+            config_manager.save_config(data, config)
+        else:
+            config_manager.save_active_config(settings)
+
+        console.print(f"[green]✓ Enabled offline mode for all components[/green]")
+        console.print(f"[blue]Configuration saved[/blue]")
+
+    except Exception as e:
+        console.print(f"[red]Error: {str(e)}[/red]")
+        raise typer.Exit(1)
+
+
+@app.command()
+def disable_all(
+    config: str = typer.Option(
+        None,
+        "--config",
+        "-c",
+        help="Configuration name to use"
+    )
+):
+    """Disable offline mode for all components."""
+    try:
+        if config:
+            settings = config_manager.get_config(config)
+        else:
+            settings = config_manager.get_active_config()
+
+        # Disable for universe
+        settings.universe.offline_mode = False
+
+        # Disable for all projects
+        for project in settings.projects.values():
+            project.offline_mode = False
+
+        # Save the updated settings
+        if config:
+            # Use the correct format for saving
+            data = {
+                "universe": settings.universe.model_dump(),
+                "projects": [p.model_dump() for p in settings.projects.values()],
+            }
+            config_manager.save_config(data, config)
+        else:
+            config_manager.save_active_config(settings)
+
+        console.print(f"[yellow]✓ Disabled offline mode for all components[/yellow]")
+        console.print(f"[blue]Configuration saved[/blue]")
+
+    except Exception as e:
+        console.print(f"[red]Error: {str(e)}[/red]")
+        raise typer.Exit(1)
+
+
+if __name__ == "__main__":
+    app()

esgvoc/cli/status.py

@@ -0,0 +1,79 @@
+import typer
+from rich.console import Console
+from rich.table import Table
+
+from esgvoc.core import service
+
+app = typer.Typer()
+console = Console()
+
+
+def display(table):
+    console = Console(record=True, width=200)
+    console.print(table)
+
+
+@app.command()
+def status():
+    """
+    Command to display status
+    i.e summary of version of usable ressources (between remote/cached)
+
+    """
+    assert service.current_state is not None
+    service.current_state.get_state_summary()
+
+    # Check for offline mode components and display summary
+    offline_components = []
+    if service.current_state.universe.offline_mode:
+        offline_components.append("universe")
+    for project_name, project in service.current_state.projects.items():
+        if project.offline_mode:
+            offline_components.append(project_name)
+
+    if offline_components:
+        console.print(f"[yellow]Offline mode enabled for: {', '.join(offline_components)}[/yellow]")
+
+    table = Table(show_header=False, show_lines=True)
+
+    table.add_row("", "Remote github repo", "Local repository", "Cache Database", "Offline Mode", style="bright_green")
+
+    # Universe row
+    universe_offline_status = "✓" if service.current_state.universe.offline_mode else "✗"
+    table.add_row(
+        "Universe path",
+        service.current_state.universe.github_repo,
+        service.current_state.universe.local_path,
+        service.current_state.universe.db_path,
+        universe_offline_status,
+        style="white",
+    )
+    table.add_row(
+        "Version",
+        service.current_state.universe.github_version or "N/A",
+        service.current_state.universe.local_version or "N/A",
+        service.current_state.universe.db_version or "N/A",
+        "",
+        style="bright_blue",
+    )
+
+    # Projects rows
+    for proj_name, proj in service.current_state.projects.items():
+        proj_offline_status = "✓" if proj.offline_mode else "✗"
+        table.add_row(
+            f"{proj_name} path",
+            proj.github_repo,
+            proj.local_path,
+            proj.db_path,
+            proj_offline_status,
+            style="white"
+        )
+        table.add_row(
+            "Version",
+            proj.github_version or "N/A",
+            proj.local_version or "N/A",
+            proj.db_version or "N/A",
+            "",
+            style="bright_blue"
+        )
+    display(table)

esgvoc/cli/test_cv.py

@@ -0,0 +1,258 @@
+"""
+Test CV CLI commands
+
+Provides commands for testing project CVs and Universe CVs integrated with esgvoc CLI.
+"""
+
+from typing import Optional
+
+import typer
+from rich.console import Console
+from rich.table import Table
+
+from esgvoc.apps.test_cv.cv_tester import CVTester
+from esgvoc.core.service.configuration.setting import ServiceSettings
+
+app = typer.Typer()
+console = Console()
+
+
+@app.command()
+def list_projects():
+    """List all available CV projects that can be tested."""
+    tester = CVTester()
+    projects = tester.get_available_projects()
+
+    table = Table(title="Available CV Projects for Testing")
+    table.add_column("Project Name", style="cyan")
+    table.add_column("Repository", style="green")
+    table.add_column("Default Branch", style="yellow")
+    table.add_column("Local Path", style="blue")
+
+    default_configs = ServiceSettings._get_default_project_configs()
+    for project_name in projects:
+        config = default_configs[project_name]
+        table.add_row(project_name, config["github_repo"], config["branch"], config["local_path"])
+
+    console.print(table)
+    console.print(f"\n[blue]Total: {len(projects)} projects available for testing[/blue]")
+
+
+@app.command()
+def configure(
+    project: str = typer.Argument(..., help="Project name to configure for testing"),
+    repo_url: Optional[str] = typer.Option(None, "--repo", "-r", help="Custom repository URL"),
+    branch: Optional[str] = typer.Option(None, "--branch", "-b", help="Custom branch to test"),
+    universe_branch: Optional[str] = typer.Option(None, "--universe-branch", "-u", help="Custom universe branch"),
+    sync: bool = typer.Option(True, "--sync/--no-sync", help="Synchronize CVs after configuration"),
+):
+    """
+    Configure esgvoc with a specific project for testing.
+
+    Examples:
+        esgvoc test configure obs4mip
+        esgvoc test configure cmip6 --branch my-test-branch
+        esgvoc test configure cmip6 --universe-branch my-universe-branch
+        esgvoc test configure custom --repo https://github.com/me/my-cvs --branch main --universe-branch dev
+    """
+    tester = CVTester()
+
+    try:
+        # Configure
+        if not tester.configure_for_testing(project, repo_url, branch, None, universe_branch):
+            raise typer.Exit(1)
+
+        # Optionally synchronize
+        if sync:
+            if not tester.synchronize_cvs():
+                raise typer.Exit(1)
+
+        console.print(f"[green]✅ Successfully configured project '{project}' for testing[/green]")
+        if not sync:
+            console.print("[yellow]Note: CVs not synchronized. Run 'esgvoc test sync' to download.[/yellow]")
+
+    except Exception as e:
+        console.print(f"[red]❌ Configuration failed: {e}[/red]")
+        raise typer.Exit(1)
+
+
+@app.command()
+def sync():
+    """Synchronize/download CVs for the currently configured project."""
+    tester = CVTester()
+
+    try:
+        if not tester.synchronize_cvs():
+            raise typer.Exit(1)
+        console.print("[green]✅ CVs synchronized successfully[/green]")
+    except Exception as e:
+        console.print(f"[red]❌ Synchronization failed: {e}[/red]")
+        raise typer.Exit(1)
+
+
+@app.command()
+def structure(
+    path: str = typer.Argument(".", help="Path to CV repository to validate"),
+):
+    """
+    Test CV repository structure and file format compliance.
+
+    Validates:
+    - Collection directory structure
+    - JSONLD context files
+    - Element JSON files
+    - project_specs.json references
+
+    Examples:
+        esgvoc test structure .
+        esgvoc test structure /path/to/cv/repo
+    """
+    tester = CVTester()
+
+    try:
+        if not tester.test_repository_structure(path):
+            raise typer.Exit(1)
+        console.print("[green]✅ Repository structure validation passed[/green]")
+    except Exception as e:
+        console.print(f"[red]❌ Structure validation failed: {e}[/red]")
+        raise typer.Exit(1)
+
+
+@app.command()
+def api(
+    project: str = typer.Argument(..., help="Project name to test API access for"),
+    path: str = typer.Argument(".", help="Path to CV repository"),
+    debug_terms: bool = typer.Option(True, "--debug-terms/--no-debug-terms", help="Show detailed debugging info for missing terms"),
+):
+    """
+    Test esgvoc API access for all repository collections and elements.
+
+    Validates:
+    - Project is accessible via esgvoc API
+    - All repository collections are queryable
+    - All repository elements are accessible
+    - API functions work correctly
+
+    Examples:
+        esgvoc test api obs4mip .
+        esgvoc test api cmip6 /path/to/cmip6/repo
+    """
+    tester = CVTester(debug_missing_terms=debug_terms)
+
+    try:
+        if not tester.test_esgvoc_api_access(project, path):
+            raise typer.Exit(1)
+        console.print("[green]✅ ESGVoc API access validation passed[/green]")
+    except Exception as e:
+        console.print(f"[red]❌ API validation failed: {e}[/red]")
+        raise typer.Exit(1)
+
+
+@app.command()
+def run(
+    project: str = typer.Argument(..., help="Project name to test"),
+    path: Optional[str] = typer.Argument(None, help="Path to CV repository (auto-detected if not provided)"),
+    repo_url: Optional[str] = typer.Option(None, "--repo", "-r", help="Custom repository URL"),
+    branch: Optional[str] = typer.Option(None, "--branch", "-b", help="Custom branch to test"),
+    universe_branch: Optional[str] = typer.Option(None, "--universe-branch", "-u", help="Custom universe branch"),
+    debug_terms: bool = typer.Option(True, "--debug-terms/--no-debug-terms", help="Show detailed debugging info for missing terms"),
+):
+    """
+    Run complete CV test suite: configure, sync, structure, and API tests.
+
+    This is the comprehensive test that runs all validation steps:
+    1. Configure esgvoc with the specified project
+    2. Synchronize/download CVs
+    3. Validate repository structure
+    4. Test esgvoc API access
+
+    Examples:
+        esgvoc test run obs4mip
+        esgvoc test run cmip6 --branch my-test-branch
+        esgvoc test run cmip6 --universe-branch my-universe-branch
+        esgvoc test run cmip6 /path/to/custom/repo --branch my-test-branch --universe-branch dev
+        esgvoc test run custom --repo https://github.com/me/cvs --branch main --universe-branch main
+    """
+    tester = CVTester(debug_missing_terms=debug_terms)
+
+    try:
+        success = tester.run_complete_test(project, repo_url, branch, path, None, universe_branch)
+        if success:
+            console.print(f"[bold green]🎉 All tests passed for project '{project}'![/bold green]")
+        else:
+            # The detailed failure information is already printed by cv_tester
+            raise typer.Exit(1)
+    except Exception as e:
+        console.print(f"[red]❌ Test suite failed: {e}[/red]")
+        raise typer.Exit(1)
+    finally:
+        tester.cleanup()
+
+
+@app.command()
+def env(
+    command: str = typer.Argument(..., help="Environment mode command: 'configure' or 'test'"),
+    project: Optional[str] = typer.Option(None, "--project", "-p", help="Project name (auto-detected if not provided)"),
+    repo_url: Optional[str] = typer.Option(
+        None, "--repo-url", help="Repository URL (from REPO_URL env var if not provided)"
+    ),
+    branch: Optional[str] = typer.Option(None, "--branch", help="Branch (from TEST_BRANCH env var if not provided)"),
+    universe_branch: Optional[str] = typer.Option(None, "--universe-branch", help="Universe branch (from UNIVERSE_BRANCH env var if not provided)"),
+    debug_terms: bool = typer.Option(True, "--debug-terms/--no-debug-terms", help="Show detailed debugging info for missing terms"),
+):
+    """
+    Environment variable mode for CI/CD integration and automated testing.
+
+    Reads configuration from environment variables:
+    - REPO_URL: Repository URL to test
+    - TEST_BRANCH: Branch to test
+    - PROJECT_NAME: Project name (auto-detected if not set)
+    - UNIVERSE_BRANCH: Universe branch to test (optional)
+    - ESGVOC_LIBRARY_BRANCH: ESGVoc library branch (informational)
+
+    Examples:
+        # Set environment and run
+        export REPO_URL=https://github.com/me/obs4MIPs_CVs
+        export TEST_BRANCH=test-branch
+        export UNIVERSE_BRANCH=my-universe-branch
+        esgvoc test env configure
+        esgvoc test env test
+
+        # Or use options
+        esgvoc test env configure --project obs4mip --repo-url https://github.com/me/repo --branch main --universe-branch dev
+    """
+    import os
+
+    # Get config from environment or options
+    final_repo_url = repo_url or os.environ.get("REPO_URL")
+    final_branch = branch or os.environ.get("TEST_BRANCH")
+    final_universe_branch = universe_branch or os.environ.get("UNIVERSE_BRANCH")
+    final_project = project or os.environ.get("PROJECT_NAME")
+
+    # Auto-detect project if not provided
+    if not final_project:
+        from esgvoc.apps.test_cv.cv_tester import detect_project_name
+
+        final_project = detect_project_name()
+
+    if command == "configure":
+        if not final_repo_url or not final_branch:
+            console.print("[red]❌ REPO_URL and TEST_BRANCH are required for env configure[/red]")
+            console.print("Set environment variables or use --repo-url and --branch options")
+            raise typer.Exit(1)
+
+        # Use configure command
+        configure(final_project, final_repo_url, final_branch, final_universe_branch, sync=True)
+
+    elif command == "test":
+        # Use run command
+        run(final_project, None, final_repo_url, final_branch, final_universe_branch, debug_terms)
+
+    else:
+        console.print(f"[red]❌ Invalid env command '{command}'. Use 'configure' or 'test'[/red]")
+        raise typer.Exit(1)
+
+
+if __name__ == "__main__":
+    app()
+