lint: Add testifylint to prevent unnecessary test code issues

keboola · Nov 20, 2024 · 65d07ab · 65d07ab
1 parent e375dc2
commit 65d07ab
Show file tree

Hide file tree

Showing 308 changed files with 2,687 additions and 2,504 deletions.
diff --git a/build/ci/golangci.yml b/build/ci/golangci.yml
@@ -102,6 +102,10 @@ linters-settings:
   exhaustive:
     check-generated: true
     default-signifies-exhaustive: true
+  testifylint:
+    disable:
+      - error-is-as
+      - go-require
 
 # https://golangci-lint.run/usage/linters
 linters:
@@ -147,6 +151,7 @@ linters:
     - staticcheck
     - stylecheck
     - tagliatelle
+    - testifylint
     - thelper
     - tparallel
     - paralleltest

diff --git a/internal/pkg/diff/diff_test.go b/internal/pkg/diff/diff_test.go
@@ -8,6 +8,7 @@ import (
 	"github.com/keboola/go-client/pkg/keboola"
 	"github.com/keboola/go-utils/pkg/orderedmap"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 
 	"github.com/keboola/keboola-as-code/internal/pkg/fixtures"
 	"github.com/keboola/keboola-as-code/internal/pkg/model"
@@ -23,11 +24,11 @@ func TestDiffOnlyInLocal(t *testing.T) {
 		BranchManifest: &model.BranchManifest{BranchKey: branchKey},
 		Local:          &model.Branch{BranchKey: branchKey},
 	}
-	assert.NoError(t, projectState.Set(branchState))
+	require.NoError(t, projectState.Set(branchState))
 
 	d := NewDiffer(projectState)
 	results, err := d.Diff()
-	assert.NoError(t, err)
+	require.NoError(t, err)
 	assert.Len(t, results.Results, 1)
 	result := results.Results[0]
 	assert.Equal(t, ResultOnlyInLocal, result.State)
@@ -43,11 +44,11 @@ func TestDiffOnlyInRemote(t *testing.T) {
 		BranchManifest: &model.BranchManifest{BranchKey: branchKey},
 		Remote:         &model.Branch{BranchKey: branchKey},
 	}
-	assert.NoError(t, projectState.Set(branchState))
+	require.NoError(t, projectState.Set(branchState))
 
 	d := NewDiffer(projectState)
 	results, err := d.Diff()
-	assert.NoError(t, err)
+	require.NoError(t, err)
 	assert.Len(t, results.Results, 1)
 	result := results.Results[0]
 	assert.Equal(t, ResultOnlyInRemote, result.State)
@@ -74,11 +75,11 @@ func TestDiffEqual(t *testing.T) {
 			IsDefault:   false,
 		},
 	}
-	assert.NoError(t, projectState.Set(branchState))
+	require.NoError(t, projectState.Set(branchState))
 
 	d := NewDiffer(projectState)
 	results, err := d.Diff()
-	assert.NoError(t, err)
+	require.NoError(t, err)
 	assert.Len(t, results.Results, 1)
 	result := results.Results[0]
 	assert.Equal(t, ResultEqual, result.State)
@@ -106,11 +107,11 @@ func TestDiffNotEqual(t *testing.T) {
 			IsDefault:   true,
 		},
 	}
-	assert.NoError(t, projectState.Set(branchState))
+	require.NoError(t, projectState.Set(branchState))
 
 	d := NewDiffer(projectState)
 	results, err := d.Diff()
-	assert.NoError(t, err)
+	require.NoError(t, err)
 	assert.Len(t, results.Results, 1)
 	result := results.Results[0]
 	assert.Equal(t, ResultNotEqual, result.State)
@@ -141,7 +142,7 @@ func TestDiffEqualConfig(t *testing.T) {
 			IsDefault:   false,
 		},
 	}
-	assert.NoError(t, projectState.Set(branchState))
+	require.NoError(t, projectState.Set(branchState))
 
 	configKey := model.ConfigKey{
 		BranchID:    123,
@@ -161,11 +162,11 @@ func TestDiffEqualConfig(t *testing.T) {
 			Description: "description",
 		},
 	}
-	assert.NoError(t, projectState.Set(configState))
+	require.NoError(t, projectState.Set(configState))
 
 	d := NewDiffer(projectState)
 	results, err := d.Diff()
-	assert.NoError(t, err)
+	require.NoError(t, err)
 	assert.Len(t, results.Results, 2)
 	result1 := results.Results[0]
 	assert.Equal(t, ResultEqual, result1.State)
@@ -199,7 +200,7 @@ func TestDiffNotEqualConfig(t *testing.T) {
 			IsDefault:   false,
 		},
 	}
-	assert.NoError(t, projectState.Set(branchState))
+	require.NoError(t, projectState.Set(branchState))
 
 	configKey := model.ConfigKey{
 		BranchID:    123,
@@ -219,11 +220,11 @@ func TestDiffNotEqualConfig(t *testing.T) {
 			Description: "changed",
 		},
 	}
-	assert.NoError(t, projectState.Set(configState))
+	require.NoError(t, projectState.Set(configState))
 
 	d := NewDiffer(projectState)
 	results, err := d.Diff()
-	assert.NoError(t, err)
+	require.NoError(t, err)
 	assert.Len(t, results.Results, 2)
 
 	result1 := results.Results[0]
@@ -259,7 +260,7 @@ func TestDiffNotEqualConfigConfiguration(t *testing.T) {
 			IsDefault:   false,
 		},
 	}
-	assert.NoError(t, projectState.Set(branchState))
+	require.NoError(t, projectState.Set(branchState))
 
 	configKey := model.ConfigKey{
 		BranchID:    123,
@@ -295,11 +296,11 @@ func TestDiffNotEqualConfigConfiguration(t *testing.T) {
 			}),
 		},
 	}
-	assert.NoError(t, projectState.Set(configState))
+	require.NoError(t, projectState.Set(configState))
 
 	d := NewDiffer(projectState)
 	results, err := d.Diff()
-	assert.NoError(t, err)
+	require.NoError(t, err)
 	assert.Len(t, results.Results, 2)
 
 	result1 := results.Results[0]
@@ -330,7 +331,7 @@ func TestDiffRelations(t *testing.T) {
 			PathValue: `path/to/target`,
 		},
 	}
-	assert.NoError(t, projectState.Set(targetState))
+	require.NoError(t, projectState.Set(targetState))
 
 	objectKey := fixtures.MockedKey{
 		ID: `345`,
@@ -369,7 +370,7 @@ func TestDiffRelations(t *testing.T) {
 			},
 		},
 	}
-	assert.NoError(t, projectState.Set(objectState))
+	require.NoError(t, projectState.Set(objectState))
 
 	differ := NewDiffer(projectState)
 	reporter := differ.diffValues(objectState, objectState.Remote.Relations, objectState.Local.Relations, differ.newOptions)
@@ -451,7 +452,7 @@ func TestDiffTransformation(t *testing.T) {
 			},
 		},
 	}
-	assert.NoError(t, projectState.Set(configState))
+	require.NoError(t, projectState.Set(configState))
 
 	// Transformation
 	differ := NewDiffer(projectState)
@@ -514,7 +515,7 @@ func TestDiffSharedCode(t *testing.T) {
 			},
 		},
 	}
-	assert.NoError(t, projectState.Set(configRowState))
+	require.NoError(t, projectState.Set(configRowState))
 
 	// Transformation
 	differ := NewDiffer(projectState)
@@ -679,7 +680,7 @@ func TestDiffOrchestration(t *testing.T) {
 			},
 		},
 	}
-	assert.NoError(t, projectState.Set(configState))
+	require.NoError(t, projectState.Set(configState))
 
 	differ := NewDiffer(projectState)
 	reporter := differ.diffValues(configState, configState.Remote.Orchestration, configState.Local.Orchestration, differ.newOptions)
@@ -763,7 +764,7 @@ func TestDiffMap(t *testing.T) {
 			}),
 		},
 	}
-	assert.NoError(t, projectState.Set(configState))
+	require.NoError(t, projectState.Set(configState))
 
 	differ := NewDiffer(projectState)
 	reporter := differ.diffValues(configState, configState.Remote.Content, configState.Local.Content, differ.newOptions)

diff --git a/internal/pkg/diff/reporter_test.go b/internal/pkg/diff/reporter_test.go
@@ -1,7 +1,6 @@
 package diff
 
 import (
-	"fmt"
 	"reflect"
 	"strings"
 	"testing"
@@ -76,7 +75,7 @@ func TestReporterStringsDiff(t *testing.T) {
 	}
 	for i, c := range cases {
 		result := stringsDiff(c.remote, c.local)
-		assert.Equal(t, c.result, result, fmt.Sprintf(`case "%d"`, i))
+		assert.Equal(t, c.result, result, `case "%d"`, i)
 	}
 }
 

diff --git a/internal/pkg/encoding/json/schema/generate_test.go b/internal/pkg/encoding/json/schema/generate_test.go
@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 
 	"github.com/keboola/keboola-as-code/internal/pkg/encoding/json"
 )
@@ -13,7 +14,7 @@ func TestGenerateDocument(t *testing.T) {
 	t.Parallel()
 	document, err := GenerateDocument(getSampleSchema())
 	documentJSON := json.MustEncodeString(document, true)
-	assert.NoError(t, err)
+	require.NoError(t, err)
 
 	expected := `
 {
@@ -50,7 +51,7 @@ func TestGenerateDocumentEmptySchema(t *testing.T) {
 	t.Parallel()
 	document, err := GenerateDocument([]byte(`{}`))
 	documentJSON := json.MustEncodeString(document, true)
-	assert.NoError(t, err)
+	require.NoError(t, err)
 	assert.Equal(t, "{}\n", documentJSON)
 }
 

diff --git a/internal/pkg/encoding/json/schema/meta_test.go b/internal/pkg/encoding/json/schema/meta_test.go
@@ -5,6 +5,7 @@ import (
 
 	"github.com/keboola/go-utils/pkg/orderedmap"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 
 	"github.com/keboola/keboola-as-code/internal/pkg/encoding/json/schema"
 )
@@ -14,7 +15,7 @@ func TestFieldMeta_Empty(t *testing.T) {
 	meta, found, err := schema.FieldMeta([]byte(""), orderedmap.Path{})
 	assert.Empty(t, meta)
 	assert.False(t, found)
-	assert.Nil(t, err)
+	require.NoError(t, err)
 }
 
 func TestFieldMeta_Complex(t *testing.T) {
@@ -54,39 +55,39 @@ func TestFieldMeta_Complex(t *testing.T) {
 	meta, found, err := schema.FieldMeta([]byte(componentSchema), orderedmap.Path{})
 	assert.Empty(t, meta)
 	assert.False(t, found)
-	assert.Nil(t, err)
+	require.NoError(t, err)
 
 	// Not found
 	meta, found, err = schema.FieldMeta([]byte(componentSchema), orderedmap.PathFromStr("foo.bar"))
 	assert.Empty(t, meta)
 	assert.False(t, found)
-	assert.Nil(t, err)
+	require.NoError(t, err)
 
 	// Found object
 	meta, found, err = schema.FieldMeta([]byte(componentSchema), orderedmap.PathFromStr("parameters.db"))
 	assert.NotEmpty(t, meta)
 	assert.True(t, found)
-	assert.Nil(t, err)
+	require.NoError(t, err)
 	assert.Equal(t, "Database", meta.Title)
 	assert.Equal(t, "", meta.Description)
-	assert.Equal(t, nil, meta.Default)
+	assert.Nil(t, meta.Default)
 	assert.False(t, meta.Required)
 
 	// Found string, required field
 	meta, found, err = schema.FieldMeta([]byte(componentSchema), orderedmap.PathFromStr("parameters.db.#connectionString"))
 	assert.NotEmpty(t, meta)
 	assert.True(t, found)
-	assert.Nil(t, err)
+	require.NoError(t, err)
 	assert.Equal(t, "Connection String", meta.Title)
 	assert.Equal(t, `Eg. "DefaultEndpointsProtocol=https;...". The value will be encrypted when saved.`, meta.Description)
-	assert.Equal(t, nil, meta.Default)
+	assert.Nil(t, meta.Default)
 	assert.True(t, meta.Required)
 
 	// Found int, default field
 	meta, found, err = schema.FieldMeta([]byte(componentSchema), orderedmap.PathFromStr("parameters.db.limit"))
 	assert.NotEmpty(t, meta)
 	assert.True(t, found)
-	assert.Nil(t, err)
+	require.NoError(t, err)
 	assert.Equal(t, "Query Limit", meta.Title)
 	assert.Equal(t, "", meta.Description)
 	assert.Equal(t, "1234", meta.Default)

diff --git a/internal/pkg/encoding/json/schema/schema_test.go b/internal/pkg/encoding/json/schema/schema_test.go
@@ -8,6 +8,7 @@ import (
 	"github.com/keboola/go-client/pkg/keboola"
 	"github.com/keboola/go-utils/pkg/orderedmap"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 
 	. "github.com/keboola/keboola-as-code/internal/pkg/encoding/json/schema"
 	"github.com/keboola/keboola-as-code/internal/pkg/filesystem/knownpaths"
@@ -27,7 +28,7 @@ func TestValidateObjects_Ok(t *testing.T) {
 	})
 	content := orderedmap.New()
 	content.Set(`parameters`, parameters)
-	assert.NoError(t, ValidateContent(schema, content))
+	require.NoError(t, ValidateContent(schema, content))
 }
 
 func TestValidateObjects_Error(t *testing.T) {
@@ -46,7 +47,7 @@ func TestValidateObjects_Error(t *testing.T) {
 	content := orderedmap.New()
 	content.Set(`parameters`, parameters)
 	err := ValidateContent(schema, content)
-	assert.Error(t, err)
+	require.Error(t, err)
 	expectedErr := `
 - missing properties: "firstName"
 - "address": missing properties: "street"
@@ -68,7 +69,7 @@ func TestValidateObjects_InvalidSchema_InvalidJSON(t *testing.T) {
 			}),
 		},
 	}))
-	assert.Error(t, err)
+	require.Error(t, err)
 	expected := `
 invalid JSON schema:
 - invalid character '.' looking for beginning of object key string, offset: 2
@@ -209,7 +210,7 @@ func TestValidateObjects_InvalidSchema_InvalidType(t *testing.T) {
 			Value: orderedmap.FromPairs([]orderedmap.Pair{{Key: "key", Value: "value"}}),
 		},
 	}))
-	assert.Error(t, err)
+	require.Error(t, err)
 	expected := `
 invalid JSON schema:
 - allOf failed:
@@ -227,7 +228,7 @@ func TestValidateObjects_BooleanRequired(t *testing.T) {
 	// But, for historical reasons, in Keboola components, "required: true" is also used.
 	// In the UI, this causes the drop-down list to not have an empty value.
 	// For this reason,the error should be ignored.
-	assert.NoError(t, ValidateContent(invalidSchema, orderedmap.FromPairs([]orderedmap.Pair{
+	require.NoError(t, ValidateContent(invalidSchema, orderedmap.FromPairs([]orderedmap.Pair{
 		{
 			Key: "parameters",
 			Value: orderedmap.FromPairs([]orderedmap.Pair{
@@ -242,7 +243,7 @@ func TestValidateObjects_SkipEmpty(t *testing.T) {
 	t.Parallel()
 	schema := getTestSchema()
 	content := orderedmap.New()
-	assert.NoError(t, ValidateContent(schema, content))
+	require.NoError(t, ValidateContent(schema, content))
 }
 
 func TestValidateObjects_InvalidSchema_Warning1(t *testing.T) {
@@ -321,19 +322,19 @@ func testInvalidComponentSchema(t *testing.T, invalidSchema []byte, expectedLogs
 		},
 	})
 	registry := state.NewRegistry(knownpaths.NewNop(context.Background()), naming.NewRegistry(), components, model.SortByID)
-	assert.NoError(t, registry.Set(&model.ConfigState{
+	require.NoError(t, registry.Set(&model.ConfigState{
 		ConfigManifest: &model.ConfigManifest{ConfigKey: model.ConfigKey{ComponentID: componentID}},
 		Local:          &model.Config{Content: someContent},
 	}))
-	assert.NoError(t, registry.Set(&model.ConfigRowState{
+	require.NoError(t, registry.Set(&model.ConfigRowState{
 		ConfigRowManifest: &model.ConfigRowManifest{ConfigRowKey: model.ConfigRowKey{ComponentID: componentID}},
 		Local:             &model.ConfigRow{Content: someContent},
 	}))
 
 	// Validate, no error
 	content := orderedmap.New()
 	content.Set(`parameters`, orderedmap.New())
-	assert.NoError(t, ValidateObjects(context.Background(), logger, registry))
+	require.NoError(t, ValidateObjects(context.Background(), logger, registry))
 	assert.Equal(t, strings.TrimLeft(expectedLogs, "\n"), logger.AllMessagesTxt())
 }