libcnb-test: Improve the ergonomics of ContainerContext::address_for_port
#605
Conversation
This file contains 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
Previously `ContainerContext::address_for_port` would panic for some failure modes, but return an `Option` for others. Given that: - the function is only used in tests - `libcnb-test` already leans heavily into the "directly panic rather than make the tests call unwrap/expect everywhere" approach - the current `Option` usage is for when there is a bug in the test (ie: the test author forgot to call `ContainerConfig::expose_port`) ...then it makes sense to panic instead of returning `None`. This avoids the `.unwrap()` boilerplate on the callers side, and also simplifies a future PR to switch from Bollard to using the Docker CLI (this change is being split out to reduce the size of that PR). The `expect()` message doesn't conform to the recommended "expect as precondition" style since the other `expect()`s in the function do not either. (We can always revisit this as part of the Bollard migration.)
edmorley
force-pushed
the
edmorley/address-for-port-panic
branch
from
59fb920 to
b8ff73e
Compare
Malax
approved these changes
Jul 21, 2023
edmorley
changed the title
ContainerContext::address_for_portContainerContext::address_for_port
edmorley
added
enhancement
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.
Previously
ContainerContext::address_for_portwould panic for some failure modes, but return anOptionfor others.Given that:
libcnb-testalready leans heavily into the "directly panic rather than make the tests call unwrap/expect everywhere" approachOptionusage is for when there is a bug in the test (ie: the test author forgot to callContainerConfig::expose_port)...then it makes sense to panic instead of returning
None.This avoids the
.unwrap()boilerplate on the callers side, and also simplifies a future PR to switch from Bollard to using the Docker CLI (this change is being split out to reduce the size of that PR).The
expect()message doesn't conform to the recommended "expect as precondition" style since the otherexpect()s in the function do not either. (We can always revisit this as part of the Bollard migration.)GUS-W-13841481.