mirror/libcron
2
0
Fork 0
mirror of https://github.com/PerMalmberg/libcron.git synced 2024-12-15 09:59:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3 from PerMalmberg/feature/random-via-textual-names

Browse Source 
Implemented support for using textual names in randomization.
This commit is contained in:
PerMalmberg 2019-05-17 15:27:28 +02:00 committed by GitHub
commit b82267acca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 180 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -71,8 +71,8 @@ the '?'-character to ensure that it is not possible to specify a statement which
The standard cron format does not allow for randomization, but with the use of `CronRandomization` you can generate random
schedules using the following format: `R(range_start-range_end)`, where `range_start` and `range_end` follow the same rules
as for a regular cron range with the addition that only numbers are allowed. All the rules for a regular cron expression
still applies when using randomization, i.e. mutual exclusiveness and not extra spaces.
as for a regular cron range (step-syntax is not supported). All the rules for a regular cron expression still applies
when using randomization, i.e. mutual exclusiveness and no extra spaces.
## Examples
|Expression | Meaning
@ -80,6 +80,7 @@ still applies when using randomization, i.e. mutual exclusiveness and not extra
| 0 0 R(13-20) * * ? | On the hour, on a random hour 13-20, inclusive.
| 0 0 0 ? * R(0-6) | A random weekday, every week, at midnight.
| 0 R(45-15) */12 ? * * | A random minute between 45-15, inclusive, every 12 hours.
|0 0 0 ? R(DEC-MAR) R(SAT-SUN)| On the hour, on a random month december to march, on a random weekday saturday to sunday.
# Used Third party libraries

2
libcron/CMakeLists.txt
View File

@ -1,7 +1,7 @@
cmake_minimum_required(VERSION 3.6)
project(libcron)
set(CMAKE_CXX_STANDARD 14)
set(CMAKE_CXX_STANDARD 17)
if( MSVC )
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4")

45
libcron/include/libcron/CronData.h
View File

@ -16,7 +16,7 @@ namespace libcron
static CronData create(const std::string& cron_expression);
CronData();
CronData() = default;
CronData(const CronData&) = default;
@ -77,6 +77,9 @@ namespace libcron
template<typename T>
bool convert_from_string_range_to_number_range(const std::string& range, std::set<T>& numbers);
template<typename T>
static std::string& replace_string_name_with_numeric(std::string& s);
private:
void parse(const std::string& cron_expression);
@ -121,8 +124,8 @@ namespace libcron
std::set<DayOfWeek> day_of_week{};
bool valid = false;
std::vector<std::string> month_names;
std::vector<std::string> day_names;
static const std::vector<std::string> month_names;
static const std::vector<std::string> day_names;
template<typename T>
void add_full_range(std::set<T>& set);
@ -343,4 +346,40 @@ namespace libcron
return res;
}
template<typename T>
std::string & CronData::replace_string_name_with_numeric(std::string& s)
{
auto value = static_cast<int>(T::First);
const std::vector<std::string>* name_source{};
static_assert(std::is_same<T, libcron::Months>()
|| std::is_same<T, libcron::DayOfWeek>(),
"T must be either Months or DayOfWeek");
if constexpr (std::is_same<T, libcron::Months>())
{
name_source = &month_names;
}
else
{
name_source = &day_names;
}
for (const auto& name : *name_source)
{
std::regex m(name, std::regex_constants::ECMAScript | std::regex_constants::icase);
std::string replaced;
std::regex_replace(std::back_inserter(replaced), s.begin(), s.end(), m, std::to_string(value));
s = replaced;
++value;
}
return s;
}
}

2
libcron/include/libcron/CronRandomization.h
View File

@ -44,7 +44,7 @@ namespace libcron
std::smatch random_match;
if (std::regex_match(section.begin(), section.end(), random_match, rand_expression))
if (std::regex_match(section.cbegin(), section.cend(), random_match, rand_expression))
{
// Random range, get left and right numbers.
auto left = std::stoi(random_match[1].str());

9
libcron/src/CronData.cpp
View File

@ -13,6 +13,9 @@ namespace libcron
Months::October,
Months::December };
const std::vector<std::string> CronData::month_names{ "JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC" };
const std::vector<std::string> CronData::day_names{ "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT" };
CronData CronData::create(const std::string& cron_expression)
{
CronData c;
@ -21,12 +24,6 @@ namespace libcron
return c;
}
CronData::CronData()
: month_names({ "JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC" }),
day_names({ "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT" })
{
}
void CronData::parse(const std::string& cron_expression)
{
// First, split on white-space. We expect six parts.

40
libcron/src/CronRandomization.cpp
View File

@ -18,14 +18,46 @@ namespace libcron
std::tuple<bool, std::string> CronRandomization::parse(const std::string& cron_schedule)
{
// Split on space to get each separate part, six parts expected
std::regex split{ R"#(^\s*(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s*$)#",
std::regex_constants::ECMAScript };
const std::regex split{ R"#(^\s*(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s*$)#",
std::regex_constants::ECMAScript };
std::smatch all_sections;
auto res = std::regex_match(cron_schedule.cbegin(), cron_schedule.cend(), all_sections, split);
std::string final_cron_schedule;
// Replace text with numbers
std::string working_copy{};
auto res = std::regex_match(cron_schedule.begin(), cron_schedule.end(), all_sections, split);
if (res)
{
// Merge seconds, minutes, hours and day of month back together
working_copy += all_sections[1].str();
working_copy += " ";
working_copy += all_sections[2].str();
working_copy += " ";
working_copy += all_sections[3].str();
working_copy += " ";
working_copy += all_sections[4].str();
working_copy += " ";
// Replace month names
auto month = all_sections[5].str();
CronData::replace_string_name_with_numeric<libcron::Months>(month);
working_copy += " ";
working_copy += month;
// Replace day names
auto dow = all_sections[6].str();
CronData::replace_string_name_with_numeric<libcron::DayOfWeek>(dow);
working_copy += " ";
working_copy += dow;
}
std::string final_cron_schedule{};
// Split again on space
res = res && std::regex_match(working_copy.cbegin(), working_copy.cend(), all_sections, split);
if (res)
{

2
test/CMakeLists.txt
View File

@ -1,7 +1,7 @@
cmake_minimum_required(VERSION 3.6)
project(cron_test)
set(CMAKE_CXX_STANDARD 14)
set(CMAKE_CXX_STANDARD 17)
if( MSVC )
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4")

13
test/CronDataTest.cpp
View File

@ -225,3 +225,16 @@ SCENARIO("Date that exist in one of the months")
{
REQUIRE(CronData::create("0 0 * 31 APR,MAY ?").is_valid());
}
SCENARIO("Replacing text with numbers")
{
{
std::string s = "SUN-TUE";
REQUIRE(CronData::replace_string_name_with_numeric<libcron::DayOfWeek>(s) == "0-2");
}
{
std::string s = "JAN-DEC";
REQUIRE(CronData::replace_string_name_with_numeric<libcron::Months>(s) == "1-12");
}
}

85
test/CronRandomizationTest.cpp
View File

@ -7,21 +7,31 @@
#include <iostream>
using namespace libcron;
const auto EXPECT_FAILURE = true;
void test(const char* const random_schedule)
void test(const char* const random_schedule, bool expect_failure = false)
{
libcron::CronRandomization cr;
std::unordered_map<int, std::unordered_map<int, int>> results{};
for (int i = 0; i < 5000; ++i)
{
auto res = cr.parse(random_schedule);
REQUIRE(std::get<0>(res));
auto schedule = std::get<1>(res);
INFO("schedule:" << schedule);
Cron<> cron;
REQUIRE(cron.add_schedule("validate schedule", schedule, []() {}));
if(expect_failure)
{
// Parsing of random might succeed, but it yields an invalid schedule.
auto r = std::get<0>(res) && cron.add_schedule("validate schedule", schedule, []() {});
REQUIRE_FALSE(r);
}
else
{
REQUIRE(std::get<0>(res));
REQUIRE(cron.add_schedule("validate schedule", schedule, []() {}));
}
}
}
@ -103,3 +113,68 @@ SCENARIO("Test readme examples")
}
}
}
SCENARIO("Randomization using text versions of days and months")
{
GIVEN("0 0 0 ? * R(TUE-FRI)")
{
THEN("Valid schedule generated")
{
test("0 0 0 ? * R(TUE-FRI)");
}
}
GIVEN("Valid schedule")
{
THEN("Valid schedule generated")
{
test("0 0 0 ? R(JAN-DEC) R(MON-FRI)");
}
AND_WHEN("Given 0 0 0 ? R(DEC-MAR) R(SAT-SUN)")
{
THEN("Valid schedule generated")
{
test("0 0 0 ? R(DEC-MAR) R(SAT-SUN)");
}
}
AND_THEN("Given 0 0 0 ? R(JAN-FEB) *")
{
THEN("Valid schedule generated")
{
test("0 0 0 ? R(JAN-FEB) *");
}
}
AND_THEN("Given 0 0 0 ? R(OCT-OCT) *")
{
THEN("Valid schedule generated")
{
test("0 0 0 ? R(OCT-OCT) *");
}
}
}
GIVEN("Invalid schedule")
{
THEN("No schedule generated")
{
// Day of month specified - not allowed with day of week
test("0 0 0 1 R(JAN-DEC) R(MON-SUN)", EXPECT_FAILURE);
}
AND_THEN("No schedule generated")
{
// Invalid range
test("0 0 0 ? R(JAN) *", EXPECT_FAILURE);
}
AND_THEN("No schedule generated")
{
// Days in month field
test("0 0 0 ? R(MON-TUE) *", EXPECT_FAILURE);
}
AND_THEN("No schedule generated")
{
// Month in day field
test("0 0 0 ? * R(JAN-JUN)", EXPECT_FAILURE);
}
}
}