bridge driver: various code quality improvements #46493
Merged
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
neersighted
reviewed
Sep 19, 2023
vvoland
added
status/2-code-review
area/networking
kind/refactor
corhere
requested changes
Oct 13, 2023
Pass the entire `*networkConfiguration` struct to `setupIPTablesInternal` to simplify the function signature and improve code readability. Signed-off-by: Richard Hansen <rhansen@rhansen.org>
That field was only used to pass `-t nat` for NAT rules. Now `-t <tableName>` (where `<tableName>` is one of the `iptables.Table` values) is always passed, eliminating the need for `preArgs`. Signed-off-by: Richard Hansen <rhansen@rhansen.org>
Rather than pass an `iptables.IPVersion` value alongside every `iptRule` parameter, embed the IP version in the `iptRule` struct. Signed-off-by: Richard Hansen <rhansen@rhansen.org>
Signed-off-by: Richard Hansen <rhansen@rhansen.org>
Signed-off-by: Richard Hansen <rhansen@rhansen.org>
Signed-off-by: Richard Hansen <rhansen@rhansen.org>
Rename all variables/fields/map keys associated with the
`com.docker.network.host_ipv4` option from `HostIP` to `HostIPv4`.
Rationale:
* This makes the variable/field name consistent with the option
name.
* This makes the code more readable because it is clear that the
variable/field does not hold an IPv6 address. This will hopefully
avoid bugs like <moby#46445> in the
future.
* If IPv6 SNAT support is ever added, the names will be symmetric.
Signed-off-by: Richard Hansen <rhansen@rhansen.org>
rhansen
force-pushed
the
bridge-cleanups
branch
from
64b883f to
96f85de
Compare
Thanks for checking @corhere, and thanks for the review! In addition to making the suggested changes, I rebased the branch onto the latest |
neersighted
approved these changes
Oct 14, 2023
|
The only test failure is our old flaky friend TestNetworkDBCRUDTableEntries. |
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.
- What I did
This PR contains a handful of commits (please do not squash) that modify the bridge driver to improve code readability and maintainability.
These commits are preparation for my work-in-progress fix for #46469.
The first commit was suggested in #46446 (comment)
No behavior changes are expected, but I'm not 100% certain that the last commit (the one that renames
HostIPtoHostIPv4) preserves API and disk file format compatibility. I'm OK with omitting that commit, but I think it improves readability, especially when combined with the fix for #46469.- Description for the changelog
(not necessary)