Testing¶
Test Suite¶
API Umbrella’s test suite uses Ruby’s minitest. All tests are located in the test
directory. Tests are separated into these areas:
test/admin_ui
: Browser-based tests for theadmin-ui
component using Capybara.test/apis
: HTTP tests for the internal APIs provided by API Umbrella.test/processes
: Testing the behavior of API Umbrella’s server processes.test/proxy
: Testing the behavior of API Umbrella’s proxy features.test/testing_sanity_checks
: Tests to sanity check certain behaviors of the overall test suite.
Running Tests¶
Assuming you have a Docker development environment, you can run all the tests with:
docker-compose run --rm app make test
Running Individual Tests¶
If you’d like to run individual tests, rather than all the tests, there are a few different ways to do that:
docker-compose run --rm app bundle exec minitest test/apis/v1/admins/test_create.rb