Use Err prefix for always return error implementation

Signed-off-by: Bogdan Drutu <[email protected]>

Author: bogdandrutu

.chloggen/use-err.yaml

@@ -0,0 +1,25 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: deprecation
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: extensionauthtest
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Deprecate NewErrorClient in favor of NewErrClient.
+
+# One or more tracking issues or pull requests related to the change
+issues: []
+
+# (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:
+
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [api]

config/confighttp/confighttp_test.go

@@ -455,7 +455,7 @@ func TestHTTPClientSettingWithAuthConfig(t *testing.T) {
 			shouldErr: true,
 			host: &mockHost{
 				ext: map[component.ID]component.Component{
-					mockID: extensionauthtest.NewErrorClient(errors.New("error")),
+					mockID: extensionauthtest.NewErrClient(errors.New("error")),
 				},
 			},
 		},

extension/extensionauth/extensionauthtest/error_client.go renamed to extension/extensionauth/extensionauthtest/err_client.go

@@ -14,21 +14,24 @@ import (
 )
 
 var (
-	_ extension.Extension      = (*errorClient)(nil)
-	_ extensionauth.HTTPClient = (*errorClient)(nil)
-	_ extensionauth.GRPCClient = (*errorClient)(nil)
+	_ extension.Extension      = (*errClient)(nil)
+	_ extensionauth.HTTPClient = (*errClient)(nil)
+	_ extensionauth.GRPCClient = (*errClient)(nil)
 )
 
-type errorClient struct {
+type errClient struct {
 	component.StartFunc
 	component.ShutdownFunc
 	extensionauth.ClientPerRPCCredentialsFunc
 	extensionauth.ClientRoundTripperFunc
 }
 
-// NewErrorClient returns a new [extension.Extension] that implements the [extensionauth.HTTPClient] and [extensionauth.GRPCClient] and always returns an error on both methods.
-func NewErrorClient(err error) extension.Extension {
-	return &errorClient{
+// Deprecated: [v0.125.0] Use NewErrClient.
+var NewErrorClient = NewErrClient
+
+// NewErrClient returns a new [extension.Extension] that implements the [extensionauth.HTTPClient] and [extensionauth.GRPCClient] and always returns an error on both methods.
+func NewErrClient(err error) extension.Extension {
+	return &errClient{
 		ClientRoundTripperFunc: func(http.RoundTripper) (http.RoundTripper, error) {
 			return nil, err
 		},

extension/extensionauth/extensionauthtest/error_client_test.go renamed to extension/extensionauth/extensionauthtest/err_client_test.go

@@ -13,7 +13,7 @@ import (
 )
 
 func TestErrorClient(t *testing.T) {
-	client := NewErrorClient(errors.New("error"))
+	client := NewErrClient(errors.New("error"))
 
 	httpClient, ok := client.(extensionauth.HTTPClient)
 	require.True(t, ok)