Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .nextchanges/bundles/triggers-pause-presets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Apply `presets.trigger_pause_status` and the development mode pause default to `triggers[]` entries on jobs.
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
bundle:
name: test-bundle

resources:
jobs:
job1:
name: job1
triggers:
- schedule:
quartz_cron_expression: "0 0 0 1 1 ? 2099"
timezone_id: UTC
- schedule:
quartz_cron_expression: "0 0 0 2 1 ? 2099"
timezone_id: UTC
pause_status: UNPAUSED

job2:
name: job2
triggers:
- file_arrival:
url: /Volumes/main/default/landing/

presets:
trigger_pause_status: PAUSED
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Cloud = false
EnvMatrix.DMS = ["", "true"]
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"job1": {
"deployment": {
"kind": "BUNDLE",
"metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/metadata.json"
},
"edit_mode": "UI_LOCKED",
"format": "MULTI_TASK",
"max_concurrent_runs": 1,
"name": "job1",
"queue": {
"enabled": true
},
"triggers": [
{
"pause_status": "PAUSED",
"schedule": {
"quartz_cron_expression": "0 0 0 1 1 ? 2099",
"timezone_id": "UTC"
}
},
{
"pause_status": "UNPAUSED",
"schedule": {
"quartz_cron_expression": "0 0 0 2 1 ? 2099",
"timezone_id": "UTC"
}
}
]
},
"job2": {
"deployment": {
"kind": "BUNDLE",
"metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/metadata.json"
},
"edit_mode": "UI_LOCKED",
"format": "MULTI_TASK",
"max_concurrent_runs": 1,
"name": "job2",
"queue": {
"enabled": true
},
"triggers": [
{
"file_arrival": {
"url": "/Volumes/main/default/landing/"
},
"pause_status": "PAUSED"
}
]
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
$CLI bundle validate -o json | jq .resources.jobs
5 changes: 5 additions & 0 deletions bundle/config/mutator/resourcemutator/apply_presets.go
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,11 @@ func (m *applyPresets) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnos
if j.Trigger != nil && j.Trigger.PauseStatus == "" {
j.Trigger.PauseStatus = paused
}
for i := range j.Triggers {
if j.Triggers[i].PauseStatus == "" {
j.Triggers[i].PauseStatus = paused
}
}
}
}

Expand Down
86 changes: 86 additions & 0 deletions bundle/config/mutator/resourcemutator/apply_presets_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"github.com/databricks/cli/bundle/config"
"github.com/databricks/cli/bundle/config/resources"
"github.com/databricks/databricks-sdk-go/service/catalog"
"github.com/databricks/databricks-sdk-go/service/jobs"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down Expand Up @@ -38,3 +39,88 @@ func TestApplyPresetsSkipsNilQualityMonitors(t *testing.T) {
require.NoError(t, diags.Error())
assert.Nil(t, b.Config.Resources.QualityMonitors["monitor"].Schedule)
}

func triggerWithPauseStatus(c jobs.TriggerConfiguration, s jobs.PauseStatus) jobs.TriggerConfiguration {
c.PauseStatus = s
return c
}

func TestApplyPresetsTriggersPauseStatus(t *testing.T) {
cron := jobs.TriggerConfiguration{
Schedule: &jobs.CronTriggerConfiguration{QuartzCronExpression: "0 0 0 1 1 ? 2099", TimezoneId: "UTC"},
}
fileArrival := jobs.TriggerConfiguration{
FileArrival: &jobs.FileArrivalTriggerConfiguration{Url: "/Volumes/main/default/landing/"},
}
tableUpdate := jobs.TriggerConfiguration{
TableUpdate: &jobs.TableUpdateTriggerConfiguration{TableNames: []string{"main.default.src"}},
}
type testCase struct {
preset string
triggers []jobs.TriggerConfiguration
expected []jobs.PauseStatus
}

tests := map[string]testCase{
"paused preset, single omitted": {
preset: config.Paused,
triggers: []jobs.TriggerConfiguration{cron},
expected: []jobs.PauseStatus{jobs.PauseStatusPaused},
},
"paused preset, multiple omitted": {
preset: config.Paused,
triggers: []jobs.TriggerConfiguration{cron, fileArrival, tableUpdate},
expected: []jobs.PauseStatus{jobs.PauseStatusPaused, jobs.PauseStatusPaused, jobs.PauseStatusPaused},
},
"unpaused preset, multiple omitted": {
preset: config.Unpaused,
triggers: []jobs.TriggerConfiguration{cron, fileArrival},
expected: []jobs.PauseStatus{jobs.PauseStatusUnpaused, jobs.PauseStatusUnpaused},
},
"explicit values preserved": {
preset: config.Paused,
triggers: []jobs.TriggerConfiguration{
triggerWithPauseStatus(cron, jobs.PauseStatusUnpaused),
triggerWithPauseStatus(fileArrival, jobs.PauseStatusPaused),
},
expected: []jobs.PauseStatus{jobs.PauseStatusUnpaused, jobs.PauseStatusPaused},
},
"mixed explicit and omitted": {
preset: config.Unpaused,
triggers: []jobs.TriggerConfiguration{
triggerWithPauseStatus(cron, jobs.PauseStatusPaused),
fileArrival,
tableUpdate,
},
expected: []jobs.PauseStatus{jobs.PauseStatusPaused, jobs.PauseStatusUnpaused, jobs.PauseStatusUnpaused},
},
"no preset leaves omitted values unset": {
triggers: []jobs.TriggerConfiguration{cron, triggerWithPauseStatus(fileArrival, jobs.PauseStatusPaused)},
expected: []jobs.PauseStatus{"", jobs.PauseStatusPaused},
},
}

for name, tc := range tests {
t.Run(name, func(t *testing.T) {
b := &bundle.Bundle{
Config: config.Root{
Presets: config.Presets{TriggerPauseStatus: tc.preset},
Resources: config.Resources{
Jobs: map[string]*resources.Job{
"job": {JobSettings: jobs.JobSettings{Name: "job", Triggers: tc.triggers}},
},
},
},
}

diags := bundle.Apply(t.Context(), b, ApplyPresets())
require.NoError(t, diags.Error())

var actual []jobs.PauseStatus
for _, tr := range b.Config.Resources.Jobs["job"].Triggers {
actual = append(actual, tr.PauseStatus)
}
assert.Equal(t, tc.expected, actual)
})
}
}
37 changes: 37 additions & 0 deletions bundle/config/mutator/resourcemutator/apply_target_mode_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -468,6 +468,43 @@ func TestProcessTargetModeDevelopment(t *testing.T) {
assert.Empty(t, b.Config.Resources.Alerts["alert3"].Schedule.PauseStatus)
}

func TestProcessTargetModeDevelopmentTriggersPauseStatus(t *testing.T) {
type testCase struct {
preset string
expected jobs.PauseStatus
}

tests := map[string]testCase{
"defaults to paused": {expected: jobs.PauseStatusPaused},
"unpaused preset is honoured": {preset: config.Unpaused, expected: jobs.PauseStatusUnpaused},
}

for name, tc := range tests {
t.Run(name, func(t *testing.T) {
b := mockBundle(config.Development)
b.Config.Presets.TriggerPauseStatus = tc.preset
b.Config.Resources.Jobs["multi_triggers"] = &resources.Job{
Name: "multi_triggers",
Triggers: []jobs.TriggerConfiguration{
{Schedule: &jobs.CronTriggerConfiguration{QuartzCronExpression: "0 0 0 1 1 ? 2099", TimezoneId: "UTC"}},
{FileArrival: &jobs.FileArrivalTriggerConfiguration{Url: "/Volumes/main/default/landing/"}},
{
Schedule: &jobs.CronTriggerConfiguration{QuartzCronExpression: "0 0 0 2 1 ? 2099", TimezoneId: "UTC"},
PauseStatus: jobs.PauseStatusPaused,
},
},
}

diags := bundle.ApplySeq(t.Context(), b, ApplyTargetMode(), ApplyPresets())
require.NoError(t, diags.Error())

triggers := b.Config.Resources.Jobs["multi_triggers"].Triggers
actual := []jobs.PauseStatus{triggers[0].PauseStatus, triggers[1].PauseStatus, triggers[2].PauseStatus}
assert.Equal(t, []jobs.PauseStatus{tc.expected, tc.expected, jobs.PauseStatusPaused}, actual)
})
}
}

func TestProcessTargetModeDevelopmentTagNormalizationForAws(t *testing.T) {
b := mockBundle(config.Development)
b.Tagging = tags.ForCloud(&sdkconfig.Config{
Expand Down