Skip to content

Commit 430902d

Browse files
authored
[Internal] Use Jobs.Get instead of Jobs.GetByJobId (#5029)
## Changes <!-- Summary of your changes that are easy to understand --> `JobsGetByJobId` is deprecated and leads to issues such as: databricks/databricks-sdk-go#1283. To get a single job, we use `Jobs.Get` instead. ## Tests <!-- How is this tested? Please see the checklist below and also describe any other relevant tests --> Updated unit tests
1 parent c0168ff commit 430902d

File tree

7 files changed

+24
-7
lines changed

7 files changed

+24
-7
lines changed

NEXT_CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@
1818
### Exporter
1919

2020
### Internal Changes
21+
* Use `Jobs.Get` instead of `JobsGetByJobId` ([#5029](https://github.com/databricks/terraform-provider-databricks/pull/5029))

jobs/job_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,9 @@ func TestAccPeriodicTrigger(t *testing.T) {
426426
jobID, err := strconv.ParseInt(id, 10, 64)
427427
assert.NoError(t, err)
428428

429-
res, err := w.Jobs.GetByJobId(ctx, jobID)
429+
res, err := w.Jobs.Get(ctx, jobs.GetJobRequest{
430+
JobId: jobID,
431+
})
430432
assert.NoError(t, err)
431433

432434
assert.Equal(t, jobs.PauseStatus("UNPAUSED"), res.Settings.Trigger.PauseStatus)

jobs/jobs_api_go_sdk.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,9 @@ func Update(jobID int64, js JobSettingsResource, w *databricks.WorkspaceClient,
309309
}
310310

311311
func Read(jobID int64, w *databricks.WorkspaceClient, ctx context.Context) (job *jobs.Job, err error) {
312-
job, err = w.Jobs.GetByJobId(ctx, jobID)
312+
job, err = w.Jobs.Get(ctx, jobs.GetJobRequest{
313+
JobId: jobID,
314+
})
313315
err = wrapMissingJobError(err, fmt.Sprintf("%d", jobID))
314316
if job.Settings != nil {
315317
js := JobSettingsResource{JobSettings: *job.Settings}

jobs/resource_job_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -668,7 +668,9 @@ func TestResourceJobCreate_PowerBiTask(t *testing.T) {
668668
Return(&jobs.CreateResponse{
669669
JobId: 789,
670670
}, nil)
671-
e.GetByJobId(mock.Anything, int64(789)).Return(&jobs.Job{
671+
e.Get(mock.Anything, jobs.GetJobRequest{
672+
JobId: int64(789),
673+
}).Return(&jobs.Job{
672674
JobId: 789,
673675
Settings: &jobs.JobSettings{
674676
Name: "power_bi_task_name",

permissions/permission_definitions.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import (
99

1010
"github.com/databricks/databricks-sdk-go"
1111
"github.com/databricks/databricks-sdk-go/service/iam"
12+
"github.com/databricks/databricks-sdk-go/service/jobs"
1213
"github.com/databricks/terraform-provider-databricks/common"
1314
"github.com/databricks/terraform-provider-databricks/permissions/entity"
1415
"github.com/databricks/terraform-provider-databricks/permissions/read"
@@ -408,7 +409,9 @@ func allResourcePermissions() []resourcePermissions {
408409
if err != nil {
409410
return "", err
410411
}
411-
job, err := w.Jobs.GetByJobId(ctx, jobId)
412+
job, err := w.Jobs.Get(ctx, jobs.GetJobRequest{
413+
JobId: jobId,
414+
})
412415
if err != nil {
413416
return "", common.IgnoreNotFoundError(err)
414417
}

permissions/permissions_test.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import (
99

1010
"github.com/databricks/databricks-sdk-go"
1111
"github.com/databricks/databricks-sdk-go/service/iam"
12+
"github.com/databricks/databricks-sdk-go/service/jobs"
1213
"github.com/databricks/terraform-provider-databricks/common"
1314
"github.com/databricks/terraform-provider-databricks/internal/acceptance"
1415
"github.com/hashicorp/terraform-plugin-testing/helper/resource"
@@ -321,7 +322,9 @@ func TestAccPermissions_Job(t *testing.T) {
321322
assert.NoError(t, err)
322323
idInt, err := strconv.Atoi(jobId)
323324
assert.NoError(t, err)
324-
job, err := w.Jobs.GetByJobId(context.Background(), int64(idInt))
325+
job, err := w.Jobs.Get(context.Background(), jobs.GetJobRequest{
326+
JobId: int64(idInt),
327+
})
325328
assert.NoError(t, err)
326329
assertContainsPermission(t, permissions, currentPrincipalType(t), job.CreatorUserName, iam.PermissionLevelIsOwner)
327330
return nil

permissions/resource_permissions_test.go

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1373,7 +1373,9 @@ func TestResourcePermissionsUpdateTokensAlwaysThereForAdmins(t *testing.T) {
13731373

13741374
func TestShouldKeepAdminsOnAnythingExceptPasswordsAndAssignsOwnerForJob(t *testing.T) {
13751375
qa.MockWorkspaceApply(t, func(mwc *mocks.MockWorkspaceClient) {
1376-
mwc.GetMockJobsAPI().EXPECT().GetByJobId(mock.Anything, int64(123)).Return(&jobs.Job{
1376+
mwc.GetMockJobsAPI().EXPECT().Get(mock.Anything, jobs.GetJobRequest{
1377+
JobId: int64(123),
1378+
}).Return(&jobs.Job{
13771379
CreatorUserName: "[email protected]",
13781380
}, nil)
13791381
e := mwc.GetMockPermissionsAPI().EXPECT()
@@ -1445,7 +1447,9 @@ func TestShouldDeleteNonExistentJob(t *testing.T) {
14451447
},
14461448
},
14471449
}, nil)
1448-
mwc.GetMockJobsAPI().EXPECT().GetByJobId(mock.Anything, int64(123)).Return(nil, &apierr.APIError{
1450+
mwc.GetMockJobsAPI().EXPECT().Get(mock.Anything, jobs.GetJobRequest{
1451+
JobId: int64(123),
1452+
}).Return(nil, &apierr.APIError{
14491453
StatusCode: 400,
14501454
Message: "Job 123 does not exist.",
14511455
ErrorCode: "INVALID_PARAMETER_VALUE",

0 commit comments

Comments
 (0)