Feature: Updated TESTING instructions.

Future TODO: Make .py test-files executable without polluting machine environment.
(AKA: Through a virtualenv permit `import toml` without raising `ImportError`).
This commit is contained in:
x10an14 2017-05-17 13:42:18 +02:00
parent d31bcc796e
commit e15fb80060
2 changed files with 18 additions and 1 deletions

View File

@ -1 +0,0 @@
There is a toml_test.py script which acts as a harness in order to allow toml to be used with [BurntSushi's toml test suite](https://github.com/BurntSushi/toml-test), written in Go. Usage means installing go, the toml-test suite and running the toml-test go binary with toml_test.py as its argument. Modification of tests should happen in BurntSushi's repository. For testing python3 (rather than python2), the toml_test3.py script should be used instead.

18
TESTING.md Normal file
View File

@ -0,0 +1,18 @@
# Testing
There is a `toml_test.py` script which acts as a harness in order to allow toml to be used with [BurntSushi's toml test suite](https://github.com/BurntSushi/toml-test), written in Go.
## Usage
1. Install Go (golang)
2. The toml-test suite
1. [Instructions](https://github.com/BurntSushi/toml-test#try-it-out)
3. Execute with either of:
* `~/go/bin/toml-test ./tests/decoding_test.sh` - Default (PATH) Python version
* `~/go/bin/toml-test ./tests/decoding_test2.sh` - Python 2
* `~/go/bin/toml-test ./tests/decoding_test3.sh` - Python 3
## Addendum
There's also two Python test-files in the `./tests` directory
* `example_test.py`,
* and `decoding_test.py`.
Both of which require the `toml` library to be importable (aka `import toml` to work).