opensource/galaxy
3
0
Fork 0
mirror of https://github.com/galaxyproject/galaxy.git synced 2026-09-24 16:30:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

Link to some recently filled out pydocs from sphinx testing docs.

Browse Source
This commit is contained in:
John Chilton
2021-01-18 17:24:28 -05:00
parent 5661e0db9f
commit 422d48bce1
1 changed files with 25 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/source/dev/writing_tests.md
+25 -10
View File
@@ -222,24 +222,33 @@ This test file shows a fairly typical API test. It demonstrates the basic
structure of a test, how to ``GET`` and ``POST`` against the API, and how to use
both typical user and admin user-only functionality.
### Populating Test Data with ``lib/galaxy_test/base/populators.py``
### Common Code for Populating Fixture Data
The ``test_roles.py`` example above also creates a ``DatasetPopulator``
The [``galaxy_test.base.populators``](../lib/galaxy_test.base.html#module-galaxy_test.base.populators) module contains detailed docstrings
describing the concept and implementation of "Populators" that can be used
for this purposes.
The ``test_roles.py`` example creates a ``DatasetPopulator``
object that it uses to get some common information from the configured
Galaxy server under test. Populators are used extensively throughout
API tests as well as integration and Selenium tests to both populate
data to test (histories, workflows, collections, libraries, etc..)
as well as access information from the Galaxy server (e.g. fetch
information from datasets, users, Galaxy's configuration, etc.).
Galaxy server under test.
Populators are used extensively throughout API tests as well as integration
and Selenium tests to both populate data to test (histories, workflows,
collections, libraries, etc..) as well as access information from the
Galaxy server (e.g. fetch information from datasets, users, Galaxy's
configuration, etc.).
Populators and API tests in general make heavy use of the [requests
library](https://requests.readthedocs.io/en/master/) for Python.
### API Test Assertions
There is a module with common assertions ``galaxy_test.base.api_asserts``
used to check API request status codes, dictionary content, and Galaxy
specific error messages.
The ``galaxy_test.base.api_asserts`` module contains common
assertion functions used to check API request status codes, dictionary
content, and Galaxy specific error messages.
See [``galaxy_test.base.api_asserts`` documentation](../lib/galaxy_test.base.html#module-galaxy_test.base.api_asserts)
for details on each function and information on verifying Galaxy API error codes.
### Continuous Integration
@@ -340,6 +349,12 @@ GitHub actions workflow definition for these tests is located in
These are full stack tests meant to test the Galaxy UI with real
browsers and are located in ``lib/galaxy_test/selenium``.
### Jupyter + Selenium
Jupyter can leveraged to develop Selenium test cases interactively,
checkout out the [``galaxy_test.selenium.jupyter``](../lib/galaxy_test.selenium.jupyter)
for more a full discussion of this.
### Continuous Integration
The Selenium tests are run against each pull request to Galaxy using