Skip to content

Commit

Permalink
[receiver/riak] Change the type of Config.Password to be `configopa…
Browse files Browse the repository at this point in the history
…que.String` (open-telemetry#24062)

**Description:**
Split out from: #17353

**Link to tracking Issue:** #17273
  • Loading branch information
mackjmr committed Jul 20, 2023
1 parent 6389064 commit 91d1cd8
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 4 deletions.
20 changes: 20 additions & 0 deletions .chloggen/riak-use-configopaque.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Use this changelog template to create an entry for release notes.
# If your change doesn't affect end users, such as a test fix or a tooling change,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.

# 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. filelogreceiver)
component: receiver/riak

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Change the type of `Config.Password` to be `configopaque.String`

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [17273]

# (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:
2 changes: 1 addition & 1 deletion receiver/riakreceiver/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ func newClient(cfg *Config, host component.Host, settings component.TelemetrySet
hostEndpoint: cfg.Endpoint,
creds: riakCredentials{
username: cfg.Username,
password: cfg.Password,
password: string(cfg.Password),
},
logger: logger,
}, nil
Expand Down
2 changes: 1 addition & 1 deletion receiver/riakreceiver/client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ func TestNewClient(t *testing.T) {
require.True(t, ok)

require.Equal(t, tc.cfg.Username, actualClient.creds.username)
require.Equal(t, tc.cfg.Password, actualClient.creds.password)
require.Equal(t, string(tc.cfg.Password), actualClient.creds.password)
require.Equal(t, tc.cfg.Endpoint, actualClient.hostEndpoint)
require.Equal(t, zap.NewNop(), actualClient.logger)
require.NotNil(t, actualClient.client)
Expand Down
3 changes: 2 additions & 1 deletion receiver/riakreceiver/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"net/url"

"go.opentelemetry.io/collector/config/confighttp"
"go.opentelemetry.io/collector/config/configopaque"
"go.opentelemetry.io/collector/receiver/scraperhelper"
"go.uber.org/multierr"

Expand All @@ -30,7 +31,7 @@ type Config struct {
scraperhelper.ScraperControllerSettings `mapstructure:",squash"`
confighttp.HTTPClientSettings `mapstructure:",squash"`
Username string `mapstructure:"username"`
Password string `mapstructure:"password"`
Password configopaque.String `mapstructure:"password"`
MetricsBuilderConfig metadata.MetricsBuilderConfig `mapstructure:"metrics"`
}

Expand Down
2 changes: 1 addition & 1 deletion receiver/riakreceiver/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ require (
github.com/stretchr/testify v1.8.4
go.opentelemetry.io/collector/component v0.81.0
go.opentelemetry.io/collector/config/confighttp v0.81.0
go.opentelemetry.io/collector/config/configopaque v0.81.0
go.opentelemetry.io/collector/config/configtls v0.81.0
go.opentelemetry.io/collector/confmap v0.81.0
go.opentelemetry.io/collector/consumer v0.81.0
Expand Down Expand Up @@ -45,7 +46,6 @@ require (
go.opentelemetry.io/collector v0.81.0 // indirect
go.opentelemetry.io/collector/config/configauth v0.81.0 // indirect
go.opentelemetry.io/collector/config/configcompression v0.81.0 // indirect
go.opentelemetry.io/collector/config/configopaque v0.81.0 // indirect
go.opentelemetry.io/collector/config/configtelemetry v0.81.0 // indirect
go.opentelemetry.io/collector/config/internal v0.81.0 // indirect
go.opentelemetry.io/collector/exporter v0.81.0 // indirect
Expand Down

0 comments on commit 91d1cd8

Please sign in to comment.