BGP multipath WECMP test (openconfig#2700)

* BGP multipath WECMP test

* fix metadata description

* gofmt check fixes

feature/bgp/multipath/otg_tests/bgp_multipath_wecmp_lbw_community_test/bgp_multipath_wecmp_test.go

@@ -0,0 +1,180 @@
+// Copyright 2023 Google LLC
+//
+// 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 bgp_multipath_wecmp_test
+
+import (
+	"sort"
+	"strconv"
+	"testing"
+	"time"
+
+	"github.com/open-traffic-generator/snappi/gosnappi"
+	"github.com/openconfig/featureprofiles/internal/cfgplugins"
+	"github.com/openconfig/featureprofiles/internal/deviations"
+	"github.com/openconfig/featureprofiles/internal/fptest"
+	"github.com/openconfig/featureprofiles/internal/otgutils"
+	"github.com/openconfig/ondatra"
+	"github.com/openconfig/ondatra/gnmi"
+	"github.com/openconfig/ondatra/gnmi/oc"
+	"github.com/openconfig/ygot/ygot"
+)
+
+const (
+	prefixesStart    = "198.51.100.0"
+	prefixP4Len      = 32
+	prefixesCount    = 3
+	pathID           = 1
+	maxPaths         = 2
+	trafficPps       = 1000
+	totalPackets     = 120000
+	lossTolerancePct = 0
+	lbToleranceFms   = 5
+)
+
+var linkBw = []int{10, 5}
+
+func TestMain(m *testing.M) {
+	fptest.RunTests(m)
+}
+
+func configureOTG(t *testing.T, bs *cfgplugins.BGPSession) {
+	devices := bs.ATETop.Devices().Items()
+	byName := func(i, j int) bool { return devices[i].Name() < devices[j].Name() }
+	sort.Slice(devices, byName)
+	for i, otgPort := range bs.ATEPorts {
+		if i < 2 {
+			continue
+		}
+
+		ipv4 := devices[i].Ethernets().Items()[0].Ipv4Addresses().Items()[0]
+		bgp4Peer := devices[i].Bgp().Ipv4Interfaces().Items()[0].Peers().Items()[0]
+		bgp4PeerRoute := bgp4Peer.V4Routes().Add()
+		bgp4PeerRoute.SetName(otgPort.Name + ".BGP4.peer.rr4")
+		bgp4PeerRoute.SetNextHopIpv4Address(ipv4.Address())
+		bgp4PeerRoute.SetNextHopAddressType(gosnappi.BgpV4RouteRangeNextHopAddressType.IPV4)
+		bgp4PeerRoute.SetNextHopMode(gosnappi.BgpV4RouteRangeNextHopMode.MANUAL)
+		routeAddress := bgp4PeerRoute.Addresses().Add().SetAddress(prefixesStart)
+		routeAddress.SetPrefix(prefixP4Len)
+		routeAddress.SetCount(prefixesCount)
+		bgp4PeerRoute.AddPath().SetPathId(pathID)
+		bgp4PeerRoute.ExtendedCommunities().Items()[0].NonTransitive2OctetAsType().LinkBandwidthSubtype().SetBandwidth(float32(linkBw[i-2] * 1000))
+	}
+
+	configureFlow(bs)
+}
+
+func configureFlow(bs *cfgplugins.BGPSession) {
+	bs.ATETop.Flows().Clear()
+
+	var rxNames []string
+	for i := 1; i < len(bs.ATEPorts); i++ {
+		rxNames = append(rxNames, bs.ATEPorts[i].Name+".BGP4.peer.rr4")
+	}
+	flow := bs.ATETop.Flows().Add().SetName("flow")
+	flow.Metrics().SetEnable(true)
+	flow.TxRx().Device().
+		SetTxNames([]string{bs.ATEPorts[0].Name + ".IPv4"}).
+		SetRxNames(rxNames)
+	flow.Duration().FixedPackets().SetPackets(totalPackets)
+	flow.Size().SetFixed(1500)
+	flow.Rate().SetPps(trafficPps)
+
+	e := flow.Packet().Add().Ethernet()
+	e.Src().SetValue(bs.ATEPorts[0].MAC)
+	v4 := flow.Packet().Add().Ipv4()
+	v4.Src().SetValue(bs.ATEPorts[0].IPv4)
+	v4.Dst().SetValue(prefixesStart)
+}
+
+func checkPacketLoss(t *testing.T, ate *ondatra.ATEDevice) {
+	countersPath := gnmi.OTG().Flow("flow").Counters()
+	rxPackets := gnmi.Get(t, ate.OTG(), countersPath.InPkts().State())
+	txPackets := gnmi.Get(t, ate.OTG(), countersPath.OutPkts().State())
+	lostPackets := txPackets - rxPackets
+
+	if txPackets < 1 {
+		t.Fatalf("Tx packets should be higher than 0")
+	}
+
+	if got := lostPackets * 100 / txPackets; got != lossTolerancePct {
+		t.Errorf("Packet loss percentage for flow: got %v, want %v", got, lossTolerancePct)
+	}
+}
+
+func verifyECMPLoadBalance(t *testing.T, ate *ondatra.ATEDevice, pc int, expectedLinks int) {
+	framesTx := gnmi.Get(t, ate.OTG(), gnmi.OTG().Port(ate.Port(t, "port1").ID()).Counters().OutFrames().State())
+	expectedPerLinkFmsP3 := (linkBw[0] / (linkBw[0] + linkBw[1])) * int(framesTx)
+	expectedPerLinkFmsP4 := (linkBw[1] / (linkBw[0] + linkBw[1])) * int(framesTx)
+	t.Logf("Total packets %d flow through the %d links and expected per link packets: %d, %d", framesTx, expectedLinks, expectedPerLinkFmsP3, expectedPerLinkFmsP4)
+
+	p3Min := expectedPerLinkFmsP3 - (expectedPerLinkFmsP3 * lbToleranceFms / 100)
+	p3Max := expectedPerLinkFmsP3 + (expectedPerLinkFmsP3 * lbToleranceFms / 100)
+	framesRxP3 := gnmi.Get(t, ate.OTG(), gnmi.OTG().Port(ate.Port(t, "port"+strconv.Itoa(3)).ID()).Counters().InFrames().State())
+
+	if int64(p3Min) < int64(framesRxP3) && int64(framesRxP3) < int64(p3Max) {
+		t.Logf("Traffic of %d on port-3 is within expected range: %d - %d", framesRxP3, p3Min, p3Max)
+	} else {
+		t.Errorf("Traffic on port-3 is expected to be in the range %d - %d but got %d. Load balance Test Failed", p3Min, p3Max, framesRxP3)
+	}
+
+	p4Min := expectedPerLinkFmsP4 - (expectedPerLinkFmsP4 * lbToleranceFms / 100)
+	p4Max := expectedPerLinkFmsP4 + (expectedPerLinkFmsP4 * lbToleranceFms / 100)
+	framesRxP4 := gnmi.Get(t, ate.OTG(), gnmi.OTG().Port(ate.Port(t, "port"+strconv.Itoa(4)).ID()).Counters().InFrames().State())
+
+	if int64(p4Min) < int64(framesRxP4) && int64(framesRxP4) < int64(p4Max) {
+		t.Logf("Traffic of %d on port-4 is within expected range: %d - %d", framesRxP4, p4Min, p4Max)
+	} else {
+		t.Errorf("Traffic on port-4 is expected to be in the range %d - %d but got %d. Load balance Test Failed", p4Min, p4Max, framesRxP4)
+	}
+}
+
+func TestBGPSetup(t *testing.T) {
+	bs := cfgplugins.NewBGPSession(t, cfgplugins.PortCount4)
+	bs.WithEBGP(t, oc.BgpTypes_AFI_SAFI_TYPE_IPV4_UNICAST, true, false)
+	dni := deviations.DefaultNetworkInstance(bs.DUT)
+	bgp := bs.DUTConf.GetOrCreateNetworkInstance(dni).GetOrCreateProtocol(oc.PolicyTypes_INSTALL_PROTOCOL_TYPE_BGP, "BGP").GetOrCreateBgp()
+	gEBGP := bgp.GetOrCreateGlobal().GetOrCreateAfiSafi(oc.BgpTypes_AFI_SAFI_TYPE_IPV4_UNICAST).GetOrCreateUseMultiplePaths().GetOrCreateEbgp()
+	bgp.GetOrCreatePeerGroup(cfgplugins.BGPPeerGroup1).GetOrCreateAfiSafi(oc.BgpTypes_AFI_SAFI_TYPE_IPV4_UNICAST).GetOrCreateUseMultiplePaths().Enabled = ygot.Bool(true)
+
+	if !deviations.SkipSettingAllowMultipleAS(bs.DUT) {
+		gEBGP.AllowMultipleAs = ygot.Bool(true)
+	}
+
+	configureOTG(t, bs)
+	bs.PushAndStart(t)
+
+	t.Logf("Verify DUT BGP sessions up")
+	cfgplugins.VerifyDUTBGPEstablished(t, bs.DUT)
+
+	t.Logf("Verify OTG BGP sessions up")
+	cfgplugins.VerifyOTGBGPEstablished(t, bs.ATE)
+
+	aftsPath := gnmi.OC().NetworkInstance(dni).Afts()
+	prefix := prefixesStart + "/" + strconv.Itoa(prefixP4Len)
+	ipv4Entry := gnmi.Get[*oc.NetworkInstance_Afts_Ipv4Entry](t, bs.DUT, aftsPath.Ipv4Entry(prefix).State())
+	hopGroup := gnmi.Get[*oc.NetworkInstance_Afts_NextHopGroup](t, bs.DUT, aftsPath.NextHopGroup(ipv4Entry.GetNextHopGroup()).State())
+	if got, want := len(hopGroup.NextHop), 2; got != want {
+		t.Errorf("prefix: %s, found %d hops, want %d", ipv4Entry.GetPrefix(), got, want)
+	}
+
+	sleepTime := time.Duration(totalPackets/trafficPps) + 5
+	bs.ATE.OTG().StartTraffic(t)
+	time.Sleep(sleepTime * time.Second)
+	bs.ATE.OTG().StopTraffic(t)
+
+	otgutils.LogFlowMetrics(t, bs.ATE.OTG(), bs.ATETop)
+	checkPacketLoss(t, bs.ATE)
+	verifyECMPLoadBalance(t, bs.ATE, int(cfgplugins.PortCount4), 2)
+}

feature/bgp/multipath/otg_tests/bgp_multipath_wecmp_lbw_community_test/metadata.textproto

@@ -0,0 +1,39 @@
+# proto-file: github.com/openconfig/featureprofiles/proto/metadata.proto
+# proto-message: Metadata
+
+uuid: "f76a89e9-a2f1-4160-b6e6-e762dc10219a"
+plan_id: "RT-1.52"
+description: "BGP multipath UCMP support with Link Bandwidth Community"
+testbed: TESTBED_DUT_ATE_4LINKS
+platform_exceptions: {
+  platform: {
+    vendor: CISCO
+  }
+  deviations: {
+    ipv4_missing_enabled: true
+  }
+}
+platform_exceptions: {
+  platform: {
+    vendor: NOKIA
+  }
+  deviations: {
+    explicit_port_speed: true
+    explicit_interface_in_default_vrf: true
+    interface_enabled: true
+  }
+}
+platform_exceptions: {
+  platform: {
+    vendor: ARISTA
+  }
+  deviations: {
+    route_policy_under_afi_unsupported: true
+    omit_l2_mtu: true
+    interface_enabled: true
+    default_network_instance: "default"
+    missing_value_for_defaults: true
+    skip_setting_allow_multiple_as: false
+  }
+}
+tags: TAGS_DATACENTER_EDGE