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