Updated test documentation
This commit is contained in:
sneakypete81
parent
d3a4036817
commit
2147b41383
2 changed files with 125 additions and 91 deletions
|
|
@ -1,101 +1,31 @@
|
|||
Tests for the Open Photo API / Python Library
|
||||
Tests for the OpenPhoto/Trovebox Python Library
|
||||
=======================
|
||||
#### OpenPhoto, a photo service for the masses
|
||||
|
||||
The openphoto-python tests are split into two categories:
|
||||
|
||||
###Unit Tests
|
||||
|
||||
The unit tests mock out all HTTP requests, and verify that the various
|
||||
components of the library are operating correctly.
|
||||
|
||||
They run very quickly, and don't require any external test hosts.
|
||||
|
||||
----------------------------------------
|
||||
<a name="requirements"></a>
|
||||
### Requirements
|
||||
A computer, Python and an empty OpenPhoto test host.
|
||||
#### Requirements
|
||||
* mock >= 1.0.0
|
||||
* httpretty >= 0.6.1
|
||||
|
||||
---------------------------------------
|
||||
<a name="setup"></a>
|
||||
### Setting up
|
||||
#### Running the tests
|
||||
To run the unit tests:
|
||||
|
||||
Create a ``~/.config/openphoto/test`` config file containing the following:
|
||||
python -m unittest discover tests/unit
|
||||
|
||||
# ~/.config/openphoto/test
|
||||
host = your.host.com
|
||||
consumerKey = your_consumer_key
|
||||
consumerSecret = your_consumer_secret
|
||||
token = your_access_token
|
||||
tokenSecret = your_access_token_secret
|
||||
###Functional Tests
|
||||
|
||||
Make sure this is an empty test server, **not a production OpenPhoto server!!!**
|
||||
The functional tests check that the openphoto-python library interoperates
|
||||
correctly with a real OpenPhoto/Trovebox server.
|
||||
|
||||
You can specify an alternate test config file with the following environment variable:
|
||||
They are slow to run, and rely on a stable HTTP connection to a test server.
|
||||
|
||||
export OPENPHOTO_TEST_CONFIG=test2
|
||||
|
||||
---------------------------------------
|
||||
<a name="running"></a>
|
||||
### Running the tests
|
||||
|
||||
The following instructions are for Python 2.7. You can adapt them for earlier
|
||||
Python versions using the ``unittest2`` package.
|
||||
|
||||
cd /path/to/openphoto-python
|
||||
python -m unittest discover -c
|
||||
|
||||
The "-c" lets you stop the tests gracefully with \[CTRL\]-c.
|
||||
|
||||
The easiest way to run a subset of the tests is with the ``nose`` package:
|
||||
|
||||
cd /path/to/openphoto-python
|
||||
nosetests -v -s --nologcapture tests/test_albums.py:TestAlbums.test_view
|
||||
|
||||
All HTTP requests and responses are recorded in the file ``tests.log``.
|
||||
|
||||
You can enable more verbose output to stdout with the following environment variable:
|
||||
|
||||
export OPENPHOTO_TEST_DEBUG=1
|
||||
|
||||
---------------------------------------
|
||||
<a name="test_details"></a>
|
||||
### Test Details
|
||||
|
||||
These tests are intended to verify the openphoto-python library.
|
||||
They don't provide comprehensive testing of the OpenPhoto API,
|
||||
there are PHP unit tests for that.
|
||||
|
||||
Each test class is run as follows:
|
||||
|
||||
**SetUpClass:**
|
||||
|
||||
Check that the server is empty
|
||||
|
||||
**SetUp:**
|
||||
|
||||
Ensure there are:
|
||||
|
||||
* Three test photos
|
||||
* A single test tag applied to each
|
||||
* A single album containing all three photos
|
||||
|
||||
**TearDownClass:**
|
||||
|
||||
Remove all photos, tags and albums
|
||||
|
||||
### Testing old servers
|
||||
|
||||
By default, all currently supported API versions will be tested.
|
||||
It's useful to test servers that only support older API versions.
|
||||
To restrict the testing to a specific maximum API version, use the
|
||||
``OPENPHOTO_TEST_SERVER_API`` environment variable.
|
||||
|
||||
For example, to restrict testing to APIv1 and APIv2:
|
||||
|
||||
export OPENPHOTO_TEST_SERVER_API=2
|
||||
|
||||
<a name="full_regression"></a>
|
||||
### Full Regression Test
|
||||
|
||||
The ``run_tests`` script uses the ``tox`` package to run a full regression across:
|
||||
* Multiple Python versions
|
||||
* All supported API versions
|
||||
|
||||
To use it, you must set up multiple OpenPhoto instances and create the following
|
||||
config files containing your credentials:
|
||||
|
||||
test : Latest self-hosted site
|
||||
test-apiv1 : APIv1 self-hosted site
|
||||
test-hosted : Credentials for test account on trovebox.com
|
||||
For full details, see the [functional test README file](functional/README.markdown).
|
||||
|
|
|
|||
104
tests/functional/README.markdown
Normal file
104
tests/functional/README.markdown
Normal file
|
|
@ -0,0 +1,104 @@
|
|||
Functional Tests for the OpenPhoto/Trovebox Python Library
|
||||
=======================
|
||||
|
||||
These functional tests check that the openphoto-python library interoperates
|
||||
correctly with a real OpenPhoto/Trovebox server.
|
||||
|
||||
They are slow to run, and require a stable HTTP connection to a test server.
|
||||
|
||||
----------------------------------------
|
||||
<a name="requirements"></a>
|
||||
### Requirements
|
||||
A computer, Python and an empty OpenPhoto/Trovebox test host.
|
||||
|
||||
---------------------------------------
|
||||
<a name="setup"></a>
|
||||
### Setting up
|
||||
|
||||
Create a ``~/.config/openphoto/test`` config file containing the following:
|
||||
|
||||
# ~/.config/openphoto/test
|
||||
host = your.host.com
|
||||
consumerKey = your_consumer_key
|
||||
consumerSecret = your_consumer_secret
|
||||
token = your_access_token
|
||||
tokenSecret = your_access_token_secret
|
||||
|
||||
Make sure this is an empty test server, **not a production OpenPhoto server!!!**
|
||||
|
||||
You can specify an alternate test config file with the following environment variable:
|
||||
|
||||
export OPENPHOTO_TEST_CONFIG=test2
|
||||
|
||||
---------------------------------------
|
||||
<a name="running"></a>
|
||||
### Running the tests
|
||||
|
||||
The following instructions are for Python 2.7. You can adapt them for earlier
|
||||
Python versions using the ``unittest2`` package.
|
||||
|
||||
cd /path/to/openphoto-python
|
||||
python -m unittest discover -c
|
||||
|
||||
The "-c" lets you stop the tests gracefully with \[CTRL\]-c.
|
||||
|
||||
The easiest way to run a subset of the tests is with the ``nose`` package:
|
||||
|
||||
cd /path/to/openphoto-python
|
||||
nosetests -v -s --nologcapture tests/test_albums.py:TestAlbums.test_view
|
||||
|
||||
All HTTP requests and responses are recorded in the file ``tests.log``.
|
||||
|
||||
You can enable more verbose output to stdout with the following environment variable:
|
||||
|
||||
export OPENPHOTO_TEST_DEBUG=1
|
||||
|
||||
---------------------------------------
|
||||
<a name="test_details"></a>
|
||||
### Test Details
|
||||
|
||||
These tests are intended to verify the openphoto-python library.
|
||||
They don't provide comprehensive testing of the OpenPhoto API,
|
||||
there are PHP unit tests for that.
|
||||
|
||||
Each test class is run as follows:
|
||||
|
||||
**SetUpClass:**
|
||||
|
||||
Check that the server is empty
|
||||
|
||||
**SetUp:**
|
||||
|
||||
Ensure there are:
|
||||
|
||||
* Three test photos
|
||||
* A single test tag applied to each
|
||||
* A single album containing all three photos
|
||||
|
||||
**TearDownClass:**
|
||||
|
||||
Remove all photos, tags and albums
|
||||
|
||||
### Testing old servers
|
||||
|
||||
By default, all currently supported API versions will be tested.
|
||||
It's useful to test servers that only support older API versions.
|
||||
To restrict the testing to a specific maximum API version, use the
|
||||
``OPENPHOTO_TEST_SERVER_API`` environment variable.
|
||||
|
||||
For example, to restrict testing to APIv1 and APIv2:
|
||||
|
||||
export OPENPHOTO_TEST_SERVER_API=2
|
||||
|
||||
<a name="full_regression"></a>
|
||||
### Full Regression Test
|
||||
|
||||
The ``run_functional_tests`` script runs a full regression across
|
||||
all supported API versions.
|
||||
|
||||
To use it, you must set up multiple OpenPhoto instances and create the following
|
||||
config files containing your credentials:
|
||||
|
||||
test : Latest self-hosted site
|
||||
test-apiv1 : APIv1 self-hosted site
|
||||
test-hosted : Credentials for test account on trovebox.com
|
||||
Loading…
Add table
Add a link
Reference in a new issue