Skip to content

Latest commit

 

History

History
93 lines (65 loc) · 2.34 KB

DEVELOPMENT.md

File metadata and controls

93 lines (65 loc) · 2.34 KB
Raw

Development

Setup development environment

Follow the instructions from README.md to setup Python and create a virtual environment.

Install the development requirements by

pip-sync requirements.txt dev-requirements.txt

Typical development

Changes shall be developed on feature-branches, tested by molecule and pre-commit locally and by CI.

Setup of git, usage of feature-branches and pushing is not explained in detail here, assumption is that you are familiar with this tool.

Check changes using pre-commit

pre-commit is used for several formatters and linters

Example execute pre-commit on all files

pre-commit run --all-files

But it's recommended to install the automatic git pre-commit hook by pre-commit install

Check changes using molecule

molecule is used for testing Ansible roles

  • molecule provides support for testing with multiple instances, operating systems and distributions, virtualization providers, test frameworks and testing scenarios.
  • molecule encourages an approach that results in consistently developed roles that are well-written, easily understood and maintained.
  • molecule is already part of the virtual environment installation.

Example execute molecule for all roles

./scripts/test-roles.sh

or use molecule on a single role

# Execute molecule on a single role
cd roles/<role>
molecule test
# Run some parts of the test sequence with debug output
molecule --debug test
# Run some parts of the test sequence
molecule converge
# If nothing works anymore, try to destroy running stuff
molecule destroy

Generate or upgrade Python [dev-]requirements.txt

# Regenerate requirement files
pip-compile --upgrade --generate-hashes --extra=dev --output-file=dev-requirements.txt --allow-unsafe pyproject.toml
pip-compile --upgrade --generate-hashes --output-file=requirements.txt pyproject.toml

Further development commands

# Install locally
pip install -e .

# Build package
python -m build

# Create test coverage
coverage run -m pytest && coverage report -m
coverage run -m pytest && coverage html

# Format code
black --line-length=120 .

# Run unit tests
pytest

# Static type checker
mypy