Files
qelectrotech-source-mirror/tests/qttest/tst_foliogrid.cpp
T
Beat Hangartner ede7bd99e1 Never use a folio grid step below 1 from the settings
The folio grid steps, diagrameditor/Xgrid and Ygrid, are read from the
settings in six places with a plain toInt() and used as they come. The
preferences page cannot store anything below 1, but a hand-edited or
damaged settings file can hold 0, a negative number or text:

- Diagram::snapToGrid() divides by the step, so 0 is a SIGFPE on the
  first click that places a symbol;
- Diagram::drawBackground() runs "while (g_x % xGrid)" and then loops
  "gx += xGrid", so 0 crashes every repaint and a negative step never
  ends;
- the paste, duplicate and align paths divide by it or multiply with it.

Add foliogrid.h, a header-only helper: FolioGrid::step() reads a
settings entry and returns the built-in step (Diagram::xGrid, 10) when
the entry is missing, not a number, below 1 or above what an int
holds (QVariant::toInt() wraps such a value around). Every reader of
the two keys goes through it; the settings page, which only writes the
spin box values, is unchanged.

No file-format change, and no change for any step the preferences page
can produce.

Tests: tst_foliogrid covers the helper: 1, 10, "7", int max are kept;
missing, 0, -5, "ten", "", "nan", 99999999999 (as text and as a
number) and int max + 1 fall back; 7.9 rounds to 8 as before; and the
two settings keys through a QSettings scope of the test's own. The
helper is new, so the test cannot fail on master; the six readers are
the replacements in the diff.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: Beat Hangartner <beat@hangartners.ch>
2026-10-08 06:04:35 +02:00

100 lines
3.4 KiB
C++

/*
Copyright 2006-2026 The QElectroTech Team
This file is part of QElectroTech.
QElectroTech is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
QElectroTech is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with QElectroTech. If not, see <http://www.gnu.org/licenses/>.
*/
#include "foliogrid.h"
#include <QtTest>
#include <QSettings>
/**
FolioGrid::step() -- the folio grid step as read from the settings.
Every reader of diagrameditor/Xgrid and Ygrid goes through it, so a
settings file holding 0 (a division by zero in Diagram::snapToGrid()
and an endless "% 0" in drawBackground()), a negative number (an
endless loop) or text can no longer reach the code that uses the step.
*/
class tst_foliogrid : public QObject
{
Q_OBJECT
private slots:
void usableValuesAreKept_data()
{
QTest::addColumn<QVariant>("value");
QTest::addColumn<int>("expected");
QTest::newRow("one") << QVariant(1) << 1;
QTest::newRow("default") << QVariant(10) << 10;
QTest::newRow("text number") << QVariant(QStringLiteral("7")) << 7;
QTest::newRow("large") << QVariant(100000) << 100000;
QTest::newRow("int max") << QVariant(2147483647) << 2147483647;
}
void usableValuesAreKept()
{
QFETCH(QVariant, value);
QFETCH(int, expected);
QCOMPARE(FolioGrid::step(value, 10), expected);
}
void unusableValuesFallBack_data()
{
QTest::addColumn<QVariant>("value");
QTest::newRow("missing") << QVariant();
QTest::newRow("zero") << QVariant(0);
QTest::newRow("negative") << QVariant(-5);
QTest::newRow("text") << QVariant(QStringLiteral("ten"));
QTest::newRow("empty") << QVariant(QString());
QTest::newRow("nan") << QVariant(QStringLiteral("nan"));
QTest::newRow("too large") << QVariant(QStringLiteral("99999999999"));
QTest::newRow("too large number") << QVariant(qlonglong(99999999999));
QTest::newRow("int max + 1") << QVariant(qlonglong(2147483648));
}
void unusableValuesFallBack()
{
QFETCH(QVariant, value);
QCOMPARE(FolioGrid::step(value, 10), 10);
QCOMPARE(FolioGrid::step(value, 20), 20);
}
// A decimal in the file is rounded to a whole number, as the plain
// QVariant::toInt() read did before.
void decimalIsRoundedLikeBefore()
{
QCOMPARE(FolioGrid::step(QVariant(7.9), 10), 8);
QCOMPARE(FolioGrid::step(QVariant(0.4), 10), 10);
}
// Through a real settings file, in a scope of this test's own.
void readsTheSettingsKeys()
{
QCoreApplication::setOrganizationName(QStringLiteral("QElectroTech-tst_foliogrid"));
QCoreApplication::setApplicationName(QStringLiteral("tst_foliogrid"));
QSettings settings;
settings.clear();
QCOMPARE(FolioGrid::step(settings.value(FolioGrid::x_key), 10), 10);
settings.setValue(FolioGrid::x_key, 0);
settings.setValue(FolioGrid::y_key, 15);
QCOMPARE(FolioGrid::step(settings.value(FolioGrid::x_key), 10), 10);
QCOMPARE(FolioGrid::step(settings.value(FolioGrid::y_key), 10), 15);
settings.clear();
}
};
QTEST_GUILESS_MAIN(tst_foliogrid)
#include "tst_foliogrid.moc"