test/test.cc

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