Skip to content

Commit 7b17027

Browse files
alexandearalexandear
committed
chore: refactor test assertions to be more idiomatic
1 parent b1c4c42 commit 7b17027

File tree

14 files changed

+34
-22
lines changed

14 files changed

+34
-22
lines changed

‎.github/workflows/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ jobs:
106106
- name: Run golangci-lint
107107
uses: golangci/golangci-lint-action@v3
108108
with:
109-
version: v1.54
109+
version: v1.60
110110
args: --timeout 5m0s
111111

112112
license:

‎.golangci.yml

+13
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,27 @@ issues:
88
- errcheck
99
- path: internal/pkg/exec/(.+)\.go
1010
text: 'is unused'
11+
- text: "S1009: should omit nil check" # TODO: remove this line after fixing all the issues
12+
linters:
13+
- gosimple
14+
- text: "printf: non-constant format string in call to" # TODO: remove this line after fixing all the issues
15+
linters:
16+
- govet
17+
18+
1119

1220
linters:
1321
enable:
1422
- revive
23+
- testifylint
1524

1625
linters-settings:
1726
revive:
1827
rules:
1928
- name: exported
2029
arguments:
2130
- disableStutteringCheck
31+
testifylint:
32+
disable-all: true
33+
enable:
34+
- error-nil

‎internal/pkg/addon/output_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ Outputs:
136136

137137
// THEN
138138
if tc.wantedErr != nil {
139-
require.NotNil(t, err, "expected a non-nil error to be returned")
139+
require.Error(t, err, "expected a non-nil error to be returned")
140140
require.True(t, strings.HasPrefix(err.Error(), tc.wantedErr.Error()), "expected the error %v to be wrapped by our prefix %v", err, tc.wantedErr)
141141
} else {
142142
require.NoError(t, err)

‎internal/pkg/aws/apprunner/apprunner_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ func Test_LogGroupName(t *testing.T) {
293293
if tc.wantErr != nil {
294294
require.EqualError(t, err, tc.wantErr.Error())
295295
} else {
296-
require.Equal(t, nil, err)
296+
require.NoError(t, err)
297297
require.Equal(t, tc.wantLogGroupName, logGroupName)
298298
}
299299
})
@@ -327,7 +327,7 @@ func Test_SystemLogGroupName(t *testing.T) {
327327
if tc.wantErr != nil {
328328
require.EqualError(t, err, tc.wantErr.Error())
329329
} else {
330-
require.Equal(t, nil, err)
330+
require.NoError(t, err)
331331
require.Equal(t, tc.wantLogGroupName, logGroupName)
332332
}
333333
})

‎internal/pkg/aws/s3/s3_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ func TestS3_Upload(t *testing.T) {
7272
if gotErr != nil {
7373
require.EqualError(t, gotErr, tc.wantError.Error())
7474
} else {
75-
require.Equal(t, gotErr, nil)
75+
require.NoError(t, gotErr)
7676
require.Equal(t, gotURL, tc.wantedURL)
7777
}
7878
})

‎internal/pkg/aws/sessions/sessions_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ func TestProvider_FromProfile(t *testing.T) {
169169
sess, err := ImmutableProvider().FromProfile("walk-like-an-egyptian")
170170

171171
// THEN
172-
require.NotNil(t, err)
172+
require.Error(t, err)
173173
require.EqualError(t, errors.New("missing region configuration"), err.Error())
174174
require.Nil(t, sess)
175175
})

‎internal/pkg/cli/pipeline_override_test.go

-1
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,6 @@ func TestOverridePipeline_Execute(t *testing.T) {
383383
}
384384

385385
require.Error(t, err)
386-
require.NotNil(t, err)
387386
require.Contains(t, err.Error(), tc.wanted.Error())
388387
} else {
389388
if err != nil {

‎internal/pkg/cli/validate_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ func TestValidatePath(t *testing.T) {
364364

365365
// THEN
366366
if tc.want == nil {
367-
require.Nil(t, got)
367+
require.NoError(t, got)
368368
} else {
369369
require.EqualError(t, tc.want, got.Error())
370370
}
@@ -518,7 +518,7 @@ func TestValidateLSIs(t *testing.T) {
518518
if tc.wantError != nil {
519519
require.EqualError(t, got, tc.wantError.Error())
520520
} else {
521-
require.Nil(t, got)
521+
require.NoError(t, got)
522522
}
523523
})
524524
}
@@ -544,7 +544,7 @@ func TestValidateCIDR(t *testing.T) {
544544
if tc.wantError != nil {
545545
require.EqualError(t, got, tc.wantError.Error())
546546
} else {
547-
require.Nil(t, got)
547+
require.NoError(t, got)
548548
}
549549
})
550550
}
@@ -708,7 +708,7 @@ func TestValidateCron(t *testing.T) {
708708
if tc.shouldPass {
709709
require.NoError(t, got)
710710
} else {
711-
require.NotNil(t, got)
711+
require.Error(t, got)
712712
}
713713
})
714714
}

‎internal/pkg/deploy/cloudformation/cloudformation_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -626,7 +626,7 @@ func testDeployTask_ReturnNilOnEmptyChangeSetWhileUpdatingStack(t *testing.T, wh
626626
err := when(client)
627627

628628
// THEN
629-
require.Nil(t, err, "should not fail if the changeset is empty")
629+
require.NoError(t, err, "should not fail if the changeset is empty")
630630
}
631631

632632
func testDeployTask_OnUpdateChangeSetFailure(t *testing.T, when func(cf CloudFormation) error) {

‎internal/pkg/docker/dockerengine/dockerengine_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ func TestDockerCommand_Build(t *testing.T) {
235235
if tc.wantedError != nil {
236236
require.EqualError(t, tc.wantedError, got.Error())
237237
} else {
238-
require.Nil(t, got)
238+
require.NoError(t, got)
239239
}
240240
})
241241
}
@@ -815,7 +815,7 @@ func TestDockerCommand_Run(t *testing.T) {
815815
return
816816
}
817817

818-
require.Nil(t, err)
818+
require.NoError(t, err)
819819
split := strings.Split(out.String(), "\n")
820820
require.ElementsMatch(t, tc.wantedOutput, split[:len(split)-1])
821821
})

‎internal/pkg/ecs/run_task_request_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ func TestRunTaskRequest_CLIString(t *testing.T) {
443443
for name, tc := range testCases {
444444
t.Run(name, func(t *testing.T) {
445445
got, err := tc.in.CLIString()
446-
require.Nil(t, err)
446+
require.NoError(t, err)
447447
require.Equal(t, tc.wanted, got)
448448
})
449449
}
@@ -475,7 +475,7 @@ func TestRunTaskRequest_fmtStringMapToString(t *testing.T) {
475475
for name, tc := range testCases {
476476
t.Run(name, func(t *testing.T) {
477477
got, err := fmtStringMapToString(tc.in)
478-
require.Nil(t, err)
478+
require.NoError(t, err)
479479
require.Equal(t, tc.wanted, got)
480480
})
481481
}

‎internal/pkg/manifest/svc_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -888,7 +888,7 @@ func TestQueueScaling_AcceptableBacklogPerTask(t *testing.T) {
888888
t.Run(name, func(t *testing.T) {
889889
actual, err := tc.in.AcceptableBacklogPerTask()
890890
if tc.wantedErr != nil {
891-
require.NotNil(t, err)
891+
require.Error(t, err)
892892
} else {
893893
require.Equal(t, tc.wantedBacklog, actual)
894894
}

‎internal/pkg/manifest/validate_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -3166,7 +3166,7 @@ func TestObservability_validate(t *testing.T) {
31663166
gotErr := tc.config.validate()
31673167

31683168
if tc.wantedErrorPrefix != "" {
3169-
require.NotNil(t, gotErr)
3169+
require.Error(t, gotErr)
31703170
require.Contains(t, gotErr.Error(), tc.wantedErrorPrefix)
31713171
} else {
31723172
require.NoError(t, gotErr)
@@ -3895,7 +3895,7 @@ func TestDeploymentConfig_validate(t *testing.T) {
38953895
gotErr := tc.deployConfig.validate()
38963896

38973897
if tc.wanted != "" {
3898-
require.NotNil(t, gotErr)
3898+
require.Error(t, gotErr)
38993899
require.Contains(t, gotErr.Error(), tc.wanted)
39003900
} else {
39013901
require.NoError(t, gotErr)
@@ -3926,7 +3926,7 @@ func TestFromEnvironment_validate(t *testing.T) {
39263926
gotErr := tc.in.validate()
39273927

39283928
if tc.wantedError != nil {
3929-
require.NotNil(t, gotErr)
3929+
require.Error(t, gotErr)
39303930
require.EqualError(t, gotErr, tc.wantedError.Error())
39313931
} else {
39323932
require.NoError(t, gotErr)

‎internal/pkg/term/progress/cloudformation_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,7 @@ func TestEcsServiceResourceComponent_Render(t *testing.T) {
594594
nl, err := c.Render(buf)
595595

596596
// THEN
597-
require.Nil(t, err)
597+
require.NoError(t, err)
598598
require.Equal(t, 1, nl)
599599
require.Equal(t, "resource\n", buf.String())
600600
})
@@ -614,7 +614,7 @@ func TestEcsServiceResourceComponent_Render(t *testing.T) {
614614
nl, err := c.Render(buf)
615615

616616
// THEN
617-
require.Nil(t, err)
617+
require.NoError(t, err)
618618
require.Equal(t, 2, nl)
619619
require.Equal(t, "resource\n"+
620620
"deployment\t\t\n", buf.String())

0 commit comments

Comments
 (0)