feat: add crontab package for supporting autostart/stop. (#844)

* feat: add crontab package for supporting autostart/stop. This is basically a small wrapper around robfig/cron/v3. Fixes #817. * fixup! feat: add crontab package for supporting autostart/stop. This is basically a small wrapper around robfig/cron/v3. * fixup! feat: add crontab package for supporting autostart/stop. This is basically a small wrapper around robfig/cron/v3. * fixup! fixup! feat: add crontab package for supporting autostart/stop. This is basically a small wrapper around robfig/cron/v3. * fix: return struct instead of interface * remove unnecessary interface and export struct * fix: doc comments * rename package to autostart/schedule * address PR comments
2025-07-09 11:45:56 +00:00 · 2022-04-04 21:34:11 +01:00
parent b621c59a03
commit 8a1ae18ede
4 changed files with 136 additions and 0 deletions
--- a/coderd/autostart/schedule/crontab_test.go
+++ b/coderd/autostart/schedule/crontab_test.go
@ -0,0 +1,67 @@
+package schedule_test
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/coder/coder/coderd/autostart/schedule"
+)
+
+func Test_Weekly(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 := schedule.Weekly(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)
+			}
+		})
+	}
+}