enforce rfc1123 compatibility for olm.package.name (#1307)

Signed-off-by: Jordan Keister <jordan@nimblewidget.com>
operator-framework · May 14, 2024 · 6bb0a3e · 6bb0a3e
1 parent 2c49e9c
commit 6bb0a3e
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/alpha/declcfg/declcfg_to_model.go b/alpha/declcfg/declcfg_to_model.go
@@ -5,6 +5,7 @@ import (
 
 	"github.com/blang/semver/v4"
 	"k8s.io/apimachinery/pkg/util/sets"
+	"k8s.io/apimachinery/pkg/util/validation"
 
 	"github.com/operator-framework/operator-registry/alpha/model"
 	"github.com/operator-framework/operator-registry/alpha/property"
@@ -22,6 +23,10 @@ func ConvertToModel(cfg DeclarativeConfig) (model.Model, error) {
 			return nil, fmt.Errorf("duplicate package %q", p.Name)
 		}
 
+		if errs := validation.IsDNS1123Label(p.Name); len(errs) > 0 {
+			return nil, fmt.Errorf("invalid package name %q: %v", p.Name, errs)
+		}
+
 		mpkg := &model.Package{
 			Name:        p.Name,
 			Description: p.Description,

diff --git a/alpha/declcfg/declcfg_to_model_test.go b/alpha/declcfg/declcfg_to_model_test.go
@@ -215,6 +215,17 @@ func TestConvertToModel(t *testing.T) {
 				Bundles:  []Bundle{newTestBundle("foo", "0.1.0")},
 			},
 		},
+		{
+			name:      "Error/PackageBreaksRFC1123",
+			assertion: hasError(`invalid package name "foo.bar": [must not contain dots]`),
+			cfg: DeclarativeConfig{
+				Packages: []Package{
+					newTestPackage("foo.bar", "alpha", svgSmallCircle),
+				},
+				Channels: []Channel{newTestChannel("foo", "alpha", ChannelEntry{Name: "foo.v0.1.0"})},
+				Bundles:  []Bundle{newTestBundle("foo", "0.1.0")},
+			},
+		},
 		{
 			name:      "Error/DuplicateChannel",
 			assertion: hasError(`package "foo" has duplicate channel "alpha"`),