Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Lint messages reported from porter should not mention mixins #2992

Merged
merged 7 commits into from
Feb 20, 2024
Merged

Lint messages reported from porter should not mention mixins #2992

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7ece46f
Lint messages reported from porter not mention mixins
kichristensen Feb 9, 2024
29b28a9
Add to CONTRIBUTORS
kichristensen Feb 9, 2024
b0511c8
Merge branch 'main' into linterNoMixins
schristoff Feb 15, 2024
3198d2e
Merge branch 'main' into linterNoMixins
schristoff Feb 15, 2024
10362c6
Do not print location when mixin is empty
kichristensen Feb 15, 2024
8541e73
Merge branch 'main' into linterNoMixins
kichristensen Feb 19, 2024
dde1c86
Merge branch 'main' into linterNoMixins
schristoff Feb 20, 2024
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
4 changes: 3 additions & 1 deletion pkg/linter/linter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ type Result struct {
func (r Result) String() string {
var buffer strings.Builder
buffer.WriteString(fmt.Sprintf("%s(%s) - %s\n", r.Level, r.Code, r.Title))
buffer.WriteString(r.Location.String() + "\n")
if r.Location.Mixin != "" {
buffer.WriteString(r.Location.String() + "\n")
}

if r.Message != "" {
buffer.WriteString(r.Message + "\n")
Expand Down
20 changes: 20 additions & 0 deletions pkg/linter/linter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,4 +153,24 @@ func TestLinter_Lint(t *testing.T) {
require.NoError(t, err, "Lint failed")
require.Len(t, results, 0, "linter should have returned 1 result")
})

t.Run("lint messages does not mention mixins in message not coming from mixin", func(t *testing.T) {
cxt := portercontext.NewTestContext(t)
mixins := mixin.NewTestMixinProvider()
l := New(cxt.Context, mixins)
param := map[string]manifest.ParameterDefinition{
"A": {
Name: "porter_test",
},
}

m := &manifest.Manifest{
Parameters: param,
}

results, err := l.Lint(ctx, m)
require.NoError(t, err, "Lint failed")
require.Len(t, results, 1, "linter should have returned 1 result")
require.NotContains(t, results[0].String(), ": 0th step in the mixin ()")
})
}
Loading