feat(api): revamp scheduling to introduce system schedules (#2433)

* feat(api): revamp scheduling to introduce system schedules

* fix(api): fix linting issues

* fix(api): fix lint issues

* refactor(api): fix lint issues

api/cron/job_snapshot.go

@@ -0,0 +1,84 @@
+package cron
+
+import (
+	"log"
+
+	"github.com/portainer/portainer"
+)
+
+// SnapshotJobRunner is used to run a SnapshotJob
+type SnapshotJobRunner struct {
+	job     *portainer.SnapshotJob
+	context *SnapshotJobContext
+}
+
+// SnapshotJobContext represents the context of execution of a SnapshotJob
+type SnapshotJobContext struct {
+	endpointService portainer.EndpointService
+	snapshotter     portainer.Snapshotter
+}
+
+// NewSnapshotJobContext returns a new context that can be used to execute a SnapshotJob
+func NewSnapshotJobContext(endpointService portainer.EndpointService, snapshotter portainer.Snapshotter) *SnapshotJobContext {
+	return &SnapshotJobContext{
+		endpointService: endpointService,
+		snapshotter:     snapshotter,
+	}
+}
+
+// NewSnapshotJobRunner returns a new runner that can be scheduled
+func NewSnapshotJobRunner(job *portainer.SnapshotJob, context *SnapshotJobContext) *SnapshotJobRunner {
+	return &SnapshotJobRunner{
+		job:     job,
+		context: context,
+	}
+}
+
+// GetScheduleID returns the schedule identifier associated to the runner
+func (runner *SnapshotJobRunner) GetScheduleID() portainer.ScheduleID {
+	return runner.job.ScheduleID
+}
+
+// SetScheduleID sets the schedule identifier associated to the runner
+func (runner *SnapshotJobRunner) SetScheduleID(ID portainer.ScheduleID) {
+	runner.job.ScheduleID = ID
+}
+
+// GetJobType returns the job type associated to the runner
+func (runner *SnapshotJobRunner) GetJobType() portainer.JobType {
+	return portainer.EndpointSyncJobType
+}
+
+// Run triggers the execution of the job.
+// It will iterate through all the endpoints available in the database to
+// create a snapshot of each one of them.
+func (runner *SnapshotJobRunner) Run() {
+	endpoints, err := runner.context.endpointService.Endpoints()
+	if err != nil {
+		log.Printf("background job error (endpoint snapshot). Unable to retrieve endpoint list (err=%s)\n", err)
+		return
+	}
+
+	for _, endpoint := range endpoints {
+		if endpoint.Type == portainer.AzureEnvironment {
+			continue
+		}
+
+		snapshot, err := runner.context.snapshotter.CreateSnapshot(&endpoint)
+		endpoint.Status = portainer.EndpointStatusUp
+		if err != nil {
+			log.Printf("background job error (endpoint snapshot). Unable to create snapshot (endpoint=%s, URL=%s) (err=%s)\n", endpoint.Name, endpoint.URL, err)
+			endpoint.Status = portainer.EndpointStatusDown
+		}
+
+		if snapshot != nil {
+			endpoint.Snapshots = []portainer.Snapshot{*snapshot}
+		}
+
+		err = runner.context.endpointService.UpdateEndpoint(endpoint.ID, &endpoint)
+		if err != nil {
+			log.Printf("background job error (endpoint snapshot). Unable to update endpoint (endpoint=%s, URL=%s) (err=%s)\n", endpoint.Name, endpoint.URL, err)
+			return
+		}
+	}
+}