Fix markdown header formatting

main
postscript-dev 3 years ago
parent 46c329081f
commit 559914d41d
No known key found for this signature in database
GPG Key ID: 285C4DA49C8FCF6D

@ -910,6 +910,7 @@ The Variable EXIV2\_PORT or EXIV2\_HTTP can be set to None to skip http tests.
[TOC](#TOC) [TOC](#TOC)
<div id="4-1"> <div id="4-1">
### 4.1 Running tests on Unix-like systems ### 4.1 Running tests on Unix-like systems
You can run tests directly from the build: You can run tests directly from the build:
@ -945,6 +946,7 @@ $
[TOC](#TOC) [TOC](#TOC)
<div id="4-2"> <div id="4-2">
### 4.2 Running tests on Visual Studio builds from cmd.exe ### 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: **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) [TOC](#TOC)
<div id="4-3"> <div id="4-3">
### 4.3 Unit Tests ### 4.3 Unit Tests
The code for the unit tests is in `<exiv2dir>/unitTests`. To include unit tests in the build, use the *cmake* option `-DEXIV2_BUILD_UNIT_TESTS=On`. The code for the unit tests is in `<exiv2dir>/unitTests`. To include unit tests in the build, use the *cmake* option `-DEXIV2_BUILD_UNIT_TESTS=On`.
@ -1014,6 +1017,7 @@ $ popd
[TOC](#TOC) [TOC](#TOC)
<div id="4-4"> <div id="4-4">
### 4.4 Bugfix Tests ### 4.4 Bugfix Tests
You can run the bugfix tests from the build directory: You can run the bugfix tests from the build directory:

@ -25,6 +25,7 @@
<div id="README-TESTS"/> <div id="README-TESTS"/>
# README-TESTS # README-TESTS
This test suite is intended for system tests, i.e. for running a binary with 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. line parameters.
<div id="running-the-test-suite"/> <div id="running-the-test-suite"/>
## Running the test suite ## Running the test suite
The test suite is written for Python 3 and is not compatible with Python 2, thus The test suite is written for Python 3 and is not compatible with Python 2, thus
@ -65,6 +67,7 @@ standard output.
[TOC](#TOC) [TOC](#TOC)
<div id="writing-new-tests"/> <div id="writing-new-tests"/>
## Writing new tests ## Writing new tests
The test suite is intended to run a binary and compare its standard output, 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) [TOC](#TOC)
<div id="test-suite"/> <div id="test-suite"/>
## Test suite ## Test suite
The test suite itself uses the builtin `unittest` module of Python to discover The test suite itself uses the builtin `unittest` module of Python to discover
@ -131,6 +135,7 @@ group test cases.
### Configuration ### Configuration
<div id="ini-style"/> <div id="ini-style"/>
#### INI style #### INI style
The test suite is configured via `INI` style files using Python's builtin 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) [TOC](#TOC)
<div id="parameters"/> <div id="parameters"/>
#### Parameters #### Parameters
The test suite's configuration file should have the following form: The test suite's configuration file should have the following form:
@ -276,6 +282,7 @@ variable names in Python.
[TOC](#TOC) [TOC](#TOC)
<div id="test-cases"/> <div id="test-cases"/>
### Test cases ### Test cases
The test cases are defined in Python source files utilizing the unittest module, 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) [TOC](#TOC)
<div id="multiline-strings"/> <div id="multiline-strings"/>
### Multiline strings ### Multiline strings
It is generally recommended to use Python's multiline strings (strings starting 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) [TOC](#TOC)
<div id="paths"/> <div id="paths"/>
### Paths ### Paths
Some test cases require the specification of paths (e.g. to the location of test 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) [TOC](#TOC)
<div id="advanced-test-cases"/> <div id="advanced-test-cases"/>
## Advanced test cases ## Advanced test cases
This section describes more advanced features that are probably not necessary This section describes more advanced features that are probably not necessary
@ -437,6 +447,7 @@ the "standard" usage of the test suite.
<div id="providing-standard-input-to-commands"/> <div id="providing-standard-input-to-commands"/>
### Providing standard input to commands ### Providing standard input to commands
The test suite supports providing a standard input to commands in a similar 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) [TOC](#TOC)
<div id="using-a-different-output-encoding"/> <div id="using-a-different-output-encoding"/>
### Using a different output encoding ### Using a different output encoding
The test suite will try to interpret the program's output as utf-8 encoded 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) [TOC](#TOC)
<div id="working-with-binary-output"/> <div id="working-with-binary-output"/>
### Working with binary output ### Working with binary output
Some programs output binary data directly to stdout or stderr. Such programs can 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) [TOC](#TOC)
<div id="creating-file-copies"/> <div id="creating-file-copies"/>
### Creating file copies ### Creating file copies
For tests that modify their input file it is useful to run these with a 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) [TOC](#TOC)
<div id="customizing-the-output-check"/> <div id="customizing-the-output-check"/>
### Customizing the output check ### Customizing the output check
Some tests do not require a "brute-force" comparison of the whole output of a 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) [TOC](#TOC)
<div id="running-all-commands-under-valgrind"/> <div id="running-all-commands-under-valgrind"/>
### Running all commands under valgrind ### Running all commands under valgrind
The test suite can run all commands under a memory checker like The test suite can run all commands under a memory checker like
@ -736,6 +752,7 @@ into account:
[TOC](#TOC) [TOC](#TOC)
<div id="manually-expanding-variables"/> <div id="manually-expanding-variables"/>
### Manually expanding variables in strings ### Manually expanding variables in strings
In case completely custom checks have to be run but one still wants to access 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) [TOC](#TOC)
<div id="hooks"/> <div id="hooks"/>
### Hooks ### Hooks
The `Case` class provides two hooks that are run after each command and after 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) [TOC](#TOC)
<div id="bash-test-cases"/> <div id="bash-test-cases"/>
## Bash test cases ## 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`. - 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`.

Loading…
Cancel
Save