upsunvalidator 0.1.1

Top-level package for Platform.sh/Upsun Configuration Validator.

upsunvalidator

Contribute, request a feature, or check out our resources

Check out Jeck.ai       Blog       Report a bug       Request a feature

     

---

A Python-based validator for Upsun (formerly Platform.sh) configuration files. This tool helps catch configuration errors before deployment by validating configuration YAML files against the official Upsun & Platform.sh schemas.

Features       Installation       Usage       Testing       License       Contribute      

Features

• Validates application runtimes, services, and their versions
• Validates application and service configurations
• Validates route patterns and configurations
• Provides clear error messages for invalid configurations
• Provides recommendations when possible
• Includes test suite with passing and failing examples

Installation

Requirements:

[!IMPORTANT]
upsunvalidator requires at least Python 3.12.

pip install upsunvalidator
# or
python -m pip install --user upsunvalidator

You can then check the installed version with:

upsunvalidator version

Upgrade

python -m pip install --user upsunvalidator --upgrade

Usage

Validating project code for various PaaS providers

1. Provider: Upsun

   # If executing from within the repository, pwd will be used.
   upsunvalidator validate --provider upsun
   # or
   upv validate --provider upsun
   
   # If outside the project dir, use the --src flag
   upsunvalidator validate --src $PATH_TO_REPO --provider upsun
   # or
   upv validate --src $PATH_TO_REPO --provider upsun
   

2. Provider: Platform.sh

   # If executing from within the repository, pwd will be used.
   upsunvalidator validate --provider platformsh
   # or
   upv validate --provider platformsh
   
   # If outside the project dir, use the --src flag
   upsunvalidator validate --src $PATH_TO_REPO --provider platformsh
   # or
   upv validate --src $PATH_TO_REPO --provider platformsh
   

3. All providers

   # If executing from within the repository, pwd will be used.
   upsunvalidator validate
   # or
   upv validate
   
   # If outside the project dir, use the --src flag
   upsunvalidator validate --src $PATH_TO_REPO
   # or
   upv validate --src $PATH_TO_REPO
   

Testing

The project includes a comprehensive test suite:

python3 -m venv venv
source venv/bin/activate
pip install .
pytest

License

MIT License

Contribute

We're very interested in adding to the passing configs. If you have working configuration files for Platform.sh and/or Upsun, please share!

1. Create an issue
2. Fork the repository
3. Create your feature branch (git checkout -b feature/amazing-feature)
4. Add you configuration to the tests/valid using the pattern tests/valid/YOUR_EXAMPLE_OR_FRAMEWORK_NAME/files/...
5. Commit your changes (git commit -am 'Add some amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

See CONTRIBUTING.md for more details.