Commit 2706dea7 authored by Adrien Dorsaz's avatar Adrien Dorsaz

tests: complete README

parent 0a8bb111
Pipeline #48 passed with stage
in 30 minutes and 53 seconds
......@@ -7,14 +7,27 @@ explains how to setup and test acme-tiny yourself.
## Setup instructions
1. Setup environment variables:
* Read top of monkey.py, all environnement variables used are defined there (top of file).
* Read top of config_maker.py, all environement variables used are defined there (top of file).
* These variables corresponds to the configuration file you have to do when using in production.
* If you don't own the gitlab project, you can set them on your build/test machine:
`export GITLABCI_DOMAIN=travis-ci.gethttpsforfree.com`
* Otherwise, you have to use your gitlab project to define environment variables for gitlab runners.
2. Install the test requirements on your build/test machine (automated by .gitlab-ci.yml for gitlab runners).
* `cd /path/to/acme-dns-tiny`
* `pip install --user -r tests/requirements.txt`
* `pip3 install --user -r tests/requirements.txt`
5. Run the test suit on your local.
* `cd /path/to/acme-dns-tiny`
* `coverage run --source ./ -m unittest tests`
## List of environment variables
* `GITLABCI_CAURL`: URL of a staging ACME server
* `GITLABCI_CHALLENGEDELAY`: time to wait between dns update and self-check (set it to `0` to cover a bit more code)
* `GITLABCI_DNSHOST`: domain name to reach of your DNS server (e.g. `adorsaz.ch`)
* `GITLABCI_DNSHOSTIP`: IP address to reach of your DNS server
* `GITLABCI_DNSPORT`: port to reach your DNS server
* `GITLABCI_DNSZONE`: zone name wich contains the domain name to test
* `GITLABCI_DOMAIN`: the main domain to test (one test uses also `www.GITLABCI_DOMAIN`)
* `GITLABCI_TSIGALGORITHM`: TSIG algorithm (e.g. `hmac-sha256`)
* `GITLABCI_TSIGKEYNAME`: TSIG key name
* `GITLABCI_TSIGKEYVALUE`: TSIG secret
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment