README.md

SVG tests

This directory contains a collection of SVG files used during resvg regression testing.

Adding a new test

Select a correct name

Each test has a type-name-index.svg format.

• type can be either an a(attribute) or an e(element)
• name corresponds to an actual SVG attribute or element
• index is just a serial number

Create an SVG file

We are using SVG files with a fixed, 200x200 viewbox for all tests.

Here is a test file template:

<svg id="svg1" viewBox="0 0 200 200" xmlns="http://www.w3.org/2000/svg">
    <title>My new test</title>

    <!-- replace with an actual SVG data -->

    <!-- image frame -->
    <rect id="frame" x="1" y="1" width="198" height="198" fill="none" stroke="black"/>
</svg>

General requirements:

1. Each test must test only a single issue.
2. Each element must have an id attribute.
3. The title value must be unique and shorter than 60 characters.
   Newlines are not allowed.
4. Each line in an XML file should be less than 100 characters.
5. No trailing spaces.
6. A single trailing newline.
7. UTF-8 only.

You could use the check.py script to automatically check those requirements.

Render PNG

After the SVG test is finished, you should render it using resvg:

cargo run --release -- \
    --width 300 \
    --skip-system-fonts \
    --use-fonts-dir 'tests/fonts' \
    --font-family 'Noto Sans' \
    --serif-family 'Noto Serif' \
    --sans-serif-family 'Noto Sans' \
    --cursive-family 'Yellowtail' \
    --fantasy-family 'Sedgwick Ave Display' \
    --monospace-family 'Noto Mono' \
    in.svg out.png

(we are using 300px width to test scaling)

After that, you should optimize the resulting PNG using oxipng:

cargo install oxipng
oxipng -o 6 -Z out.png

And then place it into the png dir.

resvg tests vs resvg-test-suite tests

resvg tests are stored in two repos: this one and in resvg-test-suite. Which can be a bit confusing.

resvg-test-suite is the source of truth. It contains the latest version of the tests and intended to help people with writing SVG processing apps. resvg/tests/svg directory contains the exact copy of resvg-test-suite/svg, maybe a bit outdated at times. The major difference is png directories. resvg-test-suite/png contains reference image. This is how the SVG files should be rendered. While resvg/tests/png contains PNGs rendered by the resvg itself and used only for regression testing.

License

MIT

The library itself is under the MPL2.0, but tests are under MIT, so you can do whatever you want with them.