mirror of
https://github.com/acedanger/shell.git
synced 2025-12-06 08:50:12 -08:00
9a941d1752
- Updated setup.sh to check for Nala installation and provide alternative installation methods based on Ubuntu version. - Added error handling for package installation, allowing fallback to apt if Nala fails. - Introduced startup.sh to perform container startup checks, including system info and permissions for logs directory. - Created test-setup.sh to validate bootstrap and setup scripts, including detailed logging of package availability and installation results. - Implemented checks for missing packages and provided recommendations for manual installation. - Enhanced logging for better traceability of actions and errors during setup and testing processes.
5.1 KiB
5.1 KiB
Shell Setup Testing Framework
This document describes the testing framework for validating the shell setup across different environments.
Overview
The testing framework consists of three main components:
- test-setup.sh: The main test script that validates the bootstrap and setup process
- run-docker-tests.sh: A runner script that executes tests in Docker containers
- Dockerfile: Definition of test environments (Ubuntu and Debian)
Testing Features
- Cross-platform testing: Test on both Ubuntu and Debian environments
- Isolated environments: All tests run in fresh Docker containers
- Comprehensive validation: Tests both the bootstrap and setup processes
- Continuous testing: Tests all packages regardless of individual failures
- Detailed reporting: Summary of all successful and failed components
How Testing Works
The Docker Test Environment
The Dockerfile defines two testing environments:
- ubuntu-test: Based on Ubuntu 24.04
- debian-test: Based on Debian 12
Each environment:
- Installs minimal dependencies (curl, git, sudo, wget)
- Creates a test user with sudo permissions
- Sets up the directory structure for testing
- Copies the test script and packages list
- Runs the test script when the container starts
The Test Script (test-setup.sh)
The test script validates:
- Script Syntax: Checks if bootstrap.sh and setup.sh have valid syntax
- Core Tools: Verifies git, curl, wget are available
- Package Availability: Checks if packages in packages.list are available in repositories
- Package Installation: Tests if each package is installed
- Shell Setup: Validates Oh My Zsh and plugin installation
- Dotfiles: Checks if dotfiles are properly symlinked
The script tracks all missing or misconfigured components and provides a summary at the end, including suggestions for fixing issues.
Test Runner (run-docker-tests.sh)
The runner script provides several test modes:
- ubuntu: Run test on Ubuntu container
- debian: Run test on Debian container
- full-ubuntu: Run full bootstrap test on Ubuntu
- full-debian: Run full bootstrap test on Debian
- all: Run tests on both Ubuntu and Debian
Testing Without Stopping on Failures
A key feature is the ability to test all packages in packages.list without stopping at the first failure. This ensures:
- Complete coverage of all requirements
- Comprehensive reporting of all issues
- Better debugging experience when multiple components need attention
Running Tests
# Test on Ubuntu
./run-docker-tests.sh ubuntu
# Test on Debian
./run-docker-tests.sh debian
# Full bootstrap test on Ubuntu
./run-docker-tests.sh full-ubuntu
# Full bootstrap test on Debian
./run-docker-tests.sh full-debian
# Test on both Ubuntu and Debian
./run-docker-tests.sh all
Choosing the Right Test Option
The testing framework offers different options for different testing needs:
| If you want to... | Use this command | Why |
|---|---|---|
| Quickly check if specific packages are available | ./run-docker-tests.sh ubuntu or debian |
Fast validation of packages without full installation |
| Test changes to the test-setup.sh script | ./run-docker-tests.sh ubuntu or debian |
Executes only the test script in a clean environment |
| Validate a fix for a package installation issue | ./run-docker-tests.sh ubuntu or debian |
Tests package availability and installation |
| Test the complete user experience | ./run-docker-tests.sh full-ubuntu or full-debian |
Executes the actual bootstrap script like a real user would |
| Ensure bootstrap.sh works correctly | ./run-docker-tests.sh full-ubuntu or full-debian |
Tests the entire installation process from scratch |
| Verify cross-platform compatibility | ./run-docker-tests.sh all |
Tests on both supported platforms |
| Before pushing changes to main | ./run-docker-tests.sh all and both full tests |
Complete validation across environments |
Key Differences
Standard Tests (ubuntu, debian):
- Use the Docker targets defined in the main Dockerfile
- Run the
test-setup.shscript to check components - Faster execution, focused on component validation
- Don't perform the actual bootstrap installation
Full Tests (full-ubuntu, full-debian):
- Create a temporary Dockerfile for comprehensive testing
- Execute the bootstrap script directly from GitHub
- Complete end-to-end testing of the actual installation process
- Simulate the real user experience
Test Output
The test provides:
- A color-coded console output showing success/failure of each component
- A list of missing packages at the end
- A detailed log file with all test results (saved to /tmp)
- Suggestions for fixing detected issues
Adding New Tests
To add new package tests:
- Add the package name to
setup/packages.list - The test framework will automatically validate its availability and installation
For more complex components:
- Add a new test function in
test-setup.sh - Call the function in the main testing sequence
- Increment the error counter if the test fails