Skip to content

Commit 5e20bbd

Browse files
AkhigbeEromoTylerHelmuthcodeboten
authored
Added default functions for configauth (#9850)
Description: Added NewDefault methods for structs in `configauth` package Link to tracking Issue: Closes #9821 Testing: Tests were added for the NewDefault functions --------- Co-authored-by: Tyler Helmuth <[email protected]> Co-authored-by: Alex Boten <[email protected]>
1 parent 4f26784 commit 5e20bbd

File tree

3 files changed

+36
-0
lines changed

3 files changed

+36
-0
lines changed
Lines changed: 25 additions & 0 deletions
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: enhancement
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
7+
component: configauth
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Adds `NewDefault*` functions for all the config structs.
11+
12+
# One or more tracking issues or pull requests related to the change
13+
issues: [9821]
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]

config/configauth/configauth.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ type Authentication struct {
2626
AuthenticatorID component.ID `mapstructure:"authenticator"`
2727
}
2828

29+
// NewDefaultAuthentication returns a default authentication configuration.
30+
func NewDefaultAuthentication() *Authentication {
31+
return &Authentication{}
32+
}
33+
2934
// GetServerAuthenticator attempts to select the appropriate auth.Server from the list of extensions,
3035
// based on the requested extension name. If an authenticator is not found, an error is returned.
3136
func (a Authentication) GetServerAuthenticator(extensions map[component.ID]component.Component) (auth.Server, error) {

config/configauth/configauth_test.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ import (
1515

1616
var mockID = component.MustNewID("mock")
1717

18+
func TestNewDefaultAuthentication(t *testing.T) {
19+
auth := NewDefaultAuthentication()
20+
assert.NotNil(t, auth)
21+
assert.Empty(t, auth)
22+
}
23+
1824
func TestGetServer(t *testing.T) {
1925
testCases := []struct {
2026
desc string

0 commit comments

Comments
 (0)