tests/unit/util/time.t.cpp

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2023 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library 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 Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */

#include "ndn-cxx/util/time.hpp"

#include "tests/boost-test.hpp"

#include <boost/lexical_cast.hpp>
#include <thread>

namespace ndn::tests {

using namespace ndn::time;

BOOST_AUTO_TEST_SUITE(Util)
BOOST_AUTO_TEST_SUITE(TestTime)

BOOST_AUTO_TEST_CASE(Duration)
{
  BOOST_TEST(years(1) == months(12));
  BOOST_TEST(months(1) == minutes(43829) + seconds(6));
  BOOST_TEST(weeks(1) == days(7));
  BOOST_TEST(days(1) == hours(24));
  BOOST_TEST(hours(1) == minutes(60));
  BOOST_TEST(minutes(1) == seconds(60));
  BOOST_TEST(seconds(1) == milliseconds(1000));
  BOOST_TEST(milliseconds(1) == microseconds(1000));
  BOOST_TEST(microseconds(1) == nanoseconds(1000));
}

BOOST_AUTO_TEST_CASE(Abs)
{
  BOOST_TEST(abs(nanoseconds(24422)) == nanoseconds(24422));
  BOOST_TEST(abs(microseconds(0)) == microseconds(0));
  BOOST_TEST(abs(milliseconds(-15583)) == milliseconds(15583));
}

BOOST_AUTO_TEST_CASE(Literals)
{
  BOOST_TEST(42_s == seconds(42));

  BOOST_TEST(1_day == 24_h);
  BOOST_TEST(2_days == 48_h);
  BOOST_TEST(0.5_day == 12_h);
  BOOST_TEST(.5_days == 12_h);

  BOOST_TEST(1_h == 60_min);
  BOOST_TEST(0.5_h == 30_min);

  BOOST_TEST(1_min == 60_s);
  BOOST_TEST(0.5_min == 30_s);

  BOOST_TEST(1_s == 1000_ms);
  BOOST_TEST(0.5_s == 500_ms);

  BOOST_TEST(1_ms == 1000_us);
  BOOST_TEST(0.5_ms == 500_us);

  BOOST_TEST(1_us == 1000_ns);
  BOOST_TEST(0.5_us == 500_ns);

  BOOST_TEST(1_ns == nanoseconds(1));
  BOOST_TEST(5.5_ns == 0.0055_us);
}

BOOST_AUTO_TEST_CASE(SystemClock)
{
  system_clock::time_point value = system_clock::now();
  system_clock::time_point referenceTime = fromUnixTimestamp(1390966967032_ms);

  BOOST_TEST(value > referenceTime);

  BOOST_TEST(toUnixTimestamp(referenceTime) == 1390966967032_ms);
  BOOST_TEST(toUnixTimestamp<nanoseconds>(referenceTime) == 1390966967032000000_ns);
  BOOST_TEST(toUnixTimestamp<seconds>(referenceTime) == 1390966967_s);

  BOOST_TEST(toIsoString(referenceTime) == "20140129T034247.032000");
  BOOST_TEST(toIsoExtendedString(referenceTime) == "2014-01-29T03:42:47.032000");
  BOOST_TEST(toString(referenceTime) == "2014-01-29 03:42:47");

  // Unfortunately, not all systems has lv_LV locale installed :(
  // BOOST_TEST(toString(referenceTime, "%Y. gada %d. %B", std::locale("lv_LV.UTF-8")) ==
  //            "2014. gada 29. Janvāris");
  BOOST_TEST(toString(referenceTime, "%Y -- %d -- %B", std::locale("C")) == "2014 -- 29 -- January");

  BOOST_TEST(fromIsoString("20140129T034247.032000") == referenceTime);
  BOOST_TEST(fromIsoString("20140129T034247.032000Z") == referenceTime);
  BOOST_TEST(fromIsoString("20140129T034247") != referenceTime);
  BOOST_TEST(fromIsoString("20140129T034247") == fromUnixTimestamp(1390966967_s));
  BOOST_TEST(fromIsoExtendedString("2014-01-29T03:42:47.032000") == referenceTime);
  BOOST_TEST(fromIsoExtendedString("2014-01-29T03:42:47.032000Z") == referenceTime);
  BOOST_TEST(fromIsoExtendedString("2014-01-29T03:42:47") != referenceTime);
  BOOST_TEST(fromIsoExtendedString("2014-01-29T03:42:47") == fromUnixTimestamp(1390966967_s));
  BOOST_TEST(fromString("2014-01-29 03:42:47") != referenceTime);
  BOOST_TEST(fromString("2014-01-29 03:42:47") == fromUnixTimestamp(1390966967_s));

  // Unfortunately, not all systems has lv_LV locale installed :(
  // BOOST_TEST(fromString("2014. gada 29. Janvāris", "%Y. gada %d. %B", std::locale("lv_LV.UTF-8")) ==
  //            fromUnixTimestamp(1390953600_s));
  BOOST_TEST(fromString("2014 -- 29 -- January", "%Y -- %d -- %B", std::locale("C")) ==
             fromUnixTimestamp(1390953600_s));
}

BOOST_AUTO_TEST_CASE(SteadyClock)
{
  steady_clock::time_point oldValue = steady_clock::now();
  std::this_thread::sleep_for(std::chrono::milliseconds(1));
  steady_clock::time_point newValue = steady_clock::now();
  BOOST_CHECK_GT(newValue, oldValue);
}

BOOST_AUTO_TEST_CASE(SecondsClock)
{
  using SecTimePoint = boost::chrono::time_point<system_clock, seconds>;
  SecTimePoint tp;
  tp += 1596592240_s;

  BOOST_TEST(toIsoString(tp) == "20200805T015040");
  BOOST_TEST(toIsoExtendedString(tp) == "2020-08-05T01:50:40");
  BOOST_TEST(toString(tp) == "2020-08-05 01:50:40");
  BOOST_TEST(fromIsoString("20200805T015040") == tp);
  BOOST_TEST(fromIsoString("20200805T015040.123456") != tp);
  BOOST_TEST(fromIsoExtendedString("2020-08-05T01:50:40") == tp);
  BOOST_TEST(fromIsoExtendedString("2020-08-05T01:50:40.123456") != tp);
  BOOST_TEST(fromString("2020-08-05 01:50:40") == tp);
}

BOOST_AUTO_TEST_CASE(LargeDates)
{
  auto value = fromUnixTimestamp(1390966967032_ms);
  BOOST_CHECK_EQUAL(toIsoString(value), "20140129T034247.032000");
  BOOST_CHECK_EQUAL(fromIsoString("20140129T034247.032000"), value);
  BOOST_CHECK_EQUAL(toString(value, "%Y-%m-%d %H:%M:%S%F"), "2014-01-29 03:42:47.032000");
  BOOST_CHECK_EQUAL(fromString("2014-01-29 03:42:47.032000", "%Y-%m-%d %H:%M:%S%F"), value);

  value += 36524_days;
  BOOST_CHECK_EQUAL(toIsoString(value), "21140129T034247.032000");
  BOOST_CHECK_EQUAL(fromIsoString("21140129T034247.032000"), value);
  BOOST_CHECK_EQUAL(toString(value, "%Y-%m-%d %H:%M:%S%F"), "2114-01-29 03:42:47.032000");
  BOOST_CHECK_EQUAL(fromString("2114-01-29 03:42:47.03200", "%Y-%m-%d %H:%M:%S%F"), value);
}

BOOST_AUTO_TEST_CASE(Year2038)
{
  auto year2042 = fromIsoString("20420101T000001.042000");
  auto year2010 = fromIsoString("20100101T000001.042000");

  BOOST_CHECK_EQUAL(boost::lexical_cast<std::string>(year2010),
                    "1262304001042000000 nanoseconds since Jan 1, 1970");
  BOOST_CHECK_EQUAL(boost::lexical_cast<std::string>(year2042),
                    "2272147201042000000 nanoseconds since Jan 1, 1970");
  BOOST_CHECK_GT(year2042, year2010);
}

BOOST_AUTO_TEST_SUITE_END() // TestTime
BOOST_AUTO_TEST_SUITE_END() // Util

} // namespace ndn::tests