test/test.cc

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  test/test.cc
  21  *  @brief Overall test stuff and useful methods for tests.
  22  */
  23
  24 #include "lib/config.h"
  25 #include "lib/util.h"
  26 #include "lib/signal_manager.h"
  27 #include "lib/film.h"
  28 #include "lib/job_manager.h"
  29 #include "lib/job.h"
  30 #include "lib/cross.h"
  31 #include "lib/encode_server_finder.h"
  32 #include "lib/image.h"
  33 #include "lib/ratio.h"
  34 #include "lib/log_entry.h"
  35 #include <dcp/dcp.h>
  36 #include <sndfile.h>
  37 #include <libxml++/libxml++.h>
  38 #include <Magick++.h>
  39 #define BOOST_TEST_DYN_LINK
  40 #define BOOST_TEST_MODULE dcpomatic_test
  41 #include <boost/test/unit_test.hpp>
  42 #include <list>
  43 #include <vector>
  44 #include <iostream>
  45
  46 using std::string;
  47 using std::vector;
  48 using std::min;
  49 using std::cout;
  50 using std::cerr;
  51 using std::list;
  52 using std::abs;
  53 using boost::shared_ptr;
  54 using boost::scoped_array;
  55
  56 boost::filesystem::path private_data = boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private");
  57
  58 class TestSignalManager : public SignalManager
  59 {
  60 public:
  61         /* No wakes in tests: we call ui_idle ourselves */
  62         void wake_ui ()
  63         {
  64
  65         }
  66 };
  67
  68 struct TestConfig
  69 {
  70         TestConfig ()
  71         {
  72                 dcpomatic_setup ();
  73
  74                 Config::instance()->set_num_local_encoding_threads (1);
  75                 Config::instance()->set_server_port_base (61921);
  76                 Config::instance()->set_default_isdcf_metadata (ISDCFMetadata ());
  77                 Config::instance()->set_default_container (Ratio::from_id ("185"));
  78                 Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
  79                 Config::instance()->set_default_audio_delay (0);
  80                 Config::instance()->set_default_j2k_bandwidth (100000000);
  81                 Config::instance()->set_log_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
  82
  83                 EncodeServerFinder::instance()->disable ();
  84
  85                 signal_manager = new TestSignalManager ();
  86         }
  87
  88         ~TestConfig ()
  89         {
  90                 JobManager::drop ();
  91         }
  92 };
  93
  94 BOOST_GLOBAL_FIXTURE (TestConfig);
  95
  96 boost::filesystem::path
  97 test_film_dir (string name)
  98 {
  99         boost::filesystem::path p;
 100         p /= "build";
 101         p /= "test";
 102         p /= name;
 103         return p;
 104 }
 105
 106 shared_ptr<Film>
 107 new_test_film (string name)
 108 {
 109         boost::filesystem::path p = test_film_dir (name);
 110         if (boost::filesystem::exists (p)) {
 111                 boost::filesystem::remove_all (p);
 112         }
 113
 114         shared_ptr<Film> film = shared_ptr<Film> (new Film (p.string()));
 115         film->write_metadata ();
 116         return film;
 117 }
 118
 119 void
 120 check_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
 121 {
 122         SF_INFO ref_info;
 123         ref_info.format = 0;
 124         SNDFILE* ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
 125         BOOST_CHECK (ref_file);
 126
 127         SF_INFO check_info;
 128         check_info.format = 0;
 129         SNDFILE* check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
 130         BOOST_CHECK (check_file);
 131
 132         BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
 133         BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
 134         BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
 135         BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
 136
 137         /* buffer_size is in frames */
 138         sf_count_t const buffer_size = 65536 * ref_info.channels;
 139         scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
 140         scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
 141
 142         sf_count_t N = ref_info.frames;
 143         while (N) {
 144                 sf_count_t this_time = min (buffer_size, N);
 145                 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
 146                 BOOST_CHECK_EQUAL (r, this_time);
 147                 r = sf_readf_int (check_file, check_buffer.get(), this_time);
 148                 BOOST_CHECK_EQUAL (r, this_time);
 149
 150                 for (sf_count_t i = 0; i < this_time; ++i) {
 151                         BOOST_REQUIRE_MESSAGE (
 152                                 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
 153                                 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
 154                                 );
 155                 }
 156
 157                 N -= this_time;
 158         }
 159 }
 160
 161 void
 162 check_file (boost::filesystem::path ref, boost::filesystem::path check)
 163 {
 164         uintmax_t N = boost::filesystem::file_size (ref);
 165         BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
 166         FILE* ref_file = fopen_boost (ref, "rb");
 167         BOOST_CHECK (ref_file);
 168         FILE* check_file = fopen_boost (check, "rb");
 169         BOOST_CHECK (check_file);
 170
 171         int const buffer_size = 65536;
 172         uint8_t* ref_buffer = new uint8_t[buffer_size];
 173         uint8_t* check_buffer = new uint8_t[buffer_size];
 174
 175         SafeStringStream error;
 176         error << "File " << check.string() << " differs from reference " << ref.string();
 177
 178         while (N) {
 179                 uintmax_t this_time = min (uintmax_t (buffer_size), N);
 180                 size_t r = fread (ref_buffer, 1, this_time, ref_file);
 181                 BOOST_CHECK_EQUAL (r, this_time);
 182                 r = fread (check_buffer, 1, this_time, check_file);
 183                 BOOST_CHECK_EQUAL (r, this_time);
 184
 185                 BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error.str ());
 186                 if (memcmp (ref_buffer, check_buffer, this_time)) {
 187                         break;
 188                 }
 189
 190                 N -= this_time;
 191         }
 192
 193         delete[] ref_buffer;
 194         delete[] check_buffer;
 195
 196         fclose (ref_file);
 197         fclose (check_file);
 198 }
 199
 200 static void
 201 note (dcp::NoteType t, string n)
 202 {
 203         if (t == dcp::DCP_ERROR) {
 204                 cerr << n << "\n";
 205         }
 206 }
 207
 208 void
 209 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
 210 {
 211         dcp::DCP ref_dcp (ref);
 212         ref_dcp.read ();
 213         dcp::DCP check_dcp (check);
 214         check_dcp.read ();
 215
 216         dcp::EqualityOptions options;
 217         options.max_mean_pixel_error = 5;
 218         options.max_std_dev_pixel_error = 5;
 219         options.max_audio_sample_error = 255;
 220         options.cpl_annotation_texts_can_differ = true;
 221         options.reel_annotation_texts_can_differ = true;
 222         options.reel_hashes_can_differ = true;
 223         options.issue_dates_can_differ = true;
 224
 225         BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
 226 }
 227
 228 void
 229 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
 230 {
 231         BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
 232         BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
 233
 234         if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
 235                 return;
 236         }
 237
 238         xmlpp::Element::NodeList ref_children = ref->get_children ();
 239         xmlpp::Element::NodeList test_children = test->get_children ();
 240         BOOST_CHECK_EQUAL (ref_children.size (), test_children.size ());
 241
 242         xmlpp::Element::NodeList::iterator k = ref_children.begin ();
 243         xmlpp::Element::NodeList::iterator l = test_children.begin ();
 244         while (k != ref_children.end ()) {
 245
 246                 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
 247
 248                 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
 249                 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
 250                 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
 251                 if (ref_el && test_el) {
 252                         check_xml (ref_el, test_el, ignore);
 253                 }
 254
 255                 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
 256                 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
 257                 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
 258                 if (ref_cn && test_cn) {
 259                         BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
 260                 }
 261
 262                 ++k;
 263                 ++l;
 264         }
 265
 266         xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
 267         xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
 268         BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
 269
 270         xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
 271         xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
 272         while (m != ref_attributes.end ()) {
 273                 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
 274                 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
 275
 276                 ++m;
 277                 ++n;
 278         }
 279 }
 280
 281 void
 282 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
 283 {
 284         xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
 285         xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
 286         xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
 287         xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
 288
 289         check_xml (ref_root, test_root, ignore);
 290 }
 291
 292 void
 293 wait_for_jobs ()
 294 {
 295         JobManager* jm = JobManager::instance ();
 296         while (jm->work_to_do ()) {
 297                 while (signal_manager->ui_idle ()) {}
 298                 dcpomatic_sleep (1);
 299         }
 300
 301         if (jm->errors ()) {
 302                 int N = 0;
 303                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 304                         if ((*i)->finished_in_error ()) {
 305                                 ++N;
 306                         }
 307                 }
 308                 cerr << N << " errors.\n";
 309
 310                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 311                         if ((*i)->finished_in_error ()) {
 312                                 cerr << (*i)->name() << ":\n"
 313                                      << "\tsummary: " << (*i)->error_summary () << "\n"
 314                                      << "\tdetails: " << (*i)->error_details () << "\n";
 315                         }
 316                 }
 317         }
 318
 319         while (signal_manager->ui_idle ()) {}
 320
 321         if (jm->errors ()) {
 322                 JobManager::drop ();
 323         }
 324 }
 325
 326 void
 327 write_image (shared_ptr<const Image> image, boost::filesystem::path file)
 328 {
 329 #ifdef DCPOMATIC_IMAGE_MAGICK
 330                 using namespace MagickCore;
 331 #else
 332                 using namespace MagickLib;
 333 #endif
 334
 335         Magick::Image m (image->size().width, image->size().height, "ARGB", CharPixel, (void *) image->data()[0]);
 336         m.write (file.string ());
 337 }