wehub-resource-sync
32 lines
1.2 KiB
Markdown
32 lines
1.2 KiB
Markdown
Test helpers for Kong (integration) tests
|
|
=========================================
|
|
|
|
To generate the documentation run the following command in the Kong source tree:
|
|
|
|
```
|
|
# install ldoc using LuaRocks
|
|
luarocks install ldoc
|
|
|
|
# generate and open the docs
|
|
cd spec && ldoc . && open docs/index.html && cd ..
|
|
```
|
|
|
|
## Environment variables
|
|
|
|
When testing, Kong will ignore the `KONG_xxx` environment variables that are
|
|
usually used to configure it. This is to make sure that the tests run deterministically.
|
|
If this behaviour needs to be overridden, the `KONG_TEST_xxx`
|
|
version of the variable can be used, which will be respected by the Kong test
|
|
instance.
|
|
|
|
To prevent the test helpers from cleaning the Kong working directory, the
|
|
variable `KONG_TEST_DONT_CLEAN` can be set.
|
|
This comes in handy when inspecting the logs after the tests complete.
|
|
|
|
When testing with Redis, the environment variable `KONG_SPEC_TEST_REDIS_HOST` can be
|
|
used to specify where the Redis server can be found. If not specified, it will default
|
|
to `127.0.0.1`. This setting is available to tests via `helpers.redis_host`.
|
|
|
|
The configuration file to be used can be set with `KONG_SPEC_TEST_CONF_PATH`. It can be
|
|
accessed via helpers as `helpers.test_conf_path`.
|