Couchbase travel-sample Application REST test-suite

This is the test suite for the REST backend of the travel-sample apps. In the near future you will run the tests from each travel-sample app, which will then create this tester.

For now, see below for how to run from this repo.

Prerequisites

To download the test suite you can either download the archive or clone the repository:

git clone https://github.com/couchbaselabs/try-cb-test.git

We recommend running tests with Docker, which starts up all components for you.

Running the tests with Docker

You will need Docker installed on your machine in order to run this application as we have defined a Dockerfile and a docker-compose.yml to run Couchbase Server 7.0.0 and one of the backend REST APIs.

Test all backends

To test all the backends, you can simply run this command from a terminal:

$ ./test-all-backends.bash

This will set up Docker instances for the Couchbase server, and each backend in turn, in order to test them all.

Test one backend

Set the variable TRY_CB_BACKEND for the backend you want to test. This must match the name of the project, so for example to test try-cb-golang you would type.

$ export TRY_CB_BACKEND=golang
$ docker-compose up test

You will get output along the following lines:

Creating network "try-cb-test_default" with the default driver
Creating test-couchbase-sandbox-7.0.0 ... done
Creating test-try-cb-api              ... done
Creating try-cb-test_test_1           ... done
Attaching to try-cb-test_test_1
test_1     | wait-for-it: waiting 400 seconds for backend:8080
test_1     | wait-for-it: backend:8080 is available after 79 seconds
test_1     | 1..3
test_1     | ok 1 /api/airports
test_1     | ok 2 /api/flightPaths/{fromloc}/{toloc}
test_1     | ok 3 /api/hotels/{description}/{location}/
try-cb-test_test_1 exited with code 0

NOTE: After the tests exit, the database and backend server will still be running. To turn them off, run:

$ docker-compose down -v

Running the tests locally

You can start a REST server via Docker with, for example:

$ export TRY_CB_BACKEND=python
$ docker-compose up backend

However, in most cases, you would be working with a checkout of the backend project, and running it locally in "mix-and-match" style as documented, for example at https://github.com/couchbaselabs/try-cb-python#running-the-backend-manually

Then install bats with:

$ npm install
$ npm install -g bats

If your server is not running on the default localhost:8080, you can set an environment variable:

# Example only
$ BACKEND_BASE_URL=http://node1.example.com:8080

And run the tests with:

$ bats travel-sample-backend.bats