test/test.cc

   1 /*
   2     Copyright (C) 2012-2017 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 /** @file  test/test.cc
  22  *  @brief Overall test stuff and useful methods for tests.
  23  */
  24
  25 #include "lib/config.h"
  26 #include "lib/util.h"
  27 #include "lib/signal_manager.h"
  28 #include "lib/film.h"
  29 #include "lib/job_manager.h"
  30 #include "lib/job.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"
  36 #include <dcp/dcp.h>
  37 #include <asdcp/AS_DCP.h>
  38 #include <sndfile.h>
  39 #include <libxml++/libxml++.h>
  40 #include <Magick++.h>
  41 #define BOOST_TEST_DYN_LINK
  42 #define BOOST_TEST_MODULE dcpomatic_test
  43 #include <boost/test/unit_test.hpp>
  44 #include <list>
  45 #include <vector>
  46 #include <iostream>
  47
  48 using std::string;
  49 using std::vector;
  50 using std::min;
  51 using std::cout;
  52 using std::cerr;
  53 using std::list;
  54 using std::abs;
  55 using boost::shared_ptr;
  56 using boost::scoped_array;
  57
  58 boost::filesystem::path private_data = boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private");
  59
  60 class TestSignalManager : public SignalManager
  61 {
  62 public:
  63         /* No wakes in tests: we call ui_idle ourselves */
  64         void wake_ui ()
  65         {
  66
  67         }
  68 };
  69
  70 struct TestConfig
  71 {
  72         TestConfig ()
  73         {
  74                 dcpomatic_setup ();
  75
  76                 Config::instance()->set_master_encoding_threads (1);
  77                 Config::instance()->set_server_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_default_interop (false);
  85                 Config::instance()->set_log_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
  86
  87                 EncodeServerFinder::instance()->stop ();
  88
  89                 signal_manager = new TestSignalManager ();
  90         }
  91
  92         ~TestConfig ()
  93         {
  94                 JobManager::drop ();
  95         }
  96 };
  97
  98 BOOST_GLOBAL_FIXTURE (TestConfig);
  99
 100 boost::filesystem::path
 101 test_film_dir (string name)
 102 {
 103         boost::filesystem::path p;
 104         p /= "build";
 105         p /= "test";
 106         p /= name;
 107         return p;
 108 }
 109
 110 shared_ptr<Film>
 111 new_test_film (string name)
 112 {
 113         boost::filesystem::path p = test_film_dir (name);
 114         if (boost::filesystem::exists (p)) {
 115                 boost::filesystem::remove_all (p);
 116         }
 117
 118         shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
 119         film->write_metadata ();
 120         return film;
 121 }
 122
 123 void
 124 check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
 125 {
 126         SF_INFO ref_info;
 127         ref_info.format = 0;
 128         SNDFILE* ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
 129         BOOST_CHECK (ref_file);
 130
 131         SF_INFO check_info;
 132         check_info.format = 0;
 133         SNDFILE* check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
 134         BOOST_CHECK (check_file);
 135
 136         BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
 137         BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
 138         BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
 139         BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
 140
 141         /* buffer_size is in frames */
 142         sf_count_t const buffer_size = 65536 * ref_info.channels;
 143         scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
 144         scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
 145
 146         sf_count_t N = ref_info.frames;
 147         while (N) {
 148                 sf_count_t this_time = min (buffer_size, N);
 149                 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
 150                 BOOST_CHECK_EQUAL (r, this_time);
 151                 r = sf_readf_int (check_file, check_buffer.get(), this_time);
 152                 BOOST_CHECK_EQUAL (r, this_time);
 153
 154                 for (sf_count_t i = 0; i < this_time; ++i) {
 155                         BOOST_REQUIRE_MESSAGE (
 156                                 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
 157                                 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
 158                                 << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
 159                                 );
 160                 }
 161
 162                 N -= this_time;
 163         }
 164 }
 165
 166 void
 167 check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
 168 {
 169         ASDCP::PCM::MXFReader ref_reader;
 170         BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.OpenRead (ref.string().c_str())));
 171
 172         ASDCP::PCM::AudioDescriptor ref_desc;
 173         BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.FillAudioDescriptor (ref_desc)));
 174
 175         ASDCP::PCM::MXFReader check_reader;
 176         BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.OpenRead (check.string().c_str())));
 177
 178         ASDCP::PCM::AudioDescriptor check_desc;
 179         BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.FillAudioDescriptor (check_desc)));
 180
 181         BOOST_REQUIRE_EQUAL (ref_desc.ContainerDuration, check_desc.ContainerDuration);
 182
 183         ASDCP::PCM::FrameBuffer ref_buffer (Kumu::Megabyte);
 184         ASDCP::PCM::FrameBuffer check_buffer (Kumu::Megabyte);
 185         for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
 186                 ref_reader.ReadFrame (i, ref_buffer, 0);
 187                 check_reader.ReadFrame (i, check_buffer, 0);
 188                 BOOST_REQUIRE (memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size()) == 0);
 189         }
 190 }
 191
 192 void
 193 check_image (boost::filesystem::path ref, boost::filesystem::path check)
 194 {
 195 #ifdef DCPOMATIC_IMAGE_MAGICK
 196         using namespace MagickCore;
 197 #else
 198         using namespace MagickLib;
 199 #endif
 200
 201         Magick::Image ref_image;
 202         ref_image.read (ref.string ());
 203         Magick::Image check_image;
 204         check_image.read (check.string ());
 205         BOOST_CHECK_MESSAGE (ref_image.compare (check_image), ref << " differs from " << check);
 206 }
 207
 208 void
 209 check_file (boost::filesystem::path ref, boost::filesystem::path check)
 210 {
 211         uintmax_t N = boost::filesystem::file_size (ref);
 212         BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
 213         FILE* ref_file = fopen_boost (ref, "rb");
 214         BOOST_CHECK (ref_file);
 215         FILE* check_file = fopen_boost (check, "rb");
 216         BOOST_CHECK (check_file);
 217
 218         int const buffer_size = 65536;
 219         uint8_t* ref_buffer = new uint8_t[buffer_size];
 220         uint8_t* check_buffer = new uint8_t[buffer_size];
 221
 222         string error = "File " + check.string() + " differs from reference " + ref.string();
 223
 224         while (N) {
 225                 uintmax_t this_time = min (uintmax_t (buffer_size), N);
 226                 size_t r = fread (ref_buffer, 1, this_time, ref_file);
 227                 BOOST_CHECK_EQUAL (r, this_time);
 228                 r = fread (check_buffer, 1, this_time, check_file);
 229                 BOOST_CHECK_EQUAL (r, this_time);
 230
 231                 BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error);
 232                 if (memcmp (ref_buffer, check_buffer, this_time)) {
 233                         break;
 234                 }
 235
 236                 N -= this_time;
 237         }
 238
 239         delete[] ref_buffer;
 240         delete[] check_buffer;
 241
 242         fclose (ref_file);
 243         fclose (check_file);
 244 }
 245
 246 static void
 247 note (dcp::NoteType t, string n)
 248 {
 249         if (t == dcp::DCP_ERROR) {
 250                 cerr << n << "\n";
 251         }
 252 }
 253
 254 void
 255 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
 256 {
 257         dcp::DCP ref_dcp (ref);
 258         ref_dcp.read ();
 259         dcp::DCP check_dcp (check);
 260         check_dcp.read ();
 261
 262         dcp::EqualityOptions options;
 263         options.max_mean_pixel_error = 5;
 264         options.max_std_dev_pixel_error = 5;
 265         options.max_audio_sample_error = 255;
 266         options.cpl_annotation_texts_can_differ = true;
 267         options.reel_annotation_texts_can_differ = true;
 268         options.reel_hashes_can_differ = true;
 269         options.issue_dates_can_differ = true;
 270
 271         BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
 272 }
 273
 274 void
 275 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
 276 {
 277         BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
 278         BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
 279
 280         if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
 281                 return;
 282         }
 283
 284         xmlpp::Element::NodeList ref_children = ref->get_children ();
 285         xmlpp::Element::NodeList test_children = test->get_children ();
 286         BOOST_CHECK_MESSAGE (
 287                 ref_children.size() == test_children.size(),
 288                 ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
 289                 );
 290
 291         xmlpp::Element::NodeList::iterator k = ref_children.begin ();
 292         xmlpp::Element::NodeList::iterator l = test_children.begin ();
 293         while (k != ref_children.end ()) {
 294
 295                 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
 296
 297                 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
 298                 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
 299                 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
 300                 if (ref_el && test_el) {
 301                         check_xml (ref_el, test_el, ignore);
 302                 }
 303
 304                 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
 305                 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
 306                 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
 307                 if (ref_cn && test_cn) {
 308                         BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
 309                 }
 310
 311                 ++k;
 312                 ++l;
 313         }
 314
 315         xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
 316         xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
 317         BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
 318
 319         xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
 320         xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
 321         while (m != ref_attributes.end ()) {
 322                 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
 323                 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
 324
 325                 ++m;
 326                 ++n;
 327         }
 328 }
 329
 330 void
 331 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
 332 {
 333         xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
 334         xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
 335         xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
 336         xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
 337
 338         check_xml (ref_root, test_root, ignore);
 339 }
 340
 341 bool
 342 wait_for_jobs ()
 343 {
 344         JobManager* jm = JobManager::instance ();
 345         while (jm->work_to_do ()) {
 346                 while (signal_manager->ui_idle ()) {}
 347                 dcpomatic_sleep (1);
 348         }
 349
 350         if (jm->errors ()) {
 351                 int N = 0;
 352                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 353                         if ((*i)->finished_in_error ()) {
 354                                 ++N;
 355                         }
 356                 }
 357                 cerr << N << " errors.\n";
 358
 359                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 360                         if ((*i)->finished_in_error ()) {
 361                                 cerr << (*i)->name() << ":\n"
 362                                      << "\tsummary: " << (*i)->error_summary () << "\n"
 363                                      << "\tdetails: " << (*i)->error_details () << "\n";
 364                         }
 365                 }
 366         }
 367
 368         while (signal_manager->ui_idle ()) {}
 369
 370         if (jm->errors ()) {
 371                 JobManager::drop ();
 372                 return true;
 373         }
 374
 375         return false;
 376 }
 377
 378 void
 379 write_image (shared_ptr<const Image> image, boost::filesystem::path file, string format)
 380 {
 381 #ifdef DCPOMATIC_IMAGE_MAGICK
 382                 using namespace MagickCore;
 383 #else
 384                 using namespace MagickLib;
 385 #endif
 386
 387         Magick::Image m (image->size().width, image->size().height, format.c_str(), CharPixel, (void *) image->data()[0]);
 388         m.write (file.string ());
 389 }