Migrate from otelcoltest.LoadConfigAndValidate to otelcoltest.LoadConfigAndValidateWithSettings

[djaglowski]

Component(s)

No response

Describe the issue you're reporting

otelcoltest.LoadConfigAndValidate is deprecated in favor of otelcoltest.LoadConfigAndValidateWithSettings in the latest core.

[djaglowski]

Is there a better way to migrate than changing the following?

- _, err = otelcoltest.LoadConfigAndValidateWithSettings(filepath.Join("testdata", test.file), factories)
- require.ErrorContains(t, err, test.contains)

+ cfg, err := otelcoltest.LoadConfigWithSettings(factories, otelcol.ConfigProviderSettings{
+ 	ResolverSettings: confmap.ResolverSettings{
+ 		URIs: []string{filepath.Join("testdata", test.file)},
+ 		ProviderFactories: []confmap.ProviderFactory{
+ 			fileprovider.NewFactory(),
+ 			envprovider.NewFactory(),
+ 			yamlprovider.NewFactory(),
+ 			httpprovider.NewFactory(),
+ 		},
+ 		ConverterFactories: []confmap.ConverterFactory{expandconverter.NewFactory()},
+ 	},
+ })
+ require.NoError(t, err)
+ require.ErrorContains(t, cfg.Validate(), test.contains)

[TylerHelmuth]

As part of open-telemetry/opentelemetry-collector#10290 we're trying to get providers and converters out of otelcol. Your solution looks correct. Maybe a better experience would be to make otelcoltest its own package so it can import that providers/converters without otelcol needing to.

To unblock the release I see 3 options.

1. move forward with the current deprecation process and add the ConfigProviderSettings everywhere.
2. revert the changes made to otelcoltest, duplicate it into a new package, deprecate the otelcoltest that lives in otelcol.
3. reproduce otelcoltest in contrib's internal, and deal how we want otelcoltest to work later.

[github-actions]

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.