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