Skip to content

Latest commit

 

History

History
81 lines (60 loc) · 3.55 KB

integration-testing.md

File metadata and controls

81 lines (60 loc) · 3.55 KB

Integration Testing

The integration tests run inside a Docker container. An associated ssh tunnel proxies elastic search requests into KBase. This tunnel is also run in a container. To ease the process of coordinating the startup of these containers, the are scripted in a docker-compose config file.

Build the images

Although the integration test script will build the images if they are missing, the build can take a few minutes, which may cause the integration test script to time out. It is more reliable to simply build the containers first.

make build-integration-test-images

You can view the files container.out and container.err to monitor progress building the images.

Run the integration tests

First you'll need to set up the required test parameters, which are provided as shell environment variables. How you provide them is up to you, but it is probably easiest (especially for test iteration) to export them:

export WS_TOKEN="<LOGIN TOKEN FOR TEST USER>"
export IP="<KBASE ES HOST>"
export SHHOST="<KBASE SSH HOST>"
export SSHUSER="<DEV ACCOUNT USERNAME>"
export SSHPASS="<DEV ACCOUNT PASSWORD>"

Note: For now the "test user" is kbaseuitest. As a kbase-ui dev for the password or a token.

TODO: We should establish a searchtest user, use it to create some narratives with data for indexing, and use that account for integration testing.

Running the tests is as simple as:

make integration-Tests

The default logging level is "DEBUG" which can emit an annoying level of messages interspersed with test results. I prefer to run the tests like:

LOGLEVEL=ERROR make integration-tests

If all goes well you should see something like:

(venv) erikpearson@Eriks-MBP-2 search_api2 % LOGLEVEL=ERROR make integration-tests
Running Integraion Tests...
sh scripts/run_integration_tests
+ path=tests/integration
+ export PYTHONPATH=.
+ PYTHONPATH=.
+ poetry run pytest -vv -s tests/integration
=================================================== test session starts ===================================================
platform darwin -- Python 3.7.9, pytest-5.4.3, py-1.9.0, pluggy-0.13.1 -- /Users/erikpearson/work/kbase/sprints/2020Q4/fixes/fix_search_api2_legacy/search_api2/venv/bin/python
cachedir: .pytest_cache
rootdir: /Users/erikpearson/work/kbase/sprints/2020Q4/fixes/fix_search_api2_legacy/search_api2
plugins: cov-2.10.1
collecting ... Logger and level: <Logger search2 (ERROR)>

** To see more or less logging information, adjust the
** log level with the LOGLEVEL environment variable set
** to one of:
**   CRITICAL ERROR WARNING INFO DEBUG NOTSET
** It is currently set to:
**   ERROR

collected 9 items                                                                                                         

tests/integration/test_integration_legacy.py::test_search_example1 PASSED
tests/integration/test_integration_legacy.py::test_search_example2 PASSED
tests/integration/test_integration_legacy.py::test_search_example3 PASSED
tests/integration/test_integration_legacy.py::test_search_example4 PASSED
tests/integration/test_integration_legacy.py::test_search_example5 PASSED
tests/integration/test_integration_legacy.py::test_search_example6 PASSED
tests/integration/test_integration_legacy.py::test_search_case1 PASSED
tests/integration/test_integration_search_workspaces.py::test_narrative_example PASSED
tests/integration/test_integration_search_workspaces.py::test_dashboard_example PASSED

=================================================== 9 passed in 24.27s ====================================================