test/test.cc

   1 /*
   2     Copyright (C) 2012-2015 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_file (boost::filesystem::path ref, boost::filesystem::path check)
 167 {
 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);
 174
 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];
 178
 179         string error = "File " + check.string() + " differs from reference " + ref.string();
 180
 181         while (N) {
 182                 uintmax_t this_time = min (uintmax_t (buffer_size), N);
 183                 size_t r = fread (ref_buffer, 1, this_time, ref_file);
 184                 BOOST_CHECK_EQUAL (r, this_time);
 185                 r = fread (check_buffer, 1, this_time, check_file);
 186                 BOOST_CHECK_EQUAL (r, this_time);
 187
 188                 BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error);
 189                 if (memcmp (ref_buffer, check_buffer, this_time)) {
 190                         break;
 191                 }
 192
 193                 N -= this_time;
 194         }
 195
 196         delete[] ref_buffer;
 197         delete[] check_buffer;
 198
 199         fclose (ref_file);
 200         fclose (check_file);
 201 }
 202
 203 static void
 204 note (dcp::NoteType t, string n)
 205 {
 206         if (t == dcp::DCP_ERROR) {
 207                 cerr << n << "\n";
 208         }
 209 }
 210
 211 void
 212 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
 213 {
 214         dcp::DCP ref_dcp (ref);
 215         ref_dcp.read ();
 216         dcp::DCP check_dcp (check);
 217         check_dcp.read ();
 218
 219         dcp::EqualityOptions options;
 220         options.max_mean_pixel_error = 5;
 221         options.max_std_dev_pixel_error = 5;
 222         options.max_audio_sample_error = 255;
 223         options.cpl_annotation_texts_can_differ = true;
 224         options.reel_annotation_texts_can_differ = true;
 225         options.reel_hashes_can_differ = true;
 226         options.issue_dates_can_differ = true;
 227
 228         BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
 229 }
 230
 231 void
 232 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
 233 {
 234         BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
 235         BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
 236
 237         if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
 238                 return;
 239         }
 240
 241         xmlpp::Element::NodeList ref_children = ref->get_children ();
 242         xmlpp::Element::NodeList test_children = test->get_children ();
 243         BOOST_CHECK_MESSAGE (
 244                 ref_children.size() == test_children.size(),
 245                 ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
 246                 );
 247
 248         xmlpp::Element::NodeList::iterator k = ref_children.begin ();
 249         xmlpp::Element::NodeList::iterator l = test_children.begin ();
 250         while (k != ref_children.end ()) {
 251
 252                 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
 253
 254                 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
 255                 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
 256                 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
 257                 if (ref_el && test_el) {
 258                         check_xml (ref_el, test_el, ignore);
 259                 }
 260
 261                 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
 262                 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
 263                 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
 264                 if (ref_cn && test_cn) {
 265                         BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
 266                 }
 267
 268                 ++k;
 269                 ++l;
 270         }
 271
 272         xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
 273         xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
 274         BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
 275
 276         xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
 277         xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
 278         while (m != ref_attributes.end ()) {
 279                 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
 280                 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
 281
 282                 ++m;
 283                 ++n;
 284         }
 285 }
 286
 287 void
 288 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
 289 {
 290         xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
 291         xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
 292         xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
 293         xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
 294
 295         check_xml (ref_root, test_root, ignore);
 296 }
 297
 298 bool
 299 wait_for_jobs ()
 300 {
 301         JobManager* jm = JobManager::instance ();
 302         while (jm->work_to_do ()) {
 303                 while (signal_manager->ui_idle ()) {}
 304                 dcpomatic_sleep (1);
 305         }
 306
 307         if (jm->errors ()) {
 308                 int N = 0;
 309                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 310                         if ((*i)->finished_in_error ()) {
 311                                 ++N;
 312                         }
 313                 }
 314                 cerr << N << " errors.\n";
 315
 316                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 317                         if ((*i)->finished_in_error ()) {
 318                                 cerr << (*i)->name() << ":\n"
 319                                      << "\tsummary: " << (*i)->error_summary () << "\n"
 320                                      << "\tdetails: " << (*i)->error_details () << "\n";
 321                         }
 322                 }
 323         }
 324
 325         while (signal_manager->ui_idle ()) {}
 326
 327         if (jm->errors ()) {
 328                 JobManager::drop ();
 329                 return true;
 330         }
 331
 332         return false;
 333 }
 334
 335 void
 336 write_image (shared_ptr<const Image> image, boost::filesystem::path file)
 337 {
 338 #ifdef DCPOMATIC_IMAGE_MAGICK
 339                 using namespace MagickCore;
 340 #else
 341                 using namespace MagickLib;
 342 #endif
 343
 344         Magick::Image m (image->size().width, image->size().height, "ARGB", CharPixel, (void *) image->data()[0]);
 345         m.write (file.string ());
 346 }