/* * SPDX-FileCopyrightText: 2007 Boudewijn Rempt boud @valdyas.org * * SPDX-License-Identifier: LGPL-2.0-or-later */ // clazy:excludeall=qstring-arg #include "KoProgressUpdater_test.h" #include "KoProgressUpdater.h" #include "KoUpdater.h" #include #include #include // KoProgressUpdater signal timer has interval of 250 ms, see PROGRESSUPDATER_GUITIMERINTERVAL // Also is the timer of type Qt::CoarseTimer, which "tr[ies] to keep accuracy within 5% of the desired interval", // so wait a little longer #define WAIT_FOR_PROGRESSUPDATER_UI_UPDATES 275 class TestWeaverJob : public ThreadWeaver::Job { public: TestWeaverJob(QPointer updater, int steps = 10) : ThreadWeaver::Job() , m_updater(updater) , m_steps(steps) { } void run(ThreadWeaver::JobPointer, ThreadWeaver::Thread *) override { for (int i = 1; i < m_steps + 1; ++i) { for (int j = 1; j < 10000; ++j){} m_updater->setProgress((100 / m_steps) * i); if (m_updater->interrupted()) { m_updater->setProgress(100); return; } } m_updater->setProgress(100); } protected: QPointer m_updater; int m_steps; }; class TestJob : public QThread { Q_OBJECT public: TestJob(QPointer updater, int steps = 10) : QThread() , m_updater(updater) , m_steps(steps) { } void run() override { for (int i = 1; i < m_steps + 1; ++i) { sleep(1); m_updater->setProgress((100 / m_steps) * i); if (m_updater->interrupted()) { m_updater->setProgress(100); return; } } m_updater->setProgress(100); } private: QPointer m_updater; int m_steps; }; class TestProgressBar : public KoProgressProxy { public: int min; int max; int value; QString formatString; TestProgressBar() : min(0) , max(0) , value(0) { } int maximum() const override { return max; } void setValue(int v) override { value = v; } void setRange(int minimum, int maximum) override { min = minimum; max = maximum; } void setFormat(const QString & format) override { formatString = format; } }; void KoProgressUpdaterTest::testCreation() { TestProgressBar bar; KoProgressUpdater pu(&bar); QPointer updater = pu.startSubtask(); QCOMPARE(bar.min, 0); QCOMPARE(bar.max, 0); QCOMPARE(bar.value, 0); QVERIFY(bar.formatString.isNull()); pu.start(); QCOMPARE(bar.min, 0); QCOMPARE(bar.max, 99); QCOMPARE(bar.value, 0); } void KoProgressUpdaterTest::testSimpleProgress() { TestProgressBar bar; KoProgressUpdater pu(&bar); pu.start(); QPointer updater = pu.startSubtask(); updater->setProgress(50); QTest::qWait(WAIT_FOR_PROGRESSUPDATER_UI_UPDATES); // allow the action to do its job. QCOMPARE(bar.value, 50); updater->setProgress(100); QTest::qWait(WAIT_FOR_PROGRESSUPDATER_UI_UPDATES); // allow the action to do its job. QCOMPARE(bar.value, 100); } void KoProgressUpdaterTest::testSimpleThreadedProgress() { TestProgressBar bar; KoProgressUpdater pu(&bar); pu.start(); QPointer u = pu.startSubtask(); TestJob t(u); t.start(); while (!t.isFinished()) { QTest::qWait(WAIT_FOR_PROGRESSUPDATER_UI_UPDATES); // allow the action to do its job. } for (int i = 0; i < 10 && bar.value < 100; ++i) { QTest::qWait(WAIT_FOR_PROGRESSUPDATER_UI_UPDATES); // allow the action to do its job. } QCoreApplication::processEvents(); // allow the actions 'gui' stuff to run. QCOMPARE(bar.value, 100); } void KoProgressUpdaterTest::testSubUpdaters() { TestProgressBar bar; KoProgressUpdater pu(&bar); pu.start(); QPointer u1 = pu.startSubtask(4); QPointer u2 = pu.startSubtask(6); u1->setProgress(100); QTest::qWait(WAIT_FOR_PROGRESSUPDATER_UI_UPDATES); // allow the action to do its job. QCoreApplication::processEvents(); // allow the actions 'gui' stuff to run. QCOMPARE(bar.value, 40); u2->setProgress(100); QTest::qWait(WAIT_FOR_PROGRESSUPDATER_UI_UPDATES); // allow the action to do its job. QCoreApplication::processEvents(); // allow the actions 'gui' stuff to run. QCOMPARE(bar.value, 100); } void KoProgressUpdaterTest::testThreadedSubUpdaters() { TestProgressBar bar; KoProgressUpdater pu(&bar); pu.start(); QPointer u1 = pu.startSubtask(4); QPointer u2= pu.startSubtask(6); TestJob t1(u1, 4); TestJob t2(u2, 6); t1.start(); t2.start(); while (t1.isRunning() || t2.isRunning()) { QTest::qWait(WAIT_FOR_PROGRESSUPDATER_UI_UPDATES); // allow the action to do its job. } for (int i = 0; i < 10 && bar.value < 100; ++i) { QTest::qWait(WAIT_FOR_PROGRESSUPDATER_UI_UPDATES); // allow the action to do its job. } QCOMPARE(bar.value, 100); } void KoProgressUpdaterTest::testRecursiveProgress() { TestProgressBar bar; KoProgressUpdater pu(&bar); pu.start(); QPointer u1 = pu.startSubtask(); KoProgressUpdater pu2(u1); pu2.start(); QPointer u2 = pu2.startSubtask(); u2->setProgress(50); u2->setProgress(100); for (int i = 0; i < 10 && bar.value < 100; ++i) { QTest::qWait(WAIT_FOR_PROGRESSUPDATER_UI_UPDATES); // allow the action to do its job. } QCOMPARE(bar.value, 100); } void KoProgressUpdaterTest::testThreadedRecursiveProgress() { TestProgressBar bar; KoProgressUpdater pu(&bar); pu.start(); QPointer u1 = pu.startSubtask(); KoProgressUpdater pu2(u1); pu2.start(); QPointer u2 = pu2.startSubtask(); TestJob t1(u2); t1.start(); while (t1.isRunning()) { QTest::qWait(WAIT_FOR_PROGRESSUPDATER_UI_UPDATES); // allow the action to do its job. } for (int i = 0; i < 10 && bar.value < 100; ++i) { QTest::qWait(WAIT_FOR_PROGRESSUPDATER_UI_UPDATES); // allow the action to do its job. } QCOMPARE(bar.value, 100); } void KoProgressUpdaterTest::testFromWeaver() { jobsdone = 0; TestProgressBar bar; KoProgressUpdater pu(&bar); pu.start(10); ThreadWeaver::Queue::instance()->setMaximumNumberOfThreads(4); for (int i = 0; i < 10; ++i) { QPointer up = pu.startSubtask(); ThreadWeaver::QObjectDecorator * job = new ThreadWeaver::QObjectDecorator(new TestWeaverJob(up, 10)); connect(job, SIGNAL(done(ThreadWeaver::JobPointer)), SLOT(jobDone(ThreadWeaver::JobPointer))); ThreadWeaver::Queue::instance()->enqueue(ThreadWeaver::make_job_raw(job)); } while (!ThreadWeaver::Queue::instance()->isIdle()) { QTest::qWait(WAIT_FOR_PROGRESSUPDATER_UI_UPDATES); } ThreadWeaver::Queue::instance()->finish(); for (int i = 0; i < 10 && jobsdone < 10; ++i) { QTest::qWait(WAIT_FOR_PROGRESSUPDATER_UI_UPDATES); // allow the action to do its job. } QCOMPARE(jobsdone, 10); } void KoProgressUpdaterTest::jobDone(ThreadWeaver::JobPointer job) { Q_UNUSED(job); ++jobsdone; } QTEST_GUILESS_MAIN(KoProgressUpdaterTest) #include "KoProgressUpdater_test.moc"