// Copyright 2022 CNI authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package main import ( "encoding/json" "fmt" "io/ioutil" "net" "os" "strings" "syscall" . "github.com/onsi/ginkgo" . "github.com/onsi/gomega" "github.com/vishvananda/netlink" "github.com/containernetworking/cni/pkg/skel" "github.com/containernetworking/cni/pkg/types" types020 "github.com/containernetworking/cni/pkg/types/020" types040 "github.com/containernetworking/cni/pkg/types/040" types100 "github.com/containernetworking/cni/pkg/types/100" "github.com/containernetworking/plugins/pkg/ns" "github.com/containernetworking/plugins/pkg/testutils" "github.com/containernetworking/plugins/plugins/ipam/host-local/backend/allocator" ) const ( TYPETAP = "tuntap" IFNAME = "tapifc" ) type Net struct { Name string `json:"name"` CNIVersion string `json:"cniVersion"` Type string `json:"type,omitempty"` IPAM *allocator.IPAMConfig `json:"ipam"` RawPrevResult map[string]interface{} `json:"prevResult,omitempty"` PrevResult types100.Result `json:"-"` } func buildOneConfig(netName string, cniVersion string, orig *Net, prevResult types.Result) (*Net, error) { var err error inject := map[string]interface{}{ "name": netName, "cniVersion": cniVersion, } // Add previous plugin result if prevResult != nil { inject["prevResult"] = prevResult } // Ensure every config uses the same name and version config := make(map[string]interface{}) confBytes, err := json.Marshal(orig) if err != nil { return nil, err } err = json.Unmarshal(confBytes, &config) if err != nil { return nil, fmt.Errorf("unmarshal existing network bytes: %s", err) } for key, value := range inject { config[key] = value } newBytes, err := json.Marshal(config) if err != nil { return nil, err } conf := &Net{} if err := json.Unmarshal(newBytes, &conf); err != nil { return nil, fmt.Errorf("error parsing configuration: %s", err) } return conf, nil } type tester interface { // verifyResult minimally verifies the Result and returns the interface's MAC address verifyResult(result types.Result, name string) string } type testerBase struct{} type testerV10x testerBase type testerV04x testerBase type testerV03x testerBase type testerV01xOr02x testerBase func newTesterByVersion(version string) tester { switch { case strings.HasPrefix(version, "1.0."): return &testerV10x{} case strings.HasPrefix(version, "0.4."): return &testerV04x{} case strings.HasPrefix(version, "0.3."): return &testerV03x{} default: return &testerV01xOr02x{} } } // verifyResult minimally verifies the Result and returns the interface's MAC address func (t *testerV10x) verifyResult(result types.Result, name string) string { r, err := types100.GetResult(result) Expect(err).NotTo(HaveOccurred()) Expect(len(r.Interfaces)).To(Equal(1)) Expect(r.Interfaces[0].Name).To(Equal(name)) Expect(len(r.IPs)).To(Equal(1)) return r.Interfaces[0].Mac } func verify0403(result types.Result, name string) string { r, err := types040.GetResult(result) Expect(err).NotTo(HaveOccurred()) Expect(len(r.Interfaces)).To(Equal(1)) Expect(r.Interfaces[0].Name).To(Equal(name)) Expect(len(r.IPs)).To(Equal(1)) return r.Interfaces[0].Mac } // verifyResult minimally verifies the Result and returns the interface's MAC address func (t *testerV04x) verifyResult(result types.Result, name string) string { return verify0403(result, name) } // verifyResult minimally verifies the Result and returns the interface's MAC address func (t *testerV03x) verifyResult(result types.Result, name string) string { return verify0403(result, name) } // verifyResult minimally verifies the Result and returns the interface's MAC address func (t *testerV01xOr02x) verifyResult(result types.Result, name string) string { r, err := types020.GetResult(result) Expect(err).NotTo(HaveOccurred()) Expect(r.IP4.IP.IP).NotTo(BeNil()) Expect(r.IP6).To(BeNil()) // 0.2 and earlier don't return MAC address return "" } // Note: the tests might not work with some security modules (like selinux) enabled // To test with security modules enabled please provide an appropriate plugin for creating the tap device var _ = Describe("Add, check, remove tap plugin", func() { var originalNS, targetNS ns.NetNS var dataDir string BeforeEach(func() { // Create a new NetNS so we don't modify the host var err error originalNS, err = testutils.NewNS() Expect(err).NotTo(HaveOccurred()) targetNS, err = testutils.NewNS() Expect(err).NotTo(HaveOccurred()) dataDir, err = ioutil.TempDir("", "dummy") Expect(err).NotTo(HaveOccurred()) }) AfterEach(func() { Expect(os.RemoveAll(dataDir)).To(Succeed()) Expect(originalNS.Close()).To(Succeed()) Expect(testutils.UnmountNS(originalNS)).To(Succeed()) Expect(targetNS.Close()).To(Succeed()) Expect(testutils.UnmountNS(targetNS)).To(Succeed()) }) for _, ver := range testutils.AllSpecVersions { ver := ver It(fmt.Sprintf("[%s] add, check and remove a tap device run correctly", ver), func() { conf := fmt.Sprintf(`{ "cniVersion": "%s", "name": "tapTest", "type": "tap", "owner": 0, "group": 0, "ipam": { "type": "host-local", "subnet": "10.1.2.0/24", "dataDir": "%s" } }`, ver, dataDir) args := &skel.CmdArgs{ ContainerID: "dummy", Netns: targetNS.Path(), IfName: IFNAME, StdinData: []byte(conf), } t := newTesterByVersion(ver) var result types.Result var macAddress string var err error err = originalNS.Do(func(ns.NetNS) error { defer GinkgoRecover() result, _, err = testutils.CmdAddWithArgs(args, func() error { return cmdAdd(args) }) Expect(err).NotTo(HaveOccurred()) macAddress = t.verifyResult(result, IFNAME) return nil }) Expect(err).NotTo(HaveOccurred()) By("Make sure the tap link exists in the target namespace") err = targetNS.Do(func(ns.NetNS) error { defer GinkgoRecover() link, err := netlink.LinkByName(IFNAME) Expect(err).NotTo(HaveOccurred()) Expect(link.Attrs().Name).To(Equal(IFNAME)) Expect(link.Type()).To(Equal(TYPETAP)) if macAddress != "" { hwaddr, err := net.ParseMAC(macAddress) Expect(err).NotTo(HaveOccurred()) Expect(link.Attrs().HardwareAddr).To(Equal(hwaddr)) } addrs, err := netlink.AddrList(link, syscall.AF_INET) Expect(err).NotTo(HaveOccurred()) Expect(len(addrs)).To(Equal(1)) return nil }) Expect(err).NotTo(HaveOccurred()) By("Running cmdCheck") n := &Net{} err = json.Unmarshal([]byte(conf), &n) Expect(err).NotTo(HaveOccurred()) n.IPAM, _, err = allocator.LoadIPAMConfig([]byte(conf), "") Expect(err).NotTo(HaveOccurred()) newConf, err := buildOneConfig("tapTest", ver, n, result) Expect(err).NotTo(HaveOccurred()) confString, err := json.Marshal(newConf) Expect(err).NotTo(HaveOccurred()) args.StdinData = confString err = originalNS.Do(func(ns.NetNS) error { defer GinkgoRecover() return testutils.CmdCheckWithArgs(args, func() error { return cmdCheck(args) }) }) if testutils.SpecVersionHasCHECK(ver) { Expect(err).NotTo(HaveOccurred()) } else { Expect(err).To(MatchError("config version does not allow CHECK")) } By("Running cmdDel") args.StdinData = []byte(conf) err = originalNS.Do(func(ns.NetNS) error { defer GinkgoRecover() err = testutils.CmdDelWithArgs(args, func() error { return cmdDel(args) }) Expect(err).NotTo(HaveOccurred()) return nil }) Expect(err).NotTo(HaveOccurred()) err = targetNS.Do(func(ns.NetNS) error { defer GinkgoRecover() link, err := netlink.LinkByName(IFNAME) Expect(err).To(HaveOccurred()) Expect(link).To(BeNil()) return nil }) Expect(err).NotTo(HaveOccurred()) By("Running cmdDel more than once without error") err = originalNS.Do(func(ns.NetNS) error { defer GinkgoRecover() err = testutils.CmdDelWithArgs(args, func() error { return cmdDel(args) }) Expect(err).NotTo(HaveOccurred()) return nil }) Expect(err).NotTo(HaveOccurred()) }) } })