docs/development/testing.md

# 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.

Bats tests can be found here:
  ```
  tests/unit/*.bats
  ```

Example apps can be found here:
  ```
  tests/apps/
  ```

### Executing tests locally

- Setup dokku in a [vagrant vm](/dokku/getting-started/install/vagrant)
- Test setup and execution

  ```shell
  $ vagrant ssh
  $ sudo su -
  $ cd ~/dokku
  $ make ci-dependencies setup-deploy-tests
  $ make test  # execute the entire test suite (linter, bats tests, and app deployment tests)
  $
  $ make lint copyfiles # run linter & update vagrant dokku install from local git clone
  $ make unit-tests  # execute all bats tests
  $ make deploy-tests  # execute all app deployment 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.
[ci skip] document test suite 2015-03-27 14:24:04 -07:00			`# 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.`

			`Bats tests can be found here:`
			```
			`tests/unit/*.bats`
			```

			`Example apps can be found here:`
			```
			`tests/apps/`
			```

			`### Executing tests locally`

Standardize on "relative" doc links This will allow us to weather any future repository movements [ci skip] 2016-02-21 03:12:41 -05:00			`- Setup dokku in a [vagrant vm](/dokku/getting-started/install/vagrant)`
[ci skip] document test suite 2015-03-27 14:24:04 -07:00			`- Test setup and execution`

			```shell
			`$ vagrant ssh`
			`$ sudo su -`
			`$ cd ~/dokku`
			`$ make ci-dependencies setup-deploy-tests`
[ci skip] cleanup some language in test docs. add reference to copyfile target. closes #1833 2016-01-06 08:11:50 -08:00			`$ make test # execute the entire test suite (linter, bats tests, and app deployment tests)`
[ci skip] document test suite 2015-03-27 14:24:04 -07:00			`$`
[ci skip] cleanup some language in test docs. add reference to copyfile target. closes #1833 2016-01-06 08:11:50 -08:00			`$ make lint copyfiles # run linter & update vagrant dokku install from local git clone`
			`$ make unit-tests # execute all bats tests`
			`$ make deploy-tests # execute all app deployment tests`
[ci skip] document test suite 2015-03-27 14:24:04 -07:00			```
			`- Additionally you may run a specific app deployment tests with a target similar to:`

			```shell
[ci skip] cleanup some language in test docs. add reference to copyfile target. closes #1833 2016-01-06 08:11:50 -08:00			`$ make deploy-test-nodejs-express`
[ci skip] document test suite 2015-03-27 14:24:04 -07:00			```
			- For a full list of test make targets check out `tests.mk` in the root of the dokku repository.