Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(DEVELOPER.md): fix links to busted and luacheck #12373

Merged
merged 3 commits into from
Apr 8, 2024
Merged

docs(DEVELOPER.md): fix links to busted and luacheck #12373

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8105822
docs: fix links to busted and luacheck in DEVELOPER.md
jenstroeger Jan 19, 2024
e31d908
Update DEVELOPER.md
jschmid1 Apr 8, 2024
bd4baa2
Update DEVELOPER.md
jschmid1 Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions DEVELOPER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,13 +195,14 @@ might be in your system.

#### Tests

Install the development dependencies ([busted], [luacheck]) with:
Install the development dependencies ([busted](https://lunarmodules.github.io/busted/),
[luacheck](https://github.com/mpeterv/luacheck)) with:

```shell
make dev
```

Kong relies on three test suites using the [busted] testing library:
Kong relies on three test suites using the [busted](https://lunarmodules.github.io/busted/) testing library:

* Unit tests
* Integration tests, which require Postgres and Cassandra to be up and running
Expand Down Expand Up @@ -242,7 +243,8 @@ Consult the [run_tests.sh](.ci/run_tests.sh) script for more advanced example
usage of the test suites and the Makefile.

Finally, a very useful tool in Lua development (as with many other dynamic
languages) is performing static linting of your code. You can use [luacheck]
languages) is performing static linting of your code. You can use
[luacheck](https://github.com/mpeterv/luacheck)
\(installed with `make dev`\) for this:

```
Expand Down Expand Up @@ -294,7 +296,8 @@ as follows:
* NEW: The `new_after_finish` phase of all applicable migration tests
is run.

Upgrade tests are run using [busted]. To support the specific testing
Upgrade tests are run using [busted](https://github.com/lunarmodules/busted).
To support the specific testing
method of upgrade testing, a number of helper functions are defined in
the [spec/upgrade_helpers.lua](spec/upgrade_helpers.lua) module.
Migration tests use functions from this module to define test cases
Expand Down
Loading