fix: mock Agent querying OS for listening ports in tests #20842
Merged
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
4dd485b to
ff1df69
Compare
mafredri
approved these changes
Nov 25, 2025
Member
mafredri
left a comment
There was a problem hiding this comment.
Solid change 👍🏻, some simplification suggestions inline.
| IgnorePorts map[int]string | ||
| // ListeningPortsGetter is used to get the list of listening ports. Only | ||
| // tests should set this. If unset, a default that queries the OS will be used. | ||
| ListeningPortsGetter ListeningPortsGetter |
Member
There was a problem hiding this comment.
Suggestion: These could be simplified a bit in naming by dropping "Getter". It makes these types somewhat verbose and limits future expansion of the type.
Hypothetical expansion: addition of ClearCache method.
A funny but legit alternative would be: type ListeningPortser interface { ListeningPorts() ... }.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
fixes coder/internal#1123
We want to tests that ports are not included after they are no longer used, but this isn't safe on the real OS networking stack because there is no way to guarantee a port won't be used. Instead, we introduce an interface and fake implementation for testing.
On order to leave the filtering logic in the test path, this PR also does some refactoring.
Caching logic is left in the real OS querying implementation and a new test case is added for it in this PR.