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 <libxml++/libxml++.h>
  28 #include <dcp/dcp.h>
  29 #include "lib/config.h"
  30 #include "lib/util.h"
  31 #include "lib/ui_signaller.h"
  32 #include "lib/film.h"
  33 #include "lib/job_manager.h"
  34 #include "lib/job.h"
  35 #include "lib/cross.h"
  36 #include "lib/server_finder.h"
  37 #include "lib/image.h"
  38 #define BOOST_TEST_DYN_LINK
  39 #define BOOST_TEST_MODULE dcpomatic_test
  40 #include <boost/test/unit_test.hpp>
  41
  42 using std::string;
  43 using std::vector;
  44 using std::min;
  45 using std::cout;
  46 using std::cerr;
  47 using std::list;
  48 using boost::shared_ptr;
  49
  50 boost::filesystem::path private_data = boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private");
  51
  52 class TestUISignaller : public UISignaller
  53 {
  54 public:
  55         /* No wakes in tests: we call ui_idle ourselves */
  56         void wake_ui ()
  57         {
  58
  59         }
  60 };
  61
  62 struct TestConfig
  63 {
  64         TestConfig ()
  65         {
  66                 dcpomatic_setup ();
  67
  68                 Config::instance()->set_num_local_encoding_threads (1);
  69                 Config::instance()->set_server_port_base (61920);
  70                 Config::instance()->set_default_isdcf_metadata (ISDCFMetadata ());
  71                 Config::instance()->set_default_container (static_cast<Ratio*> (0));
  72                 Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
  73                 Config::instance()->set_default_audio_delay (0);
  74
  75                 ServerFinder::instance()->disable ();
  76
  77                 ui_signaller = new TestUISignaller ();
  78         }
  79
  80         ~TestConfig ()
  81         {
  82                 JobManager::drop ();
  83         }
  84 };
  85
  86 BOOST_GLOBAL_FIXTURE (TestConfig);
  87
  88 boost::filesystem::path
  89 test_film_dir (string name)
  90 {
  91         boost::filesystem::path p;
  92         p /= "build";
  93         p /= "test";
  94         p /= name;
  95         return p;
  96 }
  97
  98 shared_ptr<Film>
  99 new_test_film (string name)
 100 {
 101         boost::filesystem::path p = test_film_dir (name);
 102         if (boost::filesystem::exists (p)) {
 103                 boost::filesystem::remove_all (p);
 104         }
 105
 106         shared_ptr<Film> f = shared_ptr<Film> (new Film (p.string()));
 107         f->write_metadata ();
 108         return f;
 109 }
 110
 111 void
 112 check_file (boost::filesystem::path ref, boost::filesystem::path check)
 113 {
 114         uintmax_t N = boost::filesystem::file_size (ref);
 115         BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
 116         FILE* ref_file = fopen (ref.c_str(), "rb");
 117         BOOST_CHECK (ref_file);
 118         FILE* check_file = fopen_boost (check, "rb");
 119         BOOST_CHECK (check_file);
 120
 121         int const buffer_size = 65536;
 122         uint8_t* ref_buffer = new uint8_t[buffer_size];
 123         uint8_t* check_buffer = new uint8_t[buffer_size];
 124
 125         while (N) {
 126                 uintmax_t this_time = min (uintmax_t (buffer_size), N);
 127                 size_t r = fread (ref_buffer, 1, this_time, ref_file);
 128                 BOOST_CHECK_EQUAL (r, this_time);
 129                 r = fread (check_buffer, 1, this_time, check_file);
 130                 BOOST_CHECK_EQUAL (r, this_time);
 131
 132                 BOOST_CHECK_EQUAL (memcmp (ref_buffer, check_buffer, this_time), 0);
 133                 N -= this_time;
 134         }
 135
 136         delete[] ref_buffer;
 137         delete[] check_buffer;
 138
 139         fclose (ref_file);
 140         fclose (check_file);
 141 }
 142
 143 static void
 144 note (dcp::NoteType t, string n)
 145 {
 146         if (t == dcp::DCP_ERROR) {
 147                 cerr << n << "\n";
 148         }
 149 }
 150
 151 void
 152 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
 153 {
 154         dcp::DCP ref_dcp (ref);
 155         ref_dcp.read ();
 156         dcp::DCP check_dcp (check);
 157         check_dcp.read ();
 158
 159         dcp::EqualityOptions options;
 160         options.max_mean_pixel_error = 5;
 161         options.max_std_dev_pixel_error = 5;
 162         options.max_audio_sample_error = 255;
 163         options.cpl_annotation_texts_can_differ = true;
 164         options.mxf_names_can_differ = true;
 165
 166         BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
 167 }
 168
 169 void
 170 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
 171 {
 172         BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
 173         BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
 174
 175         if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
 176                 return;
 177         }
 178
 179         xmlpp::Element::NodeList ref_children = ref->get_children ();
 180         xmlpp::Element::NodeList test_children = test->get_children ();
 181         BOOST_CHECK_EQUAL (ref_children.size (), test_children.size ());
 182
 183         xmlpp::Element::NodeList::iterator k = ref_children.begin ();
 184         xmlpp::Element::NodeList::iterator l = test_children.begin ();
 185         while (k != ref_children.end () && l != test_children.end ()) {
 186
 187                 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
 188
 189                 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
 190                 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
 191                 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
 192                 if (ref_el && test_el) {
 193                         check_xml (ref_el, test_el, ignore);
 194                 }
 195
 196                 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
 197                 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
 198                 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
 199                 if (ref_cn && test_cn) {
 200                         BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
 201                 }
 202
 203                 xmlpp::Attribute* ref_at = dynamic_cast<xmlpp::Attribute*> (*k);
 204                 xmlpp::Attribute* test_at = dynamic_cast<xmlpp::Attribute*> (*l);
 205                 BOOST_CHECK ((ref_at && test_at) || (!ref_at && !test_at));
 206                 if (ref_at && test_at) {
 207                         BOOST_CHECK_EQUAL (ref_at->get_name(), test_at->get_name ());
 208                         BOOST_CHECK_EQUAL (ref_at->get_value(), test_at->get_value ());
 209                 }
 210
 211                 ++k;
 212                 ++l;
 213         }
 214
 215         BOOST_CHECK (k == ref_children.end ());
 216         BOOST_CHECK (l == test_children.end ());
 217 }
 218
 219 void
 220 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
 221 {
 222         xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
 223         xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
 224         xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
 225         xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
 226
 227         check_xml (ref_root, test_root, ignore);
 228 }
 229
 230 void
 231 wait_for_jobs ()
 232 {
 233         JobManager* jm = JobManager::instance ();
 234         while (jm->work_to_do ()) {
 235                 ui_signaller->ui_idle ();
 236         }
 237         if (jm->errors ()) {
 238                 int N = 0;
 239                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 240                         if ((*i)->finished_in_error ()) {
 241                                 ++N;
 242                         }
 243                 }
 244                 cerr << N << " errors.\n";
 245
 246                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 247                         if ((*i)->finished_in_error ()) {
 248                                 cerr << (*i)->name() << ":\n"
 249                                      << "\tsummary: " << (*i)->error_summary () << "\n"
 250                                      << "\tdetails: " << (*i)->error_details () << "\n";
 251                         }
 252                 }
 253         }
 254
 255         BOOST_CHECK (!jm->errors());
 256
 257         ui_signaller->ui_idle ();
 258 }
 259
 260 void
 261 write_image (shared_ptr<const Image> image, boost::filesystem::path file)
 262 {
 263         using namespace MagickCore;
 264
 265         Magick::Image m (image->size().width, image->size().height, "ARGB", CharPixel, (void *) image->data()[0]);
 266         m.write (file.string ());
 267 }