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