remove component.Type cast for Providers and converters list. Update command with explicit yaml mapping instructions

Author: jackgopack4

.chloggen/jackgopack4-add-converters-component-command.yaml

@@ -15,7 +15,7 @@ issues: [11900, 12385]
 # (Optional) One or more lines of additional information to render under the primary note.
 # These lines will be padded with 2 spaces and then inserted directly into the document.
 # Use pipe (|) for multiline entries.
-subtext: Converters must now implement the "Type()" function to return type
+subtext: buildinfo in components command is now reported as "build_info" for ease of reading.
 
 # Optional: The change log or logs in which this entry should be included.
 # e.g. '[user]' or '[user, api]'

cmd/builder/internal/builder/templates/main.go.tmpl

@@ -45,13 +45,13 @@ func main() {
 				DefaultScheme: "{{ .ConfResolver.DefaultURIScheme }}",
 				{{- end }}
 			},
-		}, ProviderModules: map[component.Type]string{
+		}, ProviderModules: map[string]string{
 			{{- range .ConfmapProviders}}
-			component.MustNewType({{.Name}}.NewFactory().Create(confmap.ProviderSettings{}).Scheme()): "{{.GoMod}}",
+			{{.Name}}.NewFactory().Create(confmap.ProviderSettings{}).Scheme(): "{{.GoMod}}",
 			{{- end}}
-    }, ConverterModules: map[component.Type]string{
+    }, ConverterModules: map[string]string{
 		  {{- range .ConfmapConverters}}
-			component.MustNewType({{.Name}}.NewFactory().Create(confmap.ConverterSettings{}).Type()): "{{.GoMod}}",
+			{{.Name}}: "{{.GoMod}}",
 			{{- end}}
 		},
 

cmd/otelcorecol/main.go

@@ -35,6 +35,4 @@ func NewConverterFactory(f CreateConverterFunc) ConverterFactory {
 type Converter interface {
 	// Convert applies the conversion logic to the given "conf".
 	Convert(ctx context.Context, conf *Conf) error
-	// Type returns the type of the converter.
-	Type() string
 }

confmap/converter.go

@@ -106,18 +106,13 @@ func (f *fakeProvider) Shutdown(context.Context) error {
 }
 
 type mockConverter struct {
-	err               error
-	mockConverterType string
+	err error
 }
 
 func (m *mockConverter) Convert(context.Context, *Conf) error {
 	return errors.New("converter_err")
 }
 
-func (m *mockConverter) Type() string {
-	return m.mockConverterType
-}
-
 func TestNewResolverInvalidSchemeInURI(t *testing.T) {
 	_, err := NewResolver(ResolverSettings{URIs: []string{"s_3:has invalid char"}, ProviderFactories: []ProviderFactory{newMockProvider(&mockProvider{scheme: "s3"})}})
 	assert.EqualError(t, err, `invalid uri: "s_3:has invalid char"`)
@@ -179,7 +174,7 @@ func TestResolverErrors(t *testing.T) {
 			name:             "converter error",
 			locations:        []string{"mock:"},
 			providers:        []Provider{&mockProvider{}},
-			converters:       []Converter{&mockConverter{err: errors.New("converter_err"), mockConverterType: "mock"}},
+			converters:       []Converter{&mockConverter{err: errors.New("converter_err")}},
 			expectResolveErr: true,
 		},
 		{

confmap/resolver_test.go

@@ -70,10 +70,10 @@ type CollectorSettings struct {
 	ConfigProviderSettings ConfigProviderSettings
 
 	// ProviderModules maps provider schemes to their respective go modules.
-	ProviderModules map[component.Type]string
+	ProviderModules map[string]string
 
 	// ConverterModules maps converter names to their respective go modules.
-	ConverterModules map[component.Type]string
+	ConverterModules map[string]string
 
 	// LoggingOptions provides a way to change behavior of zap logging.
 	LoggingOptions []zap.Option

otelcol/collector.go

@@ -600,22 +600,22 @@ func TestProviderAndConverterModules(t *testing.T) {
 		BuildInfo:              component.NewDefaultBuildInfo(),
 		Factories:              nopFactories,
 		ConfigProviderSettings: newDefaultConfigProviderSettings(t, []string{filepath.Join("testdata", "otelcol-nop.yaml")}),
-		ProviderModules: map[component.Type]string{
-			component.MustNewType("nop"): "go.opentelemetry.io/collector/confmap/provider/testprovider v1.2.3",
+		ProviderModules: map[string]string{
+			"nop": "go.opentelemetry.io/collector/confmap/provider/testprovider v1.2.3",
 		},
-		ConverterModules: map[component.Type]string{
-			component.MustNewType("nopconverter"): "go.opentelemetry.io/collector/converter/testconverter v1.2.3",
+		ConverterModules: map[string]string{
+			"nopconverter": "go.opentelemetry.io/collector/converter/testconverter v1.2.3",
 		},
 	}
 	col, err := NewCollector(set)
 	require.NoError(t, err)
 	wg := startCollector(context.Background(), t, col)
 	require.NoError(t, err)
-	providerModules := map[component.Type]string{
-		component.MustNewType("nop"): "go.opentelemetry.io/collector/confmap/provider/testprovider v1.2.3",
+	providerModules := map[string]string{
+		"nop": "go.opentelemetry.io/collector/confmap/provider/testprovider v1.2.3",
 	}
-	converterModules := map[component.Type]string{
-		component.MustNewType("nopconverter"): "go.opentelemetry.io/collector/converter/testconverter v1.2.3",
+	converterModules := map[string]string{
+		"nopconverter": "go.opentelemetry.io/collector/converter/testconverter v1.2.3",
 	}
 	assert.Equal(t, providerModules, col.set.ProviderModules)
 	assert.Equal(t, converterModules, col.set.ConverterModules)

otelcol/collector_test.go

@@ -19,25 +19,26 @@ import (
 )
 
 type componentWithStability struct {
-	Name      component.Type
-	Module    string
-	Stability map[string]string
+	Name      component.Type    `yaml:"name"`
+	Module    string            `yaml:"module"`
+	Stability map[string]string `yaml:"stability"`
 }
 
 type componentWithoutStability struct {
-	Scheme string
-	Module string
+	Name   string `yaml:"name,omitempty"`
+	Scheme string `yaml:"scheme,omitempty"`
+	Module string `yaml:"module"`
 }
 
 type componentsOutput struct {
-	BuildInfo  component.BuildInfo
-	Receivers  []componentWithStability
-	Processors []componentWithStability
-	Exporters  []componentWithStability
-	Connectors []componentWithStability
-	Extensions []componentWithStability
-	Providers  []componentWithoutStability
-	Converters []componentWithoutStability
+	BuildInfo  component.BuildInfo         `yaml:"build_info"`
+	Receivers  []componentWithStability    `yaml:"receivers"`
+	Processors []componentWithStability    `yaml:"processors"`
+	Exporters  []componentWithStability    `yaml:"exporters"`
+	Connectors []componentWithStability    `yaml:"connectors"`
+	Extensions []componentWithStability    `yaml:"extensions"`
+	Providers  []componentWithoutStability `yaml:"providers"`
+	Converters []componentWithoutStability `yaml:"converters,omitempty"`
 }
 
 // newComponentsCommand constructs a new components command using the given CollectorSettings.
@@ -119,14 +120,14 @@ func newComponentsCommand(set CollectorSettings) *cobra.Command {
 
 			for providerScheme, providerModuleModule := range set.ProviderModules {
 				components.Providers = append(components.Providers, componentWithoutStability{
-					Scheme: providerScheme.String(),
+					Scheme: providerScheme,
 					Module: providerModuleModule,
 				})
 			}
 
-			for converterType, converterModule := range set.ConverterModules {
+			for converterName, converterModule := range set.ConverterModules {
 				components.Converters = append(components.Converters, componentWithoutStability{
-					Scheme: converterType.String(),
+					Name:   converterName,
 					Module: converterModule,
 				})
 			}

otelcol/command_components.go

@@ -21,11 +21,11 @@ func TestNewBuildSubCommand(t *testing.T) {
 		BuildInfo:              component.NewDefaultBuildInfo(),
 		Factories:              nopFactories,
 		ConfigProviderSettings: newDefaultConfigProviderSettings(t, []string{filepath.Join("testdata", "otelcol-nop.yaml")}),
-		ProviderModules: map[component.Type]string{
-			component.MustNewType("nop"): "go.opentelemetry.io/collector/confmap/provider/testprovider v1.2.3",
+		ProviderModules: map[string]string{
+			"nop": "go.opentelemetry.io/collector/confmap/provider/testprovider v1.2.3",
 		},
-		ConverterModules: map[component.Type]string{
-			component.MustNewType("nopconverter"): "go.opentelemetry.io/collector/converter/testconverter v1.2.3",
+		ConverterModules: map[string]string{
+			"nopconverter": "go.opentelemetry.io/collector/converter/testconverter v1.2.3",
 		},
 	}
 	cmd := NewCommand(set)

otelcol/command_components_test.go

@@ -1,4 +1,4 @@
-buildinfo:
+build_info:
     command: otelcol
     description: OpenTelemetry Collector
     version: latest
@@ -45,5 +45,5 @@ providers:
     - scheme: nop
       module: go.opentelemetry.io/collector/confmap/provider/testprovider v1.2.3
 converters:
-    - scheme: nopconverter
+    - name: nopconverter
       module: go.opentelemetry.io/collector/converter/testconverter v1.2.3