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         auto cinema_a = make_shared<Cinema>("Cinema A", list<string>(), "");
  63         cinema_a_screen_1 = std::make_shared<dcpomatic::Screen>("Screen 1", "", crypt_cert, boost::none, vector<TrustedDevice>());
  64         cinema_a->add_screen (cinema_a_screen_1);
  65         cinema_a_screen_2 = std::make_shared<dcpomatic::Screen>("Screen 2", "", crypt_cert, boost::none, vector<TrustedDevice>());
  66         cinema_a->add_screen (cinema_a_screen_2);
  67         c->add_cinema (cinema_a);
  68
  69         auto cinema_b = make_shared<Cinema>("Cinema B", list<string>(), "");
  70         cinema_b_screen_x = std::make_shared<dcpomatic::Screen>("Screen X", "", crypt_cert, boost::none, vector<TrustedDevice>());
  71         cinema_b->add_screen (cinema_b_screen_x);
  72         cinema_b_screen_y = std::make_shared<dcpomatic::Screen>("Screen Y", "", crypt_cert, boost::none, vector<TrustedDevice>());
  73         cinema_b->add_screen (cinema_b_screen_y);
  74         cinema_b_screen_z = std::make_shared<dcpomatic::Screen>("Screen Z", "", crypt_cert, boost::none, vector<TrustedDevice>());
  75         cinema_b->add_screen (cinema_b_screen_z);
  76         c->add_cinema (cinema_a);
  77
  78         /* Film */
  79         boost::filesystem::remove_all ("build/test/single_kdm_naming_test");
  80         auto film = new_test_film2 ("single_kdm_naming_test");
  81         film->set_name ("my_great_film");
  82         film->examine_and_add_content (content_factory("test/data/flat_black.png")[0]);
  83         BOOST_REQUIRE (!wait_for_jobs());
  84         film->set_encrypted (true);
  85         make_and_verify_dcp (film);
  86         auto cpls = film->cpls ();
  87         BOOST_REQUIRE(cpls.size() == 1);
  88
  89         auto sign_cert = c->signer_chain()->leaf();
  90
  91         dcp::LocalTime from = sign_cert.not_before();
  92         from.set_offset({ 4, 30 });
  93         from.add_months (2);
  94         dcp::LocalTime until = sign_cert.not_after();
  95         until.set_offset({ 4, 30 });
  96         until.add_months (-2);
  97
  98         auto cpl = cpls.front().cpl_file;
  99         auto kdm = kdm_for_screen (
 100                         film,
 101                         cpls.front().cpl_file,
 102                         cinema_a_screen_1,
 103                         from,
 104                         until,
 105                         dcp::Formulation::MODIFIED_TRANSITIONAL_1,
 106                         false,
 107                         optional<int>()
 108                         );
 109
 110         write_files (
 111                 { kdm },
 112                 boost::filesystem::path("build/test/single_kdm_naming_test"),
 113                 dcp::NameFormat("KDM %c - %s - %f - %b - %e"),
 114                 &confirm_overwrite
 115                 );
 116
 117         auto from_time = from.time_of_day (true, false);
 118         boost::algorithm::replace_all (from_time, ":", "-");
 119         auto until_time = until.time_of_day (true, false);
 120         boost::algorithm::replace_all (until_time, ":", "-");
 121
 122         auto const dcp_date = boost::gregorian::to_iso_string(film->isdcf_date());
 123         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);
 124         BOOST_CHECK_MESSAGE (boost::filesystem::exists("build/test/single_kdm_naming_test/" + ref), "File " << ref << " not found");
 125 }
 126
 127
 128 BOOST_AUTO_TEST_CASE (directory_kdm_naming_test, * boost::unit_test::depends_on("single_kdm_naming_test"))
 129 {
 130         using boost::filesystem::path;
 131
 132         /* Film */
 133         boost::filesystem::remove_all ("build/test/directory_kdm_naming_test");
 134         auto film = new_test_film2 (
 135                 "directory_kdm_naming_test",
 136                 { content_factory("test/data/flat_black.png")[0] }
 137                 );
 138
 139         film->set_name ("my_great_film");
 140         film->set_encrypted (true);
 141         make_and_verify_dcp (film);
 142         auto cpls = film->cpls ();
 143         BOOST_REQUIRE(cpls.size() == 1);
 144
 145         auto sign_cert = Config::instance()->signer_chain()->leaf();
 146
 147         dcp::LocalTime from (sign_cert.not_before());
 148         from.add_months (2);
 149         dcp::LocalTime until (sign_cert.not_after());
 150         until.add_months (-2);
 151
 152         list<shared_ptr<dcpomatic::Screen>> screens = {
 153                 cinema_a_screen_2, cinema_b_screen_x, cinema_a_screen_1, (cinema_b_screen_z)
 154         };
 155
 156         auto const cpl = cpls.front().cpl_file;
 157         auto const cpl_id = cpls.front().cpl_id;
 158
 159         list<KDMWithMetadataPtr> kdms;
 160         for (auto i: screens) {
 161                 auto kdm = kdm_for_screen (
 162                                 film,
 163                                 cpls.front().cpl_file,
 164                                 i,
 165                                 from,
 166                                 until,
 167                                 dcp::Formulation::MODIFIED_TRANSITIONAL_1,
 168                                 false,
 169                                 optional<int>()
 170                                 );
 171
 172                 kdms.push_back (kdm);
 173         }
 174
 175         write_directories (
 176                 collect(kdms),
 177                 path("build/test/directory_kdm_naming_test"),
 178                 dcp::NameFormat("%c - %s - %f - %b - %e"),
 179 #ifdef DCPOMATIC_WINDOWS
 180                 /* Use a shorter name on Windows so that the paths aren't too long */
 181                 dcp::NameFormat("KDM %f"),
 182 #else
 183                 dcp::NameFormat("KDM %c - %s - %f - %b - %e - %i"),
 184 #endif
 185                 &confirm_overwrite
 186                 );
 187
 188         auto from_time = from.time_of_day (true, false);
 189         boost::algorithm::replace_all (from_time, ":", "-");
 190         auto until_time = until.time_of_day (true, false);
 191         boost::algorithm::replace_all (until_time, ":", "-");
 192
 193         auto const dcp_date = boost::gregorian::to_iso_string(film->isdcf_date());
 194         auto const dcp_name = String::compose("MyGreatFilm_TST-1_F_XX-XX_MOS_2K_%1_SMPTE_OV", dcp_date);
 195         auto const common = String::compose("%1_-_%2_%3_-_%4_%5", dcp_name, from.date(), from_time, until.date(), until_time);
 196
 197         path const base = "build/test/directory_kdm_naming_test";
 198
 199         path dir_a = String::compose("Cinema_A_-_%s_-_%1", common);
 200         BOOST_CHECK_MESSAGE (boost::filesystem::exists(base / dir_a), "Directory " << dir_a << " not found");
 201         path dir_b = String::compose("Cinema_B_-_%s_-_%1", common);
 202         BOOST_CHECK_MESSAGE (boost::filesystem::exists(base / dir_b), "Directory " << dir_b << " not found");
 203
 204 #ifdef DCPOMATIC_WINDOWS
 205         path ref = String::compose("KDM_%1.xml", dcp_name);
 206 #else
 207         path ref = String::compose("KDM_Cinema_A_-_Screen_2_-_%1_-_%2.xml", common, cpl_id);
 208 #endif
 209         BOOST_CHECK_MESSAGE (boost::filesystem::exists(base / dir_a / ref), "File " << ref << " not found");
 210
 211 #ifdef DCPOMATIC_WINDOWS
 212         ref = String::compose("KDM_%1.xml", dcp_name);
 213 #else
 214         ref = String::compose("KDM_Cinema_B_-_Screen_X_-_%1_-_%2.xml", common, cpl_id);
 215 #endif
 216         BOOST_CHECK_MESSAGE (boost::filesystem::exists(base / dir_b / ref), "File " << ref << " not found");
 217
 218 #ifdef DCPOMATIC_WINDOWS
 219         ref = String::compose("KDM_%1.xml", dcp_name);
 220 #else
 221         ref = String::compose("KDM_Cinema_A_-_Screen_1_-_%1_-_%2.xml", common, cpl_id);
 222 #endif
 223         BOOST_CHECK_MESSAGE (boost::filesystem::exists(base / dir_a / ref), "File " << ref << " not found");
 224
 225 #ifdef DCPOMATIC_WINDOWS
 226         ref = String::compose("KDM_%1.xml", dcp_name);
 227 #else
 228         ref = String::compose("KDM_Cinema_B_-_Screen_Z_-_%1_-_%2.xml", common, cpl_id);
 229 #endif
 230         BOOST_CHECK_MESSAGE (boost::filesystem::exists(base / dir_b / ref), "File " << ref << " not found");
 231 }
 232