cloudflare/cloudflared
Publicmirrored from https://github.com/cloudflare/cloudflaredAvailable
component-tests/README.md
52lines · modecode
| 1 | # Requirements |
| 2 | 1. Python 3.7 or later with packages in the given `requirements.txt` |
| 3 | - E.g. with conda: |
| 4 | - `conda create -n component-tests python=3.7` |
| 5 | - `conda activate component-tests` |
| 6 | - `pip3 install -r requirements.txt` |
| 7 | |
| 8 | 2. Create a config yaml file, for example: |
| 9 | ``` |
| 10 | cloudflared_binary: "cloudflared" |
| 11 | tunnel: "3d539f97-cd3a-4d8e-c33b-65e9099c7a8d" |
| 12 | credentials_file: "/Users/tunnel/.cloudflared/3d539f97-cd3a-4d8e-c33b-65e9099c7a8d.json" |
| 13 | classic_hostname: "classic-tunnel-component-tests.example.com" |
| 14 | origincert: "/Users/tunnel/.cloudflared/cert.pem" |
| 15 | ingress: |
| 16 | - hostname: named-tunnel-component-tests.example.com |
| 17 | service: http_status:200 |
| 18 | - service: http_status:404 |
| 19 | ``` |
| 20 | |
| 21 | 3. Route hostname to the tunnel. For the example config above, we can do that via |
| 22 | ``` |
| 23 | cloudflared tunnel route dns 3d539f97-cd3a-4d8e-c33b-65e9099c7a8d named-tunnel-component-tests.example.com |
| 24 | ``` |
| 25 | |
| 26 | 4. Turn on linter |
| 27 | If you are using Visual Studio, follow https://code.visualstudio.com/docs/python/linting to turn on linter. |
| 28 | |
| 29 | 5. Turn on formatter |
| 30 | If you are using Visual Studio, follow https://code.visualstudio.com/docs/python/editing#_formatting |
| 31 | to turn on formatter and https://marketplace.visualstudio.com/items?itemName=cbrevik.toggle-format-on-save |
| 32 | to turn on format on save. |
| 33 | |
| 34 | 6. If you have cloudflared running as a service on your machine, you can either stop the service or ignore the service tests |
| 35 | via `--ignore test_service.py` |
| 36 | |
| 37 | # How to run |
| 38 | Specify path to config file via env var `COMPONENT_TESTS_CONFIG`. This is required. |
| 39 | ## All tests |
| 40 | Run `pytest` inside this(component-tests) folder |
| 41 | |
| 42 | ## Specific files |
| 43 | Run `pytest <file 1 name>.py <file 2 name>.py` |
| 44 | |
| 45 | ## Specific tests |
| 46 | Run `pytest file.py -k <test 1 name> -k <test 2 name>` |
| 47 | |
| 48 | ## Live Logging |
| 49 | Running with `-o log_cli=true` outputs logging to CLI as the tests are. By default the log level is WARN. |
| 50 | `--log-cli-level` control logging level. |
| 51 | For example, to log at info level, run `pytest -o log_cli=true --log-cli-level=INFO`. |
| 52 | See https://docs.pytest.org/en/latest/logging.html#live-logs for more documentation on logging. |