feat: add ability to set maintenance mode for all cron tasks running for an app

Closes #6953

plugins/cron/Makefile

@@ -1,5 +1,5 @@
 SUBCOMMANDS = subcommands/list subcommands/report subcommands/run subcommands/set
-TRIGGERS = triggers/cron-get-property
+TRIGGERS = triggers/cron-get-property triggers/install triggers/post-app-clone-setup triggers/post-app-rename-setup triggers/post-delete triggers/scheduler-stop
 BUILD = commands subcommands triggers
 PLUGIN_NAME = cron
 

plugins/cron/cron.go

@@ -12,14 +12,16 @@ import (
 var (
 	// DefaultProperties is a map of all valid cron properties with corresponding default property values
 	DefaultProperties = map[string]string{
-		"mailfrom": "",
-		"mailto":   "",
+		"mailfrom":    "",
+		"mailto":      "",
+		"maintenance": "false",
 	}
 
 	// GlobalProperties is a map of all valid global cron properties
 	GlobalProperties = map[string]bool{
-		"mailfrom": true,
-		"mailto":   true,
+		"mailfrom":    true,
+		"mailto":      true,
+		"maintenance": true,
 	}
 )
 
@@ -59,6 +61,10 @@ func (t TemplateCommand) CronCommand() string {
 // FetchCronEntries returns a list of cron commands for a given app
 func FetchCronEntries(appName string) ([]TemplateCommand, error) {
 	commands := []TemplateCommand{}
+	if reportComputedMaintenance(appName) == "true" {
+		return commands, nil
+	}
+
 	appJSON, err := appjson.GetAppJSON(appName)
 	if err != nil {
 		return commands, fmt.Errorf("Unable to fetch app.json for app %s: %s", appName, err.Error())

plugins/cron/report.go

@@ -13,9 +13,12 @@ func ReportSingleApp(appName string, format string, infoFlag string) error {
 	}
 
 	flags := map[string]common.ReportFunc{
-		"--cron-mailfrom":   reportMailfrom,
-		"--cron-mailto":     reportMailto,
-		"--cron-task-count": reportTasks,
+		"--cron-mailfrom":             reportMailfrom,
+		"--cron-mailto":               reportMailto,
+		"--cron-task-count":           reportTasks,
+		"--cron-global-maintenance":   reportGlobalMaintenance,
+		"--cron-computed-maintenance": reportComputedMaintenance,
+		"--cron-maintenance":          reportMaintenance,
 	}
 
 	flagKeys := []string{}
@@ -41,3 +44,20 @@ func reportTasks(appName string) string {
 	c, _ := FetchCronEntries(appName)
 	return strconv.Itoa(len(c))
 }
+
+func reportGlobalMaintenance(_ string) string {
+	return common.PropertyGet("cron", "--global", "maintenance")
+}
+
+func reportComputedMaintenance(appName string) string {
+	maintenance := common.PropertyGet("cron", appName, "maintenance")
+	if maintenance == "true" {
+		return "true"
+	}
+
+	return common.PropertyGetDefault("cron", "--global", "maintenance", DefaultProperties["maintenance"])
+}
+
+func reportMaintenance(appName string) string {
+	return common.PropertyGet("cron", appName, "maintenance")
+}

plugins/cron/src/triggers/triggers.go

@@ -43,6 +43,11 @@ func main() {
 	case "report":
 		appName := flag.Arg(0)
 		err = cron.ReportSingleApp(appName, "", "")
+	case "scheduler-stop":
+		scheduler := flag.Arg(0)
+		appName := flag.Arg(1)
+		removeContainers := flag.Arg(2)
+		err = cron.TriggerSchedulerStop(scheduler, appName, removeContainers)
 	default:
 		err = fmt.Errorf("Invalid plugin trigger call: %s", trigger)
 	}

plugins/cron/triggers.go

@@ -10,14 +10,16 @@ import (
 // TriggerCronGetProperty writes the cron key to stdout for a given app container
 func TriggerCronGetProperty(appName string, key string) error {
 	validProperties := map[string]bool{
-		"mailfrom": true,
-		"mailto":   true,
+		"mailfrom":    true,
+		"mailto":      true,
+		"maintenance": true,
 	}
 	if !validProperties[key] {
 		return errors.New("Invalid cron property specified")
 	}
 
-	fmt.Println(common.PropertyGet("cron", appName, key))
+	value := common.PropertyGetDefault("cron", appName, key, DefaultProperties[key])
+	fmt.Println(value)
 	return nil
 }
 
@@ -57,3 +59,12 @@ func TriggerPostAppRenameSetup(oldAppName string, newAppName string) error {
 func TriggerPostDelete(appName string) error {
 	return common.PropertyDestroy("cron", appName)
 }
+
+// TriggerSchedulerStop stops the scheduler for a given app container
+func TriggerSchedulerStop(scheduler string, appName string, removeContainers string) error {
+	if scheduler != "docker-local" {
+		return nil
+	}
+
+	return nil
+}