Improvements to "Cron Job Schedule" validation & translation. by Martinski4GitHub · Pull Request #142 · ExtremeFiretop/MerlinAutoUpdate-Router

Martinski4GitHub · 2024-02-23T02:57:00Z

Added a validator for the "Cron Job Schedule" user input to try to prevent users from setting an invalid check schedule and then wondering why it didn't work. It's not an exhaustive validation but it flags the most common user errors.
Improve translation of the "Cron Job Schedule" string to English.
Now it handles abbreviated short names for "month" values ("Jan", "Feb", "Mar", etc.) and for "day of the week" values ("Sun", "Mon", "Tue", etc.) and outputs the full names.

- Added a validator for the "Cron Job Schedule" user input to try to prevent users from setting an invalid check schedule and then wondering why it didn't work. It's not an exhaustive validation but it flags the most common user errors. - Improve translation of "Cron Job Schedule" string to English. Now it handles abbreviated short names for month ("Jan", "Feb", etc.) and day of the week ("Sun", "Mon", etc.).

Martinski4GitHub · 2024-02-23T03:04:35Z

@ExtremeFiretop,

OK, it's all yours now. Once you're happy that everything is working well and no issues are found, you can merge into the "main" branch and issue a new release.

ExtremeFiretop · 2024-02-23T03:05:11Z

@ExtremeFiretop,

OK, it's all yours now. Once you're happy that everything is working well and no issues are found, you can merge into the "main" branch and issue a new release.

Starting my review now :)

Martinski4GitHub · 2024-02-23T03:09:45Z

@ExtremeFiretop,
OK, it's all yours now. Once you're happy that everything is working well and no issues are found, you can merge into the "main" branch and issue a new release.

Starting my review now :)

I'll be around checking for any problems reported. I was just informed that dinner will be ready in about 15 minutes so I'll take a break then.

ExtremeFiretop · 2024-02-23T03:10:13Z

MerlinAU.sh

+## Modified by Martinski W. [2024-Feb-22] ##
 ##----------------------------------------##
-readonly FW_Update_CRON_DefaultSchedule="0 0 * * 0"
+readonly FW_Update_CRON_DefaultSchedule="0 0 * * Sun"


Approving changes to default values

ExtremeFiretop · 2024-02-23T03:11:59Z

MerlinAU.sh

+
+   # Special handling for "month" to map short abbreviations to long full names #
+   month_text="$(echo "$month_text" | tr [A-Z] [a-z])"
+   month_map1="jan:January feb:February mar:March apr:April may:May jun:June jul:July aug:August sep:September oct:October nov:November dec:December"


Ahhh, yes I see, this is smart, having a map1 and map2, one for each depending what is used. (short form or number)

ExtremeFiretop · 2024-02-23T03:13:33Z

MerlinAU.sh

+   then
+       # Special handling for "day of the week" to map short abbreviations to long full names #
+       day_of_week_text="$(echo "$day_of_week_text" | tr [A-Z] [a-z])"
+       dow_map1="sun:Sunday mon:Monday tue:Tuesday wed:Wednesday thu:Thursday fri:Friday sat:Saturday"


Again, this is smart, I see what you mean by exhaustive lol

ExtremeFiretop · 2024-02-23T03:14:17Z

MerlinAU.sh

+readonly FW_Update_CRON_DefaultSchedule="0 0 * * Sun"
+
+readonly CRON_MINS_RegEx="([*0-9]|[1-5][0-9])([\/,-]([0-9]|[1-5][0-9]))*"
+readonly CRON_HOUR_RegEx="([*0-9]|1[0-9]|2[0-3])([\/,-]([0-9]|1[0-9]|2[0-3]))*"


Approved the newly added regular expressions

ExtremeFiretop · 2024-02-23T03:15:56Z

MerlinAU.sh

+##-------------------------------------##
+## Added by Martinski W. [2024-Feb-22] ##
+##-------------------------------------##
+_ValidateCronJobSchedule_()


I see, so basically every input now is validated against these new regular expressions.
This addition really enhances the robustness of the cron section of the script by preventing incorrect cron schedule entries :) I like it!

ExtremeFiretop · 2024-02-23T03:16:16Z

MerlinAU.sh

+
 readonly CRON_DAYofWEEK_NAMES="(Sun|Mon|Tue|Wed|Thu|Fri|Sat)"
-readonly CRON_DAYofWEEK_RegEx="$CRON_DAYofWEEK_NAMES([\/,-]$CRON_DAYofWEEK_NAMES)*|[0-6*]([\/,-][0-6])*"
+readonly CRON_DAYofWEEK_RegEx="$CRON_DAYofWEEK_NAMES([\/,-]$CRON_DAYofWEEK_NAMES)*|[*0-6]([\/,-][0-6])*"


Approved the newly added regular expressions

ExtremeFiretop · 2024-02-23T03:16:54Z

Okay all changes understood and approved so far!. Running some tests now against the changes!

ExtremeFiretop · 2024-02-23T03:18:28Z

MerlinAU.sh

+       printf "${REDct}INVALID cron schedule string [$1]. Incorrect number of parameters.${NOct}\n"
+       return 1
+   fi
+   cronSchedsStr="$(echo "$1" | awk -F ' ' '{print $1}')"


exhaustive validation alright lol!

exhaustive validation alright lol!

Well, it's not quite an exhaustive check & validation; it's more like a syntax parser validator so it will flag the most common user errors WRT syntax, but a user can still set a "syntactically correct" schedule that it will not work like:

10 3 31 2 0
10 3 31 Feb Sun

The above entries are obviously wrong and will never actually work. Adding checks & validation for semantic errors is much more complicated and would require dozens of small functions for each possible case. Not something I'm willing to spend time on just for this one user input. My take is that users should make some effort to learn how to set a semantically valid cron schedule and take responsibility for making such errors.

ExtremeFiretop · 2024-02-23T03:29:13Z

So far all the tests pass perfect!

Here is a complete list of valid crons I've tested to try and break the validation without success:

0 0 1 1 * 
0 0 1 Jan *
0 0 1 * Sun
*/5 0 29 Feb *
0 22 * * Fri
59 23 31 Dec *
0 0 * * */2
0 4 1 Jan,Feb,Mar * 
15,30,45 * 10 * Mon-Fri

A small list of some invalid crons below I tried to use to trick the validation without success:

0 12 25 Dec ? 
0 0 L * *
0 0 * * 5L
0 0 * * 3#2
* * * * Jan-Feb
* 60 0 * * *
* 24:00 * * * *
* * 25 * * *
* 0 0 -1 * *
* 0 0 * 13 *
* */61 * * * *
* 1-60 * * * *
* 0 0 32 * *
* * 0 0 * * sun-mon
* * * * * Jan-Feb

Martinski4GitHub · 2024-02-23T03:44:39Z

So far all the tests pass perfect!

Here is a complete list of valid crons I've tested to try and break the validation without success::
0 0 1 1 * 
0 0 1 Jan *
0 0 1 * Sun
*/5 0 29 Feb *
0 22 * * Fri
59 23 31 Dec *
0 0 * * */2
0 4 1 Jan,Feb,Mar * 
15,30,45 * 10 * Mon-Fri
A small list of some invalid crons below I tried to use to trick the validation without success:
0 12 25 Dec ? 
0 0 L * *
0 0 * * 5L
0 0 * * 3#2
* * * * Jan-Feb
* 60 0 * * *
* 24:00 * * * *
* * 25 * * *
* 0 0 -1 * *
* 0 0 * 13 *
* */61 * * * *
* 1-60 * * * *
* 0 0 32 * *
* * 0 0 * * sun-mon
* * * * * Jan-Feb

Excellent!! I went through a similar long list of valid & invalid entries to verify functionality and my final test results went perfectly well. Thank you for testing & verifying the code.

Martinski4GitHub · 2024-02-23T03:57:11Z

OK, I'm being summoned by a "higher power." :>) Be back in 30 or so...

ExtremeFiretop · 2024-02-23T04:08:39Z

OK, I'm being summoned by a "higher power." :>) Be back in 30 or so...

Enjoy dinner!
Your right on the crons, Idk what I was thinking, I thought it was case sensitive but it clearly isn't when you do a cru l in the system :) (That's embarrassing!)

Ready to release when your back!

Martinski4GitHub added 2 commits February 22, 2024 18:50

Merge branch 'ExtremeFiretop:dev' into dev

58d2457

Martinski4GitHub requested a review from ExtremeFiretop as a code owner February 23, 2024 02:57

ExtremeFiretop assigned ExtremeFiretop and Martinski4GitHub Feb 23, 2024

ExtremeFiretop added the enhancement New feature or request label Feb 23, 2024

ExtremeFiretop reviewed Feb 23, 2024

View reviewed changes

ExtremeFiretop merged commit 711c05f into ExtremeFiretop:dev Feb 23, 2024

ExtremeFiretop mentioned this pull request Feb 23, 2024

Dev 1.0.5 Targeted as Next Stable Release #141

Merged

Repository owner deleted a comment from Martinski4GitHub Feb 23, 2024

Conversation

Martinski4GitHub commented Feb 23, 2024

Uh oh!

Martinski4GitHub commented Feb 23, 2024

Uh oh!

ExtremeFiretop commented Feb 23, 2024

Uh oh!

Martinski4GitHub commented Feb 23, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ExtremeFiretop commented Feb 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ExtremeFiretop commented Feb 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Martinski4GitHub commented Feb 23, 2024

Uh oh!

Martinski4GitHub commented Feb 23, 2024

Uh oh!

ExtremeFiretop commented Feb 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ExtremeFiretop commented Feb 23, 2024 •

edited

Loading

ExtremeFiretop commented Feb 23, 2024 •

edited

Loading

ExtremeFiretop commented Feb 23, 2024 •

edited

Loading