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