diff --git a/README.md b/README.md index 72db7c00..fd3222f8 100644 --- a/README.md +++ b/README.md @@ -910,6 +910,7 @@ The Variable EXIV2\_PORT or EXIV2\_HTTP can be set to None to skip http tests. [TOC](#TOC)
+ ### 4.1 Running tests on Unix-like systems You can run tests directly from the build: @@ -945,6 +946,7 @@ $ [TOC](#TOC)
+ ### 4.2 Running tests on Visual Studio builds from cmd.exe **Caution:** _The python3 interpreter must be on the PATH, build for DOS, and called python3.exe._ I copied the python.exe program: @@ -995,6 +997,7 @@ set EXIV2_PORT= [TOC](#TOC)
+ ### 4.3 Unit Tests The code for the unit tests is in `/unitTests`. To include unit tests in the build, use the *cmake* option `-DEXIV2_BUILD_UNIT_TESTS=On`. @@ -1014,6 +1017,7 @@ $ popd [TOC](#TOC)
+ ### 4.4 Bugfix Tests You can run the bugfix tests from the build directory: diff --git a/tests/README-TESTS.md b/tests/README-TESTS.md index 41655834..702cb23a 100644 --- a/tests/README-TESTS.md +++ b/tests/README-TESTS.md @@ -25,6 +25,7 @@
+ # README-TESTS This test suite is intended for system tests, i.e. for running a binary with @@ -34,6 +35,7 @@ of new features where unit testing is not feasible, e.g. to test new command line parameters.
+ ## Running the test suite The test suite is written for Python 3 and is not compatible with Python 2, thus @@ -65,6 +67,7 @@ standard output. [TOC](#TOC)
+ ## Writing new tests The test suite is intended to run a binary and compare its standard output, @@ -112,6 +115,7 @@ When creating new tests, follow roughly these steps: [TOC](#TOC)
+ ## Test suite The test suite itself uses the builtin `unittest` module of Python to discover @@ -131,6 +135,7 @@ group test cases. ### Configuration
+ #### INI style The test suite is configured via `INI` style files using Python's builtin @@ -181,6 +186,7 @@ some_var:some value with whitespaces before and after [TOC](#TOC)
+ #### Parameters The test suite's configuration file should have the following form: @@ -276,6 +282,7 @@ variable names in Python. [TOC](#TOC)
+ ### Test cases The test cases are defined in Python source files utilizing the unittest module, @@ -363,6 +370,7 @@ writing 0 ten times. The same is of course possible for strings. [TOC](#TOC)
+ ### Multiline strings It is generally recommended to use Python's multiline strings (strings starting @@ -401,6 +409,7 @@ character. To achieve that put the `"""` on the following line. [TOC](#TOC)
+ ### Paths Some test cases require the specification of paths (e.g. to the location of test @@ -430,6 +439,7 @@ class AnInformativeName(metaclass=CaseMeta): [TOC](#TOC)
+ ## Advanced test cases This section describes more advanced features that are probably not necessary @@ -437,6 +447,7 @@ the "standard" usage of the test suite.
+ ### Providing standard input to commands The test suite supports providing a standard input to commands in a similar @@ -483,6 +494,7 @@ test suite will implicitly assume `None` for every command. [TOC](#TOC)
+ ### Using a different output encoding The test suite will try to interpret the program's output as utf-8 encoded @@ -526,6 +538,7 @@ encodings can be found [TOC](#TOC)
+ ### Working with binary output Some programs output binary data directly to stdout or stderr. Such programs can @@ -595,6 +608,7 @@ and your test case will get only the specified environment variables. [TOC](#TOC)
+ ### Creating file copies For tests that modify their input file it is useful to run these with a @@ -636,6 +650,7 @@ deleted. Please note that variable expansion in the filenames is possible. [TOC](#TOC)
+ ### Customizing the output check Some tests do not require a "brute-force" comparison of the whole output of a @@ -694,6 +709,7 @@ class AnInformativeName(metaclass=system_tests.CaseMeta): [TOC](#TOC)
+ ### Running all commands under valgrind The test suite can run all commands under a memory checker like @@ -736,6 +752,7 @@ into account: [TOC](#TOC)
+ ### Manually expanding variables in strings In case completely custom checks have to be run but one still wants to access @@ -791,6 +808,7 @@ will result in `another_string` being "foo" and not "bar". [TOC](#TOC)
+ ### Hooks The `Case` class provides two hooks that are run after each command and after @@ -848,6 +866,7 @@ class AnInformativeName(metaclass=system_tests.CaseMeta): [TOC](#TOC)
+ ## Bash test cases - Previously, Exiv2 had some bash test scripts, which were saved as the file `EXIV2_DIR/test/*.sh`. We're going to rewrite them as Python test scripts and save them to the directory `EXIV2_DIR/tests/bash_tests`.