review mods

Signed-off-by: grokspawn <jordan@nimblewidget.com>

Author: grokspawn

alpha/template/basic/basic.go

@@ -18,24 +18,24 @@ func init() {
 	template.GetTemplateRegistry().Register(&Factory{})
 }
 
-type BasicTemplate struct {
+type basicTemplate struct {
 	renderBundle template.BundleRenderer
 }
 
-// NewTemplate creates a new basic template instance
-func NewTemplate(renderBundle template.BundleRenderer) template.Template {
-	return &BasicTemplate{
+// New creates a new basic template instance
+func New(renderBundle template.BundleRenderer) template.Template {
+	return &basicTemplate{
 		renderBundle: renderBundle,
 	}
 }
 
 // RenderBundle implements the template.Template interface
-func (t *BasicTemplate) RenderBundle(ctx context.Context, image string) (*declcfg.DeclarativeConfig, error) {
+func (t *basicTemplate) RenderBundle(ctx context.Context, image string) (*declcfg.DeclarativeConfig, error) {
 	return t.renderBundle(ctx, image)
 }
 
 // Render implements the template.Template interface
-func (t *BasicTemplate) Render(ctx context.Context, reader io.Reader) (*declcfg.DeclarativeConfig, error) {
+func (t *basicTemplate) Render(ctx context.Context, reader io.Reader) (*declcfg.DeclarativeConfig, error) {
 	bt, err := parseSpec(reader)
 	if err != nil {
 		return nil, err
@@ -62,7 +62,7 @@ func (t *BasicTemplate) Render(ctx context.Context, reader io.Reader) (*declcfg.
 }
 
 // Schema implements the template.Template interface
-func (t *BasicTemplate) Schema() string {
+func (t *basicTemplate) Schema() string {
 	return schema
 }
 
@@ -71,7 +71,7 @@ type Factory struct{}
 
 // CreateTemplate implements the template.TemplateFactory interface
 func (f *Factory) CreateTemplate(renderBundle template.BundleRenderer) template.Template {
-	return NewTemplate(renderBundle)
+	return New(renderBundle)
 }
 
 // Schema implements the template.TemplateFactory interface

alpha/template/registry.go

@@ -9,11 +9,11 @@ import (
 var tr = NewTemplateRegistry()
 
 // GetTemplateRegistry returns the global template registry
-func GetTemplateRegistry() *TemplateRegistry {
+func GetTemplateRegistry() *templateRegistry {
 	return tr
 }
 
-func (r *TemplateRegistry) HelpText() string {
+func (r *templateRegistry) HelpText() string {
 	var help strings.Builder
 	supportedTypes := r.GetSupportedTypes()
 	help.WriteString("\n")

alpha/template/semver/semver.go

@@ -42,25 +42,25 @@ type SemverTemplateData struct {
 
 // IO structs -- END
 
-// SemverTemplate implements the common template interface
-type SemverTemplate struct {
+// semverTemplate implements the common template interface
+type semverTemplate struct {
 	renderBundle template.BundleRenderer
 }
 
-// NewTemplate creates a new semver template instance
-func NewTemplate(renderBundle template.BundleRenderer) template.Template {
-	return &SemverTemplate{
+// New creates a new semver template instance
+func New(renderBundle template.BundleRenderer) template.Template {
+	return &semverTemplate{
 		renderBundle: renderBundle,
 	}
 }
 
 // RenderBundle implements the template.Template interface
-func (t *SemverTemplate) RenderBundle(ctx context.Context, image string) (*declcfg.DeclarativeConfig, error) {
+func (t *semverTemplate) RenderBundle(ctx context.Context, image string) (*declcfg.DeclarativeConfig, error) {
 	return t.renderBundle(ctx, image)
 }
 
 // Render implements the template.Template interface
-func (t *SemverTemplate) Render(ctx context.Context, reader io.Reader) (*declcfg.DeclarativeConfig, error) {
+func (t *semverTemplate) Render(ctx context.Context, reader io.Reader) (*declcfg.DeclarativeConfig, error) {
 	var out declcfg.DeclarativeConfig
 
 	sv, err := readFile(reader)
@@ -102,7 +102,7 @@ func (t *SemverTemplate) Render(ctx context.Context, reader io.Reader) (*declcfg
 }
 
 // Schema implements the template.Template interface
-func (t *SemverTemplate) Schema() string {
+func (t *semverTemplate) Schema() string {
 	return schema
 }
 
@@ -111,7 +111,7 @@ type Factory struct{}
 
 // CreateTemplate implements the template.TemplateFactory interface
 func (f *Factory) CreateTemplate(renderBundle template.BundleRenderer) template.Template {
-	return NewTemplate(renderBundle)
+	return New(renderBundle)
 }
 
 // Schema implements the template.TemplateFactory interface

alpha/template/semver/semver_test.go

@@ -529,7 +529,9 @@ func TestGenerateChannels(t *testing.T) {
 		t.Run(tt.name, func(t *testing.T) {
 			sv := &SemverTemplateData{GenerateMajorChannels: tt.generateMajorChannels, GenerateMinorChannels: tt.generateMinorChannels, pkg: "a", DefaultChannelTypePreference: tt.channelTypePreference}
 			out := sv.generateChannels(&channelOperatorVersions)
-			require.ElementsMatch(t, tt.out, out)
+			if diff := gocmp.Diff(tt.out, out); diff != "" {
+				t.Errorf("unexpected generated channels (-expected +received):\n%s", diff)
+			}
 			require.Equal(t, tt.defaultChannel, sv.defaultChannel)
 		})
 	}

alpha/template/template.go

@@ -5,67 +5,82 @@ import (
 	"io"
 	"slices"
 	"strings"
+	"sync"
 
 	"github.com/operator-framework/operator-registry/alpha/declcfg"
 )
 
-// BundleRenderer defines the function signature for rendering bundle images
+// BundleRenderer defines the function signature for rendering a string containing a bundle image/path/file into a DeclarativeConfig fragment
+// It's provided as a discrete type to allow for easy mocking in tests as well as facilitating variable
+// restrictions on reference types
 type BundleRenderer func(context.Context, string) (*declcfg.DeclarativeConfig, error)
 
 // Template defines the common interface for all template types
 type Template interface {
-	// RenderBundle renders a bundle image reference into a DeclarativeConfig
-	RenderBundle(ctx context.Context, image string) (*declcfg.DeclarativeConfig, error)
-	// Render processes the template input and returns a DeclarativeConfig
+	// RenderBundle renders a bundle image reference into a DeclarativeConfig fragment.
+	// This function is used to render a single bundle image reference by a template instance,
+	// and is provided to the template on construction.
+	// This is typically used in the call to Render the template to DeclarativeConfig, and
+	// needs to be configurable to handle different bundle image formats and configurations.
+	RenderBundle(ctx context.Context, imageRef string) (*declcfg.DeclarativeConfig, error)
+	// Render processes the raw template yaml/json input and returns an expanded DeclarativeConfig
+	// in the case where expansion fails, it returns an error
 	Render(ctx context.Context, reader io.Reader) (*declcfg.DeclarativeConfig, error)
 	// Schema returns the schema identifier for this template type
 	Schema() string
 }
 
-// TemplateFactory creates template instances based on schema
-type TemplateFactory interface {
+// Factory creates template instances based on schema
+type Factory interface {
 	// CreateTemplate creates a new template instance with the given RenderBundle function
 	CreateTemplate(renderBundle BundleRenderer) Template
 	// Schema returns the schema identifier this factory handles
 	Schema() string
 }
 
-// TemplateRegistry maintains a mapping of schema identifiers to template factories
-type TemplateRegistry struct {
-	factories map[string]TemplateFactory
+// templateRegistry maintains a mapping of schema identifiers to template factories
+type templateRegistry struct {
+	mu        sync.RWMutex
+	factories map[string]Factory
 }
 
 // NewTemplateRegistry creates a new template registry
-func NewTemplateRegistry() *TemplateRegistry {
-	return &TemplateRegistry{
-		factories: make(map[string]TemplateFactory),
+func NewTemplateRegistry() *templateRegistry {
+	return &templateRegistry{
+		factories: make(map[string]Factory),
 	}
 }
 
 // Register adds a template factory to the registry
-func (r *TemplateRegistry) Register(factory TemplateFactory) {
+func (r *templateRegistry) Register(factory Factory) {
+	r.mu.Lock()
+	defer r.mu.Unlock()
 	r.factories[factory.Schema()] = factory
 }
 
 // CreateTemplateBySchema creates a template instance based on the schema found in the input
 // and returns a reader that can be used to render the template. The returned reader includes
 // both the data consumed during schema detection and the remaining unconsumed data.
-func (r *TemplateRegistry) CreateTemplateBySchema(reader io.Reader, renderBundle BundleRenderer) (Template, io.Reader, error) {
+func (r *templateRegistry) CreateTemplateBySchema(reader io.Reader, renderBundle BundleRenderer) (Template, io.Reader, error) {
 	schema, replayReader, err := detectSchema(reader)
 	if err != nil {
 		return nil, nil, err
 	}
 
+	r.mu.RLock()
 	factory, exists := r.factories[schema]
+	r.mu.RUnlock()
 	if !exists {
 		return nil, nil, &UnknownSchemaError{Schema: schema}
 	}
 
 	return factory.CreateTemplate(renderBundle), replayReader, nil
 }
 
-func (r *TemplateRegistry) CreateTemplateByType(templateType string, renderBundle BundleRenderer) (Template, error) {
+func (r *templateRegistry) CreateTemplateByType(templateType string, renderBundle BundleRenderer) (Template, error) {
+	r.mu.RLock()
 	factory, exists := r.factories[templateType]
+	r.mu.RUnlock()
 	if !exists {
 		return nil, &UnknownSchemaError{Schema: templateType}
 	}
@@ -74,7 +89,9 @@ func (r *TemplateRegistry) CreateTemplateByType(templateType string, renderBundl
 }
 
 // GetSupportedSchemas returns all supported schema identifiers
-func (r *TemplateRegistry) GetSupportedSchemas() []string {
+func (r *templateRegistry) GetSupportedSchemas() []string {
+	r.mu.RLock()
+	defer r.mu.RUnlock()
 	schemas := make([]string, 0, len(r.factories))
 	for schema := range r.factories {
 		schemas = append(schemas, schema)
@@ -86,7 +103,9 @@ func (r *TemplateRegistry) GetSupportedSchemas() []string {
 // GetSupportedTypes returns all supported template types
 // TODO: in future, might store the type separately from the schema
 // right now it's just the last part of the schema string
-func (r *TemplateRegistry) GetSupportedTypes() []string {
+func (r *templateRegistry) GetSupportedTypes() []string {
+	r.mu.RLock()
+	defer r.mu.RUnlock()
 	types := make([]string, 0, len(r.factories))
 	for schema := range r.factories {
 		types = append(types, schema[strings.LastIndex(schema, ".")+1:])
@@ -95,11 +114,18 @@ func (r *TemplateRegistry) GetSupportedTypes() []string {
 	return types
 }
 
-func (r *TemplateRegistry) HasSchema(schema string) bool {
+func (r *templateRegistry) HasSchema(schema string) bool {
+	r.mu.RLock()
+	defer r.mu.RUnlock()
 	_, exists := r.factories[schema]
 	return exists
 }
 
+func (r *templateRegistry) HasType(templateType string) bool {
+	types := r.GetSupportedTypes()
+	return slices.Contains(types, templateType)
+}
+
 // UnknownSchemaError is returned when a schema is not recognized
 type UnknownSchemaError struct {
 	Schema string