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

[confignet] added NewDefaultFunctions #9671

Merged
merged 5 commits into from
Mar 20, 2024
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
25 changes: 25 additions & 0 deletions .chloggen/confignet-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: confignet

# 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: [9656]

# (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]
19 changes: 19 additions & 0 deletions config/confignet/confignet.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ type DialerConfig struct {
Timeout time.Duration `mapstructure:"timeout"`
}

// NewDefaultDialerConfig creates a new DialerConfig with any default values set
func NewDefaultDialerConfig() DialerConfig {
return DialerConfig{}
}

// AddrConfig represents a network endpoint address.
type AddrConfig struct {
// Endpoint configures the address for this network connection.
Expand All @@ -33,6 +38,13 @@ type AddrConfig struct {
DialerConfig DialerConfig `mapstructure:"dialer"`
}

// NewDefaultAddrConfig creates a new AddrConfig with any default values set
func NewDefaultAddrConfig() AddrConfig {
Sanket-0510 marked this conversation as resolved.
Show resolved Hide resolved
return AddrConfig{
DialerConfig: NewDefaultDialerConfig(),
}
}

// Dial equivalent with net.Dialer's DialContext for this address.
func (na *AddrConfig) Dial(ctx context.Context) (net.Conn, error) {
d := net.Dialer{Timeout: na.DialerConfig.Timeout}
Expand All @@ -58,6 +70,13 @@ type TCPAddrConfig struct {
DialerConfig DialerConfig `mapstructure:"dialer"`
}

// NewDefaultTCPAddrConfig creates a new TCPAddrConfig with any default values set
func NewDefaultTCPAddrConfig() TCPAddrConfig {
return TCPAddrConfig{
DialerConfig: NewDefaultDialerConfig(),
}
}

// Dial equivalent with net.Dialer's DialContext for this address.
func (na *TCPAddrConfig) Dial(ctx context.Context) (net.Conn, error) {
d := net.Dialer{Timeout: na.DialerConfig.Timeout}
Expand Down
19 changes: 19 additions & 0 deletions config/confignet/confignet_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,27 @@ import (
"time"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestNewDefaultDialerConfig(t *testing.T) {
expectedDialerConfig := DialerConfig{}
dialerConfig := NewDefaultDialerConfig()
require.Equal(t, expectedDialerConfig, dialerConfig)
}

func TestNewDefaultAddrConfig(t *testing.T) {
expectedAddrConfig := AddrConfig{}
addrConfig := NewDefaultAddrConfig()
require.Equal(t, expectedAddrConfig, addrConfig)
}

func TestNewDefaultTCPAddrConfig(t *testing.T) {
expectedTCPAddrConfig := TCPAddrConfig{}
tcpAddrconfig := NewDefaultTCPAddrConfig()
require.Equal(t, expectedTCPAddrConfig, tcpAddrconfig)
}

func TestAddrConfigTimeout(t *testing.T) {
nac := &AddrConfig{
Endpoint: "localhost:0",
Expand Down
Loading