|
| 1 | +// FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16: |
| 2 | +//go:build go1.22 |
| 3 | + |
| 4 | +package environment |
| 5 | + |
| 6 | +import ( |
| 7 | + "context" |
| 8 | + "errors" |
| 9 | + "maps" |
| 10 | + "net" |
| 11 | + "testing" |
| 12 | + |
| 13 | + "github.com/docker/docker/internal/nlwrap" |
| 14 | + "github.com/docker/docker/libnetwork/drivers/bridge" |
| 15 | + "github.com/vishvananda/netlink" |
| 16 | + "gotest.tools/v3/assert" |
| 17 | +) |
| 18 | + |
| 19 | +type defaultBridgeInfo struct { |
| 20 | + bridge netlink.Link |
| 21 | + addrs map[string]*netlink.Addr |
| 22 | +} |
| 23 | + |
| 24 | +var _, llSubnet, _ = net.ParseCIDR("fe80::/64") |
| 25 | + |
| 26 | +// ProtectDefaultBridge remembers default bridge settings so that, when a test |
| 27 | +// runs its own daemon and tramples settings of the bridge belonging to the |
| 28 | +// CI-started bridge, the bridge is restored to its old state before the next |
| 29 | +// test. |
| 30 | +// |
| 31 | +// For example, a test may enable IPv6 with a link-local fixed-cidr-v6. That's |
| 32 | +// likely to break later tests, even if they also start their own daemon |
| 33 | +// (because, in the absence of any specific settings, the daemon learns default |
| 34 | +// bridge config from addresses on an existing bridge device). |
| 35 | +func ProtectDefaultBridge(_ context.Context, t testing.TB, testEnv *Execution) { |
| 36 | + t.Helper() |
| 37 | + // Find the bridge - there should always be one, belonging to the daemon started by CI. |
| 38 | + br, err := nlwrap.LinkByName(bridge.DefaultBridgeName) |
| 39 | + if err != nil { |
| 40 | + var lnf netlink.LinkNotFoundError |
| 41 | + if !errors.As(err, &lnf) { |
| 42 | + t.Fatal("Getting default bridge before test:", err) |
| 43 | + } |
| 44 | + return |
| 45 | + } |
| 46 | + testEnv.ProtectDefaultBridge(t, &defaultBridgeInfo{ |
| 47 | + bridge: br, |
| 48 | + addrs: getAddrs(t, br), |
| 49 | + }) |
| 50 | +} |
| 51 | + |
| 52 | +func getAddrs(t testing.TB, br netlink.Link) map[string]*netlink.Addr { |
| 53 | + t.Helper() |
| 54 | + addrs, err := nlwrap.AddrList(br, netlink.FAMILY_ALL) |
| 55 | + assert.NilError(t, err, "Getting default bridge addresses before test") |
| 56 | + addrMap := map[string]*netlink.Addr{} |
| 57 | + for _, addr := range addrs { |
| 58 | + addrMap[addr.IPNet.String()] = &addr |
| 59 | + } |
| 60 | + return addrMap |
| 61 | +} |
| 62 | + |
| 63 | +// ProtectDefaultBridge stores default bridge info, to be restored on clean. |
| 64 | +func (e *Execution) ProtectDefaultBridge(t testing.TB, info *defaultBridgeInfo) { |
| 65 | + e.protectedElements.defaultBridgeInfo = info |
| 66 | +} |
| 67 | + |
| 68 | +func restoreDefaultBridge(t testing.TB, info *defaultBridgeInfo) { |
| 69 | + t.Helper() |
| 70 | + if info == nil { |
| 71 | + return |
| 72 | + } |
| 73 | + // Re-create the bridge if the test was antisocial enough to delete it. |
| 74 | + // Yes, I'm looking at you TestDockerDaemonSuite/TestBuildOnDisabledBridgeNetworkDaemon. |
| 75 | + br, err := nlwrap.LinkByName(bridge.DefaultBridgeName) |
| 76 | + if err != nil { |
| 77 | + var lnf netlink.LinkNotFoundError |
| 78 | + if !errors.As(err, &lnf) { |
| 79 | + t.Fatal("Failed to find default bridge after test:", err) |
| 80 | + } |
| 81 | + err := netlink.LinkAdd(info.bridge) |
| 82 | + assert.NilError(t, err, "Failed to re-create default bridge after test") |
| 83 | + br, err = nlwrap.LinkByName(bridge.DefaultBridgeName) |
| 84 | + assert.NilError(t, err, "Failed to find re-created default bridge after test") |
| 85 | + } |
| 86 | + addrs, err := nlwrap.AddrList(br, netlink.FAMILY_ALL) |
| 87 | + assert.NilError(t, err, "Failed get default bridge addresses after test") |
| 88 | + // Delete addresses the bridge didn't have before the test, apart from IPv6 LL |
| 89 | + // addresses - because the bridge doesn't get a kernel-assigned LL address until |
| 90 | + // the first veth is hooked up and, once that address is deleted, it's not |
| 91 | + // re-added. |
| 92 | + wantAddrs := maps.Clone(info.addrs) |
| 93 | + for _, addr := range addrs { |
| 94 | + if _, ok := wantAddrs[addr.IPNet.String()]; ok { |
| 95 | + delete(wantAddrs, addr.IPNet.String()) |
| 96 | + } else if !llSubnet.Contains(addr.IP) { |
| 97 | + err := netlink.AddrDel(br, &netlink.Addr{IPNet: addr.IPNet}) |
| 98 | + assert.NilError(t, err, "Failed to remove default bridge address '%s' after test", addr.IPNet.String()) |
| 99 | + } |
| 100 | + } |
| 101 | + // Add missing addresses. |
| 102 | + for _, wantAddr := range wantAddrs { |
| 103 | + err = netlink.AddrAdd(br, wantAddr) |
| 104 | + assert.NilError(t, err, "Failed to add default bridge address '%s' after test", wantAddr.IPNet.String()) |
| 105 | + } |
| 106 | +} |
0 commit comments