Skip to content

Commit 66e901c

Browse files
authored
[extension] Deprecate extension/auth in favor of extension/extensionauth (#12478)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description - Deprecates `extension/auth` in favor of `extension/extensionauth`. - Deprecates `extension/auth/authtest` in favor of `extension/auth/authtest`
1 parent 5812712 commit 66e901c

File tree

46 files changed

+692
-307
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+692
-307
lines changed

.chloggen/mx-psi_extensionauth.yaml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: deprecation
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
7+
component: extension/auth, extension/auth/authtest
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Deprecate extension/auth and the related test module in favor of extension/extensionauth
11+
12+
# One or more tracking issues or pull requests related to the change
13+
issues: [12478]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# Optional: The change log or logs in which this entry should be included.
21+
# e.g. '[user]' or '[user, api]'
22+
# Include 'user' if the change is relevant to end users.
23+
# Include 'api' if there is a change to a library API.
24+
# Default: '[user]'
25+
change_logs: [api]

cmd/builder/internal/builder/main_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ var replaceModules = []string{
7676
"/exporter/otlpexporter",
7777
"/exporter/otlphttpexporter",
7878
"/extension",
79-
"/extension/auth",
80-
"/extension/auth/authtest",
79+
"/extension/extensionauth",
80+
"/extension/extensionauth/extensionauthtest",
8181
"/extension/extensioncapabilities",
8282
"/extension/extensiontest",
8383
"/extension/zpagesextension",

cmd/otelcorecol/builder-config.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ replaces:
7676
- go.opentelemetry.io/collector/exporter/otlpexporter => ../../exporter/otlpexporter
7777
- go.opentelemetry.io/collector/exporter/otlphttpexporter => ../../exporter/otlphttpexporter
7878
- go.opentelemetry.io/collector/extension => ../../extension
79-
- go.opentelemetry.io/collector/extension/auth => ../../extension/auth
80-
- go.opentelemetry.io/collector/extension/auth/authtest => ../../extension/auth/authtest
79+
- go.opentelemetry.io/collector/extension/extensionauth => ../../extension/extensionauth
80+
- go.opentelemetry.io/collector/extension/extensionauth/extensionauthtest => ../../extension/extensionauth/extensionauthtest
8181
- go.opentelemetry.io/collector/extension/extensioncapabilities => ../../extension/extensioncapabilities
8282
- go.opentelemetry.io/collector/extension/extensiontest => ../../extension/extensiontest
8383
- go.opentelemetry.io/collector/extension/memorylimiterextension => ../../extension/memorylimiterextension

cmd/otelcorecol/go.mod

+3-3
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ require (
104104
go.opentelemetry.io/collector/exporter/exporterhelper/xexporterhelper v0.120.0 // indirect
105105
go.opentelemetry.io/collector/exporter/exportertest v0.120.0 // indirect
106106
go.opentelemetry.io/collector/exporter/xexporter v0.120.0 // indirect
107-
go.opentelemetry.io/collector/extension/auth v0.120.0 // indirect
107+
go.opentelemetry.io/collector/extension/extensionauth v0.120.0 // indirect
108108
go.opentelemetry.io/collector/extension/extensioncapabilities v0.120.0 // indirect
109109
go.opentelemetry.io/collector/extension/extensiontest v0.120.0 // indirect
110110
go.opentelemetry.io/collector/extension/xextension v0.120.0 // indirect
@@ -241,9 +241,9 @@ replace go.opentelemetry.io/collector/exporter/otlphttpexporter => ../../exporte
241241

242242
replace go.opentelemetry.io/collector/extension => ../../extension
243243

244-
replace go.opentelemetry.io/collector/extension/auth => ../../extension/auth
244+
replace go.opentelemetry.io/collector/extension/extensionauth => ../../extension/extensionauth
245245

246-
replace go.opentelemetry.io/collector/extension/auth/authtest => ../../extension/auth/authtest
246+
replace go.opentelemetry.io/collector/extension/extensionauth/extensionauthtest => ../../extension/extensionauth/extensionauthtest
247247

248248
replace go.opentelemetry.io/collector/extension/extensioncapabilities => ../../extension/extensioncapabilities
249249

config/configauth/configauth.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212
"fmt"
1313

1414
"go.opentelemetry.io/collector/component"
15-
"go.opentelemetry.io/collector/extension/auth"
15+
"go.opentelemetry.io/collector/extension/extensionauth"
1616
)
1717

1818
var (
@@ -27,11 +27,11 @@ type Authentication struct {
2727
AuthenticatorID component.ID `mapstructure:"authenticator"`
2828
}
2929

30-
// GetServerAuthenticator attempts to select the appropriate auth.Server from the list of extensions,
30+
// GetServerAuthenticator attempts to select the appropriate extensionauth.Server from the list of extensions,
3131
// based on the requested extension name. If an authenticator is not found, an error is returned.
32-
func (a Authentication) GetServerAuthenticator(_ context.Context, extensions map[component.ID]component.Component) (auth.Server, error) {
32+
func (a Authentication) GetServerAuthenticator(_ context.Context, extensions map[component.ID]component.Component) (extensionauth.Server, error) {
3333
if ext, found := extensions[a.AuthenticatorID]; found {
34-
if server, ok := ext.(auth.Server); ok {
34+
if server, ok := ext.(extensionauth.Server); ok {
3535
return server, nil
3636
}
3737
return nil, errNotServer
@@ -40,12 +40,12 @@ func (a Authentication) GetServerAuthenticator(_ context.Context, extensions map
4040
return nil, fmt.Errorf("failed to resolve authenticator %q: %w", a.AuthenticatorID, errAuthenticatorNotFound)
4141
}
4242

43-
// GetClientAuthenticator attempts to select the appropriate auth.Client from the list of extensions,
43+
// GetClientAuthenticator attempts to select the appropriate extensionauth.Client from the list of extensions,
4444
// based on the component id of the extension. If an authenticator is not found, an error is returned.
4545
// This should be only used by HTTP clients.
46-
func (a Authentication) GetClientAuthenticator(_ context.Context, extensions map[component.ID]component.Component) (auth.Client, error) {
46+
func (a Authentication) GetClientAuthenticator(_ context.Context, extensions map[component.ID]component.Component) (extensionauth.Client, error) {
4747
if ext, found := extensions[a.AuthenticatorID]; found {
48-
if client, ok := ext.(auth.Client); ok {
48+
if client, ok := ext.(extensionauth.Client); ok {
4949
return client, nil
5050
}
5151
return nil, errNotClient

config/configauth/configauth_test.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212

1313
"go.opentelemetry.io/collector/component"
1414
"go.opentelemetry.io/collector/extension"
15-
"go.opentelemetry.io/collector/extension/auth"
15+
"go.opentelemetry.io/collector/extension/extensionauth"
1616
)
1717

1818
var mockID = component.MustNewID("mock")
@@ -25,12 +25,12 @@ func TestGetServer(t *testing.T) {
2525
}{
2626
{
2727
name: "obtain server authenticator",
28-
authenticator: auth.NewServer(),
28+
authenticator: extensionauth.NewServer(),
2929
expected: nil,
3030
},
3131
{
3232
name: "not a server authenticator",
33-
authenticator: auth.NewClient(),
33+
authenticator: extensionauth.NewClient(),
3434
expected: errNotServer,
3535
},
3636
}
@@ -76,12 +76,12 @@ func TestGetClient(t *testing.T) {
7676
}{
7777
{
7878
name: "obtain client authenticator",
79-
authenticator: auth.NewClient(),
79+
authenticator: extensionauth.NewClient(),
8080
expected: nil,
8181
},
8282
{
8383
name: "not a client authenticator",
84-
authenticator: auth.NewServer(),
84+
authenticator: extensionauth.NewServer(),
8585
expected: errNotClient,
8686
},
8787
}

config/configauth/go.mod

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ require (
66
github.com/stretchr/testify v1.10.0
77
go.opentelemetry.io/collector/component v0.120.0
88
go.opentelemetry.io/collector/extension v0.120.0
9-
go.opentelemetry.io/collector/extension/auth v0.120.0
9+
go.opentelemetry.io/collector/extension/extensionauth v0.120.0
1010
go.uber.org/goleak v1.3.0
1111
)
1212

@@ -37,4 +37,4 @@ replace go.opentelemetry.io/collector/component/componenttest => ../../component
3737

3838
replace go.opentelemetry.io/collector/extension => ../../extension
3939

40-
replace go.opentelemetry.io/collector/extension/auth => ../../extension/auth
40+
replace go.opentelemetry.io/collector/extension/extensionauth => ../../extension/extensionauth

config/configgrpc/configgrpc.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import (
3434
"go.opentelemetry.io/collector/config/confignet"
3535
"go.opentelemetry.io/collector/config/configopaque"
3636
"go.opentelemetry.io/collector/config/configtls"
37-
"go.opentelemetry.io/collector/extension/auth"
37+
"go.opentelemetry.io/collector/extension/extensionauth"
3838
)
3939

4040
var errMetadataNotFound = errors.New("no request metadata found")
@@ -561,7 +561,7 @@ func contextWithClient(ctx context.Context, includeMetadata bool) context.Contex
561561
return client.NewContext(ctx, cl)
562562
}
563563

564-
func authUnaryServerInterceptor(ctx context.Context, req any, _ *grpc.UnaryServerInfo, handler grpc.UnaryHandler, server auth.Server) (any, error) {
564+
func authUnaryServerInterceptor(ctx context.Context, req any, _ *grpc.UnaryServerInfo, handler grpc.UnaryHandler, server extensionauth.Server) (any, error) {
565565
headers, ok := metadata.FromIncomingContext(ctx)
566566
if !ok {
567567
return nil, errMetadataNotFound
@@ -575,7 +575,7 @@ func authUnaryServerInterceptor(ctx context.Context, req any, _ *grpc.UnaryServe
575575
return handler(ctx, req)
576576
}
577577

578-
func authStreamServerInterceptor(srv any, stream grpc.ServerStream, _ *grpc.StreamServerInfo, handler grpc.StreamHandler, server auth.Server) error {
578+
func authStreamServerInterceptor(srv any, stream grpc.ServerStream, _ *grpc.StreamServerInfo, handler grpc.StreamHandler, server extensionauth.Server) error {
579579
ctx := stream.Context()
580580
headers, ok := metadata.FromIncomingContext(ctx)
581581
if !ok {

config/configgrpc/configgrpc_test.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ import (
2929
"go.opentelemetry.io/collector/config/confignet"
3030
"go.opentelemetry.io/collector/config/configopaque"
3131
"go.opentelemetry.io/collector/config/configtls"
32-
"go.opentelemetry.io/collector/extension/auth"
33-
"go.opentelemetry.io/collector/extension/auth/authtest"
32+
"go.opentelemetry.io/collector/extension/extensionauth"
33+
"go.opentelemetry.io/collector/extension/extensionauth/extensionauthtest"
3434
"go.opentelemetry.io/collector/pdata/ptrace/ptraceotlp"
3535
)
3636

@@ -164,7 +164,7 @@ func TestAllGrpcClientSettings(t *testing.T) {
164164
},
165165
host: &mockHost{
166166
ext: map[component.ID]component.Component{
167-
testAuthID: &authtest.MockClient{},
167+
testAuthID: &extensionauthtest.MockClient{},
168168
},
169169
},
170170
},
@@ -193,7 +193,7 @@ func TestAllGrpcClientSettings(t *testing.T) {
193193
},
194194
host: &mockHost{
195195
ext: map[component.ID]component.Component{
196-
testAuthID: &authtest.MockClient{},
196+
testAuthID: &extensionauthtest.MockClient{},
197197
},
198198
},
199199
},
@@ -222,7 +222,7 @@ func TestAllGrpcClientSettings(t *testing.T) {
222222
},
223223
host: &mockHost{
224224
ext: map[component.ID]component.Component{
225-
testAuthID: &authtest.MockClient{},
225+
testAuthID: &extensionauthtest.MockClient{},
226226
},
227227
},
228228
},
@@ -401,7 +401,7 @@ func TestGrpcServerAuthSettings(t *testing.T) {
401401
}
402402
host := &mockHost{
403403
ext: map[component.ID]component.Component{
404-
mockID: auth.NewServer(),
404+
mockID: extensionauth.NewServer(),
405405
},
406406
}
407407
srv, err := gss.ToServer(context.Background(), host, componenttest.NewNopTelemetrySettings())
@@ -976,7 +976,7 @@ func TestDefaultUnaryInterceptorAuthSucceeded(t *testing.T) {
976976
ctx := metadata.NewIncomingContext(context.Background(), metadata.Pairs("authorization", "some-auth-data"))
977977

978978
// test
979-
res, err := authUnaryServerInterceptor(ctx, nil, &grpc.UnaryServerInfo{}, handler, auth.NewServer(auth.WithServerAuthenticate(authFunc)))
979+
res, err := authUnaryServerInterceptor(ctx, nil, &grpc.UnaryServerInfo{}, handler, extensionauth.NewServer(extensionauth.WithServerAuthenticate(authFunc)))
980980

981981
// verify
982982
assert.Nil(t, res)
@@ -1000,7 +1000,7 @@ func TestDefaultUnaryInterceptorAuthFailure(t *testing.T) {
10001000
ctx := metadata.NewIncomingContext(context.Background(), metadata.Pairs("authorization", "some-auth-data"))
10011001

10021002
// test
1003-
res, err := authUnaryServerInterceptor(ctx, nil, &grpc.UnaryServerInfo{}, handler, auth.NewServer(auth.WithServerAuthenticate(authFunc)))
1003+
res, err := authUnaryServerInterceptor(ctx, nil, &grpc.UnaryServerInfo{}, handler, extensionauth.NewServer(extensionauth.WithServerAuthenticate(authFunc)))
10041004

10051005
// verify
10061006
assert.Nil(t, res)
@@ -1021,7 +1021,7 @@ func TestDefaultUnaryInterceptorMissingMetadata(t *testing.T) {
10211021
}
10221022

10231023
// test
1024-
res, err := authUnaryServerInterceptor(context.Background(), nil, &grpc.UnaryServerInfo{}, handler, auth.NewServer(auth.WithServerAuthenticate(authFunc)))
1024+
res, err := authUnaryServerInterceptor(context.Background(), nil, &grpc.UnaryServerInfo{}, handler, extensionauth.NewServer(extensionauth.WithServerAuthenticate(authFunc)))
10251025

10261026
// verify
10271027
assert.Nil(t, res)
@@ -1052,7 +1052,7 @@ func TestDefaultStreamInterceptorAuthSucceeded(t *testing.T) {
10521052
}
10531053

10541054
// test
1055-
err := authStreamServerInterceptor(nil, streamServer, &grpc.StreamServerInfo{}, handler, auth.NewServer(auth.WithServerAuthenticate(authFunc)))
1055+
err := authStreamServerInterceptor(nil, streamServer, &grpc.StreamServerInfo{}, handler, extensionauth.NewServer(extensionauth.WithServerAuthenticate(authFunc)))
10561056

10571057
// verify
10581058
require.NoError(t, err)
@@ -1078,7 +1078,7 @@ func TestDefaultStreamInterceptorAuthFailure(t *testing.T) {
10781078
}
10791079

10801080
// test
1081-
err := authStreamServerInterceptor(nil, streamServer, &grpc.StreamServerInfo{}, handler, auth.NewServer(auth.WithServerAuthenticate(authFunc)))
1081+
err := authStreamServerInterceptor(nil, streamServer, &grpc.StreamServerInfo{}, handler, extensionauth.NewServer(extensionauth.WithServerAuthenticate(authFunc)))
10821082

10831083
// verify
10841084
require.ErrorContains(t, err, expectedErr.Error()) // unfortunately, grpc errors don't wrap the original ones
@@ -1101,7 +1101,7 @@ func TestDefaultStreamInterceptorMissingMetadata(t *testing.T) {
11011101
}
11021102

11031103
// test
1104-
err := authStreamServerInterceptor(nil, streamServer, &grpc.StreamServerInfo{}, handler, auth.NewServer(auth.WithServerAuthenticate(authFunc)))
1104+
err := authStreamServerInterceptor(nil, streamServer, &grpc.StreamServerInfo{}, handler, extensionauth.NewServer(extensionauth.WithServerAuthenticate(authFunc)))
11051105

11061106
// verify
11071107
assert.Equal(t, errMetadataNotFound, err)

config/configgrpc/go.mod

+4-4
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ require (
1313
go.opentelemetry.io/collector/config/confignet v1.26.0
1414
go.opentelemetry.io/collector/config/configopaque v1.26.0
1515
go.opentelemetry.io/collector/config/configtls v1.26.0
16-
go.opentelemetry.io/collector/extension/auth v0.120.0
17-
go.opentelemetry.io/collector/extension/auth/authtest v0.120.0
16+
go.opentelemetry.io/collector/extension/extensionauth v0.120.0
17+
go.opentelemetry.io/collector/extension/extensionauth/extensionauthtest v0.120.0
1818
go.opentelemetry.io/collector/pdata v1.26.0
1919
go.opentelemetry.io/collector/pdata/testdata v0.120.0
2020
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.59.0
@@ -67,7 +67,7 @@ replace go.opentelemetry.io/collector/config/configtls => ../configtls
6767

6868
replace go.opentelemetry.io/collector/extension => ../../extension
6969

70-
replace go.opentelemetry.io/collector/extension/auth => ../../extension/auth
70+
replace go.opentelemetry.io/collector/extension/extensionauth => ../../extension/extensionauth
7171

7272
replace go.opentelemetry.io/collector/pdata => ../../pdata
7373

@@ -81,4 +81,4 @@ replace go.opentelemetry.io/collector/component/componenttest => ../../component
8181

8282
replace go.opentelemetry.io/collector/consumer => ../../consumer
8383

84-
replace go.opentelemetry.io/collector/extension/auth/authtest => ../../extension/auth/authtest
84+
replace go.opentelemetry.io/collector/extension/extensionauth/extensionauthtest => ../../extension/extensionauth/extensionauthtest

config/confighttp/confighttp.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import (
2929
"go.opentelemetry.io/collector/config/confighttp/internal"
3030
"go.opentelemetry.io/collector/config/configopaque"
3131
"go.opentelemetry.io/collector/config/configtls"
32-
"go.opentelemetry.io/collector/extension/auth"
32+
"go.opentelemetry.io/collector/extension/extensionauth"
3333
)
3434

3535
const (
@@ -537,7 +537,7 @@ func NewDefaultCORSConfig() *CORSConfig {
537537
return &CORSConfig{}
538538
}
539539

540-
func authInterceptor(next http.Handler, server auth.Server, requestParams []string) http.Handler {
540+
func authInterceptor(next http.Handler, server extensionauth.Server, requestParams []string) http.Handler {
541541
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
542542
sources := r.Header
543543
query := r.URL.Query()

0 commit comments

Comments
 (0)