Merge pull request #212 from ninech/sched

add scheduled jobs

Author: gajicdev

create/application.go

@@ -45,6 +45,7 @@ type applicationCmd struct {
 	BuildEnv                 map[string]string `help:"Environment variables which are passed to the app build process."`
 	DeployJob                deployJob         `embed:"" prefix:"deploy-job-"`
 	WorkerJob                workerJob         `embed:"" prefix:"worker-job-"`
+	ScheduledJob             scheduledJob      `embed:"" prefix:"scheduled-job-"`
 	GitInformationServiceURL string            `help:"URL of the git information service." default:"https://git-info.deplo.io" env:"GIT_INFORMATION_SERVICE_URL" hidden:""`
 	SkipRepoAccessCheck      bool              `help:"Skip the git repository access check" default:"false"`
 	Debug                    bool              `help:"Enable debug messages" default:"false"`
@@ -75,6 +76,13 @@ type workerJob struct {
 	Size    *string `help:"Size of the worker (defaults to \"${app_default_size}\")." placeholder:"${app_default_size}"`
 }
 
+type scheduledJob struct {
+	Command  string  `help:"Command to execute to start the scheduled job." placeholder:"\"bundle exec rails runner\""`
+	Name     string  `help:"Name of the scheduled job job to add." placeholder:"scheduled-1"`
+	Size     *string `help:"Size (resources) of the scheduled job (defaults to \"${app_default_size}\")." placeholder:"${app_default_size}"`
+	Schedule string  `help:"Cron notation string for the scheduled job (defaults to \"* * * * *\")." placeholder:"* * * * *"`
+}
+
 type dockerfileBuild struct {
 	Enabled      bool   `name:"dockerfile" help:"${app_dockerfile_enable_help}" default:"false"`
 	Path         string `name:"dockerfile-path" help:"${app_dockerfile_path_help}" default:""`
@@ -298,6 +306,20 @@ func (app *applicationCmd) config() apps.Config {
 		config.WorkerJobs = append(config.WorkerJobs, workerJob)
 	}
 
+	if len(app.ScheduledJob.Command) != 0 && len(app.ScheduledJob.Name) != 0 && len(app.ScheduledJob.Schedule) != 0 {
+		scheduledJob := apps.ScheduledJob{
+			Job: apps.Job{
+				Name:    app.ScheduledJob.Name,
+				Command: app.ScheduledJob.Command,
+			},
+			Schedule: app.ScheduledJob.Schedule,
+		}
+		if app.ScheduledJob.Size != nil {
+			scheduledJob.Size = ptr.To(apps.ApplicationSize(*app.ScheduledJob.Size))
+		}
+		config.ScheduledJobs = append(config.ScheduledJobs, scheduledJob)
+	}
+
 	if app.Size != nil {
 		config.Size = apps.ApplicationSize(*app.Size)
 	}

create/mysql_test.go

@@ -3,7 +3,6 @@ package create
 import (
 	"context"
 	"errors"
-	"reflect"
 	"testing"
 	"time"
 
@@ -114,17 +113,7 @@ func TestMySQL(t *testing.T) {
 				return
 			}
 
-			// we set defaults for the slices
-			if tt.want.AllowedCIDRs == nil {
-				tt.want.AllowedCIDRs = []meta.IPv4CIDR{}
-			}
-			if tt.want.SSHKeys == nil {
-				tt.want.SSHKeys = []storage.SSHKey{}
-			}
-
-			if !reflect.DeepEqual(created.Spec.ForProvider, tt.want) {
-				t.Fatalf("expected mysql.Spec.ForProvider = %+v, got: %+v", created.Spec.ForProvider, tt.want)
-			}
+			require.Equal(t, tt.want, created.Spec.ForProvider)
 		})
 	}
 }

create/postgres_test.go

@@ -3,7 +3,6 @@ package create
 import (
 	"context"
 	"errors"
-	"reflect"
 	"testing"
 	"time"
 
@@ -94,17 +93,7 @@ func TestPostgres(t *testing.T) {
 				return
 			}
 
-			// we set defaults for the slices
-			if tt.want.AllowedCIDRs == nil {
-				tt.want.AllowedCIDRs = []meta.IPv4CIDR{}
-			}
-			if tt.want.SSHKeys == nil {
-				tt.want.SSHKeys = []storage.SSHKey{}
-			}
-
-			if !reflect.DeepEqual(created.Spec.ForProvider, tt.want) {
-				t.Fatalf("expected postgres.Spec.ForProvider = %+v, got: %+v", created.Spec.ForProvider, tt.want)
-			}
+			require.Equal(t, tt.want, created.Spec.ForProvider)
 		})
 	}
 }

get/application.go

@@ -83,7 +83,7 @@ func printApplication(apps []apps.Application, get *Cmd, out io.Writer, header b
 	w := tabwriter.NewWriter(out, 0, 0, 4, ' ', 0)
 
 	if header {
-		get.writeHeader(w, "NAME", "REPLICAS", "WORKERJOBS", "HOSTS", "UNVERIFIEDHOSTS")
+		get.writeHeader(w, "NAME", "REPLICAS", "WORKERJOBS", "SCHEDULEDJOBS", "HOSTS", "UNVERIFIEDHOSTS")
 	}
 
 	for _, app := range apps {
@@ -94,8 +94,9 @@ func printApplication(apps []apps.Application, get *Cmd, out io.Writer, header b
 			replicas = int(*app.Status.AtProvider.Replicas)
 		}
 		workerJobs := fmt.Sprintf("%d", len(app.Status.AtProvider.WorkerJobs))
+		scheduledJobs := fmt.Sprintf("%d", len(app.Status.AtProvider.ScheduledJobs))
 
-		get.writeTabRow(w, app.Namespace, app.Name, fmt.Sprintf("%d", replicas), workerJobs, join(verifiedHosts), join(unverifiedHosts))
+		get.writeTabRow(w, app.Namespace, app.Name, fmt.Sprintf("%d", replicas), workerJobs, scheduledJobs, join(verifiedHosts), join(unverifiedHosts))
 	}
 
 	return w.Flush()
@@ -214,6 +215,10 @@ func (cmd *applicationsCmd) printStats(ctx context.Context, c *api.Client, appLi
 			workers = append(workers, wjs.ReplicaObservation...)
 		}
 
+		for _, sjs := range rel.Status.AtProvider.ScheduledJobStatus {
+			workers = append(workers, sjs.ReplicaObservation...)
+		}
+
 		for _, replica := range append(replicas, workers...) {
 			podMetrics := metricsv1beta1.PodMetrics{}
 			if err := runtimeClient.Get(ctx, api.NamespacedName(replica.ReplicaName, app.Namespace), &podMetrics); err != nil {

get/releases.go

@@ -64,6 +64,7 @@ func (cmd *releasesCmd) printReleases(releases []apps.Release, get *Cmd, header
 			"SIZE",
 			"REPLICAS",
 			"WORKERJOBS",
+			"SCHEDULEDJOBS",
 			"STATUS",
 			"AGE",
 		)
@@ -78,6 +79,7 @@ func (cmd *releasesCmd) printReleases(releases []apps.Release, get *Cmd, header
 			replicas = strconv.Itoa(int(*r.Spec.ForProvider.Config.Replicas))
 		}
 		workerJobs := strconv.Itoa(len(r.Spec.ForProvider.Config.WorkerJobs))
+		scheduledJobs := strconv.Itoa(len(r.Spec.ForProvider.Config.ScheduledJobs))
 
 		get.writeTabRow(
 			w,
@@ -88,6 +90,7 @@ func (cmd *releasesCmd) printReleases(releases []apps.Release, get *Cmd, header
 			string(r.Spec.ForProvider.Config.Size),
 			replicas,
 			workerJobs,
+			scheduledJobs,
 			string(r.Status.AtProvider.ReleaseStatus),
 			duration.HumanDuration(time.Since(r.ObjectMeta.CreationTimestamp.Time)),
 		)

go.mod

@@ -26,7 +26,7 @@ require (
 	github.com/mattn/go-isatty v0.0.20
 	github.com/moby/moby v27.1.1+incompatible
 	github.com/moby/term v0.5.0
-	github.com/ninech/apis v0.0.0-20250120083942-90d315ad8c32
+	github.com/ninech/apis v0.0.0-20250304140759-2e6d16e9749f 
 	github.com/posener/complete v1.2.3
 	github.com/prometheus/common v0.55.0
 	github.com/stretchr/testify v1.9.0

go.sum

@@ -597,6 +597,12 @@ github.com/mxk/go-flowrate v0.0.0-20140419014527-cca7078d478f/go.mod h1:ZdcZmHo+
 github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
 github.com/ninech/apis v0.0.0-20250120083942-90d315ad8c32 h1:0XaOKTYVCIVd+oqG+7Km9j2/hVqkB4U7ySyEw15KvF0=
 github.com/ninech/apis v0.0.0-20250120083942-90d315ad8c32/go.mod h1:6srtlYi3nj8GRxQkbhvSbanIBc9vsoPLFOp5VQzNNhM=
+github.com/ninech/apis v0.0.0-20250304140759-2e6d16e9749f h1:3RXpRcPZKkw2rE7TyuFk8e+tWr8Mhl8bZqTDFm0ybWM=
+github.com/ninech/apis v0.0.0-20250304140759-2e6d16e9749f/go.mod h1:6srtlYi3nj8GRxQkbhvSbanIBc9vsoPLFOp5VQzNNhM=
+github.com/ninech/apis v0.0.0-20250304143335-386c5bf8bc63 h1:B8UqsTldPq5j2kLrkOsi++2jd1b5hk/O+yVrlR+AnVY=
+github.com/ninech/apis v0.0.0-20250304143335-386c5bf8bc63/go.mod h1:6srtlYi3nj8GRxQkbhvSbanIBc9vsoPLFOp5VQzNNhM=
+github.com/ninech/apis v0.0.0-20250305125840-3bc1e01edb09 h1:vihjujYXJAgRSa5VQgtpVkWNRcd3DccVbUn6PliMrgQ=
+github.com/ninech/apis v0.0.0-20250305125840-3bc1e01edb09/go.mod h1:6srtlYi3nj8GRxQkbhvSbanIBc9vsoPLFOp5VQzNNhM=
 github.com/nxadm/tail v1.4.8 h1:nPr65rt6Y5JFSKQO7qToXr7pePgD6Gwiw05lkbyAQTE=
 github.com/nxadm/tail v1.4.8/go.mod h1:+ncqLTQzXmGhMZNUePPaPqPvBxHAIsmXswZKocGu+AU=
 github.com/oklog/ulid v1.3.1 h1:EGfNDEx6MqHz8B3uNV6QAib1UR2Lm97sHi3ocA6ESJ4=

logs/application.go

@@ -11,7 +11,7 @@ import (
 type applicationCmd struct {
 	resourceCmd
 	logsCmd
-	Type appLogType `short:"t" help:"Which type of app logs to output. ${enum}" enum:"all,app,build,worker_job,deploy_job" default:"all"`
+	Type appLogType `short:"t" help:"Which type of app logs to output. ${enum}" enum:"all,app,build,worker_job,deploy_job,scheduled_job" default:"all"`
 }
 
 func (cmd *applicationCmd) Run(ctx context.Context, client *api.Client) error {
@@ -26,7 +26,7 @@ func (cmd *applicationCmd) Run(ctx context.Context, client *api.Client) error {
 		cmd.Type.queryExpressions(),
 		inProject(client.Project),
 		queryExpr(opEquals, apps.LogLabelApplication, cmd.Name))...),
-		apps.LogLabelBuild, apps.LogLabelReplica, apps.LogLabelWorkerJob, apps.LogLabelDeployJob,
+		apps.LogLabelBuild, apps.LogLabelReplica, apps.LogLabelWorkerJob, apps.LogLabelDeployJob, apps.LogLabelDeployJob,
 	)
 }
 
@@ -41,11 +41,12 @@ func ApplicationQuery(name, project string) string {
 type appLogType string
 
 const (
-	logTypeAll       appLogType = "all"
-	logTypeApp       appLogType = "app"
-	logTypeBuild     appLogType = "build"
-	logTypeDeployJob appLogType = "deploy_job"
-	logTypeWorkerJob appLogType = "worker_job"
+	logTypeAll          appLogType = "all"
+	logTypeApp          appLogType = "app"
+	logTypeBuild        appLogType = "build"
+	logTypeDeployJob    appLogType = "deploy_job"
+	logTypeWorkerJob    appLogType = "worker_job"
+	logTypeScheduledJob appLogType = "scheduled_job"
 )
 
 func (a appLogType) queryExpressions() []string {
@@ -57,13 +58,16 @@ func (a appLogType) queryExpressions() []string {
 		expr = append(expr,
 			queryExpr(opEquals, apps.LogLabelDeployJob, ""),
 			queryExpr(opEquals, apps.LogLabelWorkerJob, ""),
+			queryExpr(opEquals, apps.LogLabelScheduledJob, ""),
 			queryExpr(opEquals, apps.LogLabelBuild, ""))
 	case logTypeBuild:
 		expr = append(expr, queryExpr(opNotEquals, apps.LogLabelBuild, ""))
 	case logTypeDeployJob:
 		expr = append(expr, queryExpr(opNotEquals, apps.LogLabelDeployJob, ""))
 	case logTypeWorkerJob:
 		expr = append(expr, queryExpr(opNotEquals, apps.LogLabelWorkerJob, ""))
+	case logTypeScheduledJob:
+		expr = append(expr, queryExpr(opNotEquals, apps.LogLabelScheduledJob, ""))
 	}
 	return expr
 }

update/application.go

@@ -37,7 +37,9 @@ type applicationCmd struct {
 	DeleteBuildEnv           *[]string         `help:"Build environment variables which are to be deleted."`
 	DeployJob                *deployJob        `embed:"" prefix:"deploy-job-"`
 	WorkerJob                *workerJob        `embed:"" prefix:"worker-job-"`
+	ScheduledJob             *scheduledJob     `embed:"" prefix:"scheduled-job-"`
 	DeleteWorkerJob          *string           `help:"Delete a worker job by name"`
+	DeleteScheduledJob       *string           `help:"Delete a scheduled job by name"`
 	RetryBuild               *bool             `help:"Retries build for the application if set to true." placeholder:"false"`
 	GitInformationServiceURL string            `help:"URL of the git information service." default:"https://git-info.deplo.io" env:"GIT_INFORMATION_SERVICE_URL" hidden:""`
 	SkipRepoAccessCheck      bool              `help:"Skip the git repository access check" default:"false"`
@@ -91,6 +93,13 @@ type workerJob struct {
 	Size    *string `help:"Size of the worker (defaults to \"${app_default_size}\")." placeholder:"${app_default_size}"`
 }
 
+type scheduledJob struct {
+	Command  *string `help:"Command to execute to start the scheduled job." placeholder:"\"bundle exec rails runner\""`
+	Name     *string `help:"Name of the scheduled job job to add." placeholder:"scheduled-1"`
+	Size     *string `help:"Size (resources) of the scheduled job (defaults to \"${app_default_size}\")." placeholder:"${app_default_size}"`
+	Schedule *string `help:"Cron notation string for the scheduled job (defaults to \"* * * * *\")." placeholder:"* * * * *"`
+}
+
 type dockerfileBuild struct {
 	Path         *string `name:"dockerfile-path" help:"${app_dockerfile_path_help}" placeholder:"."`
 	BuildContext *string `name:"dockerfile-build-context" help:"${app_dockerfile_build_context_help}" placeholder:"."`
@@ -225,6 +234,12 @@ func (cmd *applicationCmd) applyUpdates(app *apps.Application) {
 	if cmd.DeleteWorkerJob != nil {
 		deleteWorkerJob(*cmd.DeleteWorkerJob, &app.Spec.ForProvider.Config)
 	}
+	if cmd.ScheduledJob != nil {
+		cmd.ScheduledJob.applyUpdates(&app.Spec.ForProvider.Config)
+	}
+	if cmd.DeleteScheduledJob != nil {
+		deleteScheduledJob(*cmd.DeleteScheduledJob, &app.Spec.ForProvider.Config)
+	}
 	if cmd.Language != nil {
 		app.Spec.ForProvider.Language = apps.Language(*cmd.Language)
 	}
@@ -297,29 +312,26 @@ func (job workerJob) applyUpdates(cfg *apps.Config) {
 	if job.Name == nil {
 		return
 	}
-	found := false
 	for i := range cfg.WorkerJobs {
 		if cfg.WorkerJobs[i].Name == *job.Name {
-			found = true
 			if job.Command != nil {
 				cfg.WorkerJobs[i].Command = *job.Command
 			}
 			if job.Size != nil {
 				cfg.WorkerJobs[i].Size = ptr.To(apps.ApplicationSize(*job.Size))
 			}
+			return
 		}
 	}
 
-	if !found {
-		newJob := apps.WorkerJob{Job: apps.Job{Name: *job.Name}}
-		if job.Command != nil {
-			newJob.Command = *job.Command
-		}
-		if job.Size != nil {
-			newJob.Size = ptr.To(apps.ApplicationSize(*job.Size))
-		}
-		cfg.WorkerJobs = append(cfg.WorkerJobs, newJob)
+	newJob := apps.WorkerJob{Job: apps.Job{Name: *job.Name}}
+	if job.Command != nil {
+		newJob.Command = *job.Command
 	}
+	if job.Size != nil {
+		newJob.Size = ptr.To(apps.ApplicationSize(*job.Size))
+	}
+	cfg.WorkerJobs = append(cfg.WorkerJobs, newJob)
 }
 
 func deleteWorkerJob(name string, cfg *apps.Config) {
@@ -336,6 +348,51 @@ func deleteWorkerJob(name string, cfg *apps.Config) {
 	cfg.WorkerJobs = newJobs
 }
 
+func (job scheduledJob) applyUpdates(cfg *apps.Config) {
+	if job.Name == nil {
+		format.PrintWarningf("you need to pass a job name to update the command, schedule or size\n")
+		return
+	}
+
+	for i := range cfg.ScheduledJobs {
+		if cfg.ScheduledJobs[i].Name == *job.Name {
+			if job.Command != nil {
+				cfg.ScheduledJobs[i].Command = *job.Command
+			}
+			if job.Size != nil {
+				cfg.ScheduledJobs[i].Size = ptr.To(apps.ApplicationSize(*job.Size))
+			}
+			if job.Schedule != nil {
+				cfg.ScheduledJobs[i].Schedule = *job.Schedule
+			}
+			return
+		}
+	}
+
+	newJob := apps.ScheduledJob{Job: apps.Job{Name: *job.Name}}
+	if job.Command != nil {
+		newJob.Command = *job.Command
+	}
+	if job.Size != nil {
+		newJob.Size = ptr.To(apps.ApplicationSize(*job.Size))
+	}
+	cfg.ScheduledJobs = append(cfg.ScheduledJobs, newJob)
+}
+
+func deleteScheduledJob(name string, cfg *apps.Config) {
+	newJobs := []apps.ScheduledJob{}
+	for _, sj := range cfg.ScheduledJobs {
+		if sj.Name != name {
+			newJobs = append(newJobs, sj)
+		}
+	}
+	if len(cfg.ScheduledJobs) == len(newJobs) {
+		format.PrintWarningf("did not find a scheduled job with the name %q\n", name)
+		return
+	}
+	cfg.ScheduledJobs = newJobs
+}
+
 func warnIfDockerfileNotEnabled(app *apps.Application, flag string) {
 	if !app.Spec.ForProvider.DockerfileBuild.Enabled {
 		format.PrintWarningf("updating %s has no effect as dockerfile builds are not enabled on this app\n", flag)