feat(cron): upgrade cron

Signed-off-by: liyinan <[email protected]>

Author: liyinan

Changelog.md

@@ -24,6 +24,7 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
    different compressors/decompressors when backing up or restoring.
  * Add support for MySQL version 8.0
  * Add `go modules` cache
+ * Support cron timezone
 ### Changed
  * Only add `binlog-space-limit` for `percona` image
  * Make user-defined InitContainer take the precedence

go.mod

@@ -13,9 +13,9 @@ require (
 	github.com/onsi/ginkgo v1.16.4
 	github.com/onsi/gomega v1.13.0
 	github.com/presslabs/controller-util v0.3.0
+	github.com/robfig/cron/v3 v3.0.1
 	github.com/spf13/cobra v1.1.1
 	github.com/spf13/pflag v1.0.5
-	github.com/wgliang/cron v0.0.0-20180129105837-79834306f643
 	golang.org/x/net v0.0.0-20210428140749-89ef3d95e781
 	gopkg.in/ini.v1 v1.57.0 // indirect
 

go.sum

@@ -363,6 +363,8 @@ github.com/prometheus/procfs v0.2.0/go.mod h1:lV6e/gmhEcM9IjHGsFOCxxuZ+z1YqCvr4O
 github.com/prometheus/procfs v0.6.0 h1:mxy4L2jP6qMonqmq+aTtOx1ifVWUgG/TAmntgbh3xv4=
 github.com/prometheus/procfs v0.6.0/go.mod h1:cz+aTbrPOrUb4q7XlbU9ygM+/jj0fzG6c1xBZuNvfVA=
 github.com/prometheus/tsdb v0.7.1/go.mod h1:qhTCs0VvXwvX/y3TZrWD7rabWM+ijKTux40TwIPHuXU=
+github.com/robfig/cron/v3 v3.0.1 h1:WdRxkvbJztn8LMz/QEvLN5sBU+xKpSqwwUO1Pjr4qDs=
+github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro=
 github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg=
 github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
 github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
@@ -407,8 +409,6 @@ github.com/subosito/gotenv v1.2.0/go.mod h1:N0PQaV/YGNqwC0u51sEeR/aUtSLEXKX9iv69
 github.com/tmc/grpc-websocket-proxy v0.0.0-20170815181823-89b8d40f7ca8/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U=
 github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U=
 github.com/urfave/cli v1.20.0/go.mod h1:70zkFmudgCuE/ngEzBv17Jvp/497gISqfk5gWijbERA=
-github.com/wgliang/cron v0.0.0-20180129105837-79834306f643 h1:1fftKBnwgZ+quDW84aOBX0WY1/AivOUlimBSt5XKtKY=
-github.com/wgliang/cron v0.0.0-20180129105837-79834306f643/go.mod h1:8vrxYe6J+ZIHJViXE2UhdSbbu3VWHGxLo+QzdqeGDvM=
 github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2/go.mod h1:UETIi67q53MR2AWcXfiuqkDkRtnGDLqkBTpCHuJHxtU=
 github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=

pkg/controller/mysqlbackupcron/mysqlbackupcron_controller.go

@@ -22,7 +22,7 @@ import (
 	"reflect"
 	"sync"
 
-	"github.com/wgliang/cron"
+	cron "github.com/robfig/cron/v3"
 	"k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
@@ -43,18 +43,25 @@ const (
 	controllerName = "mysqlbackupcron-controller"
 )
 
-var log = logf.Log.WithName(controllerName)
+var (
+	log           = logf.Log.WithName(controllerName)
+	defaultParser = cron.NewParser(
+		cron.Second | cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.DowOptional | cron.Descriptor,
+	)
+)
 
 // Add creates a new MysqlBackup Controller and adds it to the Manager with default RBAC. The Manager will set fields on the Controller
 // and Start it when the Manager is Started.
 func Add(mgr manager.Manager) error {
 	sscron := startStopCron{
 		Cron: cron.New(),
 	}
+
 	err := mgr.Add(sscron)
 	if err != nil {
 		return err
 	}
+
 	return add(mgr, newReconciler(mgr, sscron.Cron))
 }
 
@@ -131,7 +138,7 @@ func (r *ReconcileMysqlBackup) Reconcile(ctx context.Context, request reconcile.
 		return reconcile.Result{}, nil
 	}
 
-	schedule, err := cron.Parse(cluster.Spec.BackupSchedule)
+	schedule, err := defaultParser.Parse(cluster.Spec.BackupSchedule)
 	if err != nil {
 		return reconcile.Result{}, fmt.Errorf("failed to parse schedule: %s", err)
 	}
@@ -149,16 +156,16 @@ func (r *ReconcileMysqlBackup) updateClusterSchedule(cluster *mysqlv1alpha1.Mysq
 	for _, entry := range r.cron.Entries() {
 		j, ok := entry.Job.(*job)
 		if ok && j.ClusterName == cluster.Name && j.Namespace == cluster.Namespace {
+
 			log.V(1).Info("cluster already added to cron.", "key", cluster)
 
 			// change scheduler for already added crons
 			if !reflect.DeepEqual(entry.Schedule, schedule) {
 				log.Info("update cluster scheduler", "key", cluster,
 					"scheduler", cluster.Spec.BackupSchedule)
 
-				if err := r.cron.Remove(cluster.Name); err != nil {
-					return err
-				}
+				r.cron.Remove(entry.ID)
+
 				break
 			}
 
@@ -169,9 +176,8 @@ func (r *ReconcileMysqlBackup) updateClusterSchedule(cluster *mysqlv1alpha1.Mysq
 					newValFmt = fmt.Sprintf("%d", cluster.Spec.BackupScheduleJobsHistoryLimit)
 				}
 				log.Info("update cluster backup limit", "key", cluster, "limit_val", newValFmt)
-				if err := r.cron.Remove(cluster.Name); err != nil {
-					return err
-				}
+				r.cron.Remove(entry.ID)
+
 				break
 
 			}
@@ -187,7 +193,7 @@ func (r *ReconcileMysqlBackup) updateClusterSchedule(cluster *mysqlv1alpha1.Mysq
 		c:                              r.Client,
 		BackupScheduleJobsHistoryLimit: cluster.Spec.BackupScheduleJobsHistoryLimit,
 		BackupRemoteDeletePolicy:       cluster.Spec.BackupRemoteDeletePolicy,
-	}, cluster.Name)
+	})
 
 	return nil
 }
@@ -196,8 +202,11 @@ func (r *ReconcileMysqlBackup) unregisterCluster(clusterKey types.NamespacedName
 	r.lockJobRegister.Lock()
 	defer r.lockJobRegister.Unlock()
 
-	if err := r.cron.Remove(clusterKey.Name); err != nil {
-		return err
+	for _, entry := range r.cron.Entries() {
+		j, ok := entry.Job.(*job)
+		if ok && j.ClusterName == clusterKey.Name && j.Namespace == clusterKey.Namespace {
+			r.cron.Remove(entry.ID)
+		}
 	}
 
 	return nil
@@ -209,6 +218,7 @@ func addBackupFieldIndexers(mgr manager.Manager) error {
 		if b.(*mysqlv1alpha1.MysqlBackup).Status.Completed {
 			completed = "true"
 		}
+
 		return []string{completed}
 	})
 }

pkg/controller/mysqlbackupcron/mysqlbackupcron_controller_test.go

@@ -27,7 +27,7 @@ import (
 	. "github.com/onsi/gomega/gstruct"
 	gomegatypes "github.com/onsi/gomega/types"
 
-	cronpkg "github.com/wgliang/cron"
+	cronpkg "github.com/robfig/cron/v3"
 	"golang.org/x/net/context"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/labels"
@@ -50,7 +50,10 @@ var _ = Describe("MysqlBackupCron controller", func() {
 		// cron job
 		cron *cronpkg.Cron
 
-		ctxCancel func()
+		ctxCancel     func()
+		defaultParser = cronpkg.NewParser(
+			cronpkg.Second | cronpkg.Minute | cronpkg.Hour | cronpkg.Dom | cronpkg.Month | cronpkg.DowOptional | cronpkg.Descriptor,
+		)
 	)
 
 	BeforeEach(func() {
@@ -107,7 +110,7 @@ var _ = Describe("MysqlBackupCron controller", func() {
 			},
 		}
 
-		schedule, err = cronpkg.Parse(cluster.Spec.BackupSchedule)
+		schedule, err = defaultParser.Parse(cluster.Spec.BackupSchedule)
 		Expect(err).To(Succeed())
 	})
 
@@ -142,7 +145,7 @@ var _ = Describe("MysqlBackupCron controller", func() {
 		It("should update cluster backup schedule", func() {
 			// update cluster scheduler
 			cluster.Spec.BackupSchedule = "0 0 0 * * *"
-			newSchedule, _ := cronpkg.Parse(cluster.Spec.BackupSchedule)
+			newSchedule, _ := defaultParser.Parse(cluster.Spec.BackupSchedule)
 			Expect(c.Update(context.TODO(), cluster)).To(Succeed())
 
 			// expect an reconcile event
@@ -176,12 +179,12 @@ var _ = Describe("MysqlBackupCron controller", func() {
 			Eventually(requests, timeout).Should(Receive(Equal(expectedRequest)))
 
 			// check cron entry to have a single entry
-			Expect(cron.Entries()).To(ContainElement(PointTo(MatchFields(IgnoreExtras, Fields{
+			Expect(cron.Entries()).To(ContainElement(MatchFields(IgnoreExtras, Fields{
 				"Job": PointTo(MatchFields(IgnoreExtras, Fields{
 					"ClusterName":                    Equal(cluster.Name),
 					"BackupScheduleJobsHistoryLimit": PointTo(Equal(limit)),
 				})),
-			}))))
+			})))
 		})
 
 		When("backup is executed once per second", func() {
@@ -221,10 +224,10 @@ var _ = Describe("MysqlBackupCron controller", func() {
 })
 
 func haveCronJob(name string, sched cronpkg.Schedule) gomegatypes.GomegaMatcher {
-	return ContainElement(PointTo(MatchFields(IgnoreExtras, Fields{
+	return ContainElement(MatchFields(IgnoreExtras, Fields{
 		"Job": PointTo(MatchFields(IgnoreExtras, Fields{
 			"ClusterName": Equal(name),
 		})),
 		"Schedule": Equal(sched),
-	})))
+	}))
 }