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

Update nsxtreceiver to checkapi standards #26509

Merged
Merged
Show file tree
Hide file tree
Changes from 6 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/26304-checkapi-nsxtreceiver.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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this is test code, it's not considered a breaking change, and you can delete the changelog entry. I'll mark this PR as "Skip Changelog". Changes look good otherwise.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah good point! Thank you! Will do

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this enhancement or bug_fix or does it even matter?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can simply remove this file since it's a test-only change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh gotcha. Yeah that was in the sentence sure enough... Some days... 🧠


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

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

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

# (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:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# 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]
1 change: 0 additions & 1 deletion cmd/checkapi/allowlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ receiver/kafkareceiver
receiver/mongodbatlasreceiver
receiver/mongodbreceiver
receiver/mysqlreceiver
receiver/nsxtreceiver
receiver/podmanreceiver
receiver/pulsarreceiver
receiver/windowseventlogreceiver
4 changes: 2 additions & 2 deletions receiver/nsxtreceiver/client_mock_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@ func (m *MockClient) TransportNodes(ctx context.Context) ([]model.TransportNode,
return r0, r1
}

// NewMockClient creates a new instance of MockClient. It also registers the testing.TB interface on the mock and a cleanup function to assert the mocks expectations.
func NewMockClient(t testing.TB) *MockClient {
// newMockClient creates a new instance of MockClient. It also registers the testing.TB interface on the mock and a cleanup function to assert the mocks expectations.
func newMockClient(t testing.TB) *MockClient {
mock := &MockClient{}
mock.Mock.Test(t)

Expand Down
6 changes: 3 additions & 3 deletions receiver/nsxtreceiver/scraper_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import (
)

func TestScrape(t *testing.T) {
mockClient := NewMockClient(t)
mockClient := newMockClient(t)

mockClient.On("ClusterNodes", mock.Anything).Return(loadTestClusterNodes())
mockClient.On("TransportNodes", mock.Anything).Return(loadTestTransportNodes())
Expand Down Expand Up @@ -68,7 +68,7 @@ func TestScrape(t *testing.T) {
}

func TestScrapeTransportNodeErrors(t *testing.T) {
mockClient := NewMockClient(t)
mockClient := newMockClient(t)
mockClient.On("TransportNodes", mock.Anything).Return(nil, errUnauthorized)
scraper := newScraper(
&Config{
Expand All @@ -84,7 +84,7 @@ func TestScrapeTransportNodeErrors(t *testing.T) {
}

func TestScrapeClusterNodeErrors(t *testing.T) {
mockClient := NewMockClient(t)
mockClient := newMockClient(t)

mockClient.On("ClusterNodes", mock.Anything).Return(nil, errUnauthorized)
mockClient.On("TransportNodes", mock.Anything).Return(loadTestTransportNodes())
Expand Down