2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 /** @file test/test.cc
22 * @brief Overall test stuff and useful methods for tests.
25 #include "lib/config.h"
27 #include "lib/signal_manager.h"
29 #include "lib/job_manager.h"
31 #include "lib/cross.h"
32 #include "lib/encode_server_finder.h"
33 #include "lib/image.h"
34 #include "lib/ratio.h"
35 #include "lib/log_entry.h"
38 #include <libxml++/libxml++.h>
40 #define BOOST_TEST_DYN_LINK
41 #define BOOST_TEST_MODULE dcpomatic_test
42 #include <boost/test/unit_test.hpp>
43 #include <boost/make_shared.hpp>
55 using boost::shared_ptr;
56 using boost::scoped_array;
57 using boost::make_shared;
59 boost::filesystem::path private_data = boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private");
61 class TestSignalManager : public SignalManager
64 /* No wakes in tests: we call ui_idle ourselves */
77 Config::instance()->set_num_local_encoding_threads (1);
78 Config::instance()->set_server_port_base (61921);
79 Config::instance()->set_default_isdcf_metadata (ISDCFMetadata ());
80 Config::instance()->set_default_container (Ratio::from_id ("185"));
81 Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
82 Config::instance()->set_default_audio_delay (0);
83 Config::instance()->set_default_j2k_bandwidth (100000000);
84 Config::instance()->set_log_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
86 EncodeServerFinder::instance()->disable ();
88 signal_manager = new TestSignalManager ();
97 BOOST_GLOBAL_FIXTURE (TestConfig);
99 boost::filesystem::path
100 test_film_dir (string name)
102 boost::filesystem::path p;
110 new_test_film (string name)
112 boost::filesystem::path p = test_film_dir (name);
113 if (boost::filesystem::exists (p)) {
114 boost::filesystem::remove_all (p);
117 shared_ptr<Film> film = boost::make_shared<Film> (p.string());
118 film->write_metadata ();
123 check_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
127 SNDFILE* ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
128 BOOST_CHECK (ref_file);
131 check_info.format = 0;
132 SNDFILE* check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
133 BOOST_CHECK (check_file);
135 BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
136 BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
137 BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
138 BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
140 /* buffer_size is in frames */
141 sf_count_t const buffer_size = 65536 * ref_info.channels;
142 scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
143 scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
145 sf_count_t N = ref_info.frames;
147 sf_count_t this_time = min (buffer_size, N);
148 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
149 BOOST_CHECK_EQUAL (r, this_time);
150 r = sf_readf_int (check_file, check_buffer.get(), this_time);
151 BOOST_CHECK_EQUAL (r, this_time);
153 for (sf_count_t i = 0; i < this_time; ++i) {
154 BOOST_REQUIRE_MESSAGE (
155 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
156 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
157 << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
166 check_file (boost::filesystem::path ref, boost::filesystem::path check)
168 uintmax_t N = boost::filesystem::file_size (ref);
169 BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
170 FILE* ref_file = fopen_boost (ref, "rb");
171 BOOST_CHECK (ref_file);
172 FILE* check_file = fopen_boost (check, "rb");
173 BOOST_CHECK (check_file);
175 int const buffer_size = 65536;
176 uint8_t* ref_buffer = new uint8_t[buffer_size];
177 uint8_t* check_buffer = new uint8_t[buffer_size];
179 SafeStringStream error;
180 error << "File " << check.string() << " differs from reference " << ref.string();
183 uintmax_t this_time = min (uintmax_t (buffer_size), N);
184 size_t r = fread (ref_buffer, 1, this_time, ref_file);
185 BOOST_CHECK_EQUAL (r, this_time);
186 r = fread (check_buffer, 1, this_time, check_file);
187 BOOST_CHECK_EQUAL (r, this_time);
189 BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error.str ());
190 if (memcmp (ref_buffer, check_buffer, this_time)) {
198 delete[] check_buffer;
205 note (dcp::NoteType t, string n)
207 if (t == dcp::DCP_ERROR) {
213 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
215 dcp::DCP ref_dcp (ref);
217 dcp::DCP check_dcp (check);
220 dcp::EqualityOptions options;
221 options.max_mean_pixel_error = 5;
222 options.max_std_dev_pixel_error = 5;
223 options.max_audio_sample_error = 255;
224 options.cpl_annotation_texts_can_differ = true;
225 options.reel_annotation_texts_can_differ = true;
226 options.reel_hashes_can_differ = true;
227 options.issue_dates_can_differ = true;
229 BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
233 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
235 BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
236 BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
238 if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
242 xmlpp::Element::NodeList ref_children = ref->get_children ();
243 xmlpp::Element::NodeList test_children = test->get_children ();
244 BOOST_CHECK_EQUAL (ref_children.size (), test_children.size ());
246 xmlpp::Element::NodeList::iterator k = ref_children.begin ();
247 xmlpp::Element::NodeList::iterator l = test_children.begin ();
248 while (k != ref_children.end ()) {
250 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
252 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
253 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
254 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
255 if (ref_el && test_el) {
256 check_xml (ref_el, test_el, ignore);
259 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
260 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
261 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
262 if (ref_cn && test_cn) {
263 BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
270 xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
271 xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
272 BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
274 xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
275 xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
276 while (m != ref_attributes.end ()) {
277 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
278 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
286 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
288 xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
289 xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
290 xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
291 xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
293 check_xml (ref_root, test_root, ignore);
299 JobManager* jm = JobManager::instance ();
300 while (jm->work_to_do ()) {
301 while (signal_manager->ui_idle ()) {}
307 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
308 if ((*i)->finished_in_error ()) {
312 cerr << N << " errors.\n";
314 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
315 if ((*i)->finished_in_error ()) {
316 cerr << (*i)->name() << ":\n"
317 << "\tsummary: " << (*i)->error_summary () << "\n"
318 << "\tdetails: " << (*i)->error_details () << "\n";
323 while (signal_manager->ui_idle ()) {}
331 write_image (shared_ptr<const Image> image, boost::filesystem::path file)
333 #ifdef DCPOMATIC_IMAGE_MAGICK
334 using namespace MagickCore;
336 using namespace MagickLib;
339 Magick::Image m (image->size().width, image->size().height, "ARGB", CharPixel, (void *) image->data()[0]);
340 m.write (file.string ());