webfinger-test/README.md

25 lines
1.4 KiB
Markdown

# WebFinger tests for ForgeFlux/ftest
## Environment Variables
Please see [`.env_sample`](./.env_sample)
| NAME | Purpose | Example |
| ------------------- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- |
| `FTEST_AUTH` | Authorization token for uploading test results to ftest server | a random-generated string that will be provided by ftest server |
| `FTEST_TARGET_HOST` | The URL of the implementation's instance against which tests will be run | `http://localhost:3000`, if Forgejo or any other WebFinger implementation is running on localhost at port 3000 |
| `FTEST_USER` | address of the actor against which WebFinger tests will be run | `john@localhost:3000`. User `john` should exist on the instance |
## Usage
```bash
cp .env_sample .env # edit and populate .env with the right values
source .env
python run.py
```
## TODO
- [ ] Write code to upload to ftest server
- [ ] Package Docker container
- [ ] Upload to Docker Hub