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