Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove configauth default, use nil in configgrpc default #12271

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .chloggen/configauth-remove-default.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: breaking

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: configauth

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Remove NewDefaultAuthentication

# One or more tracking issues or pull requests related to the change
issues: [12223]

# (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: |
The value returned by this function will always cause an error on startup.
In `configgrpc.Client/ServerConfig.Auth`, `nil` should be used instead to disable authentication.

# 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]
26 changes: 26 additions & 0 deletions .chloggen/configgrpc-noauth-default.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: configgrpc

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "Set Auth to nil in NewDefaultClientConfig/NewDefaultServerConfig"

# One or more tracking issues or pull requests related to the change
issues: [12223]

# (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: |
The value that was used previously would always cause an error on startup.

# 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]
5 changes: 0 additions & 5 deletions config/configauth/configauth.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,6 @@ type Authentication struct {
AuthenticatorID component.ID `mapstructure:"authenticator"`
}

// NewDefaultAuthentication returns a default authentication configuration.
func NewDefaultAuthentication() *Authentication {
return &Authentication{}
}

// GetServerAuthenticator attempts to select the appropriate auth.Server from the list of extensions,
// based on the requested extension name. If an authenticator is not found, an error is returned.
func (a Authentication) GetServerAuthenticator(_ context.Context, extensions map[component.ID]component.Component) (auth.Server, error) {
Expand Down
6 changes: 0 additions & 6 deletions config/configauth/configauth_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,6 @@ import (

var mockID = component.MustNewID("mock")

func TestNewDefaultAuthentication(t *testing.T) {
auth := NewDefaultAuthentication()
assert.NotNil(t, auth)
assert.Empty(t, auth)
}

func TestGetServer(t *testing.T) {
testCases := []struct {
name string
Expand Down
2 changes: 0 additions & 2 deletions config/configgrpc/configgrpc.go
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@ func NewDefaultClientConfig() *ClientConfig {
return &ClientConfig{
TLSSetting: configtls.NewDefaultClientConfig(),
Keepalive: NewDefaultKeepaliveClientConfig(),
Auth: configauth.NewDefaultAuthentication(),
BalancerName: BalancerName(),
}
}
Expand Down Expand Up @@ -196,7 +195,6 @@ type ServerConfig struct {
func NewDefaultServerConfig() *ServerConfig {
return &ServerConfig{
Keepalive: NewDefaultKeepaliveServerConfig(),
Auth: configauth.NewDefaultAuthentication(),
}
}

Expand Down
2 changes: 0 additions & 2 deletions config/configgrpc/configgrpc_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ func TestNewDefaultClientConfig(t *testing.T) {
expected := &ClientConfig{
TLSSetting: configtls.NewDefaultClientConfig(),
Keepalive: NewDefaultKeepaliveClientConfig(),
Auth: configauth.NewDefaultAuthentication(),
BalancerName: BalancerName(),
}

Expand Down Expand Up @@ -83,7 +82,6 @@ func TestNewDefaultKeepaliveServerConfig(t *testing.T) {
func TestNewDefaultServerConfig(t *testing.T) {
expected := &ServerConfig{
Keepalive: NewDefaultKeepaliveServerConfig(),
Auth: configauth.NewDefaultAuthentication(),
}

result := NewDefaultServerConfig()
Expand Down
Loading