Write logs during tests to a file.
[dcpomatic.git] / test / test.cc
index 71cd50ac928b9b9cab897abc445532c7c918a55e..c0d5d776f17b89a0a00e738aa44a2f8526caee18 100644 (file)
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
  *  @brief Overall test stuff and useful methods for tests.
  */
 
-#include <vector>
-#include <list>
-#include <Magick++.h>
-#include <sndfile.h>
-#include <libxml++/libxml++.h>
-#include <dcp/dcp.h>
 #include "lib/config.h"
 #include "lib/util.h"
-#include "lib/ui_signaller.h"
+#include "lib/signal_manager.h"
 #include "lib/film.h"
 #include "lib/job_manager.h"
 #include "lib/job.h"
 #include "lib/cross.h"
-#include "lib/server_finder.h"
+#include "lib/encode_server_finder.h"
 #include "lib/image.h"
+#include "lib/ratio.h"
+#include "lib/dcp_content_type.h"
+#include "lib/log_entry.h"
+#include "lib/compose.hpp"
+#include "lib/file_log.h"
+#include "lib/dcpomatic_log.h"
+#include "test.h"
+#include <dcp/dcp.h>
+#include <dcp/cpl.h>
+#include <dcp/reel.h>
+#include <dcp/reel_picture_asset.h>
+#include <dcp/mono_picture_frame.h>
+#include <dcp/mono_picture_asset.h>
+#include <dcp/openjpeg_image.h>
+#include <asdcp/AS_DCP.h>
+#include <sndfile.h>
+#include <libxml++/libxml++.h>
+#include <Magick++.h>
+extern "C" {
+#include <libavformat/avformat.h>
+}
 #define BOOST_TEST_DYN_LINK
 #define BOOST_TEST_MODULE dcpomatic_test
 #include <boost/test/unit_test.hpp>
+#include <boost/algorithm/string.hpp>
+#include <list>
+#include <vector>
+#include <iostream>
 
 using std::string;
 using std::vector;
@@ -46,11 +66,31 @@ using std::min;
 using std::cout;
 using std::cerr;
 using std::list;
+using std::abs;
 using boost::shared_ptr;
+using boost::scoped_array;
+using boost::dynamic_pointer_cast;
+
+boost::filesystem::path private_data = boost::filesystem::canonical(boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private"));
 
-boost::filesystem::path private_data = boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private");
+void
+setup_test_config ()
+{
+       Config::instance()->set_master_encoding_threads (1);
+       Config::instance()->set_server_encoding_threads (1);
+       Config::instance()->set_server_port_base (61921);
+       Config::instance()->set_default_isdcf_metadata (ISDCFMetadata ());
+       Config::instance()->set_default_container (Ratio::from_id ("185"));
+       Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
+       Config::instance()->set_default_audio_delay (0);
+       Config::instance()->set_default_j2k_bandwidth (100000000);
+       Config::instance()->set_default_interop (false);
+       Config::instance()->set_default_still_length (10);
+       Config::instance()->set_log_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
+       Config::instance()->set_automatic_audio_analysis (false);
+}
 
-class TestUISignaller : public UISignaller
+class TestSignalManager : public SignalManager
 {
 public:
        /* No wakes in tests: we call ui_idle ourselves */
@@ -65,18 +105,18 @@ struct TestConfig
        TestConfig ()
        {
                dcpomatic_setup ();
+               setup_test_config ();
 
-               Config::instance()->set_num_local_encoding_threads (1);
-               Config::instance()->set_server_port_base (61920);
-               Config::instance()->set_default_isdcf_metadata (ISDCFMetadata ());
-               Config::instance()->set_default_container (static_cast<Ratio*> (0));
-               Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
-               Config::instance()->set_default_audio_delay (0);
-               Config::instance()->set_default_j2k_bandwidth (100000000);
+               EncodeServerFinder::instance()->stop ();
 
-               ServerFinder::instance()->disable ();
+               signal_manager = new TestSignalManager ();
 
-               ui_signaller = new TestUISignaller ();
+               char* env_private = getenv("DCPOMATIC_TEST_PRIVATE");
+               if (env_private) {
+                       private_data = env_private;
+               }
+
+               dcpomatic_log.reset (new FileLog("build/test/log"));
        }
 
        ~TestConfig ()
@@ -104,20 +144,35 @@ new_test_film (string name)
        if (boost::filesystem::exists (p)) {
                boost::filesystem::remove_all (p);
        }
-       
-       shared_ptr<Film> f = shared_ptr<Film> (new Film (p.string()));
-       f->write_metadata ();
-       return f;
+
+       shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
+       film->write_metadata ();
+       return film;
+}
+
+shared_ptr<Film>
+new_test_film2 (string name)
+{
+       boost::filesystem::path p = test_film_dir (name);
+       if (boost::filesystem::exists (p)) {
+               boost::filesystem::remove_all (p);
+       }
+
+       shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
+       film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
+       film->set_container (Ratio::from_id ("185"));
+       film->write_metadata ();
+       return film;
 }
 
 void
-check_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
+check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
 {
        SF_INFO ref_info;
        ref_info.format = 0;
        SNDFILE* ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
        BOOST_CHECK (ref_file);
-       
+
        SF_INFO check_info;
        check_info.format = 0;
        SNDFILE* check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
@@ -130,25 +185,71 @@ check_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
 
        /* buffer_size is in frames */
        sf_count_t const buffer_size = 65536 * ref_info.channels;
-       int32_t* ref_buffer = new int32_t[buffer_size];
-       int32_t* check_buffer = new int32_t[buffer_size];
-       
+       scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
+       scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
+
        sf_count_t N = ref_info.frames;
        while (N) {
                sf_count_t this_time = min (buffer_size, N);
-               sf_count_t r = sf_readf_int (ref_file, ref_buffer, this_time);
+               sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
                BOOST_CHECK_EQUAL (r, this_time);
-               r = sf_readf_int (check_file, check_buffer, this_time);
+               r = sf_readf_int (check_file, check_buffer.get(), this_time);
                BOOST_CHECK_EQUAL (r, this_time);
 
                for (sf_count_t i = 0; i < this_time; ++i) {
-                       BOOST_CHECK (fabs (ref_buffer[i] - check_buffer[i]) <= 65536);
+                       BOOST_REQUIRE_MESSAGE (
+                               abs (ref_buffer[i] - check_buffer[i]) <= 65536,
+                               ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
+                               << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
+                               );
                }
 
                N -= this_time;
        }
 }
 
+void
+check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
+{
+       ASDCP::PCM::MXFReader ref_reader;
+       BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.OpenRead (ref.string().c_str())));
+
+       ASDCP::PCM::AudioDescriptor ref_desc;
+       BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.FillAudioDescriptor (ref_desc)));
+
+       ASDCP::PCM::MXFReader check_reader;
+       BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.OpenRead (check.string().c_str())));
+
+       ASDCP::PCM::AudioDescriptor check_desc;
+       BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.FillAudioDescriptor (check_desc)));
+
+       BOOST_REQUIRE_EQUAL (ref_desc.ContainerDuration, check_desc.ContainerDuration);
+
+       ASDCP::PCM::FrameBuffer ref_buffer (Kumu::Megabyte);
+       ASDCP::PCM::FrameBuffer check_buffer (Kumu::Megabyte);
+       for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
+               ref_reader.ReadFrame (i, ref_buffer, 0);
+               check_reader.ReadFrame (i, check_buffer, 0);
+               BOOST_REQUIRE (memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size()) == 0);
+       }
+}
+
+void
+check_image (boost::filesystem::path ref, boost::filesystem::path check, double threshold)
+{
+       using namespace MagickCore;
+
+       Magick::Image ref_image;
+       ref_image.read (ref.string ());
+       Magick::Image check_image;
+       check_image.read (check.string ());
+       /* XXX: this is a hack; we really want the ImageMagick call but GraphicsMagick doesn't have it;
+          this may cause random test failures on platforms that use GraphicsMagick.
+       */
+       double const dist = ref_image.compare(check_image, Magick::RootMeanSquaredErrorMetric);
+       BOOST_CHECK_MESSAGE (dist < threshold, ref << " differs from " << check << " " << dist);
+}
+
 void
 check_file (boost::filesystem::path ref, boost::filesystem::path check)
 {
@@ -158,14 +259,13 @@ check_file (boost::filesystem::path ref, boost::filesystem::path check)
        BOOST_CHECK (ref_file);
        FILE* check_file = fopen_boost (check, "rb");
        BOOST_CHECK (check_file);
-       
+
        int const buffer_size = 65536;
        uint8_t* ref_buffer = new uint8_t[buffer_size];
        uint8_t* check_buffer = new uint8_t[buffer_size];
 
-       SafeStringStream error;
-       error << "File " << check.string() << " differs from reference " << ref.string();
-       
+       string error = "File " + check.string() + " differs from reference " + ref.string();
+
        while (N) {
                uintmax_t this_time = min (uintmax_t (buffer_size), N);
                size_t r = fread (ref_buffer, 1, this_time, ref_file);
@@ -173,11 +273,11 @@ check_file (boost::filesystem::path ref, boost::filesystem::path check)
                r = fread (check_buffer, 1, this_time, check_file);
                BOOST_CHECK_EQUAL (r, this_time);
 
-               BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error.str ());
+               BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error);
                if (memcmp (ref_buffer, check_buffer, this_time)) {
                        break;
                }
-               
+
                N -= this_time;
        }
 
@@ -209,9 +309,10 @@ check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
        options.max_std_dev_pixel_error = 5;
        options.max_audio_sample_error = 255;
        options.cpl_annotation_texts_can_differ = true;
-       options.mxf_names_can_differ = true;
+       options.reel_annotation_texts_can_differ = true;
        options.reel_hashes_can_differ = true;
-       
+       options.issue_dates_can_differ = true;
+
        BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
 }
 
@@ -224,15 +325,18 @@ check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
        if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
                return;
        }
-           
+
        xmlpp::Element::NodeList ref_children = ref->get_children ();
        xmlpp::Element::NodeList test_children = test->get_children ();
-       BOOST_CHECK_EQUAL (ref_children.size (), test_children.size ());
+       BOOST_REQUIRE_MESSAGE (
+               ref_children.size() == test_children.size(),
+               ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
+               );
 
        xmlpp::Element::NodeList::iterator k = ref_children.begin ();
        xmlpp::Element::NodeList::iterator l = test_children.begin ();
-       while (k != ref_children.end () && l != test_children.end ()) {
-               
+       while (k != ref_children.end ()) {
+
                /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
 
                xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
@@ -249,20 +353,23 @@ check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
                        BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
                }
 
-               xmlpp::Attribute* ref_at = dynamic_cast<xmlpp::Attribute*> (*k);
-               xmlpp::Attribute* test_at = dynamic_cast<xmlpp::Attribute*> (*l);
-               BOOST_CHECK ((ref_at && test_at) || (!ref_at && !test_at));
-               if (ref_at && test_at) {
-                       BOOST_CHECK_EQUAL (ref_at->get_name(), test_at->get_name ());
-                       BOOST_CHECK_EQUAL (ref_at->get_value(), test_at->get_value ());
-               }
-
                ++k;
                ++l;
        }
 
-       BOOST_CHECK (k == ref_children.end ());
-       BOOST_CHECK (l == test_children.end ());
+       xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
+       xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
+       BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
+
+       xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
+       xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
+       while (m != ref_attributes.end ()) {
+               BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
+               BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
+
+               ++m;
+               ++n;
+       }
 }
 
 void
@@ -276,13 +383,15 @@ check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<strin
        check_xml (ref_root, test_root, ignore);
 }
 
-void
+bool
 wait_for_jobs ()
 {
        JobManager* jm = JobManager::instance ();
        while (jm->work_to_do ()) {
-               ui_signaller->ui_idle ();
+               while (signal_manager->ui_idle ()) {}
+               dcpomatic_sleep_seconds (1);
        }
+
        if (jm->errors ()) {
                int N = 0;
                for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
@@ -300,17 +409,116 @@ wait_for_jobs ()
                        }
                }
        }
-               
-       BOOST_CHECK (!jm->errors());
 
-       ui_signaller->ui_idle ();
+       while (signal_manager->ui_idle ()) {}
+
+       if (jm->errors ()) {
+               JobManager::drop ();
+               return true;
+       }
+
+       return false;
 }
 
 void
-write_image (shared_ptr<const Image> image, boost::filesystem::path file)
+write_image (shared_ptr<const Image> image, boost::filesystem::path file, string format, MagickCore::StorageType pixel_type)
 {
        using namespace MagickCore;
 
-       Magick::Image m (image->size().width, image->size().height, "ARGB", CharPixel, (void *) image->data()[0]);
+       Magick::Image m (image->size().width, image->size().height, format.c_str(), pixel_type, (void *) image->data()[0]);
        m.write (file.string ());
 }
+
+void
+check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check, int audio_tolerance)
+{
+       int const r = system (String::compose("ffcmp -t %1 %2 %3", audio_tolerance, ref.string(), check.string()).c_str());
+       BOOST_REQUIRE_EQUAL (WEXITSTATUS(r), 0);
+}
+
+void
+check_one_frame (boost::filesystem::path dcp_dir, int64_t index, boost::filesystem::path ref)
+{
+       dcp::DCP dcp (dcp_dir);
+       dcp.read ();
+       shared_ptr<dcp::MonoPictureAsset> asset = dynamic_pointer_cast<dcp::MonoPictureAsset> (dcp.cpls().front()->reels().front()->main_picture()->asset());
+       BOOST_REQUIRE (asset);
+       shared_ptr<const dcp::MonoPictureFrame> frame = asset->start_read()->get_frame(index);
+       shared_ptr<const dcp::MonoPictureFrame> ref_frame (new dcp::MonoPictureFrame (ref));
+
+       shared_ptr<dcp::OpenJPEGImage> image = frame->xyz_image ();
+       shared_ptr<dcp::OpenJPEGImage> ref_image = ref_frame->xyz_image ();
+
+       BOOST_REQUIRE (image->size() == ref_image->size());
+
+       int off = 0;
+       for (int y = 0; y < ref_image->size().height; ++y) {
+               for (int x = 0; x < ref_image->size().width; ++x) {
+                       BOOST_REQUIRE_EQUAL (ref_image->data(0)[off], image->data(0)[off]);
+                       BOOST_REQUIRE_EQUAL (ref_image->data(1)[off], image->data(1)[off]);
+                       BOOST_REQUIRE_EQUAL (ref_image->data(2)[off], image->data(2)[off]);
+                       ++off;
+               }
+       }
+}
+
+boost::filesystem::path
+dcp_file (shared_ptr<const Film> film, string prefix)
+{
+       boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->dir(film->dcp_name()));
+       while (i != boost::filesystem::directory_iterator() && !boost::algorithm::starts_with (i->path().leaf().string(), prefix)) {
+               ++i;
+       }
+
+       BOOST_REQUIRE (i != boost::filesystem::directory_iterator());
+       return i->path();
+}
+
+boost::filesystem::path
+subtitle_file (shared_ptr<Film> film)
+{
+       for (
+               boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->directory().get() / film->dcp_name (false));
+               i != boost::filesystem::directory_iterator ();
+               ++i) {
+
+               if (boost::filesystem::is_directory (i->path ())) {
+                       for (
+                               boost::filesystem::directory_iterator j = boost::filesystem::directory_iterator (i->path ());
+                               j != boost::filesystem::directory_iterator ();
+                               ++j) {
+
+                               if (boost::algorithm::starts_with (j->path().leaf().string(), "sub_")) {
+                                       return j->path();
+                               }
+                       }
+               }
+       }
+
+       BOOST_REQUIRE (false);
+       /* Remove warning */
+       return boost::filesystem::path("/");
+}
+
+void
+make_random_file (boost::filesystem::path path, size_t size)
+{
+       size_t const chunk = 128 * 1024;
+       uint8_t* buffer = static_cast<uint8_t*> (malloc(chunk));
+       BOOST_REQUIRE (buffer);
+       FILE* r = fopen("/dev/urandom", "rb");
+       BOOST_REQUIRE (r);
+       FILE* t = fopen_boost(path, "wb");
+       BOOST_REQUIRE (t);
+       while (size) {
+               size_t this_time = min (size, chunk);
+               size_t N = fread (buffer, 1, this_time, r);
+               BOOST_REQUIRE (N == this_time);
+               N = fwrite (buffer, 1, this_time, t);
+               BOOST_REQUIRE (N == this_time);
+               size -= this_time;
+       }
+       fclose (t);
+       fclose (r);
+       free (buffer);
+}