docs(tests): minor cleanup

Author: jonlabelle

scripts/prune/README.md

@@ -4,45 +4,33 @@
 
 > Container image pruning script that supports both Docker Hub and GitHub Container Registry (GHCR).
 
-## Overview
+## Usage
 
-- Support both Docker Hub and GitHub Container Registry
-- Use a modular architecture with separate registry implementations
-- Provide multiple pruning strategies including a new "keep latest N images" option
-- Better error handling and logging
-
-## Usage Examples
+```console
+usage: main.py [-h] --container CONTAINER
+  [--registry {ghcr, dockerhub, all}]
+  [--verbose] [--dry-run]
+  (--prune-untagged-age DAYS | --prune-all-untagged | --keep-latest COUNT)
+```
 
 ### Environment Variables
 
-To use the script, you need to set up environment variables for authentication. The script supports both Docker Hub and GitHub Container Registry.
+To use the script, you need to set up environment variables for authentication.
+The script supports both [Docker Hub](https://hub.docker.com) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry).
 
-#### Docker Hub
+**Docker Hub variables:**
 
 ```bash
 export DOCKER_USERNAME=<your_docker_username>
 export DOCKER_PASSWORD=<your_docker_password_or_token>
 ```
 
-#### GitHub Container Registry
+**GitHub Container Registry variables:**
 
 ```bash
 export GHCR_TOKEN=<your_github_token>
 ```
 
-### Command Examples
-
-```bash
-# Prune untagged images older than 7 days from both registries
-python main.py --container network-tools --registry all --prune-untagged-age 7 --verbose
-
-# Keep only the latest 5 images in GHCR (delete everything else)
-python main.py --container network-tools --registry ghcr --keep-latest 5 --verbose
-
-# Dry run: see what would be deleted from Docker Hub
-python main.py --container network-tools --registry dockerhub --prune-all-untagged --dry-run --verbose
-```
-
 ### CLI Options
 
 - `--container`: Name of the container image (required)
@@ -56,81 +44,23 @@ python main.py --container network-tools --registry dockerhub --prune-all-untagg
 - `--prune-all-untagged`: Delete all untagged images
 - `--keep-latest COUNT`: Keep only the latest COUNT images
 
-## Integration with GitHub Actions
+### Examples
 
-The script is integrated into two GitHub Actions workflows:
-
-### Production Usage (`cd.yml`)
+```bash
+# Prune untagged images older than 7 days from both registries
+python main.py --container network-tools --registry all --prune-untagged-age 7 --verbose
 
-The script runs after successful image builds to clean up old images:
+# Keep only the latest 5 images in GHCR (delete everything else)
+python main.py --container network-tools --registry ghcr --keep-latest 5 --verbose
 
-```yaml
-- name: Prune old images
-  run: python scripts/prune/main.py --container ${{ env.IMAGE_NAME }} --registry all --keep-latest 25 --verbose
+# Dry run: see what would be deleted from Docker Hub
+python main.py --container network-tools --registry dockerhub --prune-all-untagged --dry-run --verbose
 ```
 
-### Automated Testing (`test-prune-script.yml`)
-
-The test suite runs automatically whenever files in the prune directory are modified:
-
-- ✅ Unit tests (20 comprehensive tests)
-- ✅ Integration tests (7 CLI tests)
-- ✅ Help interface validation
-- ✅ Dry-run functionality testing
-
-This ensures that:
-
-- All changes to the prune script are automatically tested
-- Old untagged images are cleaned up automatically in production
-- Storage usage is kept manageable
-- Both Docker Hub and GHCR are maintained consistently
-
-## Error Handling
-
-- Graceful handling of missing credentials
-- Registry-specific error reporting
-- Continues processing other registries if one fails
-- Detailed error messages in verbose mode
-
 ## Testing
 
-The script includes a comprehensive test suite to ensure reliability and correctness. All tests are organized in the `tests/` directory.
-
-### Test Structure
-
-```plaintext
-tests/
-├── README.md             # Testing documentation
-├── __init__.py           # Package initialization
-├── test_prune.py         # Comprehensive unit tests (20 tests)
-├── test_integration.py   # Integration tests (7 tests)
-└── run_all_tests.py      # Master test runner
-```
-
-### Running Tests
-
-**From the prune script root directory:**
-
-```bash
-python test_runner.py                   # Master test runner
-```
-
-**From the tests directory:**
-
 ```bash
-python tests/run_all_tests.py           # Run all test suites
-python tests/test_prune.py              # Unit tests only
-python tests/test_integration.py        # Integration tests only
+python test_runner.py  # Run all tests
 ```
 
-### Test Coverage
-
-The test suite covers:
-
-- ✅ All pruning strategies
-- ✅ Registry factory functionality
-- ✅ Error handling scenarios
-- ✅ CLI argument parsing
-- ✅ Dry-run functionality
-- ✅ Multi-registry support
-- ✅ Authentication handling
+> For comprehensive testing documentation, see [`tests/README.md`](tests/README.md).

scripts/prune/tests/README.md

@@ -1,13 +1,25 @@
-# Tests Directory
+# Tests
 
 This directory contains comprehensive tests for the container image pruning script.
 
-## Test Files
+## Overview
+
+The test suite provides comprehensive coverage of:
+
+- ✅ All pruning strategies (age-based, all-untagged, keep-latest)
+- ✅ Multi-registry support (Docker Hub + GHCR)
+- ✅ Registry factory functionality
+- ✅ Error handling and edge cases
+- ✅ CLI argument parsing and validation
+- ✅ Dry-run functionality
+- ✅ Authentication handling
+- ✅ Modular architecture components
+
+## Test Structure
 
 ### Core Test Suites
 
 - **`test_prune.py`** - Comprehensive unit tests covering all components (20 tests)
-
   - ImageVersion class functionality
   - All pruning strategies
   - Registry factory
@@ -27,7 +39,7 @@ This directory contains comprehensive tests for the container image pruning scri
 
 ## Running Tests
 
-### From the prune script root directory:
+### From the prune script root directory
 
 ```bash
 # Run all tests using the master test runner
@@ -37,7 +49,7 @@ python test_runner.py
 python tests/run_all_tests.py
 ```
 
-### From the tests directory:
+### From the tests directory
 
 ```bash
 # Run individual test files
@@ -48,45 +60,21 @@ python test_integration.py     # Integration tests
 python run_all_tests.py
 ```
 
-## Test Coverage
-
-The test suite provides comprehensive coverage of:
-
-- ✅ All pruning strategies (age-based, all-untagged, keep-latest)
-- ✅ Multi-registry support (Docker Hub + GHCR)
-- ✅ Registry factory functionality
-- ✅ Error handling and edge cases
-- ✅ CLI argument parsing and validation
-- ✅ Dry-run functionality
-- ✅ Authentication handling
-- ✅ Modular architecture components
-
-## Test Results
-
-**Current Status:** All tests passing ✅
-
-- 20/20 unit tests passed
-- 7/7 integration tests passed
-- 5/5 core functionality tests passed
-- **Total: 32/32 tests passed**
-
 ## Adding New Tests
 
 When adding new functionality to the prune script:
 
-1. Add unit tests to `test_prune.py` for new components
-2. Add integration tests to `test_integration.py` for CLI changes
-3. Update `validate_tests.py` for core functionality changes
+1. Add unit tests to [`test_prune.py`](test_prune.py) for new components
+2. Add integration tests to [`test_integration.py`](test_integration.py) for CLI changes
+3. Run [`run_all_tests.py`](run_all_tests.py) to validate all functionality works together
 4. Run the full test suite to ensure no regressions
 
-## Test Dependencies
+## Dependencies
 
-Tests use only Python standard library modules:
+Tests use only Python standard library modules (no external dependencies):
 
 - `unittest` - Main testing framework
 - `unittest.mock` - Mocking for isolated testing
 - `subprocess` - For CLI integration tests
 - `datetime` - For time-based testing
 - `pathlib` - For file path handling
-
-No external dependencies required for testing.