Skip to content

Commit

Permalink
docs: fix links to busted and luacheck in DEVELOPER.md (#12373)
Browse files Browse the repository at this point in the history
* docs: fix links to busted and luacheck in DEVELOPER.md


---------

Co-authored-by: Joshua Schmid <joshua.schmid@konghq.com>
Co-authored-by: Vinicius Mignot <vinicius.mignot@gmail.com>
  • Loading branch information
3 people authored Apr 8, 2024
1 parent da28d30 commit bff6515
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions DEVELOPER.md
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

1 comment on commit bff6515

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bazel Build

Docker image available kong/kong:bff6515a7d8922bf0cc6345f2e1b14c201e098a1
Artifacts available https://github.com/Kong/kong/actions/runs/8600307324

Please sign in to comment.