Allow cancellation of un-started jobs (#2777).
[dcpomatic.git] / test / job_manager_test.cc
1 /*
2     Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
6     DCP-o-matic is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     DCP-o-matic is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21
22 /** @file  test/job_manager_test.cc
23  *  @brief Test JobManager.
24  *  @ingroup selfcontained
25  */
26
27
28 #include "lib/cross.h"
29 #include "lib/job.h"
30 #include "lib/job_manager.h"
31 #include <boost/test/unit_test.hpp>
32
33
34 using std::make_shared;
35 using std::shared_ptr;
36 using std::string;
37 using std::vector;
38
39
40 class TestJob : public Job
41 {
42 public:
43         explicit TestJob (shared_ptr<Film> film)
44                 : Job (film)
45         {
46
47         }
48
49         ~TestJob ()
50         {
51                 stop_thread ();
52         }
53
54         void set_finished_ok () {
55                 set_state (FINISHED_OK);
56         }
57
58         void set_finished_error () {
59                 set_state (FINISHED_ERROR);
60         }
61
62         void run () override
63         {
64                 while (true) {
65                         if (finished ()) {
66                                 return;
67                         }
68                         boost::this_thread::interruption_point();
69                 }
70         }
71
72         string name () const override {
73                 return "";
74         }
75
76         string json_name () const override {
77                 return "";
78         }
79 };
80
81
82 BOOST_AUTO_TEST_CASE (job_manager_test1)
83 {
84         shared_ptr<Film> film;
85
86         /* Single job */
87         auto a = make_shared<TestJob>(film);
88
89         JobManager::instance()->add (a);
90         dcpomatic_sleep_seconds (1);
91         BOOST_CHECK (a->running());
92         a->set_finished_ok ();
93         dcpomatic_sleep_seconds (2);
94         BOOST_CHECK (a->finished_ok());
95 }
96
97
98 BOOST_AUTO_TEST_CASE (job_manager_test2)
99 {
100         shared_ptr<Film> film;
101
102         vector<shared_ptr<TestJob>> jobs;
103         for (int i = 0; i < 16; ++i) {
104                 auto job = make_shared<TestJob>(film);
105                 jobs.push_back (job);
106                 JobManager::instance()->add (job);
107         }
108
109         dcpomatic_sleep_seconds (1);
110         BOOST_CHECK (jobs[0]->running());
111         jobs[0]->set_finished_ok();
112
113         dcpomatic_sleep_seconds (1);
114         BOOST_CHECK (!jobs[0]->running());
115         BOOST_CHECK (jobs[1]->running());
116
117         /* Push our jobs[5] to the top of the list */
118         for (int i = 0; i < 5; ++i) {
119                 JobManager::instance()->increase_priority(jobs[5]);
120         }
121
122         dcpomatic_sleep_seconds (1);
123         for (int i = 0; i < 16; ++i) {
124                 BOOST_CHECK (i == 5 ? jobs[i]->running() : !jobs[i]->running());
125         }
126
127         /* Set any jobs that are started to be finished, until they're all finished */
128         while (true) {
129                 if (std::find_if(jobs.begin(), jobs.end(), [](shared_ptr<Job> job) { return !job->finished_ok(); }) == jobs.end()) {
130                         break;
131                 }
132
133                 for (auto job: jobs) {
134                         if (job->running()) {
135                                 job->set_finished_ok();
136                         }
137                 }
138         }
139
140         BOOST_REQUIRE (!wait_for_jobs());
141 }
142
143
144 BOOST_AUTO_TEST_CASE(cancel_job_test)
145 {
146         shared_ptr<Film> film;
147
148         vector<shared_ptr<TestJob>> jobs;
149         for (int i = 0; i < 2; ++i) {
150                 auto job = make_shared<TestJob>(film);
151                 jobs.push_back(job);
152                 JobManager::instance()->add(job);
153         }
154
155         jobs[1]->cancel();
156         jobs[0]->cancel();
157
158         dcpomatic_sleep_seconds(1);
159
160         BOOST_CHECK(jobs[0]->finished_cancelled());
161         BOOST_CHECK(jobs[1]->finished_cancelled());
162 }
163