test/kdm_naming_test.cc

   1 /*
   2     Copyright (C) 2020-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21
  22 #include "lib/cinema.h"
  23 #include "lib/config.h"
  24 #include "lib/content_factory.h"
  25 #include "lib/film.h"
  26 #include "lib/kdm_with_metadata.h"
  27 #include "lib/screen.h"
  28 #include "test.h"
  29 #include <boost/test/unit_test.hpp>
  30
  31
  32 using std::dynamic_pointer_cast;
  33 using std::list;
  34 using std::make_shared;
  35 using std::shared_ptr;
  36 using std::string;
  37 using std::vector;
  38 using boost::optional;
  39
  40
  41 static
  42 bool
  43 confirm_overwrite (boost::filesystem::path)
  44 {
  45         return true;
  46 }
  47
  48
  49 static shared_ptr<dcpomatic::Screen> cinema_a_screen_1;
  50 static shared_ptr<dcpomatic::Screen> cinema_a_screen_2;
  51 static shared_ptr<dcpomatic::Screen> cinema_b_screen_x;
  52 static shared_ptr<dcpomatic::Screen> cinema_b_screen_y;
  53 static shared_ptr<dcpomatic::Screen> cinema_b_screen_z;
  54
  55
  56 BOOST_AUTO_TEST_CASE (single_kdm_naming_test)
  57 {
  58         auto c = Config::instance();
  59
  60         auto crypt_cert = c->decryption_chain()->leaf();
  61
  62         /* Cinema A: UTC +4:30 */
  63         auto cinema_a = make_shared<Cinema>("Cinema A", list<string>(), "", 4, 30);
  64         cinema_a_screen_1 = std::make_shared<dcpomatic::Screen>("Screen 1", "", crypt_cert, boost::none, vector<TrustedDevice>());
  65         cinema_a->add_screen (cinema_a_screen_1);
  66         cinema_a_screen_2 = std::make_shared<dcpomatic::Screen>("Screen 2", "", crypt_cert, boost::none, vector<TrustedDevice>());
  67         cinema_a->add_screen (cinema_a_screen_2);
  68         c->add_cinema (cinema_a);
  69
  70         /* Cinema B: UTC -1:00 */
  71         auto cinema_b = make_shared<Cinema>("Cinema B", list<string>(), "", -1, 0);
  72         cinema_b_screen_x = std::make_shared<dcpomatic::Screen>("Screen X", "", crypt_cert, boost::none, vector<TrustedDevice>());
  73         cinema_b->add_screen (cinema_b_screen_x);
  74         cinema_b_screen_y = std::make_shared<dcpomatic::Screen>("Screen Y", "", crypt_cert, boost::none, vector<TrustedDevice>());
  75         cinema_b->add_screen (cinema_b_screen_y);
  76         cinema_b_screen_z = std::make_shared<dcpomatic::Screen>("Screen Z", "", crypt_cert, boost::none, vector<TrustedDevice>());
  77         cinema_b->add_screen (cinema_b_screen_z);
  78         c->add_cinema (cinema_a);
  79
  80         /* Film */
  81         boost::filesystem::remove_all ("build/test/single_kdm_naming_test");
  82         auto film = new_test_film2 ("single_kdm_naming_test");
  83         film->set_name ("my_great_film");
  84         film->examine_and_add_content (content_factory("test/data/flat_black.png").front());
  85         BOOST_REQUIRE (!wait_for_jobs());
  86         film->set_encrypted (true);
  87         make_and_verify_dcp (film);
  88         auto cpls = film->cpls ();
  89         BOOST_REQUIRE(cpls.size() == 1);
  90
  91         auto sign_cert = c->signer_chain()->leaf();
  92
  93         dcp::LocalTime from (sign_cert.not_before());
  94         from.add_months (2);
  95         dcp::LocalTime until (sign_cert.not_after());
  96         until.add_months (-2);
  97
  98         auto const from_string = from.date() + " " + from.time_of_day(true, false);
  99         auto const until_string = until.date() + " " + until.time_of_day(true, false);
 100
 101         auto cpl = cpls.front().cpl_file;
 102         auto kdm = kdm_for_screen (
 103                         film,
 104                         cpls.front().cpl_file,
 105                         cinema_a_screen_1,
 106                         boost::posix_time::time_from_string(from_string),
 107                         boost::posix_time::time_from_string(until_string),
 108                         dcp::Formulation::MODIFIED_TRANSITIONAL_1,
 109                         false,
 110                         optional<int>()
 111                         );
 112
 113         write_files (
 114                 { kdm },
 115                 boost::filesystem::path("build/test/single_kdm_naming_test"),
 116                 dcp::NameFormat("KDM %c - %s - %f - %b - %e"),
 117                 &confirm_overwrite
 118                 );
 119
 120         auto from_time = from.time_of_day (true, false);
 121         boost::algorithm::replace_all (from_time, ":", "-");
 122         auto until_time = until.time_of_day (true, false);
 123         boost::algorithm::replace_all (until_time, ":", "-");
 124
 125         auto const dcp_date = boost::gregorian::to_iso_string(film->isdcf_date());
 126         auto const ref = String::compose("KDM_Cinema_A_-_Screen_1_-_MyGreatFilm_TST-1_F_XX-XX_MOS_2K_%1_SMPTE_OV_-_%2_%3_-_%4_%5.xml", dcp_date, from.date(), from_time, until.date(), until_time);
 127         BOOST_CHECK_MESSAGE (boost::filesystem::exists("build/test/single_kdm_naming_test/" + ref), "File " << ref << " not found");
 128 }
 129
 130
 131 BOOST_AUTO_TEST_CASE (directory_kdm_naming_test, * boost::unit_test::depends_on("single_kdm_naming_test"))
 132 {
 133         using boost::filesystem::path;
 134
 135         /* Film */
 136         boost::filesystem::remove_all ("build/test/directory_kdm_naming_test");
 137         auto film = new_test_film2 (
 138                 "directory_kdm_naming_test",
 139                 { content_factory("test/data/flat_black.png").front() }
 140                 );
 141
 142         film->set_name ("my_great_film");
 143         film->set_encrypted (true);
 144         make_and_verify_dcp (film);
 145         auto cpls = film->cpls ();
 146         BOOST_REQUIRE(cpls.size() == 1);
 147
 148         auto sign_cert = Config::instance()->signer_chain()->leaf();
 149
 150         dcp::LocalTime from (sign_cert.not_before());
 151         from.add_months (2);
 152         dcp::LocalTime until (sign_cert.not_after());
 153         until.add_months (-2);
 154
 155         string const from_string = from.date() + " " + from.time_of_day(true, false);
 156         string const until_string = until.date() + " " + until.time_of_day(true, false);
 157
 158         list<shared_ptr<dcpomatic::Screen>> screens = {
 159                 cinema_a_screen_2, cinema_b_screen_x, cinema_a_screen_1, (cinema_b_screen_z)
 160         };
 161
 162         auto const cpl = cpls.front().cpl_file;
 163         auto const cpl_id = cpls.front().cpl_id;
 164
 165         list<KDMWithMetadataPtr> kdms;
 166         for (auto i: screens) {
 167                 auto kdm = kdm_for_screen (
 168                                 film,
 169                                 cpls.front().cpl_file,
 170                                 i,
 171                                 boost::posix_time::time_from_string(from_string),
 172                                 boost::posix_time::time_from_string(until_string),
 173                                 dcp::Formulation::MODIFIED_TRANSITIONAL_1,
 174                                 false,
 175                                 optional<int>()
 176                                 );
 177
 178                 kdms.push_back (kdm);
 179         }
 180
 181         write_directories (
 182                 collect(kdms),
 183                 path("build/test/directory_kdm_naming_test"),
 184                 dcp::NameFormat("%c - %s - %f - %b - %e"),
 185 #ifdef DCPOMATIC_WINDOWS
 186                 /* Use a shorter name on Windows so that the paths aren't too long */
 187                 dcp::NameFormat("KDM %f"),
 188 #else
 189                 dcp::NameFormat("KDM %c - %s - %f - %b - %e - %i"),
 190 #endif
 191                 &confirm_overwrite
 192                 );
 193
 194         auto from_time = from.time_of_day (true, false);
 195         boost::algorithm::replace_all (from_time, ":", "-");
 196         auto until_time = until.time_of_day (true, false);
 197         boost::algorithm::replace_all (until_time, ":", "-");
 198
 199         auto const dcp_date = boost::gregorian::to_iso_string(film->isdcf_date());
 200         auto const dcp_name = String::compose("MyGreatFilm_TST-1_F_XX-XX_MOS_2K_%1_SMPTE_OV", dcp_date);
 201         auto const common = String::compose("%1_-_%2_%3_-_%4_%5", dcp_name, from.date(), from_time, until.date(), until_time);
 202
 203         path const base = "build/test/directory_kdm_naming_test";
 204
 205         path dir_a = String::compose("Cinema_A_-_%s_-_%1", common);
 206         BOOST_CHECK_MESSAGE (boost::filesystem::exists(base / dir_a), "Directory " << dir_a << " not found");
 207         path dir_b = String::compose("Cinema_B_-_%s_-_%1", common);
 208         BOOST_CHECK_MESSAGE (boost::filesystem::exists(base / dir_b), "Directory " << dir_b << " not found");
 209
 210 #ifdef DCPOMATIC_WINDOWS
 211         path ref = String::compose("KDM_%1.xml", dcp_name);
 212 #else
 213         path ref = String::compose("KDM_Cinema_A_-_Screen_2_-_%1_-_%2.xml", common, cpl_id);
 214 #endif
 215         BOOST_CHECK_MESSAGE (boost::filesystem::exists(base / dir_a / ref), "File " << ref << " not found");
 216
 217 #ifdef DCPOMATIC_WINDOWS
 218         ref = String::compose("KDM_%1.xml", dcp_name);
 219 #else
 220         ref = String::compose("KDM_Cinema_B_-_Screen_X_-_%1_-_%2.xml", common, cpl_id);
 221 #endif
 222         BOOST_CHECK_MESSAGE (boost::filesystem::exists(base / dir_b / ref), "File " << ref << " not found");
 223
 224 #ifdef DCPOMATIC_WINDOWS
 225         ref = String::compose("KDM_%1.xml", dcp_name);
 226 #else
 227         ref = String::compose("KDM_Cinema_A_-_Screen_1_-_%1_-_%2.xml", common, cpl_id);
 228 #endif
 229         BOOST_CHECK_MESSAGE (boost::filesystem::exists(base / dir_a / ref), "File " << ref << " not found");
 230
 231 #ifdef DCPOMATIC_WINDOWS
 232         ref = String::compose("KDM_%1.xml", dcp_name);
 233 #else
 234         ref = String::compose("KDM_Cinema_B_-_Screen_Z_-_%1_-_%2.xml", common, cpl_id);
 235 #endif
 236         BOOST_CHECK_MESSAGE (boost::filesystem::exists(base / dir_b / ref), "File " << ref << " not found");
 237 }
 238