1
0
mirror of https://github.com/pdf2htmlEX/pdf2htmlEX.git synced 2024-07-16 13:58:51 +00:00
pdf2htmlEX/test/README.md
2016-09-26 18:28:01 +02:00

35 lines
1.3 KiB
Markdown

### Dependencies
- python2 and packages
- Python Imaging Library
- Selenium
- unittest
- Firefox
- firefoxdriver
### Usage
- Run all tests:
- python test_output.py
- python test_local_browser.py
- Environment variables:
- `export P2H_TEST_GEN=1` to generate new reference files (when done, `unset P2H_TEST_GEN`)
- `export P2H_TEST_REMOTE=1` to test different browsers using Sauce Labs
- Install `sauceclient` for Python
- Set correct values for `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY`
- Setup a HTTP server at `/` on port 8000
- Enable Sauce Connect
- See `.travis.yml` as an example
- python test_remote_browser.py
### Add new test cases
- Make sure you have the proper copyrights.
- Using meaningful file names, a description of the file, or issueXXX.pdf.
- Make each test case minimal:
- One page only, unless the test case is about multiple pages.
- Grayscale only, unless the test case is about colors.
- Remove unnecessary elements.
- [Optional] Include the source files that the PDF file is generated from.
- Add the new PDF file to the correct folder in `test/`, and add a new function in the corresponding Python file
- Run `P2H_TEST_GEN=1 test/test.py test_issueXXX` to generate the reference, assuming that the new function is called `test_issueXXX`