github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Cleaning testing docs

Browse Source 
- Simplify test location documentation
- Add documentation surrounding our existing CI environment
- Dedent items that shouldn't be in a list

[ci skip]
This commit is contained in:
Jose Diaz-Gonzalez
2016-07-30 16:51:31 -04:00
parent edd7c3c248
commit 60a44c88af
2 changed files with 22 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/development/testing.md
View File

@@ -1,21 +1,24 @@
# Dokku test suite
Dokku now has a full test suite to assist in quick iterating development. These tests include a linter using [shellcheck](https://github.com/koalaman/shellcheck), functional unit tests using the [bats testing framework](https://github.com/sstephenson/bats), and a deployment suite of example apps that use the most popular languages and frameworks.
Dokku has a full test suite to assist in quick iterating development. These tests include a linter using [shellcheck](https://github.com/koalaman/shellcheck), functional unit tests using the [bats testing framework](https://github.com/sstephenson/bats), and a deployment suite of example apps that use the most popular languages and frameworks.
Bats tests can be found here:
```
tests/unit/*.bats
```
We maintain the Dokku test harness within the `tests` directory:
Example apps can be found here:
```
tests/apps/
```
- `tests/unit/*.bats`: Bats tests
- `tests/apps/`: Example applications that can be used for tests
### Executing tests locally
## Continuous Integration
All pull requests have tests run against them on [CircleCI](https://circleci.com/), a continuous integration platform that provides Docker support for Ubuntu Trusty 14.04.
If you wish to skip tests for a particular commit - e.g. Documentation changes - you may add the `[ci skip]` designator to your commit message. Commits that *should* be tested but have the above designator will not be merged.
While we do provide official packages for a variety of platforms, as our test suite currently runs on Ubuntu Trusty 14.04, we only provide official installation support for that platform.
## Local Test Execution
- Setup dokku in a [vagrant vm](/dokku/getting-started/install/vagrant)
- Test setup and execution
- Run the following to setup tests and execute them:
```shell
vagrant ssh
@@ -35,9 +38,11 @@ Example apps can be found here:
# execute all app deployment tests
make deploy-tests
```
- Additionally you may run a specific app deployment tests with a target similar to:
```shell
$ make deploy-test-nodejs-express
```
- For a full list of test make targets check out `tests.mk` in the root of the dokku repository.
Additionally you may run a specific app deployment tests with a target similar to:
```shell
make deploy-test-nodejs-express
```
For a full list of test make targets check out `tests.mk` in the root of the dokku repository.