Skip to content

Added default functions for configauth #9850

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

25 changes: 25 additions & 0 deletions .chloggen/configauth-add-NewDefault-func.yaml
Original file line number Diff line number Diff line change
@@ -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: enhancement

# 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: Adds `NewDefault*` functions for all the config structs.

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

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

// DefaultAuthentication 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(extensions map[component.ID]component.Component) (auth.Server, error) {
Expand Down
6 changes: 6 additions & 0 deletions config/configauth/configauth_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ 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 {
desc string
Expand Down