4e3d6a5572d34d37422cfcfa968d79f0b03a7844
[yaffs-website] / vendor / lsolesen / pel / test / README.md
1 # README file for PEL Test Suite
2
3 The tests run automatically on each commit on TravisCI. Status for the
4 master branch is:
5
6 [![Build Status](https://secure.travis-ci.org/lsolesen/pel.png?branch=master)](http://travis-ci.org/lsolesen/pel)
7
8
9 ## PEL Test Suite
10
11 This directory holds the PHPUnit test suite for PEL. The test
12 suite consists of a number of core tests which exercise the basic
13 functionality of PEL.
14
15 In addition to the core tests, one can download a set of image tests.
16 These consist of example images taken from as many different camera
17 models as possible together with a test case that will ensure that PEL
18 can read the data in the image, and that it keeps interpreting the
19 data in the same way.  This ensures stability in the development
20 process by making sure that PEL keeps reading images in the same way.
21
22
23 ## Running the Test Suite
24
25 First the make sure PHPUnit is downloaded. You can do so in
26 the project's top directory via composer
27
28 ```bash
29 composer update
30 ```
31
32 Now from the top of the project, you can run
33
34 ```bash
35 phpunit
36 ```
37
38 ## Failing Tests
39
40 Should one or more of the tests fail, then first ensure that
41 SimpleTest is placed correctly so that run-tests.php can find it. If
42 everything seems correct, then please report the error to the PEL
43 developers:
44
45   https://github.com/lsolesen/pel/issues
46
47 Remember to include all the output in your bug report.