Florian Eitel
a60f830927
I can't run tests in travis and due to the bind9 dependency it's difficult to run on the local machine. Docker is tricky due to changing the nameserver to 127.0.0.1 but with the right parameter it works. There are still a handful of tests failing. I couldn't figure out why yet.
2.0 KiB
2.0 KiB
Dependency management
Get Pipenv and checkout the Pipenv Command reference
Install new dependencies
https://pipenv.pypa.io/en/latest/commands/#install
pipenv install mypkg
Spawn a shell with correct python paths
pipenv shell
Exit the shell with exit
Dependency maintenance
Update requirements.txt files including transitive dependencies
pipenv update
NOTE: This is not done today and only a suggestion.
pipenv requirements --exclude-markers > requirements.d/all.txt
pipenv requirements --exclude-markers --dev-only > requirements.d/dev.txt
Verify the updated dependencies don't include any security vulnerabilities
pipenv check
Build locally
- Install
build(see docs for example viapacman -S python-buildon ArchLinux - Afterwards run the command to generate pip packgases in
dist/:pyproject-build
NOTE: This is also needed before development because the command generates ./src/nsupdate/_version.py.
Run locally
- Install dependencies
pipenv install --dev - Generate
src/nsupdate/_version.pyfile by runningpyproject-build - Create database using
pipenv run ./manage.py migrate - Create a superuser with
pipenv run ./manage.py createsuperuser - Run the server with
pipenv run ./manage.py runserver
Lint
Run pylint in error-only mode to check any problems: pipenv run pylint src/nsupdate
NOTE: The project does not use pylint for formatting. Disabling the errors-only mode in .pylintrc will show a lot of warnings.
Run tests
Tests need to run inside Docker because they depend on specific bind9 config on 127.0.0.1:53.
- Build the docker image using:
docker build -t nsupdate scripts/docker/once - Then run tests via
docker run --dns 127.0.0.1 -v $PWD:/app nsupdate