/
testqgstaskmanager.cpp
1646 lines (1391 loc) · 49.3 KB
/
testqgstaskmanager.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************
testqgstaskmanager.cpp
----------------------
begin : April 2016
copyright : (C) 2016 by Nyall Dawson
email : nyall dot dawson at gmail dot com
***************************************************************************/
/***************************************************************************
* *
* This program 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. *
* *
***************************************************************************/
#include "qgstaskmanager.h"
#include "qgsproject.h"
#include "qgsvectorlayer.h"
#include "qgsapplication.h"
#include "qgsproxyprogresstask.h"
#include <QObject>
#include "qgstest.h"
class TestTask : public QgsTask
{
Q_OBJECT
public:
TestTask( const QString &desc = QString() ) : QgsTask( desc )
{
qDebug() << "created task " << desc;
}
TestTask( const QString &desc, const QgsTask::Flags &flags ) : QgsTask( desc, flags )
{
qDebug() << "created task " << desc;
}
~TestTask() override
{
qDebug() << "deleting task " << description();
}
void emitTaskStopped() { }
void emitTaskCompleted() { }
bool runCalled = false ;
protected:
bool run() override
{
runCalled = true;
return true;
}
};
class ProgressReportingTask : public QgsTask
{
Q_OBJECT
public:
ProgressReportingTask( const QString &desc = QString() ) : QgsTask( desc )
{
qDebug() << "created task " << desc;
}
~ProgressReportingTask() override
{
qDebug() << "deleting task " << description();
}
void emitProgressChanged( double progress )
{
QMutexLocker locker( &mProgressMutex );
mProgress.append( progress );
}
bool finished = false ;
bool terminated = false ;
public slots:
void finish()
{
QMutexLocker locker( &mCompletedMutex );
finished = true;
}
void terminate()
{
QMutexLocker locker( &mCompletedMutex );
terminated = true;
}
protected:
bool run() override
{
while ( true )
{
mCompletedMutex.lock();
if ( finished || terminated || isCanceled() )
{
mCompletedMutex.unlock();
return finished;
}
mCompletedMutex.unlock();
QMutexLocker locker( &mProgressMutex );
while ( !mProgress.isEmpty() )
{
setProgress( mProgress.takeFirst() );
}
}
return finished;
}
QList<double> mProgress;
QMutex mProgressMutex;
QMutex mCompletedMutex;
};
class TestTerminationTask : public TestTask
{
Q_OBJECT
public:
TestTerminationTask( const QString &desc = QString() ) : TestTask( desc ) {}
~TestTerminationTask() override
{
//make sure task has been terminated by manager prior to deletion
QVERIFY( status() == QgsTask::Terminated );
}
protected:
bool run() override
{
while ( !isCanceled() )
{}
return false;
}
};
class CancelableTask : public QgsTask
{
Q_OBJECT
public:
CancelableTask( const QString &desc = QString() ) : QgsTask( desc )
{
qDebug() << "created task " << desc;
}
~CancelableTask() override
{
qDebug() << "deleting task " << description();
}
protected:
bool run() override
{
while ( !isCanceled() )
{}
return true;
}
};
class SuccessTask : public QgsTask
{
Q_OBJECT
public:
SuccessTask( const QString &desc = QString() ) : QgsTask( desc )
{
qDebug() << "created task " << desc;
}
~SuccessTask() override
{
qDebug() << "deleting task " << description();
}
protected:
bool run() override
{
return true;
}
};
class FailTask : public QgsTask
{
Q_OBJECT
public:
FailTask( const QString &desc = QString() ) : QgsTask( desc )
{
qDebug() << "created task " << desc;
}
~FailTask() override
{
qDebug() << "deleting task " << description();
}
protected:
bool run() override
{
return false;
}
};
class FinishTask : public QgsTask
{
Q_OBJECT
public:
FinishTask( bool *result, const QString &desc )
: QgsTask( desc )
, desiredResult( false )
, resultObtained( result )
{
qDebug() << "created task " << desc;
}
~FinishTask() override
{
qDebug() << "deleting task " << description();
}
bool desiredResult;
bool *resultObtained = nullptr;
protected:
bool run() override
{
return desiredResult;
}
void finished( bool result ) override
{
QVERIFY( QApplication::instance()->thread() == QThread::currentThread() );
*resultObtained = result;
}
};
void flushEvents()
{
for ( int i = 0; i < 1000; ++i )
{
QCoreApplication::processEvents();
}
}
class WaitTask : public QgsTask
{
Q_OBJECT
public:
WaitTask( const QString &desc = QString() ) : QgsTask( desc )
{
qDebug() << "created task " << desc;
}
~WaitTask() override
{
qDebug() << "deleting task " << description();
}
protected:
bool run() override
{
QThread::sleep( 2 );
return true;
}
};
class TestQgsTaskManager : public QObject
{
Q_OBJECT
public:
private slots:
void initTestCase();// will be called before the first testfunction is executed.
void cleanupTestCase();// will be called after the last testfunction was executed.
void init();// will be called before each testfunction is executed.
void cleanup();// will be called after every testfunction.
void task();
void taskResult();
void taskFinished();
void subTaskSimple();
void subTaskGrandChildren();
void subTaskProgress();
void subTaskCancelParent();
void subTaskTerminateSubTask();
void subTaskPartialComplete();
void subTaskPartialComplete2();
void addTask();
void taskTerminationBeforeDelete();
void taskId();
void waitForFinished();
void waitForFinishedBeforeStart();
void progressChanged();
void statusChanged();
void allTasksFinished();
void activeTasks();
void holdTask();
void dependencies();
void layerDependencies();
void managerWithSubTasks();
void managerWithSubTasks2();
void managerWithSubTasks3();
void cancelBeforeStart();
void proxyTask();
void proxyTask2();
void scopedProxyTask();
};
void TestQgsTaskManager::initTestCase()
{
QgsApplication::init();
QgsApplication::initQgis();
}
void TestQgsTaskManager::cleanupTestCase()
{
QgsApplication::exitQgis();
}
void TestQgsTaskManager::init()
{
}
void TestQgsTaskManager::cleanup()
{
}
void TestQgsTaskManager::task()
{
std::unique_ptr< TestTask > task( new TestTask( QStringLiteral( "test_task_desc" ) ) );
QCOMPARE( task->status(), QgsTask::Queued );
QCOMPARE( task->description(), QStringLiteral( "test_task_desc" ) );
QVERIFY( !task->isActive() );
QVERIFY( task->canCancel() );
QVERIFY( task->flags() & QgsTask::CanCancel );
QSignalSpy startedSpy( task.get(), &QgsTask::begun );
QSignalSpy statusSpy( task.get(), &QgsTask::statusChanged );
task->start();
QVERIFY( task->runCalled );
QCOMPARE( startedSpy.count(), 1 );
QCOMPARE( statusSpy.count(), 2 );
QCOMPARE( static_cast< QgsTask::TaskStatus >( statusSpy.at( 0 ).at( 0 ).toInt() ), QgsTask::Running );
QCOMPARE( static_cast< QgsTask::TaskStatus >( statusSpy.at( 1 ).at( 0 ).toInt() ), QgsTask::Complete );
//test that calling stopped sets correct state
std::unique_ptr< FailTask > failTask( new FailTask( QStringLiteral( "task_fail" ) ) );
QSignalSpy stoppedSpy( failTask.get(), &QgsTask::taskTerminated );
QSignalSpy statusSpy2( failTask.get(), &QgsTask::statusChanged );
failTask->start();
QCOMPARE( failTask->status(), QgsTask::Terminated );
QVERIFY( !failTask->isActive() );
QCOMPARE( stoppedSpy.count(), 1 );
QCOMPARE( statusSpy2.count(), 2 );
QCOMPARE( static_cast< QgsTask::TaskStatus >( statusSpy2.last().at( 0 ).toInt() ), QgsTask::Terminated );
//test that calling completed sets correct state
task.reset( new TestTask( QStringLiteral( "test_task_3" ) ) );
QSignalSpy completeSpy( task.get(), &QgsTask::taskCompleted );
QSignalSpy statusSpy3( task.get(), &QgsTask::statusChanged );
task->start();
QCOMPARE( task->status(), QgsTask::Complete );
QVERIFY( !task->isActive() );
QCOMPARE( completeSpy.count(), 1 );
QCOMPARE( statusSpy3.count(), 2 );
QCOMPARE( static_cast< QgsTask::TaskStatus >( statusSpy3.last().at( 0 ).toInt() ), QgsTask::Complete );
// test that canceling tasks which have not begin immediately ends them
task.reset( new TestTask( QStringLiteral( "test_task_4" ) ) );
task->cancel(); // Queued task
QCOMPARE( task->status(), QgsTask::Terminated );
task.reset( new TestTask( QStringLiteral( "test_task_5" ) ) );
task->hold(); // OnHold task
task->cancel();
QCOMPARE( task->status(), QgsTask::Terminated );
// test flags
task.reset( new TestTask( QStringLiteral( "test_task_6" ), nullptr ) );
QVERIFY( !task->canCancel() );
QVERIFY( !( task->flags() & QgsTask::CanCancel ) );
task.reset( new TestTask( QStringLiteral( "test_task_7" ), QgsTask::CanCancel ) );
QVERIFY( task->canCancel() );
QVERIFY( task->flags() & QgsTask::CanCancel );
}
void TestQgsTaskManager::taskResult()
{
std::unique_ptr< QgsTask > task( new SuccessTask( QStringLiteral( "task_result_1" ) ) );
QCOMPARE( task->status(), QgsTask::Queued );
QSignalSpy statusSpy( task.get(), &QgsTask::statusChanged );
task->start();
QCOMPARE( statusSpy.count(), 2 );
QCOMPARE( static_cast< QgsTask::TaskStatus >( statusSpy.at( 0 ).at( 0 ).toInt() ), QgsTask::Running );
QCOMPARE( static_cast< QgsTask::TaskStatus >( statusSpy.at( 1 ).at( 0 ).toInt() ), QgsTask::Complete );
QCOMPARE( task->status(), QgsTask::Complete );
task.reset( new FailTask( QStringLiteral( "task_result_2" ) ) );
QCOMPARE( task->status(), QgsTask::Queued );
QSignalSpy statusSpy2( task.get(), &QgsTask::statusChanged );
task->start();
QCOMPARE( statusSpy2.count(), 2 );
QCOMPARE( static_cast< QgsTask::TaskStatus >( statusSpy2.at( 0 ).at( 0 ).toInt() ), QgsTask::Running );
QCOMPARE( static_cast< QgsTask::TaskStatus >( statusSpy2.at( 1 ).at( 0 ).toInt() ), QgsTask::Terminated );
QCOMPARE( task->status(), QgsTask::Terminated );
QApplication::sendPostedEvents( nullptr, QEvent::DeferredDelete );
}
void TestQgsTaskManager::addTask()
{
//create an empty manager
QgsTaskManager manager;
//should be empty
QVERIFY( manager.tasks().isEmpty() );
QCOMPARE( manager.count(), 0 );
QVERIFY( !manager.task( 0L ) );
QSignalSpy spy( &manager, &QgsTaskManager::taskAdded );
// null task
QVERIFY( !manager.addTask( nullptr ) );
//add a task
CancelableTask *task = new CancelableTask( QStringLiteral( "add_task_1" ) );
long id = manager.addTask( task );
QCOMPARE( id, 1L );
QCOMPARE( manager.tasks().count(), 1 );
QCOMPARE( manager.count(), 1 );
QCOMPARE( spy.count(), 1 );
QCOMPARE( spy.last().at( 0 ).toLongLong(), 1LL );
while ( !task->isActive() )
{
QCoreApplication::processEvents();
}
flushEvents();
QVERIFY( task->isActive() );
QCOMPARE( task->status(), QgsTask::Running );
//retrieve task
QCOMPARE( manager.task( 1L ), task );
QCOMPARE( manager.tasks().at( 0 ), task );
//add a second task
CancelableTask *task2 = new CancelableTask( QStringLiteral( "add_task_2" ) );
id = manager.addTask( task2 );
QCOMPARE( id, 2L );
QCOMPARE( manager.tasks().count(), 2 );
QCOMPARE( manager.count(), 2 );
QCOMPARE( manager.task( 1L ), task );
QVERIFY( manager.tasks().contains( task ) );
QCOMPARE( manager.task( 2L ), task2 );
QVERIFY( manager.tasks().contains( task2 ) );
while ( !task2->isActive() )
{
QCoreApplication::processEvents();
}
flushEvents();
QVERIFY( task2->isActive() );
QCOMPARE( task2->status(), QgsTask::Running );
QCOMPARE( spy.count(), 2 );
QCOMPARE( spy.last().at( 0 ).toLongLong(), 2LL );
task->cancel();
task2->cancel();
while ( manager.countActiveTasks() > 0 )
{
QCoreApplication::processEvents();
}
flushEvents();
}
void TestQgsTaskManager::taskTerminationBeforeDelete()
{
//test that task is terminated by manager prior to delete
QgsTaskManager *manager = new QgsTaskManager();
//TestTerminationTask will assert that it's been terminated prior to deletion
TestTask *task = new TestTerminationTask( QStringLiteral( "termination_task_1" ) );
manager->addTask( task );
// wait till task spins up
while ( !task->isActive() )
{
QCoreApplication::processEvents();
}
flushEvents();
// if task is not terminated assert will trip
delete manager;
QApplication::sendPostedEvents( nullptr, QEvent::DeferredDelete );
flushEvents();
}
void TestQgsTaskManager::taskFinished()
{
// test that finished is called and passed correct result, and that it is called
// from main thread
QgsTaskManager manager;
bool resultObtained = false;
FinishTask *task = new FinishTask( &resultObtained, QStringLiteral( "finished_task_1" ) );
task->desiredResult = true;
manager.addTask( task );
while ( task->status() == QgsTask::Running
|| task->status() == QgsTask::Queued )
{
QCoreApplication::processEvents();
}
while ( manager.countActiveTasks() > 0 )
{
QCoreApplication::processEvents();
}
flushEvents();
QCOMPARE( resultObtained, true );
task = new FinishTask( &resultObtained, QStringLiteral( "finished_task_2" ) );
task->desiredResult = false;
manager.addTask( task );
while ( task->status() == QgsTask::Running
|| task->status() == QgsTask::Queued )
{
QCoreApplication::processEvents();
}
while ( manager.countActiveTasks() > 0 )
{
QCoreApplication::processEvents();
}
flushEvents();
QCOMPARE( resultObtained, false );
}
void TestQgsTaskManager::subTaskSimple()
{
// parent with one subtask
ProgressReportingTask *parent = new ProgressReportingTask( QStringLiteral( "sub_task_parent_task_1" ) );
QPointer<ProgressReportingTask> subTask( new ProgressReportingTask( QStringLiteral( "sub_task_sub_task_1" ) ) );
parent->addSubTask( subTask );
// subtask should be deleted with parent
delete parent;
QVERIFY( !subTask.data() );
}
void TestQgsTaskManager::subTaskGrandChildren()
{
// parent with grand children
ProgressReportingTask *parent = new ProgressReportingTask( QStringLiteral( "sub_task_parent_task_2" ) );
QPointer<ProgressReportingTask> subTask = new ProgressReportingTask( QStringLiteral( "sub_task_sub_task_2" ) );
QPointer< ProgressReportingTask> subsubTask( new ProgressReportingTask( QStringLiteral( "sub_task_subsub_task_2" ) ) );
subTask->addSubTask( subsubTask );
parent->addSubTask( subTask );
delete parent;
QVERIFY( !subTask.data() );
QVERIFY( !subsubTask.data() );
}
void TestQgsTaskManager::subTaskProgress()
{
// we need 3 threads to run this test (one for each task)
QThreadPool::globalInstance()->setMaxThreadCount( 3 );
QCOMPARE( QThreadPool::globalInstance()->maxThreadCount(), 3 );
QgsTaskManager manager;
// test parent task progress
ProgressReportingTask *parent = new ProgressReportingTask( QStringLiteral( "sub_task_parent_task_3" ) );
QPointer<ProgressReportingTask> subTask = new ProgressReportingTask( QStringLiteral( "sub_task_sub_task_3" ) );
QPointer< ProgressReportingTask > subTask2( new ProgressReportingTask( QStringLiteral( "sub_task_sub_task_3a" ) ) );
parent->addSubTask( subTask );
parent->addSubTask( subTask2 );
manager.addTask( parent );
while ( parent->status() != QgsTask::Running
|| subTask->status() != QgsTask::Running
|| subTask2->status() != QgsTask::Running )
{
QCoreApplication::processEvents();
}
flushEvents();
// test progress calculation
flushEvents();
QSignalSpy spy( parent, &QgsTask::progressChanged );
parent->emitProgressChanged( 50 );
while ( spy.count() == 0 )
{
QCoreApplication::processEvents();
}
QCOMPARE( std::round( parent->progress() ), 17.0 );
QCOMPARE( spy.count(), 1 );
QCOMPARE( std::round( spy.last().at( 0 ).toDouble() ), 17.0 );
subTask->emitProgressChanged( 100 );
flushEvents();
while ( spy.count() == 1 )
{
QCoreApplication::processEvents();
}
QCOMPARE( std::round( parent->progress() ), 50.0 );
QCOMPARE( spy.count(), 2 );
QCOMPARE( std::round( spy.last().at( 0 ).toDouble() ), 50.0 );
subTask2->finish();
while ( subTask2->status() != QgsTask::Complete )
{
QCoreApplication::processEvents();
}
flushEvents();
QCOMPARE( std::round( parent->progress() ), 83.0 );
QCOMPARE( spy.count(), 3 );
QCOMPARE( std::round( spy.last().at( 0 ).toDouble() ), 83.0 );
parent->emitProgressChanged( 100 );
while ( spy.count() != 4 )
{
QCoreApplication::processEvents();
}
QCOMPARE( std::round( parent->progress() ), 100.0 );
QCOMPARE( std::round( spy.last().at( 0 ).toDouble() ), 100.0 );
parent->terminate();
subTask->terminate();
}
void TestQgsTaskManager::subTaskCancelParent()
{
// test canceling task with subtasks
ProgressReportingTask *parent = new ProgressReportingTask( QStringLiteral( "sub_task_parent_task_4" ) );
QPointer<ProgressReportingTask> subTask = new ProgressReportingTask( QStringLiteral( "sub_task_sub_task_4" ) );
QPointer<ProgressReportingTask> subsubTask = new ProgressReportingTask( QStringLiteral( "sub_task_sub_sub_task_4" ) );
subTask->addSubTask( subsubTask );
parent->addSubTask( subTask );
parent->cancel();
QCOMPARE( subsubTask->status(), QgsTask::Terminated );
QCOMPARE( subTask->status(), QgsTask::Terminated );
QCOMPARE( parent->status(), QgsTask::Terminated );
delete parent;
}
void TestQgsTaskManager::subTaskTerminateSubTask()
{
// we need 3 threads to run this test (one for each task)
QThreadPool::globalInstance()->setMaxThreadCount( 3 );
QCOMPARE( QThreadPool::globalInstance()->maxThreadCount(), 3 );
QgsTaskManager manager;
// test that if a subtask terminates the parent task is canceled
ProgressReportingTask *parent = new ProgressReportingTask( QStringLiteral( "sub_task_parent_task_5" ) );
QPointer<ProgressReportingTask> subTask = new ProgressReportingTask( QStringLiteral( "sub_task_sub_task_5" ) );
QPointer<ProgressReportingTask> subsubTask = new ProgressReportingTask( QStringLiteral( "sub_task_sub_sub_task_5" ) );
subTask->addSubTask( subsubTask );
parent->addSubTask( subTask );
manager.addTask( parent );
while ( subsubTask->status() != QgsTask::Running
|| subTask->status() != QgsTask::Running
|| parent->status() != QgsTask::Running )
{
QCoreApplication::processEvents();
}
QSignalSpy parentTerminated( parent, &QgsTask::taskTerminated );
QSignalSpy subTerminated( subTask, &QgsTask::taskTerminated );
QSignalSpy subsubTerminated( subsubTask, &QgsTask::taskTerminated );
subsubTask->terminate();
while ( subsubTask->status() == QgsTask::Running
|| subTask->status() == QgsTask::Running
|| parent->status() == QgsTask::Running )
{
QCoreApplication::processEvents();
}
flushEvents();
QVERIFY( parentTerminated.count() > 0 );
QVERIFY( subTerminated.count() > 0 );
QVERIFY( subsubTerminated.count() > 0 );
}
void TestQgsTaskManager::subTaskPartialComplete()
{
// we need 3 threads to run this test (one for each task)
QThreadPool::globalInstance()->setMaxThreadCount( 3 );
QCOMPARE( QThreadPool::globalInstance()->maxThreadCount(), 3 );
QgsTaskManager manager;
// test that a task is not marked complete until all subtasks are complete
ProgressReportingTask *parent = new ProgressReportingTask( QStringLiteral( "sub_task_parent_task_6" ) );
QPointer<ProgressReportingTask> subTask = new ProgressReportingTask( QStringLiteral( "sub_task_sub_task_6" ) );
QPointer<ProgressReportingTask> subsubTask = new ProgressReportingTask( QStringLiteral( "sub_task_sub_sub_task_6" ) );
subTask->addSubTask( subsubTask );
parent->addSubTask( subTask );
manager.addTask( parent );
while ( subsubTask->status() != QgsTask::Running
|| subTask->status() != QgsTask::Running
|| parent->status() != QgsTask::Running )
{
QCoreApplication::processEvents();
}
flushEvents();
parent->finish();
flushEvents();
//should still be running
QCOMPARE( ( int )parent->status(), ( int )QgsTask::Running );
subTask->finish();
flushEvents();
QCOMPARE( parent->status(), QgsTask::Running );
QCOMPARE( ( int )subTask->status(), ( int )QgsTask::Running );
QSignalSpy parentFinished( parent, &QgsTask::taskCompleted );
QSignalSpy subFinished( subTask, &QgsTask::taskCompleted );
QSignalSpy subsubFinished( subsubTask, &QgsTask::taskCompleted );
subsubTask->finish();
while ( subsubTask->status() == QgsTask::Running
|| subTask->status() == QgsTask::Running
|| parent->status() == QgsTask::Running )
{
QCoreApplication::processEvents();
}
flushEvents();
QVERIFY( parentFinished.count() > 0 );
QVERIFY( subFinished.count() > 0 );
QVERIFY( subsubFinished.count() > 0 );
}
void TestQgsTaskManager::subTaskPartialComplete2()
{
// we need 3 threads to run this test (one for each task)
QThreadPool::globalInstance()->setMaxThreadCount( 3 );
QCOMPARE( QThreadPool::globalInstance()->maxThreadCount(), 3 );
QgsTaskManager manager;
// another test
ProgressReportingTask *parent = new ProgressReportingTask( QStringLiteral( "sub_task_parent_task_7" ) );
QPointer<ProgressReportingTask> subTask = new ProgressReportingTask( QStringLiteral( "sub_task_sub_task_7" ) );
QPointer<ProgressReportingTask> subsubTask = new ProgressReportingTask( QStringLiteral( "sub_task_sub_sub_task_7" ) );
subTask->addSubTask( subsubTask );
parent->addSubTask( subTask );
manager.addTask( parent );
while ( subsubTask->status() != QgsTask::Running
|| subTask->status() != QgsTask::Running
|| parent->status() != QgsTask::Running )
{
QCoreApplication::processEvents();
}
flushEvents();
subTask->finish();
flushEvents();
QCOMPARE( parent->status(), QgsTask::Running );
QCOMPARE( subTask->status(), QgsTask::Running );
QCOMPARE( subsubTask->status(), QgsTask::Running );
subsubTask->finish();
while ( subsubTask->status() == QgsTask::Running )
{
QCoreApplication::processEvents();
}
flushEvents();
QCOMPARE( subsubTask->status(), QgsTask::Complete );
QCOMPARE( subTask->status(), QgsTask::Complete );
QCOMPARE( parent->status(), QgsTask::Running );
QSignalSpy parentFinished2( parent, &QgsTask::taskCompleted );
parent->finish();
while ( parent->status() == QgsTask::Running )
{
QCoreApplication::processEvents();
}
flushEvents();
QVERIFY( parentFinished2.count() > 0 );
}
void TestQgsTaskManager::taskId()
{
//test finding task IDs
//create manager with some tasks
QgsTaskManager manager;
TestTask *task = new TestTask( QStringLiteral( "task_id_1" ) );
TestTask *task2 = new TestTask( QStringLiteral( "task_id_2" ) );
manager.addTask( task );
manager.addTask( task2 );
//also a task not in the manager
TestTask *task3 = new TestTask( QStringLiteral( "task_id_3" ) );
QCOMPARE( manager.taskId( nullptr ), -1L );
QCOMPARE( manager.taskId( task ), 1L );
QCOMPARE( manager.taskId( task2 ), 2L );
QCOMPARE( manager.taskId( task3 ), -1L );
delete task3;
flushEvents();
}
void TestQgsTaskManager::waitForFinished()
{
QgsTaskManager manager;
QEventLoop loop;
ProgressReportingTask *finishedTask = new ProgressReportingTask();
connect( finishedTask, &ProgressReportingTask::begun, &loop, &QEventLoop::quit );
manager.addTask( finishedTask );
if ( finishedTask->status() != QgsTask::Running )
loop.exec();
// we have to run the timer in a different thread, because waitForFinished will block this thread, meaning the
// event loop never runs and the timer timeout signal never gets through...
QThread *timerThread = new QThread();
connect( timerThread, &QThread::finished, timerThread, &QThread::deleteLater );
QTimer *timer = new QTimer( nullptr );
connect( timer, &QTimer::timeout, finishedTask, &ProgressReportingTask::finish, Qt::DirectConnection );
timer->moveToThread( timerThread );
connect( timerThread, &QThread::started, timer, [ = ]
{
timer->start( 2000 );
} );
connect( timerThread, &QThread::finished, timer, &QTimer::deleteLater );
timerThread->start();
QCOMPARE( finishedTask->waitForFinished(), true );
QCOMPARE( finishedTask->status(), QgsTask::Complete );
timerThread->quit();
ProgressReportingTask *failedTask = new ProgressReportingTask();
connect( failedTask, &ProgressReportingTask::begun, &loop, &QEventLoop::quit );
manager.addTask( failedTask );
if ( failedTask->status() != QgsTask::Running )
loop.exec();
timerThread = new QThread();
connect( timerThread, &QThread::finished, timerThread, &QThread::deleteLater );
timer = new QTimer( nullptr );
connect( timer, &QTimer::timeout, failedTask, &ProgressReportingTask::terminate, Qt::DirectConnection );
timer->moveToThread( timerThread );
connect( timerThread, &QThread::started, timer, [ = ]
{
timer->start( 500 );
} );
connect( timerThread, &QThread::finished, timer, &QTimer::deleteLater );
timerThread->start();
QCOMPARE( failedTask->waitForFinished(), true );
QCOMPARE( failedTask->status(), QgsTask::Terminated );
timerThread->quit();
ProgressReportingTask *timeoutTooShortTask = new ProgressReportingTask();
connect( timeoutTooShortTask, &ProgressReportingTask::begun, &loop, &QEventLoop::quit );
manager.addTask( timeoutTooShortTask );
if ( timeoutTooShortTask->status() != QgsTask::Running )
loop.exec();
timerThread = new QThread();
connect( timerThread, &QThread::finished, timerThread, &QThread::deleteLater );
timer = new QTimer( nullptr );
connect( timer, &QTimer::timeout, timeoutTooShortTask, &ProgressReportingTask::finish, Qt::DirectConnection );
timer->moveToThread( timerThread );
connect( timerThread, &QThread::started, timer, [ = ]
{
timer->start( 1000 );
} );
connect( timerThread, &QThread::finished, timer, &QTimer::deleteLater );
timerThread->start();
QCOMPARE( timeoutTooShortTask->waitForFinished( 20 ), false );
QCOMPARE( timeoutTooShortTask->status(), QgsTask::Running );
timerThread->quit();
flushEvents();
}
void TestQgsTaskManager::waitForFinishedBeforeStart()
{
// backup max thread count and force it to 1 so there is only one slot in task manager queue
int maxThreadCount = QThreadPool::globalInstance()->maxThreadCount();
QThreadPool::globalInstance()->setMaxThreadCount( 1 );
QgsTaskManager manager;
// add a wait task so the test task is not started when we call waitforfinished
QPointer<QgsTask> waitTask = new WaitTask( "wait_task" );
manager.addTask( waitTask );
QPointer<QgsTask> testTask = new TestTask( "test_task" );
manager.addTask( testTask );
testTask->waitForFinished();
QgsTask::TaskStatus status = testTask->status();
QCOMPARE( status, QgsTask::Complete );
waitTask->waitForFinished();
QCOMPARE( waitTask->status(), QgsTask::Complete );
// wait for task to be removed from active task
while ( manager.count() > 0 )
{
QCoreApplication::processEvents();
}
// restore max thread count (for other tests)
QThreadPool::globalInstance()->setMaxThreadCount( maxThreadCount );
flushEvents();
}
void TestQgsTaskManager::progressChanged()
{
// check that progressChanged signals emitted by tasks result in progressChanged signal from manager
QgsTaskManager manager;
ProgressReportingTask *task = new ProgressReportingTask();
ProgressReportingTask *task2 = new ProgressReportingTask();
manager.addTask( task );
manager.addTask( task2 );
while ( task->status() != QgsTask::Running ||
task2->status() != QgsTask::Running )
{
QCoreApplication::processEvents();
}
flushEvents();
QCOMPARE( task->status(), QgsTask::Running );
QCOMPARE( task2->status(), QgsTask::Running );
QSignalSpy spy( &manager, &QgsTaskManager::progressChanged );
QSignalSpy spy2( &manager, &QgsTaskManager::finalTaskProgressChanged );
task->emitProgressChanged( 50.0 );
while ( spy.count() == 0 )
{
QCoreApplication::processEvents();
}
QCOMPARE( task->progress(), 50.0 );
QCOMPARE( spy.count(), 1 );
QCOMPARE( spy.last().at( 0 ).toLongLong(), 1LL );
QCOMPARE( spy.last().at( 1 ).toDouble(), 50.0 );
//multiple running tasks, so finalTaskProgressChanged(double) should not be emitted
QCOMPARE( spy2.count(), 0 );
task2->emitProgressChanged( 75.0 );