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