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

Fail On Duplicate Config Names #1372

Merged
merged 8 commits into from
Jan 8, 2025
Merged

Fail On Duplicate Config Names #1372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8aee6a1
Updated melange to fail if a duplicate package config name is encount…
paulgibert Dec 13, 2024
e9a053c
Updated duplicate test files with different versions
paulgibert Dec 13, 2024
6f6cab9
Update comment typo
paulgibert Dec 13, 2024
c797060
Added file names to error messages and added check to ensure the pack…
paulgibert Jan 7, 2025
40edcf1
Merge branch 'wolfi-dev:main' into paulgibert/block-duplicates
paulgibert Jan 7, 2025
cb7fa84
Linted melange files
paulgibert Jan 8, 2025
2a71d32
Merge branch 'paulgibert/block-duplicates' of github.com:paulgibert/w…
paulgibert Jan 8, 2025
8a55195
Fixed check-subpipeline-version-matches test
paulgibert Jan 8, 2025
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
2 changes: 1 addition & 1 deletion pkg/lint/rules_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ func TestLinter_Rules(t *testing.T) {
file: "check-subpipeline-version-matches.yaml",
minSeverity: SeverityWarning,
want: EvalResult{
File: "check-version-matches",
File: "check-subpipeline-version-matches",
Errors: EvalRuleErrors{
{
Rule: Rule{
Expand Down
2 changes: 1 addition & 1 deletion pkg/lint/testdata/files/check-subpipeline-version-matches.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
package:
name: check-version-matches
name: check-subpipeline-version-matches
version: 0.9.0
epoch: 0
description: "a package with an out of date comment"
Expand Down
14 changes: 13 additions & 1 deletion pkg/melange/melange.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,19 @@ func ReadAllPackagesFromRepo(ctx context.Context, dir string) (map[string]*Packa
return p, fmt.Errorf("failed to read package config %s: %w", fi, err)
}

p[packageConfig.Package.Name] = &Packages{
// check that the package name matches the file name
name := packageConfig.Package.Name
fiBase := strings.TrimSuffix(filepath.Base(fi), filepath.Ext(fi))
if name != fiBase {
return p, fmt.Errorf("package name does not match file name in '%s': '%s' != '%s'", fi, name, fiBase)
}

// check that the package config name is unique
_, exists := p[name]
if exists {
return p, fmt.Errorf("package config names must be unique. Found a package called '%s' in '%s' and '%s'", name, fi, p[name].Filename)
}
p[name] = &Packages{
Config: *packageConfig,
Filename: relativeFilename,
Dir: dir,
Expand Down
6 changes: 6 additions & 0 deletions pkg/melange/melange_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ func TestMelange_readAllPackages(t *testing.T) {
assert.Equal(t, 4, len(packages))
}

func TestMelange_readAllPackagesErrorOnDuplicate(t *testing.T) {
ctx := context.Background()
_, err := ReadAllPackagesFromRepo(ctx, filepath.Join("testdata", "duplicates_dir"))
assert.Error(t, err, "package name does not match file name in 'foo1.yaml': 'foo' != 'foo1")
}

func TestMelange_readPackageConfigForBar(t *testing.T) {
ctx := context.Background()
packages, err := ReadPackageConfigs(ctx, []string{"bar"}, filepath.Join("testdata", "melange_dir"))
Expand Down
3 changes: 3 additions & 0 deletions pkg/melange/testdata/duplicates_dir/foo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package:
name: foo
version: 1.2.3
3 changes: 3 additions & 0 deletions pkg/melange/testdata/duplicates_dir/foo2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package:
name: foo
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we might also want to fail if .package.name is not the same as the filename.

These are potentially different/separate issues, but it does I think violate some assumptions we've made, and is worth avoiding.

If we have that check, we also get uniqueness "for free" since there can't be two foo.yamls

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the .package.name field must match the filename, couldn't you make an argument that the field is redundant and should be removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a check to error if the config name does not match the package name. This makes it impossible to test the package duplicate logic because, as you said, this gives us uniqueness for free, but I left the original check in just in case.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It probably is redundant, but I don't think we can easily remove it without causing lots and lots of downstream effects. I think it's fine to leave it, and just ensure it's the same as the filename, for now.

version: 1.2.4
Loading