test_CloudSchedule.cpp

/*
   Copyright (c) 2021 Arduino.  All rights reserved.
*/

/**************************************************************************************
   INCLUDE
 **************************************************************************************/

#include <catch.hpp>

#include <property/types/CloudSchedule.h>

unsigned long time_now = 1;

/**************************************************************************************
 * TimeService Fake CTOR/DTOR
 **************************************************************************************/

TimeService::TimeService() {}

/**************************************************************************************
 * TimeService Fake Methods
 **************************************************************************************/

unsigned long TimeService::getLocalTime() {return time_now;}

/**************************************************************************************
  TEST CODE
 **************************************************************************************/

SCENARIO("Testing cloud type 'Schedule' Ctor", "[Schedule::Schedule]")
{
  WHEN("A Schedule(0,0,0,0) is being instantiated")
  {
    Schedule schedule(0,0,0,0);
    THEN("The member variable 'frm' should be 0") {
      REQUIRE(schedule.frm == 0);
    }
    THEN("The member variable 'to' should be 0") {
      REQUIRE(schedule.to == 0);
    }
    THEN("The member variable 'len' should be 0") {
      REQUIRE(schedule.len == 0);
    }
    THEN("The member variable 'msk' should be 0") {
      REQUIRE(schedule.msk == 0);
    }
  }
}

/**************************************************************************************/

SCENARIO("Setup a schedule that repeats each 20 minutes and test isActive Method", "[Schedule::isActive]")
{
  Schedule schedule( 1633305600,   /* Start 4/10/2021 00:00:00 */
                     1633651200,   /* End   8/10/2021 00:00:00 */
                            600,   /* Duration        00:10:00 */
                     1140850708    /* Minutes                  */
                                   /* Repeats         00:20:00 */
                    );

  WHEN("Time is 4/10/2021 00:00:00")
  {
    time_now = 1633305600;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 4/10/2021 00:10:00")
  {
    time_now = 1633306200;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 4/10/2021 00:10:01")
  {
    time_now = 1633306201;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 4/10/2021 00:19:59")
  {
    time_now = 1633306799;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 4/10/2021 00:20:00")
  {
    time_now = 1633306800;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 7/10/2021 23:45:00")
  {
    time_now = 1633650300;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 7/10/2021 23:55:00")
  {
    time_now = 1633650900;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 8/10/2021 00:00:00")
  {
    time_now = 1633651200;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 8/10/2021 00:05:00")
  {
    time_now = 1633651500;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }
}

/**************************************************************************************/

SCENARIO("Setup a weekly schedule and test isActive Method", "[Schedule::isActive]")
{
  Schedule schedule( 1633305600,   /* Start 4/10/2021 00:00:00 */
                     1633651200,   /* End   8/10/2021 00:00:00 */
                            600,   /* Duration        00:10:00 */
                      134217798    /* Weekly                   */
                                   /* Daymask          1000110 */
                    );

  WHEN("Time is 4/10/2021 00:05:00")
  {
    time_now = 1633305900;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 4/10/2021 00:25:00")
  {
    time_now = 1633307100;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 5/10/2021 00:05:00")
  {
    time_now = 1633392300;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 5/10/2021 00:25:00")
  {
    time_now = 1633393500;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 6/10/2021 00:05:00")
  {
    time_now = 1633478700;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 7/10/2021 00:05:00")
  {
    time_now = 1633565100;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }
}

/**************************************************************************************/

SCENARIO("Setup a monthly schedule and test isActive Method", "[Schedule::isActive]")
{
  Schedule schedule( 1633305600,   /* Start 4/10/2021 00:00:00 */
                     1664841600,   /* End   4/10/2022 00:00:00 */
                            600,   /* Duration        00:10:00 */
                      201326598    /* Monthly                  */
                                   /* Day of month           6 */
                    );

  WHEN("Time is 6/09/2021 00:05:00")
  {
    time_now = 1630886700;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 6/10/2021 00:05:00")
  {
    time_now = 1633478700;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/10/2021 00:25:00")
  {
    time_now = 1633479900;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 6/11/2021 00:05:00")
  {
    time_now = 1636157100;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/11/2021 00:25:00")
  {
    time_now = 1636158300;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 7/11/2021 00:05:00")
  {
    time_now = 1636243500;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 6/12/2021 00:05:00")
  {
    time_now = 1638749100;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/01/2022 00:05:00")
  {
    time_now = 1641427500;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/02/2022 00:05:00")
  {
    time_now = 1644105900;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/03/2022 00:05:00")
  {
    time_now = 1646525100;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/04/2022 00:05:00")
  {
    time_now = 1649203500;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/05/2022 00:05:00")
  {
    time_now = 1651795500;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/06/2022 00:05:00")
  {
    time_now = 1654473900;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/07/2022 00:05:00")
  {
    time_now = 1657065900;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/08/2022 00:05:00")
  {
    time_now = 1659744300;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/09/2022 00:05:00")
  {
    time_now = 1662422700;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/10/2022 00:05:00")
  {
    time_now = 1665014700;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }
}

/**************************************************************************************/

SCENARIO("Setup a yearly schedule and test isActive Method", "[Schedule::isActive]")
{
  Schedule schedule( 1633305600,   /* Start 4/10/2021 00:00:00 */
                     1759536000,   /* End   4/10/2025 00:00:00 */
                            600,   /* Duration        00:10:00 */
                      268438022    /* Yearly                   */
                                   /* Month 11, Day of month 6 */
                    );

  WHEN("Time is 6/11/2020 00:05:00")
  {
    time_now = 1604621100;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 6/11/2021 00:05:00")
  {
    time_now = 1636157100;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/11/2021 00:25:00")
  {
    time_now = 1636158300;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 6/11/2022 00:05:00")
  {
    time_now = 1667693100;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/11/2022 00:25:00")
  {
    time_now = 1667694300;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 7/11/2021 00:05:00")
  {
    time_now = 1636243500;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 6/11/2023 00:05:00")
  {
    time_now = 1699229100;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/11/2024 00:05:00")
  {
    time_now = 1730851500;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/11/2025 00:05:00")
  {
    time_now = 1762387500;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }
}

/**************************************************************************************/

SCENARIO("Setup a one shot schedule and test isActive Method", "[Schedule::isActive]")
{
  Schedule schedule( 1636156800,   /* Start 6/11/2021 00:00:00 */
                     1636243199,   /* End   6/11/2021 23:59:59 */
                            600,   /* Duration        00:10:00 */
                              0    /* One shot                 */
                    );

  WHEN("Time is 6/11/2020 00:05:00")
  {
    time_now = 1604621100;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 6/11/2021 00:05:00")
  {
    time_now = 1636157100;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 6/11/2021 00:25:00")
  {
    time_now = 1636158300;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 6/11/2022 00:05:00")
  {
    time_now = 1667693100;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 7/11/2021 00:05:00")
  {
    time_now = 1636243500;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 7/11/2021 00:15:00")
  {
    time_now = 1636244100;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 6/11/2021 00:11:00")
  {
    time_now = 1636157460;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }

  WHEN("Time is 6/11/2021 00:01:00")
  {
    time_now = 1636156860;
    THEN("Schedule must be active") {
      REQUIRE(schedule.isActive() == true);
    }
  }

  WHEN("Time is 7/11/2021 00:11:00")
  {
    time_now = 1636243860;
    THEN("Schedule must be inactive") {
      REQUIRE(schedule.isActive() == false);
    }
  }
}