XiboAPI-TestSuite

From Xibo

Create a test suite to test the Xibo REST API XiboAPI.

Contents 1 Architecture 2 Install Instructions 2.1 Linux 2.1.1 Ubuntu 10.04 2.2 Windows 2.2.1 Windows XP 3 Running the tests 3.1 Prerequisites 3.2 First Run 3.3 Subsequent Runs

Architecture

The test suite is written in Python and is based on the unittest module.

There is one file for each broad area of the system and there is one test method for each test scenario.

Install Instructions

Linux

Ubuntu 10.04

1. Install simplegeo's OAuth2 Library from this PPA: [1] 2. Download the test suite (Currently only in bzr branch at lp:~alexharrington/xibo/api-testsuite) 3. Download the test media files and extract into the core/api-testsuite/media folder (currently unavailable publically)

Windows

Windows XP

1. Download and install Python 2.6 [2]. Get the appropriate MSI and install.
2. Download ez_setup.py and run it "python ez_setup.py" to install setuptools.
3. Download and install the simplegeo OAuth2 Library
   1. Download the latest release [3]
   2. Unzip the file
   3. From a command prompt, change in to the directory you extracted and then run "python setup.py install"
   4. The install should complete sucessfully.
4. Download the test media files and extract into the core/api-testsuite/media folder (currently unavailable publically)

Running the tests

Prerequisites

• The test suite should be run against a newly installed Xibo server with no existing media, users, layouts etc besides those that ship with Xibo.
• You must run an appropriate version of the test suite for the server you're testing.

First Run

• Initially run the MiscTests.py test suite

python MiscTests.py

• You will be given a URL to visit at your Xibo server. Sign in as xibo_admin and then authorise the test suite to run as you.
• Once you've authorised the test suite, return to the test suite and press 'y' to continue.
• The tests will then run. Any additional users required will be created for you. You will be asked to sign in as them and authorise the client at several points as the test progresses. Ensure you follow the on screen instructions exactly.

Subsequent Runs

• Once your test suite has been authorised, subsequent runs should not require you to reauthorised the client, except where users are only temporarily created for a particular test.
• You can then run any of the test suites, or AllTests.py to run them all in turn.