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 ("test") / boost::filesystem::path ("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_dci_metadata (DCIMetadata ());
  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
  81 BOOST_GLOBAL_FIXTURE (TestConfig);
  82
  83 boost::filesystem::path
  84 test_film_dir (string name)
  85 {
  86         boost::filesystem::path p;
  87         p /= "build";
  88         p /= "test";
  89         p /= name;
  90         return p;
  91 }
  92
  93 shared_ptr<Film>
  94 new_test_film (string name)
  95 {
  96         boost::filesystem::path p = test_film_dir (name);
  97         if (boost::filesystem::exists (p)) {
  98                 boost::filesystem::remove_all (p);
  99         }
 100
 101         shared_ptr<Film> f = shared_ptr<Film> (new Film (p.string()));
 102         f->write_metadata ();
 103         return f;
 104 }
 105
 106 void
 107 check_file (boost::filesystem::path ref, boost::filesystem::path check)
 108 {
 109         uintmax_t N = boost::filesystem::file_size (ref);
 110         BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
 111         FILE* ref_file = fopen (ref.c_str(), "rb");
 112         BOOST_CHECK (ref_file);
 113         FILE* check_file = fopen_boost (check, "rb");
 114         BOOST_CHECK (check_file);
 115
 116         int const buffer_size = 65536;
 117         uint8_t* ref_buffer = new uint8_t[buffer_size];
 118         uint8_t* check_buffer = new uint8_t[buffer_size];
 119
 120         while (N) {
 121                 uintmax_t this_time = min (uintmax_t (buffer_size), N);
 122                 size_t r = fread (ref_buffer, 1, this_time, ref_file);
 123                 BOOST_CHECK_EQUAL (r, this_time);
 124                 r = fread (check_buffer, 1, this_time, check_file);
 125                 BOOST_CHECK_EQUAL (r, this_time);
 126
 127                 BOOST_CHECK_EQUAL (memcmp (ref_buffer, check_buffer, this_time), 0);
 128                 N -= this_time;
 129         }
 130
 131         delete[] ref_buffer;
 132         delete[] check_buffer;
 133
 134         fclose (ref_file);
 135         fclose (check_file);
 136 }
 137
 138 static void
 139 note (dcp::NoteType t, string n)
 140 {
 141         if (t == dcp::ERROR) {
 142                 cerr << n << "\n";
 143         }
 144 }
 145
 146 void
 147 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
 148 {
 149         dcp::DCP ref_dcp (ref);
 150         ref_dcp.read ();
 151         dcp::DCP check_dcp (check);
 152         check_dcp.read ();
 153
 154         dcp::EqualityOptions options;
 155         options.max_mean_pixel_error = 5;
 156         options.max_std_dev_pixel_error = 5;
 157         options.max_audio_sample_error = 255;
 158         options.cpl_annotation_texts_can_differ = true;
 159         options.mxf_names_can_differ = true;
 160
 161         BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
 162 }
 163
 164 void
 165 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
 166 {
 167         BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
 168         BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
 169
 170         if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
 171                 return;
 172         }
 173
 174         xmlpp::Element::NodeList ref_children = ref->get_children ();
 175         xmlpp::Element::NodeList test_children = test->get_children ();
 176         BOOST_CHECK_EQUAL (ref_children.size (), test_children.size ());
 177
 178         xmlpp::Element::NodeList::iterator k = ref_children.begin ();
 179         xmlpp::Element::NodeList::iterator l = test_children.begin ();
 180         while (k != ref_children.end ()) {
 181
 182                 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
 183
 184                 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
 185                 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
 186                 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
 187                 if (ref_el && test_el) {
 188                         check_xml (ref_el, test_el, ignore);
 189                 }
 190
 191                 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
 192                 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
 193                 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
 194                 if (ref_cn && test_cn) {
 195                         BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
 196                 }
 197
 198                 xmlpp::Attribute* ref_at = dynamic_cast<xmlpp::Attribute*> (*k);
 199                 xmlpp::Attribute* test_at = dynamic_cast<xmlpp::Attribute*> (*l);
 200                 BOOST_CHECK ((ref_at && test_at) || (!ref_at && !test_at));
 201                 if (ref_at && test_at) {
 202                         BOOST_CHECK_EQUAL (ref_at->get_name(), test_at->get_name ());
 203                         BOOST_CHECK_EQUAL (ref_at->get_value(), test_at->get_value ());
 204                 }
 205
 206                 ++k;
 207                 ++l;
 208         }
 209 }
 210
 211 void
 212 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
 213 {
 214         xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
 215         xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
 216         xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
 217         xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
 218
 219         check_xml (ref_root, test_root, ignore);
 220 }
 221
 222 void
 223 wait_for_jobs ()
 224 {
 225         JobManager* jm = JobManager::instance ();
 226         while (jm->work_to_do ()) {
 227                 ui_signaller->ui_idle ();
 228         }
 229         if (jm->errors ()) {
 230                 int N = 0;
 231                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 232                         if ((*i)->finished_in_error ()) {
 233                                 ++N;
 234                         }
 235                 }
 236                 cerr << N << " errors.\n";
 237
 238                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 239                         if ((*i)->finished_in_error ()) {
 240                                 cerr << (*i)->name() << ":\n"
 241                                      << "\tsummary: " << (*i)->error_summary () << "\n"
 242                                      << "\tdetails: " << (*i)->error_details () << "\n";
 243                         }
 244                 }
 245         }
 246
 247         BOOST_CHECK (!jm->errors());
 248
 249         ui_signaller->ui_idle ();
 250 }
 251
 252 void
 253 write_image (shared_ptr<const Image> image, boost::filesystem::path file)
 254 {
 255         using namespace MagickCore;
 256
 257         Magick::Image m (image->size().width, image->size().height, "ARGB", CharPixel, (void *) image->data()[0]);
 258         m.write (file.string ());
 259 }