feat: add crontab package for supporting autostart/stop. #844
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| // package crontab provides utilities for parsing and deserializing | ||
| // cron-style expressions. | ||
| package crontab | ||
|
|
||
| import ( | ||
| "time" | ||
|
|
||
| "github.com/robfig/cron/v3" | ||
| "golang.org/x/xerrors" | ||
| ) | ||
|
|
||
| // For the purposes of this library, we only need minute, hour, and | ||
| //day-of-week. | ||
| const parserFormat = cron.Minute | cron.Hour | cron.Dow | ||
|
|
||
| var defaultParser = cron.NewParser(parserFormat) | ||
johnstcn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // Parse parses a WeeklySchedule from spec. | ||
| // | ||
| // Example Usage: | ||
| // local_sched, _ := cron.Parse("59 23 *") | ||
| // fmt.Println(sched.Next(time.Now().Format(time.RFC3339))) | ||
| // // Output: 2022-04-04T23:59:00Z | ||
| // us_sched, _ := cron.Parse("CRON_TZ=US/Central 30 9 1-5") | ||
| // fmt.Println(sched.Next(time.Now()).Format(time.RFC3339)) | ||
| // // Output: 2022-04-04T14:30:00Z | ||
| func Parse(spec string) (*WeeklySchedule, error) { | ||
johnstcn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| specSched, err := defaultParser.Parse(spec) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("parse schedule: %w", err) | ||
| } | ||
|
|
||
| schedule, ok := specSched.(*cron.SpecSchedule) | ||
| if !ok { | ||
| return nil, xerrors.Errorf("expected *cron.SpecSchedule but got %T", specSched) | ||
| } | ||
|
|
||
| cronSched := &WeeklySchedule{ | ||
| sched: schedule, | ||
| spec: spec, | ||
| } | ||
| return cronSched, nil | ||
| } | ||
|
|
||
| // WeeklySchedule represents a weekly cron schedule. | ||
| // It's essentially a thin wrapper for robfig/cron/v3 that implements Stringer. | ||
| type WeeklySchedule struct { | ||
|
There was a problem hiding this comment. This weekly schedule feels pretty specified to autostart/stop. Could we add this to the autostart/stop package once that's in (assuming it'll be inside it's own package)? There was a problem hiding this comment. Also, I'm not sure this needs to have There was a problem hiding this comment. I can move this to There was a problem hiding this comment. Based on what's here, I'd say that makes sense. I'm uncertain what structurally makes sense until we have more of the implementation worked out, but as long as we're not opposed to moving this afterwards, I'm good with it! |
||
| sched *cron.SpecSchedule | ||
| // XXX: there isn't any nice way for robfig/cron to serialize | ||
| spec string | ||
| } | ||
|
|
||
| // String serializes the schedule to its original human-friendly format. | ||
| func (s WeeklySchedule) String() string { | ||
| return s.spec | ||
| } | ||
|
|
||
| // Next returns the next time in the schedule relative to t. | ||
| func (s WeeklySchedule) Next(t time.Time) time.Time { | ||
| return s.sched.Next(t) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| package crontab_test | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/coder/coder/coderd/crontab" | ||
| ) | ||
|
|
||
| func Test_Parse(t *testing.T) { | ||
| t.Parallel() | ||
| testCases := []struct { | ||
| name string | ||
| spec string | ||
| at time.Time | ||
| expectedNext time.Time | ||
| expectedError string | ||
| }{ | ||
| { | ||
| name: "with timezone", | ||
| spec: "CRON_TZ=US/Central 30 9 1-5", | ||
| at: time.Date(2022, 4, 1, 14, 29, 0, 0, time.UTC), | ||
| expectedNext: time.Date(2022, 4, 1, 14, 30, 0, 0, time.UTC), | ||
| expectedError: "", | ||
| }, | ||
| { | ||
| name: "without timezone", | ||
| spec: "30 9 1-5", | ||
| at: time.Date(2022, 4, 1, 9, 29, 0, 0, time.Local), | ||
| expectedNext: time.Date(2022, 4, 1, 9, 30, 0, 0, time.Local), | ||
| expectedError: "", | ||
| }, | ||
| { | ||
| name: "invalid schedule", | ||
| spec: "asdfasdfasdfsd", | ||
| at: time.Time{}, | ||
| expectedNext: time.Time{}, | ||
| expectedError: "parse schedule: expected exactly 3 fields, found 1: [asdfasdfasdfsd]", | ||
| }, | ||
| { | ||
| name: "invalid location", | ||
| spec: "CRON_TZ=Fictional/Country 30 9 1-5", | ||
| at: time.Time{}, | ||
| expectedNext: time.Time{}, | ||
| expectedError: "parse schedule: provided bad location Fictional/Country: unknown time zone Fictional/Country", | ||
| }, | ||
| } | ||
|
|
||
| for _, testCase := range testCases { | ||
| testCase := testCase | ||
| t.Run(testCase.name, func(t *testing.T) { | ||
| t.Parallel() | ||
| actual, err := crontab.Parse(testCase.spec) | ||
| if testCase.expectedError == "" { | ||
| nextTime := actual.Next(testCase.at) | ||
| require.NoError(t, err) | ||
| require.Equal(t, testCase.expectedNext, nextTime) | ||
| require.Equal(t, testCase.spec, actual.String()) | ||
| } else { | ||
| require.EqualError(t, err, testCase.expectedError) | ||
| require.Nil(t, actual) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.