summaryrefslogtreecommitdiff
path: root/tests
diff options
context:
space:
mode:
authorSimon Hausmann <simon.hausmann@qt.io>2019-05-24 13:38:31 +0200
committerSimon Hausmann <simon.hausmann@qt.io>2019-05-24 14:01:04 +0200
commita21cf52e101ad50c330ad0b42416cc83318afea7 (patch)
tree8bab9b45166dd490ac7badfd81f13a726bb6621d /tests
parent1983ba1de3d4ffec65fcfbd74328963afb2c57c1 (diff)
downloadqtsvg-a21cf52e101ad50c330ad0b42416cc83318afea7.tar.gz
Add little helper program for finding visual regressions
Change-Id: I0b6c7a7d82d64011fb9b1e2aea5ff0552c719f54 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Diffstat (limited to 'tests')
-rw-r--r--tests/manual/rendertestsuite/.gitignore2
-rw-r--r--tests/manual/rendertestsuite/README32
-rw-r--r--tests/manual/rendertestsuite/main.cpp139
-rw-r--r--tests/manual/rendertestsuite/rendertestsuite.pro3
4 files changed, 176 insertions, 0 deletions
diff --git a/tests/manual/rendertestsuite/.gitignore b/tests/manual/rendertestsuite/.gitignore
new file mode 100644
index 0000000..54f7094
--- /dev/null
+++ b/tests/manual/rendertestsuite/.gitignore
@@ -0,0 +1,2 @@
+baseline
+difference
diff --git a/tests/manual/rendertestsuite/README b/tests/manual/rendertestsuite/README
new file mode 100644
index 0000000..0609d4f
--- /dev/null
+++ b/tests/manual/rendertestsuite/README
@@ -0,0 +1,32 @@
+This little helper program can be used together with the SVG Tiny 1.2 test
+suite to determine the visual impact of changes to the renderer on the basis of
+the test suite.
+
+Suppose you have the test suite installed in ~/tests, then you can create a
+base line of renderings of all the SVG images by running
+
+ mkdir baseline
+ ./rendertestsuite create-baseline ~/tests
+
+and the output will be stored in the 'baseline/' sub-directory.
+
+After making changes to the renderer, you can create a new set of images by running
+
+ mkdir difference
+ ./rendertestsuite diff ~/tests
+
+and side-by-side images of the old and the new images in case they differ will
+be stored in the sub-directory 'difference/'.
+
+An easy way to inspect the output is by using KDE's gwenview:
+
+ gwenview difference/
+
+
+Note that due to rounding errors there will always be subtle differences, even
+when not doing any changes to the renderer.
+
+
+You can find the test suite at
+
+ https://www.w3.org/Graphics/SVG/WG/wiki/Test_Suite_Overview#SVG_1.2_Tiny_Test_Suite:_12_September_2008
diff --git a/tests/manual/rendertestsuite/main.cpp b/tests/manual/rendertestsuite/main.cpp
new file mode 100644
index 0000000..dfdf88c
--- /dev/null
+++ b/tests/manual/rendertestsuite/main.cpp
@@ -0,0 +1,139 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt SVG module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QtCore>
+#include <QtSvg>
+#include <QtGui>
+#include <stdlib.h>
+
+static QImage render(const QString &filePath)
+{
+ fprintf(stdout, "Rendering %s\n", qPrintable(filePath));
+ QSvgRenderer renderer(filePath);
+ if (!renderer.isValid()) {
+ fprintf(stderr, "Could not load SVG file %s\n", qPrintable(filePath));
+ return QImage();
+ }
+ QImage image(480, 360, QImage::Format_ARGB32);
+ image.fill(Qt::transparent);
+ {
+ QPainter p(&image);
+ renderer.render(&p);
+ }
+ return image;
+}
+
+int main(int argc, char **argv)
+{
+ QGuiApplication app(argc, argv);
+
+ QCommandLineParser parser;
+ parser.addHelpOption();
+ parser.addPositionalArgument(QLatin1String("command"), QLatin1String("[create-baseline,diff]"));
+ parser.addPositionalArgument(QLatin1String("path-to-svg-testsuite"), QLatin1String("Path to the svg/ sub-directory of the test suite"));
+
+ parser.process(app);
+
+ const auto args = parser.positionalArguments();
+
+ if (args.count() != 2) {
+ parser.showHelp(EXIT_FAILURE);
+ return EXIT_FAILURE; // never reached
+ }
+
+ const QString commandAsString = args.at(0);
+ const QString sourcePath = args.at(1);
+
+ QDirIterator sourceFileIterator(sourcePath, QStringList(QLatin1String("*.svg")), QDir::Files);
+ const QString baselinePath = "baseline";
+
+ const auto referenceFilePath = [baselinePath](const QFileInfo &testCaseFileInfo) -> QString {
+ return baselinePath + QLatin1Char('/') + testCaseFileInfo.baseName() + QLatin1String(".png");
+ };
+
+ if (commandAsString == "create-baseline") {
+ while (sourceFileIterator.hasNext()) {
+ sourceFileIterator.next();
+
+ QImage image = render(sourceFileIterator.filePath());
+ if (image.isNull())
+ return EXIT_FAILURE;
+ QString outputFileName = referenceFilePath(sourceFileIterator.fileInfo());
+ if (!image.save(outputFileName)) {
+ fprintf(stderr, "Could not save PNG file %s\n", qPrintable(outputFileName));
+ return EXIT_FAILURE;
+ }
+ }
+ } else if (commandAsString == "diff") {
+ while (sourceFileIterator.hasNext()) {
+ sourceFileIterator.next();
+
+ QImage actual = render(sourceFileIterator.filePath());
+ const QString referencePath = referenceFilePath(sourceFileIterator.fileInfo());
+ QImage reference;
+ if (!reference.load(referencePath)) {
+ fprintf(stderr, "Could not load reference file %s\n", qPrintable(referencePath));
+ return EXIT_FAILURE;
+ }
+
+ if (actual == reference)
+ continue;
+
+ QImage sideBySideImage(actual.width() * 2, actual.height(), QImage::Format_ARGB32);
+ sideBySideImage.fill(Qt::transparent);
+ {
+ QPainter p(&sideBySideImage);
+ p.drawImage(0, 0, actual);
+ p.drawImage(actual.width(), 0, reference);
+ }
+
+ const QString sideBySideFileName = "difference/" + sourceFileIterator.fileInfo().baseName() + QLatin1String(".png");
+ if (!sideBySideImage.save(sideBySideFileName)) {
+ fprintf(stderr, "Could not save side-by-side image at %s\n", qPrintable(sideBySideFileName));
+ return EXIT_FAILURE;
+ }
+ }
+ } else {
+ fprintf(stderr, "Unknown command %s\n", qPrintable(commandAsString));
+ return EXIT_FAILURE;
+ }
+
+ return EXIT_SUCCESS;
+}
+
diff --git a/tests/manual/rendertestsuite/rendertestsuite.pro b/tests/manual/rendertestsuite/rendertestsuite.pro
new file mode 100644
index 0000000..855d3fc
--- /dev/null
+++ b/tests/manual/rendertestsuite/rendertestsuite.pro
@@ -0,0 +1,3 @@
+TEMPLATE = app
+QT = core gui svg
+SOURCES = main.cpp