summaryrefslogtreecommitdiffstats
path: root/test/icinga-legacytimeperiod.cpp
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--test/icinga-legacytimeperiod.cpp694
1 files changed, 694 insertions, 0 deletions
diff --git a/test/icinga-legacytimeperiod.cpp b/test/icinga-legacytimeperiod.cpp
new file mode 100644
index 0000000..e1150be
--- /dev/null
+++ b/test/icinga-legacytimeperiod.cpp
@@ -0,0 +1,694 @@
+/* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */
+
+#include "base/utility.hpp"
+#include "icinga/legacytimeperiod.hpp"
+#include <boost/date_time/posix_time/posix_time.hpp>
+#include <boost/date_time/posix_time/ptime.hpp>
+#include <boost/date_time/posix_time/posix_time_duration.hpp>
+#include <boost/date_time/gregorian/conversion.hpp>
+#include <boost/date_time/date.hpp>
+#include <boost/optional.hpp>
+#include <iomanip>
+#include <BoostTestTargetConfig.h>
+
+using namespace icinga;
+
+BOOST_AUTO_TEST_SUITE(icinga_legacytimeperiod);
+
+struct GlobalTimezoneFixture
+{
+ char *tz;
+
+ GlobalTimezoneFixture(const char *fixed_tz = "")
+ {
+ tz = getenv("TZ");
+#ifdef _WIN32
+ _putenv_s("TZ", fixed_tz == "" ? "UTC" : fixed_tz);
+#else
+ setenv("TZ", fixed_tz, 1);
+#endif
+ tzset();
+ }
+
+ ~GlobalTimezoneFixture()
+ {
+#ifdef _WIN32
+ if (tz)
+ _putenv_s("TZ", tz);
+ else
+ _putenv_s("TZ", "");
+#else
+ if (tz)
+ setenv("TZ", tz, 1);
+ else
+ unsetenv("TZ");
+#endif
+ tzset();
+ }
+};
+
+BOOST_GLOBAL_FIXTURE(GlobalTimezoneFixture);
+
+// DST changes in America/Los_Angeles:
+// 2021-03-14: 01:59:59 PST (UTC-8) -> 03:00:00 PDT (UTC-7)
+// 2021-11-07: 01:59:59 PDT (UTC-7) -> 01:00:00 PST (UTC-8)
+#ifndef _WIN32
+static const char *dst_test_timezone = "America/Los_Angeles";
+#else /* _WIN32 */
+// Tests are using pacific time because Windows only really supports timezones following US DST rules with the TZ
+// environment variable. Format is "[Standard TZ][negative UTC offset][DST TZ]".
+// https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/tzset?view=msvc-160#remarks
+static const char *dst_test_timezone = "PST8PDT";
+#endif /* _WIN32 */
+
+BOOST_AUTO_TEST_CASE(simple)
+{
+ tm tm_beg, tm_end, tm_ref;
+ String timestamp;
+ boost::posix_time::ptime begin;
+ boost::posix_time::ptime end;
+ boost::posix_time::ptime expectedBegin;
+ boost::posix_time::ptime expectedEnd;
+
+ //-----------------------------------------------------
+ // check parsing of "YYYY-MM-DD" specs
+ timestamp = "2016-01-01";
+
+ expectedBegin = boost::posix_time::ptime(boost::gregorian::date(2016, 1, 1), boost::posix_time::time_duration(0, 0, 0));
+
+ expectedEnd = boost::posix_time::ptime(boost::gregorian::date(2016, 1, 2), boost::posix_time::time_duration(0, 0, 0));
+
+ // Run test
+ LegacyTimePeriod::ParseTimeSpec(timestamp, &tm_beg, &tm_end, &tm_ref);
+
+ // Compare times
+ begin = boost::posix_time::ptime_from_tm(tm_beg);
+ end = boost::posix_time::ptime_from_tm(tm_end);
+
+ BOOST_CHECK_EQUAL(begin, expectedBegin);
+ BOOST_CHECK_EQUAL(end, expectedEnd);
+
+ //-----------------------------------------------------
+ timestamp = "2015-12-31";
+
+ expectedBegin = boost::posix_time::ptime(boost::gregorian::date(2015, 12, 31), boost::posix_time::time_duration(0, 0, 0));
+
+ expectedEnd = boost::posix_time::ptime(boost::gregorian::date(2016, 1, 1), boost::posix_time::time_duration(0, 0, 0));
+
+ // Run test
+ LegacyTimePeriod::ParseTimeSpec(timestamp, &tm_beg, &tm_end, &tm_ref);
+
+ // Compare times
+ begin = boost::posix_time::ptime_from_tm(tm_beg);
+ end = boost::posix_time::ptime_from_tm(tm_end);
+
+ BOOST_CHECK_EQUAL(begin, expectedBegin);
+ BOOST_CHECK_EQUAL(end, expectedEnd);
+
+ //-----------------------------------------------------
+ // Break things forcefully
+ BOOST_CHECK_THROW(LegacyTimePeriod::ParseTimeSpec("2015-12-32", &tm_beg, &tm_end, &tm_ref),
+ std::invalid_argument);
+
+ BOOST_CHECK_THROW(LegacyTimePeriod::ParseTimeSpec("2015-28-01", &tm_beg, &tm_end, &tm_ref),
+ std::invalid_argument);
+
+ //-----------------------------------------------------
+ // check parsing of "day X" and "day -X" specs
+ timestamp = "day 2";
+ tm_ref.tm_year = 2016 - 1900;
+ tm_ref.tm_mon = 2 - 1;
+
+ expectedBegin = boost::posix_time::ptime(boost::gregorian::date(2016, 2, 2), boost::posix_time::time_duration(0, 0, 0));
+
+ expectedEnd = boost::posix_time::ptime(boost::gregorian::date(2016, 2, 3), boost::posix_time::time_duration(0, 0, 0));
+
+ // Run Tests
+ LegacyTimePeriod::ParseTimeSpec(timestamp, &tm_beg, &tm_end, &tm_ref);
+
+ // Compare times
+ begin = boost::posix_time::ptime_from_tm(tm_beg);
+ end = boost::posix_time::ptime_from_tm(tm_end);
+
+ BOOST_CHECK_EQUAL(begin, expectedBegin);
+ BOOST_CHECK_EQUAL(end, expectedEnd);
+
+ //-----------------------------------------------------
+ timestamp = "day 31";
+ tm_ref.tm_year = 2018 - 1900;
+ tm_ref.tm_mon = 12 - 1;
+
+ expectedBegin = boost::posix_time::ptime(boost::gregorian::date(2018, 12, 31), boost::posix_time::time_duration(0, 0, 0));
+
+ expectedEnd = boost::posix_time::ptime(boost::gregorian::date(2019, 1, 1), boost::posix_time::time_duration(0, 0, 0));
+
+ // Run Tests
+ LegacyTimePeriod::ParseTimeSpec(timestamp, &tm_beg, &tm_end, &tm_ref);
+
+ // Compare times
+ begin = boost::posix_time::ptime_from_tm(tm_beg);
+ end = boost::posix_time::ptime_from_tm(tm_end);
+
+ BOOST_CHECK_EQUAL(begin, expectedBegin);
+ BOOST_CHECK_EQUAL(end, expectedEnd);
+
+ //-----------------------------------------------------
+ // Last day of the month
+ timestamp = "day -1";
+ tm_ref.tm_year = 2012 - 1900;
+ tm_ref.tm_mon = 7 - 1;
+
+ expectedBegin = boost::posix_time::ptime(boost::gregorian::date(2012, 7, 31), boost::posix_time::time_duration(0, 0, 0));
+
+ expectedEnd = boost::posix_time::ptime(boost::gregorian::date(2012, 8, 1), boost::posix_time::time_duration(0, 0, 0));
+
+ // Run Tests
+ LegacyTimePeriod::ParseTimeSpec(timestamp, &tm_beg, &tm_end, &tm_ref);
+
+ // Compare times
+ begin = boost::posix_time::ptime_from_tm(tm_beg);
+ end = boost::posix_time::ptime_from_tm(tm_end);
+
+ BOOST_CHECK_EQUAL(begin, expectedBegin);
+ BOOST_CHECK_EQUAL(end, expectedEnd);
+
+ //-----------------------------------------------------
+ // Third last day of the month
+ timestamp = "day -3";
+ tm_ref.tm_year = 2019 - 1900;
+ tm_ref.tm_mon = 7 - 1;
+
+ expectedBegin = boost::posix_time::ptime(boost::gregorian::date(2019, 7, 29), boost::posix_time::time_duration(0, 0, 0));
+
+ expectedEnd = boost::posix_time::ptime(boost::gregorian::date(2019, 7, 30), boost::posix_time::time_duration(0, 0, 0));
+
+ // Run Tests
+ LegacyTimePeriod::ParseTimeSpec(timestamp, &tm_beg, &tm_end, &tm_ref);
+
+ // Compare times
+ begin = boost::posix_time::ptime_from_tm(tm_beg);
+ end = boost::posix_time::ptime_from_tm(tm_end);
+
+ BOOST_CHECK_EQUAL(begin, expectedBegin);
+ BOOST_CHECK_EQUAL(end, expectedEnd);
+
+ //-----------------------------------------------------
+ // Leap year with the last day of the month
+ timestamp = "day -1";
+ tm_ref.tm_year = 2016 - 1900; // leap year
+ tm_ref.tm_mon = 2 - 1;
+
+ expectedBegin = boost::posix_time::ptime(boost::gregorian::date(2016, 2, 29), boost::posix_time::time_duration(0, 0, 0));
+
+ expectedEnd = boost::posix_time::ptime(boost::gregorian::date(2016, 3, 1), boost::posix_time::time_duration(0, 0, 0));
+
+ // Run Tests
+ LegacyTimePeriod::ParseTimeSpec("day -1", &tm_beg, &tm_end, &tm_ref);
+
+ // Compare times
+ begin = boost::posix_time::ptime_from_tm(tm_beg);
+ end = boost::posix_time::ptime_from_tm(tm_end);
+
+ BOOST_CHECK_EQUAL(begin, expectedBegin);
+ BOOST_CHECK_EQUAL(end, expectedEnd);
+}
+
+struct DateTime
+{
+ struct {
+ int Year, Month, Day;
+ } Date;
+ struct {
+ int Hour, Minute, Second;
+ } Time;
+};
+
+static inline
+void AdvancedHelper(const char *timestamp, DateTime from, DateTime to)
+{
+ using boost::gregorian::date;
+ using boost::posix_time::ptime;
+ using boost::posix_time::ptime_from_tm;
+ using boost::posix_time::time_duration;
+
+ tm tm_beg, tm_end, tm_ref;
+
+ tm_ref.tm_year = from.Date.Year - 1900;
+ tm_ref.tm_mon = from.Date.Month - 1;
+ tm_ref.tm_mday = from.Date.Day;
+
+ // Run test
+ LegacyTimePeriod::ProcessTimeRangeRaw(timestamp, &tm_ref, &tm_beg, &tm_end);
+
+ // Compare times
+ BOOST_CHECK_EQUAL(ptime_from_tm(tm_beg), ptime(date(from.Date.Year, from.Date.Month, from.Date.Day), time_duration(from.Time.Hour, from.Time.Minute, from.Time.Second)));
+ BOOST_CHECK_EQUAL(ptime_from_tm(tm_end), ptime(date(to.Date.Year, to.Date.Month, to.Date.Day), time_duration(to.Time.Hour, to.Time.Minute, to.Time.Second)));
+}
+
+BOOST_AUTO_TEST_CASE(advanced)
+{
+ tm tm_beg, tm_end, tm_ref;
+ String timestamp;
+ boost::posix_time::ptime begin;
+ boost::posix_time::ptime end;
+ boost::posix_time::ptime expectedBegin;
+ boost::posix_time::ptime expectedEnd;
+
+ //-----------------------------------------------------
+ // 2019-05-06 where Icinga celebrates 10 years #monitoringlove
+ // 2019-05-06 22:00:00 - 2019-05-07 06:00:00
+ AdvancedHelper("22:00-06:00", {{2019, 5, 6}, {22, 0, 0}}, {{2019, 5, 7}, {6, 0, 0}});
+ AdvancedHelper("22:00:01-06:00", {{2019, 5, 6}, {22, 0, 1}}, {{2019, 5, 7}, {6, 0, 0}});
+ AdvancedHelper("22:00-06:00:02", {{2019, 5, 6}, {22, 0, 0}}, {{2019, 5, 7}, {6, 0, 2}});
+ AdvancedHelper("22:00:03-06:00:04", {{2019, 5, 6}, {22, 0, 3}}, {{2019, 5, 7}, {6, 0, 4}});
+
+ //-----------------------------------------------------
+ // 2019-05-06 Icinga is unleashed.
+ // 09:00:00 - 17:00:00
+ AdvancedHelper("09:00-17:00", {{2009, 5, 6}, {9, 0, 0}}, {{2009, 5, 6}, {17, 0, 0}});
+ AdvancedHelper("09:00:01-17:00", {{2009, 5, 6}, {9, 0, 1}}, {{2009, 5, 6}, {17, 0, 0}});
+ AdvancedHelper("09:00-17:00:02", {{2009, 5, 6}, {9, 0, 0}}, {{2009, 5, 6}, {17, 0, 2}});
+ AdvancedHelper("09:00:03-17:00:04", {{2009, 5, 6}, {9, 0, 3}}, {{2009, 5, 6}, {17, 0, 4}});
+
+ //-----------------------------------------------------
+ // At our first Icinga Camp in SFO 2014 at GitHub HQ, we partied all night long with an overflow.
+ // 2014-09-24 09:00:00 - 2014-09-25 06:00:00
+ AdvancedHelper("09:00-30:00", {{2014, 9, 24}, {9, 0, 0}}, {{2014, 9, 25}, {6, 0, 0}});
+ AdvancedHelper("09:00:01-30:00", {{2014, 9, 24}, {9, 0, 1}}, {{2014, 9, 25}, {6, 0, 0}});
+ AdvancedHelper("09:00-30:00:02", {{2014, 9, 24}, {9, 0, 0}}, {{2014, 9, 25}, {6, 0, 2}});
+ AdvancedHelper("09:00:03-30:00:04", {{2014, 9, 24}, {9, 0, 3}}, {{2014, 9, 25}, {6, 0, 4}});
+}
+
+tm make_tm(std::string s)
+{
+ int dst = -1;
+ size_t l = strlen("YYYY-MM-DD HH:MM:SS");
+ if (s.size() > l) {
+ std::string zone = s.substr(l);
+ if (zone == " PST") {
+ dst = 0;
+ } else if (zone == " PDT") {
+ dst = 1;
+ } else {
+ // tests should only use PST/PDT (for now)
+ BOOST_CHECK_MESSAGE(false, "invalid or unknown time time: " << zone);
+ }
+ }
+
+ std::tm t = {};
+#if defined(__GNUC__) && __GNUC__ < 5
+ // GCC did not implement std::get_time() until version 5
+ strptime(s.c_str(), "%Y-%m-%d %H:%M:%S", &t);
+#else /* defined(__GNUC__) && __GNUC__ < 5 */
+ std::istringstream stream(s);
+ stream >> std::get_time(&t, "%Y-%m-%d %H:%M:%S");
+#endif /* defined(__GNUC__) && __GNUC__ < 5 */
+ t.tm_isdst = dst;
+
+ return t;
+}
+
+time_t make_time_t(const tm* t)
+{
+ tm copy = *t;
+ return mktime(&copy);
+}
+
+time_t make_time_t(std::string s)
+{
+ tm t = make_tm(s);
+ return mktime(&t);
+}
+
+struct Segment
+{
+ time_t begin, end;
+
+ Segment(time_t begin, time_t end) : begin(begin), end(end) {}
+ Segment(std::string begin, std::string end) : begin(make_time_t(begin)), end(make_time_t(end)) {}
+
+ bool operator==(const Segment& o) const
+ {
+ return o.begin == begin && o.end == end;
+ }
+};
+
+std::string pretty_time(const tm& t)
+{
+#if defined(__GNUC__) && __GNUC__ < 5
+ // GCC did not implement std::put_time() until version 5
+ char buf[128];
+ size_t n = strftime(buf, sizeof(buf), "%Y-%m-%d %H:%M:%S %Z", &t);
+ return std::string(buf, n);
+#else /* defined(__GNUC__) && __GNUC__ < 5 */
+ std::ostringstream stream;
+ stream << std::put_time(&t, "%Y-%m-%d %H:%M:%S %Z");
+ return stream.str();
+#endif /* defined(__GNUC__) && __GNUC__ < 5 */
+}
+
+std::string pretty_time(time_t t)
+{
+ return pretty_time(Utility::LocalTime(t));
+}
+
+std::ostream& operator<<(std::ostream& o, const Segment& s)
+{
+ return o << "(" << pretty_time(s.begin) << " (" << s.begin << ") .. " << pretty_time(s.end) << " (" << s.end << "))";
+}
+
+std::ostream& operator<<(std::ostream& o, const boost::optional<Segment>& s)
+{
+ if (s) {
+ return o << *s;
+ } else {
+ return o << "none";
+ }
+}
+
+BOOST_AUTO_TEST_CASE(dst)
+{
+ GlobalTimezoneFixture tz(dst_test_timezone);
+
+ // Self-tests for helper functions
+ BOOST_CHECK_EQUAL(make_tm("2021-11-07 02:30:00").tm_isdst, -1);
+ BOOST_CHECK_EQUAL(make_tm("2021-11-07 02:30:00 PST").tm_isdst, 0);
+ BOOST_CHECK_EQUAL(make_tm("2021-11-07 02:30:00 PDT").tm_isdst, 1);
+ BOOST_CHECK_EQUAL(make_time_t("2021-11-07 01:30:00 PST"), 1636277400); // date -d '2021-11-07 01:30:00 PST' +%s
+ BOOST_CHECK_EQUAL(make_time_t("2021-11-07 01:30:00 PDT"), 1636273800); // date -d '2021-11-07 01:30:00 PDT' +%s
+
+ struct TestData {
+ std::string day;
+ std::string ranges;
+ std::vector<tm> before;
+ std::vector<tm> during;
+ boost::optional<Segment> expected;
+ };
+
+ // Some of the following test cases have comments describing the current behavior. This might not necessarily be the
+ // best possible behavior, especially that it differs on Windows. So it might be perfectly valid to change this.
+ // These cases are just there to actually notice these changes in this case.
+ std::vector<TestData> tests;
+
+ // 2021-03-14: 01:59:59 PST (UTC-8) -> 03:00:00 PDT (UTC-7)
+ for (const std::string& day : {"2021-03-14", "sunday", "sunday 2", "sunday -3"}) {
+ // range before DST change
+ tests.push_back(TestData{
+ day, "00:30-01:30",
+ {make_tm("2021-03-14 00:00:00 PST")},
+ {make_tm("2021-03-14 01:00:00 PST")},
+ Segment("2021-03-14 00:30:00 PST", "2021-03-14 01:30:00 PST"),
+ });
+
+ if (day.find("sunday") == std::string::npos) { // skip for non-absolute day specs (would find another sunday)
+ // range end actually does not exist on that day
+ tests.push_back(TestData{
+ day, "01:30-02:30",
+ {make_tm("2021-03-14 01:00:00 PST")},
+ {make_tm("2021-03-14 01:59:59 PST")},
+#ifndef _WIN32
+ // As 02:30 does not exist on this day, it is parsed as if it was 02:30 PST which is actually 03:30 PDT.
+ Segment("2021-03-14 01:30:00 PST", "2021-03-14 03:30:00 PDT"),
+#else
+ // Windows interpretes 02:30 as 01:30 PST, so it is an empty segment.
+ boost::none,
+#endif
+ });
+ }
+
+ if (day.find("sunday") == std::string::npos) { // skip for non-absolute day specs (would find another sunday)
+ // range beginning does not actually exist on that day
+ tests.push_back(TestData{
+ day, "02:30-03:30",
+ {make_tm("2021-03-14 01:00:00 PST")},
+ {make_tm("2021-03-14 03:00:00 PDT")},
+#ifndef _WIN32
+ // As 02:30 does not exist on this day, it is parsed as if it was 02:30 PST which is actually 03:30 PDT.
+ // Therefore, the result is a segment from 03:30 PDT to 03:30 PDT with a duration of 0, i.e. no segment.
+ boost::none,
+#else
+ // Windows parses non-existing 02:30 as 01:30 PST, resulting in an 1 hour segment.
+ Segment("2021-03-14 01:30:00 PST", "2021-03-14 03:30:00 PDT"),
+#endif
+ });
+ }
+
+ // another range where the beginning does not actually exist on that day
+ tests.push_back(TestData{
+ day, "02:15-03:45",
+ {make_tm("2021-03-14 01:00:00 PST")},
+ {make_tm("2021-03-14 03:30:00 PDT")},
+#ifndef _WIN32
+ // As 02:15 does not exist on this day, it is parsed as if it was 02:15 PST which is actually 03:15 PDT.
+ Segment("2021-03-14 03:15:00 PDT", "2021-03-14 03:45:00 PDT"),
+#else
+ // Windows interprets 02:15 as 01:15 PST though.
+ Segment("2021-03-14 01:15:00 PST", "2021-03-14 03:45:00 PDT"),
+#endif
+ });
+
+ // range after DST change
+ tests.push_back(TestData{
+ day, "03:30-04:30",
+ {make_tm("2021-03-14 01:00:00 PST"), make_tm("2021-03-14 03:00:00 PDT")},
+ {make_tm("2021-03-14 04:00:00 PDT")},
+ Segment("2021-03-14 03:30:00 PDT", "2021-03-14 04:30:00 PDT"),
+ });
+
+ // range containing DST change
+ tests.push_back(TestData{
+ day, "01:30-03:30",
+ {make_tm("2021-03-14 01:00:00 PST")},
+ {make_tm("2021-03-14 01:45:00 PST"), make_tm("2021-03-14 03:15:00 PDT")},
+ Segment("2021-03-14 01:30:00 PST", "2021-03-14 03:30:00 PDT"),
+ });
+ }
+
+ // 2021-11-07: 01:59:59 PDT (UTC-7) -> 01:00:00 PST (UTC-8)
+ for (const std::string& day : {"2021-11-07", "sunday", "sunday 1", "sunday -4"}) {
+ // range before DST change
+ tests.push_back(TestData{
+ day, "00:15-00:45",
+ {make_tm("2021-11-07 00:00:00 PDT")},
+ {make_tm("2021-11-07 00:30:00 PDT")},
+ Segment("2021-11-07 00:15:00 PDT", "2021-11-07 00:45:00 PDT"),
+ });
+
+ if (day.find("sunday") == std::string::npos) { // skip for non-absolute day specs (would find another sunday)
+ // range existing twice during DST change (first instance)
+#ifndef _WIN32
+ tests.push_back(TestData{
+ day, "01:15-01:45",
+ {make_tm("2021-11-07 01:00:00 PDT")},
+ {make_tm("2021-11-07 01:30:00 PDT")},
+ // Duplicate times are interpreted as the first occurrence.
+ Segment("2021-11-07 01:15:00 PDT", "2021-11-07 01:45:00 PDT"),
+ });
+#else
+ tests.push_back(TestData{
+ day, "01:15-01:45",
+ {make_tm("2021-11-07 01:00:00 PDT")},
+ {make_tm("2021-11-07 01:30:00 PST")},
+ // However, Windows always uses the second occurrence.
+ Segment("2021-11-07 01:15:00 PST", "2021-11-07 01:45:00 PST"),
+ });
+#endif
+ }
+
+ if (day.find("sunday") == std::string::npos) { // skip for non-absolute day specs (would find another sunday)
+ // range existing twice during DST change (second instance)
+ tests.push_back(TestData{
+ day, "01:15-01:45",
+ {make_tm("2021-11-07 01:00:00 PST")},
+ {make_tm("2021-11-07 01:30:00 PST")},
+#ifndef _WIN32
+ // Interpreted as the first occurrence, so it's in the past.
+ boost::none,
+#else
+ // On Windows, it's the second occurrence, so it's still in the present/future and is found.
+ Segment("2021-11-07 01:15:00 PST", "2021-11-07 01:45:00 PST"),
+#endif
+ });
+ }
+
+ // range after DST change
+ tests.push_back(TestData{
+ day, "03:30-04:30",
+ {make_tm("2021-11-07 01:00:00 PDT"), make_tm("2021-11-07 03:00:00 PST")},
+ {make_tm("2021-11-07 04:00:00 PST")},
+ Segment("2021-11-07 03:30:00 PST", "2021-11-07 04:30:00 PST"),
+ });
+
+ // range containing DST change
+ tests.push_back(TestData{
+ day, "00:30-02:30",
+ {make_tm("2021-11-07 00:00:00 PDT")},
+ {make_tm("2021-11-07 00:45:00 PDT"), make_tm("2021-11-07 01:30:00 PDT"),
+ make_tm("2021-11-07 01:30:00 PST"), make_tm("2021-11-07 02:15:00 PST")},
+ Segment("2021-11-07 00:30:00 PDT", "2021-11-07 02:30:00 PST"),
+ });
+
+ // range ending during duplicate DST hour (first instance)
+ tests.push_back(TestData{
+ day, "00:30-01:30",
+ {make_tm("2021-11-07 00:00:00 PDT")},
+ {make_tm("2021-11-07 01:00:00 PDT")},
+#ifndef _WIN32
+ // Both times are interpreted as the first instance on that day (i.e both PDT).
+ Segment("2021-11-07 00:30:00 PDT", "2021-11-07 01:30:00 PDT")
+#else
+ // Windows interprets duplicate times as the second instance (i.e. both PST).
+ Segment("2021-11-07 00:30:00 PDT", "2021-11-07 01:30:00 PST")
+#endif
+ });
+
+ // range beginning during duplicate DST hour (first instance)
+ tests.push_back(TestData{
+ day, "01:30-02:30",
+ {make_tm("2021-11-07 01:00:00 PDT")},
+ {make_tm("2021-11-07 02:00:00 PST")},
+#ifndef _WIN32
+ // 01:30 is interpreted as the first occurrence (PDT) but since there's no 02:30 PDT, it's PST.
+ Segment("2021-11-07 01:30:00 PDT", "2021-11-07 02:30:00 PST")
+#else
+ // Windows interprets both as PST though.
+ Segment("2021-11-07 01:30:00 PST", "2021-11-07 02:30:00 PST")
+#endif
+ });
+
+ if (day.find("sunday") == std::string::npos) { // skip for non-absolute day specs (would find another sunday)
+ // range ending during duplicate DST hour (second instance)
+#ifndef _WIN32
+ tests.push_back(TestData{
+ day, "00:30-01:30",
+ {make_tm("2021-11-07 00:00:00 PST")},
+ {make_tm("2021-11-07 01:00:00 PST")},
+ // Both times are parsed as PDT. Thus, 00:00 PST (01:00 PDT) is during the segment and
+ // 01:00 PST (02:00 PDT) is after the segment.
+ boost::none,
+ });
+#else
+ tests.push_back(TestData{
+ day, "00:30-01:30",
+ {make_tm("2021-11-07 00:00:00 PDT")},
+ {make_tm("2021-11-07 01:00:00 PST")},
+ // As Windows interprets the end as PST, it's still in the future and the segment is found.
+ Segment("2021-11-07 00:30:00 PDT", "2021-11-07 01:30:00 PST"),
+ });
+#endif
+ }
+
+ // range beginning during duplicate DST hour (second instance)
+ tests.push_back(TestData{
+ day, "01:30-02:30",
+ {make_tm("2021-11-07 01:00:00 PDT")},
+ {make_tm("2021-11-07 02:00:00 PST")},
+#ifndef _WIN32
+ // As 01:30 always refers to the first occurrence (PDT), this is actually a 2 hour segment.
+ Segment("2021-11-07 01:30:00 PDT", "2021-11-07 02:30:00 PST"),
+#else
+ // On Windows, it refers t the second occurrence (PST), therefore it's an 1 hour segment.
+ Segment("2021-11-07 01:30:00 PST", "2021-11-07 02:30:00 PST"),
+#endif
+ });
+ }
+
+ auto seg = [](const Dictionary::Ptr& segment) -> boost::optional<Segment> {
+ if (segment == nullptr) {
+ return boost::none;
+ }
+
+ BOOST_CHECK(segment->Contains("begin"));
+ BOOST_CHECK(segment->Contains("end"));
+
+ return Segment{time_t(segment->Get("begin")), time_t(segment->Get("end"))};
+ };
+
+ for (const TestData& t : tests) {
+ for (const tm& ref : t.during) {
+ if (t.expected) {
+ // test data sanity check
+ time_t ref_ts = make_time_t(&ref);
+ BOOST_CHECK_MESSAGE(t.expected->begin < ref_ts, "[day='" << t.day << "' ranges='" << t.ranges
+ << "'] expected.begin='"<< pretty_time(t.expected->begin) << "' < ref='" << pretty_time(ref_ts)
+ << "' violated");
+ BOOST_CHECK_MESSAGE(ref_ts < t.expected->end, "[day='" << t.day << "' ranges='" << t.ranges
+ << "'] ref='" << pretty_time(ref_ts) << "' < expected.end='" << pretty_time(t.expected->end)
+ << "' violated");
+ }
+
+ tm mutRef = ref;
+ auto runningSeg = seg(LegacyTimePeriod::FindRunningSegment(t.day, t.ranges, &mutRef));
+ BOOST_CHECK_MESSAGE(runningSeg == t.expected, "FindRunningSegment(day='" << t.day
+ << "' ranges='" << t.ranges << "' ref='" << pretty_time(ref) << "'): got=" << runningSeg
+ << " expected=" << t.expected);
+ }
+
+ for (const tm& ref : t.before) {
+ if (t.expected) {
+ // test data sanity check
+ time_t ref_ts = make_time_t(&ref);
+ BOOST_CHECK_MESSAGE(ref_ts < t.expected->begin, "[day='" << t.day << "' ranges='" << t.ranges
+ << "'] ref='"<< pretty_time(ref_ts) << "' < expected.begin='" << pretty_time(t.expected->begin)
+ << "' violated");
+ BOOST_CHECK_MESSAGE(t.expected->begin < t.expected->end, "[day='" << t.day << "' ranges='" << t.ranges
+ << "'] expected.begin='" << pretty_time(t.expected->begin)
+ << "' < expected.end='" << pretty_time(t.expected->end) << "' violated");
+ }
+
+ tm mutRef = ref;
+ auto nextSeg = seg(LegacyTimePeriod::FindNextSegment(t.day, t.ranges, &mutRef));
+ BOOST_CHECK_MESSAGE(nextSeg == t.expected, "FindNextSegment(day='" << t.day << "' ranges='" << t.ranges
+ << "' ref='" << pretty_time(ref) << "'): got=" << nextSeg << " expected=" << t.expected);
+ }
+ }
+}
+
+// This tests checks that TimePeriod::IsInside() always returns true for a 24x7 period, even around DST changes.
+BOOST_AUTO_TEST_CASE(dst_isinside)
+{
+ GlobalTimezoneFixture tz(dst_test_timezone);
+
+ Function::Ptr update = new Function("LegacyTimePeriod", LegacyTimePeriod::ScriptFunc, {"tp", "begin", "end"});
+ Dictionary::Ptr ranges = new Dictionary({
+ {"monday", "00:00-24:00"},
+ {"tuesday", "00:00-24:00"},
+ {"wednesday", "00:00-24:00"},
+ {"thursday", "00:00-24:00"},
+ {"friday", "00:00-24:00"},
+ {"saturday", "00:00-24:00"},
+ {"sunday", "00:00-24:00"},
+ });
+
+ // Vary begin from Sat 06 Nov 2021 00:00:00 PDT to Mon 08 Nov 2021 00:00:00 PST in 30 minute intervals.
+ for (time_t t_begin = 1636182000; t_begin <= 1636358400; t_begin += 30*60) {
+ // Test varying interval lengths: 60 minutes, 24 hours, 48 hours.
+ for (time_t len : {60*60, 24*60*60, 48*60*60}) {
+ time_t t_end = t_begin + len;
+
+ TimePeriod::Ptr p = new TimePeriod();
+ p->SetUpdate(update, true);
+ p->SetRanges(ranges, true);
+
+ p->UpdateRegion(double(t_begin), double(t_end), true);
+
+ {
+ // Print resulting segments for easier debugging.
+ Array::Ptr segments = p->GetSegments();
+ ObjectLock lock(segments);
+ for (Dictionary::Ptr segment: segments) {
+ BOOST_TEST_MESSAGE("t_begin=" << t_begin << " t_end=" << t_end
+ << " segment.begin=" << segment->Get("begin") << " segment.end=" << segment->Get("end"));
+ }
+ }
+
+ time_t step = 10*60;
+ for (time_t t = t_begin+step; t < t_end; t += step) {
+ BOOST_CHECK_MESSAGE(p->IsInside(double(t)),
+ t << " should be inside for t_begin=" << t_begin << " t_end=" << t_end);
+ }
+ }
+ }
+}
+
+BOOST_AUTO_TEST_SUITE_END()