hop3-testing 0.4.0__tar.gz

hop3_testing-0.4.0/PKG-INFO

@@ -0,0 +1,183 @@
+Metadata-Version: 2.4
+Name: hop3-testing
+Version: 0.4.0
+Summary: Testing utilities for Hop3
+Author: Stefane Fermigier
+Author-email: Stefane Fermigier <sf@abilian.com>
+License-Expression: Apache-2.0
+Requires-Dist: hop3-cli
+Requires-Dist: hop3-installer
+Requires-Dist: pytest>=8.0.0
+Requires-Dist: docker>=7.0.0
+Requires-Dist: tomli>=2.0.0 ; python_full_version < '3.11'
+Requires-Dist: devtools>=0.12.2
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: httpcore>=1.0.6
+Requires-Dist: httpx>=0.27.2
+Requires-Dist: paramiko>=2.11.0,<3.0.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: sqlalchemy>=2.0.0
+Requires-Dist: pyjwt>=2.8.0
+Requires-Dist: hcloud>=2.0
+Requires-Dist: jinja2>=3.0
+Requires-Dist: rich>=13.0
+Requires-Dist: attrs>=23.0
+Requires-Dist: termcolor>=2.0
+Requires-Python: >=3.10, <4
+Description-Content-Type: text/markdown
+
+# hop3-testing
+
+Testing framework for Hop3 deployment validation.
+
+## Overview
+
+hop3-testing provides utilities and fixtures for testing Hop3 deployments. It supports running tests against Docker containers or remote servers, with a catalog of test applications covering various languages and frameworks.
+
+## Features
+
+- **Multiple targets**: Test against Docker containers or remote SSH servers
+- **App catalog**: Pre-built test applications for various languages
+- **Deployment sessions**: Automated deploy/verify/cleanup workflow
+- **pytest fixtures**: Integration with pytest for E2E testing
+- **Category filtering**: Run tests by language or framework
+
+## Installation
+
+```bash
+pip install hop3-testing
+```
+
+## Quick Start
+
+```bash
+# List available tests
+hop3-test list
+
+# Run system tests on Docker
+hop3-test system --docker
+
+# Test specific apps
+hop3-test apps 010-flask-pip-wsgi
+
+# Test against remote server
+hop3-test apps --host server.example.com
+
+# Run CI tests
+hop3-test ci
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `hop3-test system` | Deploy Hop3 and run system tests |
+| `hop3-test apps` | Test apps against pre-deployed Hop3 |
+| `hop3-test list` | List available tests |
+| `hop3-test show <name>` | Show test details |
+| `hop3-test ci` | Run CI tests (fast+medium, P0) |
+| `hop3-test dev` | Run developer tests (fast, P0 only) |
+| `hop3-test hetzner` | Run E2E tests on Hetzner Cloud |
+| `hop3-test multi-distro` | Test across multiple Linux distributions |
+
+### Common Options
+
+| Option | Description |
+|--------|-------------|
+| `-v, --verbose` | Verbose output |
+| `--fail-fast` | Stop on first failure |
+| `--keep` | Keep apps deployed after testing |
+| `--docker` | Use Docker target |
+| `--host HOST` | Remote server hostname |
+
+## Architecture
+
+```
+hop3-testing/
+├── src/hop3_testing/
+│   ├── cli/              # CLI commands
+│   │   └── commands/     # Click command implementations
+│   ├── catalog/          # Test discovery
+│   │   ├── scanner.py    # Discovers test.toml files
+│   │   └── models.py     # TestDefinition, Category
+│   ├── apps/
+│   │   ├── catalog.py    # AppSource dataclass
+│   │   └── deployment.py # DeploymentSession
+│   ├── targets/
+│   │   ├── base.py       # DeploymentTarget ABC
+│   │   ├── docker.py     # DockerTarget
+│   │   └── remote.py     # RemoteTarget
+│   └── results/          # Result storage and reporting
+└── tests/
+```
+
+## Test Categories
+
+| Category | Languages/Frameworks |
+|----------|---------------------|
+| `python` | Flask, FastAPI, Django |
+| `nodejs` | Express, Fastify |
+| `ruby` | Sinatra, Rails |
+| `go` | Fiber, Gin |
+| `rust` | Actix-web, Axum |
+| `static` | HTML, Hugo, Jekyll |
+
+## Hetzner Cloud Testing
+
+Run full E2E tests on real Hetzner Cloud servers. Requires `HETZNER_API_TOKEN` environment variable.
+
+```bash
+# List available images
+hop3-test multi-distro --list-images
+
+# Run tests on a single distribution
+hop3-test hetzner --image ubuntu-24.04 --suites test-apps
+
+# Run tests across multiple distributions
+hop3-test multi-distro --images ubuntu-24.04 debian-13 fedora-42
+
+# Use local code instead of git
+hop3-test hetzner --use-local-repo
+
+# Skip phases for debugging
+hop3-test hetzner --skip-reset    # Keep existing server state
+hop3-test hetzner --skip-deploy   # Use existing Hop3 installation
+hop3-test hetzner --skip-tests    # Only reset and deploy
+```
+
+### Hetzner Options
+
+| Option | Description |
+|--------|-------------|
+| `--server-id ID` | Use specific Hetzner server |
+| `--image IMAGE` | OS image (e.g., ubuntu-24.04) |
+| `--branch BRANCH` | Git branch to test (default: devel) |
+| `--use-local-repo` | Deploy from local code |
+| `--skip-reset` | Skip server reset |
+| `--skip-deploy` | Skip Hop3 deployment |
+| `--suites SUITE` | Test suites to run |
+| `--continue-on-failure` | Don't stop on first failure (multi-distro) |
+
+## Development
+
+```bash
+# Run tests
+uv run pytest tests/ -v
+
+# Lint and format
+uv run ruff check src/
+uv run ruff format src/
+```
+
+## Documentation
+
+- [Testing Strategy](../../docs/src/dev/testing-strategy.md)
+
+## Related Packages
+
+- [hop3-server](../hop3-server/) - The server being tested
+- [hop3-cli](../hop3-cli/) - CLI used for deployments in tests
+
+## License
+
+Apache-2.0 - Copyright (c) 2024-2026, Abilian SAS

hop3_testing-0.4.0/README.md

@@ -0,0 +1,155 @@
+# hop3-testing
+
+Testing framework for Hop3 deployment validation.
+
+## Overview
+
+hop3-testing provides utilities and fixtures for testing Hop3 deployments. It supports running tests against Docker containers or remote servers, with a catalog of test applications covering various languages and frameworks.
+
+## Features
+
+- **Multiple targets**: Test against Docker containers or remote SSH servers
+- **App catalog**: Pre-built test applications for various languages
+- **Deployment sessions**: Automated deploy/verify/cleanup workflow
+- **pytest fixtures**: Integration with pytest for E2E testing
+- **Category filtering**: Run tests by language or framework
+
+## Installation
+
+```bash
+pip install hop3-testing
+```
+
+## Quick Start
+
+```bash
+# List available tests
+hop3-test list
+
+# Run system tests on Docker
+hop3-test system --docker
+
+# Test specific apps
+hop3-test apps 010-flask-pip-wsgi
+
+# Test against remote server
+hop3-test apps --host server.example.com
+
+# Run CI tests
+hop3-test ci
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `hop3-test system` | Deploy Hop3 and run system tests |
+| `hop3-test apps` | Test apps against pre-deployed Hop3 |
+| `hop3-test list` | List available tests |
+| `hop3-test show <name>` | Show test details |
+| `hop3-test ci` | Run CI tests (fast+medium, P0) |
+| `hop3-test dev` | Run developer tests (fast, P0 only) |
+| `hop3-test hetzner` | Run E2E tests on Hetzner Cloud |
+| `hop3-test multi-distro` | Test across multiple Linux distributions |
+
+### Common Options
+
+| Option | Description |
+|--------|-------------|
+| `-v, --verbose` | Verbose output |
+| `--fail-fast` | Stop on first failure |
+| `--keep` | Keep apps deployed after testing |
+| `--docker` | Use Docker target |
+| `--host HOST` | Remote server hostname |
+
+## Architecture
+
+```
+hop3-testing/
+├── src/hop3_testing/
+│   ├── cli/              # CLI commands
+│   │   └── commands/     # Click command implementations
+│   ├── catalog/          # Test discovery
+│   │   ├── scanner.py    # Discovers test.toml files
+│   │   └── models.py     # TestDefinition, Category
+│   ├── apps/
+│   │   ├── catalog.py    # AppSource dataclass
+│   │   └── deployment.py # DeploymentSession
+│   ├── targets/
+│   │   ├── base.py       # DeploymentTarget ABC
+│   │   ├── docker.py     # DockerTarget
+│   │   └── remote.py     # RemoteTarget
+│   └── results/          # Result storage and reporting
+└── tests/
+```
+
+## Test Categories
+
+| Category | Languages/Frameworks |
+|----------|---------------------|
+| `python` | Flask, FastAPI, Django |
+| `nodejs` | Express, Fastify |
+| `ruby` | Sinatra, Rails |
+| `go` | Fiber, Gin |
+| `rust` | Actix-web, Axum |
+| `static` | HTML, Hugo, Jekyll |
+
+## Hetzner Cloud Testing
+
+Run full E2E tests on real Hetzner Cloud servers. Requires `HETZNER_API_TOKEN` environment variable.
+
+```bash
+# List available images
+hop3-test multi-distro --list-images
+
+# Run tests on a single distribution
+hop3-test hetzner --image ubuntu-24.04 --suites test-apps
+
+# Run tests across multiple distributions
+hop3-test multi-distro --images ubuntu-24.04 debian-13 fedora-42
+
+# Use local code instead of git
+hop3-test hetzner --use-local-repo
+
+# Skip phases for debugging
+hop3-test hetzner --skip-reset    # Keep existing server state
+hop3-test hetzner --skip-deploy   # Use existing Hop3 installation
+hop3-test hetzner --skip-tests    # Only reset and deploy
+```
+
+### Hetzner Options
+
+| Option | Description |
+|--------|-------------|
+| `--server-id ID` | Use specific Hetzner server |
+| `--image IMAGE` | OS image (e.g., ubuntu-24.04) |
+| `--branch BRANCH` | Git branch to test (default: devel) |
+| `--use-local-repo` | Deploy from local code |
+| `--skip-reset` | Skip server reset |
+| `--skip-deploy` | Skip Hop3 deployment |
+| `--suites SUITE` | Test suites to run |
+| `--continue-on-failure` | Don't stop on first failure (multi-distro) |
+
+## Development
+
+```bash
+# Run tests
+uv run pytest tests/ -v
+
+# Lint and format
+uv run ruff check src/
+uv run ruff format src/
+```
+
+## Documentation
+
+- [Testing Strategy](../../docs/src/dev/testing-strategy.md)
+
+## Related Packages
+
+- [hop3-server](../hop3-server/) - The server being tested
+- [hop3-cli](../hop3-cli/) - CLI used for deployments in tests
+
+## License
+
+Apache-2.0 - Copyright (c) 2024-2026, Abilian SAS

hop3_testing-0.4.0/pyproject.toml

@@ -0,0 +1,58 @@
+[project]
+name = "hop3-testing"
+version = "0.4.0"
+description = "Testing utilities for Hop3"
+readme = "README.md"
+license = "Apache-2.0"
+authors = [
+    { name = "Stefane Fermigier", email = "sf@abilian.com" }
+]
+requires-python = ">=3.10, <4"
+dependencies = [
+    # Hop3 packages
+    "hop3-cli",
+    "hop3-installer",
+    # Testing
+    "pytest>=8.0.0",
+    "docker>=7.0.0",
+    # TOML parsing (Python 3.10 compat)
+    "tomli>=2.0.0; python_version < '3.11'",
+    # Dev tools
+    "devtools>=0.12.2",
+    "python-dotenv>=1.0.1",
+    # Communication
+    "httpcore>=1.0.6",
+    "httpx>=0.27.2",
+    # Pin paramiko to 2.x for compatibility with sshtunnel (used in hop3-cli)
+    "paramiko>=2.11.0,<3.0.0",
+    # CLI
+    "click>=8.0.0",
+    # Result storage
+    "sqlalchemy>=2.0.0",
+    # JWT token generation for E2E tests
+    "PyJWT>=2.8.0",
+    # Hetzner system tests
+    "hcloud>=2.0",
+    "jinja2>=3.0",
+    "rich>=13.0",
+    "attrs>=23.0",
+    "termcolor>=2.0",
+]
+
+[project.scripts]
+hop3-test = "hop3_testing.cli:main"
+
+[build-system]
+requires = ["uv-build>=0.8.4,<0.9.0"]
+build-backend = "uv_build"
+
+#
+# Tools
+#
+
+# Keep!
+[tool.pyrefly]
+project-includes = [
+    "**/*.py*",
+    "**/*.ipynb",
+]

hop3_testing-0.4.0/src/hop3_testing/__init__.py

@@ -0,0 +1,20 @@
+# Copyright (c) 2023-2025, Abilian SAS
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""Hop3 deployment testing framework."""
+
+from __future__ import annotations
+
+import warnings
+
+# Suppress TripleDES deprecation warnings from paramiko
+# This happens when paramiko imports the cipher at module load time
+# We disable using it in connections via disabled_algorithms config
+try:
+    from cryptography.utils import CryptographyDeprecationWarning
+
+    warnings.filterwarnings("ignore", category=CryptographyDeprecationWarning)
+except ImportError:
+    # Fallback if CryptographyDeprecationWarning not available
+    warnings.filterwarnings("ignore", message=".*TripleDES.*")

hop3_testing-0.4.0/src/hop3_testing/apps/__init__.py

@@ -0,0 +1,23 @@
+# Copyright (c) 2023-2025, Abilian SAS
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""Test application utilities."""
+
+from __future__ import annotations
+
+from .catalog import AppSource
+from .debug import DeploymentDebugger
+from .deployment import DeploymentSession
+from .preparation import AppPreparation
+from .verification import AppVerifier, CheckScriptRunner, HttpVerifier
+
+__all__ = [
+    "AppPreparation",
+    "AppSource",
+    "AppVerifier",
+    "CheckScriptRunner",
+    "DeploymentDebugger",
+    "DeploymentSession",
+    "HttpVerifier",
+]

hop3_testing-0.4.0/src/hop3_testing/apps/catalog.py

@@ -0,0 +1,41 @@
+# Copyright (c) 2023-2025, Abilian SAS
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""Test application data class for deployment sessions."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+
+
+@dataclass
+class AppSource:
+    """Represents a test application for deployment.
+
+    This is a simple data class used by DeploymentSession to track
+    app metadata during deployment and testing.
+    """
+
+    name: str
+    path: Path
+    category: str = ""
+    description: str = ""
+
+    @property
+    def has_check_script(self) -> bool:
+        """Check if app has a check.py script."""
+        return (self.path / "check.py").exists()
+
+    @property
+    def has_procfile(self) -> bool:
+        """Check if app has a Procfile.
+
+        Checks for Procfile in:
+        1. Root directory (standard location)
+        2. hop3/ subdirectory (alternate config path)
+        """
+        return (self.path / "Procfile").exists() or (
+            self.path / "hop3" / "Procfile"
+        ).exists()