[*] migrate all helpers to testutil
#1071
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pull Request Test Coverage Report for Build 20036744139Details
💛 - Coveralls |
The setup function should be invoked once across all tests because it setups a global port listener, otherwise running tests parallely may fail with `address already in use` error.
pashagolub
reviewed
Dec 8, 2025
pashagolub
requested changes
Dec 8, 2025
Comment on lines
-17
to
-33
| type mockReader struct { | ||
| toReturn sources.Sources | ||
| toErr error | ||
| } | ||
|
|
||
| func (m *mockReader) GetSources() (sources.Sources, error) { | ||
| if m.toErr != nil { | ||
| return nil, m.toErr | ||
| } | ||
| return m.toReturn, nil | ||
| } | ||
|
|
||
| func (m *mockReader) WriteSources(sources.Sources) error { return nil } | ||
| func (m *mockReader) DeleteSource(string) error { return nil } | ||
| func (m *mockReader) UpdateSource(sources.Source) error { return nil } | ||
| func (m *mockReader) CreateSource(sources.Source) error { return nil } | ||
|
|
Collaborator
There was a problem hiding this comment.
Revert this. testutil must contain only structs and functions that are used in more than one place.
Collaborator
Author
There was a problem hiding this comment.
This sources mock was removed and I used the general sources mock defined previously in webserver (moved to testutil) instead.
refer to #1071 (comment)
internal/testutil/mocks.go
Outdated
Comment on lines
48
to
116
| //---------------Sources-Metrics Mocks-------------- | ||
|
|
||
| type MockMetricsReaderWriter struct { | ||
| GetMetricsFunc func() (*metrics.Metrics, error) | ||
| UpdateMetricFunc func(name string, m metrics.Metric) error | ||
| CreateMetricFunc func(name string, m metrics.Metric) error | ||
| DeleteMetricFunc func(name string) error | ||
| DeletePresetFunc func(name string) error | ||
| UpdatePresetFunc func(name string, preset metrics.Preset) error | ||
| CreatePresetFunc func(name string, preset metrics.Preset) error | ||
| WriteMetricsFunc func(metricDefs *metrics.Metrics) error | ||
| } | ||
|
|
||
| func (m *MockMetricsReaderWriter) GetMetrics() (*metrics.Metrics, error) { | ||
| return m.GetMetricsFunc() | ||
| } | ||
| func (m *MockMetricsReaderWriter) UpdateMetric(name string, metric metrics.Metric) error { | ||
| return m.UpdateMetricFunc(name, metric) | ||
| } | ||
| func (m *MockMetricsReaderWriter) CreateMetric(name string, metric metrics.Metric) error { | ||
| return m.CreateMetricFunc(name, metric) | ||
| } | ||
| func (m *MockMetricsReaderWriter) DeleteMetric(name string) error { | ||
| return m.DeleteMetricFunc(name) | ||
| } | ||
| func (m *MockMetricsReaderWriter) DeletePreset(name string) error { | ||
| return m.DeletePresetFunc(name) | ||
| } | ||
| func (m *MockMetricsReaderWriter) UpdatePreset(name string, preset metrics.Preset) error { | ||
| return m.UpdatePresetFunc(name, preset) | ||
| } | ||
| func (m *MockMetricsReaderWriter) CreatePreset(name string, preset metrics.Preset) error { | ||
| return m.CreatePresetFunc(name, preset) | ||
| } | ||
| func (m *MockMetricsReaderWriter) WriteMetrics(metricDefs *metrics.Metrics) error { | ||
| return m.WriteMetricsFunc(metricDefs) | ||
| } | ||
|
|
||
| type MockSourcesReaderWriter struct { | ||
| GetSourcesFunc func() (sources.Sources, error) | ||
| UpdateSourceFunc func(md sources.Source) error | ||
| CreateSourceFunc func(md sources.Source) error | ||
| DeleteSourceFunc func(name string) error | ||
| WriteSourcesFunc func(sources.Sources) error | ||
| } | ||
|
|
||
| func (m *MockSourcesReaderWriter) GetSources() (sources.Sources, error) { | ||
| return m.GetSourcesFunc() | ||
| } | ||
| func (m *MockSourcesReaderWriter) UpdateSource(md sources.Source) error { | ||
| return m.UpdateSourceFunc(md) | ||
| } | ||
| func (m *MockSourcesReaderWriter) CreateSource(md sources.Source) error { | ||
| return m.CreateSourceFunc(md) | ||
| } | ||
| func (m *MockSourcesReaderWriter) DeleteSource(name string) error { | ||
| return m.DeleteSourceFunc(name) | ||
| } | ||
| func (m *MockSourcesReaderWriter) WriteSources(srcs sources.Sources) error { | ||
| return m.WriteSourcesFunc(srcs) | ||
| } | ||
|
|
||
| type MockFS struct { | ||
| OpenFunc func(name string) (fs.File, error) | ||
| } | ||
|
|
||
| func (m MockFS) Open(name string) (fs.File, error) { | ||
| return m.OpenFunc(name) | ||
| } |
Collaborator
There was a problem hiding this comment.
Revert this. testutil must contain only structs and functions that are used in more than one place.
Collaborator
Author
There was a problem hiding this comment.
- Reverted
MockFS. MockSourcesReaderWriteris already used in multiple places as mentioned in [*] migrate all helpers totestutil#1071 (comment),- For
mockMetricsReaderWriter, I think it should stay, as it's very probable that it will get used in the future in packages other thanwebserver.
Now in this PR we have only migrated container helpers, and these Mock{Metrics,Sources}ReaderWriter mocks.
Comment on lines
-17
to
-41
| type mockSourcesReaderWriter struct { | ||
| GetSourcesFunc func() (sources.Sources, error) | ||
| UpdateSourceFunc func(md sources.Source) error | ||
| CreateSourceFunc func(md sources.Source) error | ||
| DeleteSourceFunc func(name string) error | ||
| WriteSourcesFunc func(sources.Sources) error | ||
| } | ||
|
|
||
| func (m *mockSourcesReaderWriter) GetSources() (sources.Sources, error) { | ||
| return m.GetSourcesFunc() | ||
| } | ||
| func (m *mockSourcesReaderWriter) UpdateSource(md sources.Source) error { | ||
| return m.UpdateSourceFunc(md) | ||
| } | ||
| func (m *mockSourcesReaderWriter) CreateSource(md sources.Source) error { | ||
| return m.CreateSourceFunc(md) | ||
| } | ||
| func (m *mockSourcesReaderWriter) DeleteSource(name string) error { | ||
| return m.DeleteSourceFunc(name) | ||
| } | ||
| func (m *mockSourcesReaderWriter) WriteSources(srcs sources.Sources) error { | ||
| return m.WriteSourcesFunc(srcs) | ||
| } | ||
|
|
||
| func newTestSourceServer(mrw *mockSourcesReaderWriter) *WebUIServer { |
Collaborator
There was a problem hiding this comment.
Revert this. testutil must contain only structs and functions that are used in more than one place.
Collaborator
Author
There was a problem hiding this comment.
mockSourcesReaderWriter is already used in more than one place. If you observe the changes at reaper_test.go, you will see that I reused it there and removed the other sources mock that existed
Collaborator
|
It's probably easier to start a new PR. I propose to focus only on docker container helpers first. |
0xgouda
force-pushed
the
migrate-all-helpers-to-testutil
branch
from
27e6d46 to
9fd0919
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
testutilpackage #1064 and migrates all remaining helpers/mocks totestutilpackage.TODO:
SetupRPCServers()in tests multiple times.