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