hs-test: add support for running vpp in gdb
[vpp.git] / extras / hs-test / hst_suite.go
index 9cd9aea..4e4b7d2 100644 (file)
@@ -1,9 +1,11 @@
 package main
 
 import (
+       "flag"
        "fmt"
        "io/ioutil"
        "os"
+       "time"
 
        "github.com/edwarnicke/exechelper"
        "github.com/stretchr/testify/assert"
@@ -12,24 +14,22 @@ import (
 )
 
 const (
-       defaultNamespaceName string = "default"
+       defaultNetworkNumber int = 1
 )
 
-func IsPersistent() bool {
-       return os.Getenv("HST_PERSIST") == "1"
-}
-
-func IsVerbose() bool {
-       return os.Getenv("HST_VERBOSE") == "1"
-}
+var IsPersistent = flag.Bool("persist", false, "persists topology config")
+var IsVerbose = flag.Bool("verbose", false, "verbose test output")
+var IsUnconfiguring = flag.Bool("unconfigure", false, "remove topology")
+var IsVppDebug = flag.Bool("debug", false, "attach gdb to vpp")
 
 type HstSuite struct {
        suite.Suite
        containers    map[string]*Container
        volumes       []string
        netConfigs    []NetConfig
-       netInterfaces map[string]NetInterface
+       netInterfaces map[string]*NetInterface
        addresser     *Addresser
+       testIds       map[string]string
 }
 
 func (s *HstSuite) TearDownSuite() {
@@ -37,14 +37,21 @@ func (s *HstSuite) TearDownSuite() {
 }
 
 func (s *HstSuite) TearDownTest() {
-       if IsPersistent() {
+       if *IsPersistent {
                return
        }
        s.ResetContainers()
        s.RemoveVolumes()
 }
 
+func (s *HstSuite) skipIfUnconfiguring() {
+       if *IsUnconfiguring {
+               s.skip("skipping to unconfigure")
+       }
+}
+
 func (s *HstSuite) SetupTest() {
+       s.skipIfUnconfiguring()
        s.SetupVolumes()
        s.SetupContainers()
 }
@@ -112,7 +119,8 @@ func (s *HstSuite) assertNotEmpty(object interface{}, msgAndArgs ...interface{})
 }
 
 func (s *HstSuite) log(args ...any) {
-       if IsVerbose() {
+       if *IsVerbose {
+               s.T().Helper()
                s.T().Log(args...)
        }
 }
@@ -173,7 +181,6 @@ func (s *HstSuite) loadContainerTopology(topologyName string) {
                if err != nil {
                        s.T().Fatalf("container config error: %v", err)
                }
-               s.log(newContainer.getRunCommand())
                s.containers[newContainer.name] = newContainer
        }
 }
@@ -190,7 +197,7 @@ func (s *HstSuite) loadNetworkTopology(topologyName string) {
        }
 
        s.addresser = NewAddresser(s)
-       s.netInterfaces = make(map[string]NetInterface)
+       s.netInterfaces = make(map[string]*NetInterface)
        for _, elem := range yamlTopo.Devices {
                switch elem["type"].(string) {
                case NetNs:
@@ -201,20 +208,11 @@ func (s *HstSuite) loadNetworkTopology(topologyName string) {
                                        s.T().Fatalf("network config error: %v", err)
                                }
                        }
-               case Veth:
+               case Veth, Tap:
                        {
-                               if veth, err := NewVeth(elem, s.addresser); err == nil {
-                                       s.netConfigs = append(s.netConfigs, &veth)
-                                       s.netInterfaces[veth.Name()] = &veth
-                               } else {
-                                       s.T().Fatalf("network config error: %v", err)
-                               }
-                       }
-               case Tap:
-                       {
-                               if tap, err := NewTap(elem, s.addresser); err == nil {
-                                       s.netConfigs = append(s.netConfigs, &tap)
-                                       s.netInterfaces[tap.Name()] = &tap
+                               if netIf, err := NewNetworkInterface(elem, s.addresser); err == nil {
+                                       s.netConfigs = append(s.netConfigs, netIf)
+                                       s.netInterfaces[netIf.Name()] = netIf
                                } else {
                                        s.T().Fatalf("network config error: %v", err)
                                }
@@ -234,6 +232,10 @@ func (s *HstSuite) loadNetworkTopology(topologyName string) {
 func (s *HstSuite) configureNetworkTopology(topologyName string) {
        s.loadNetworkTopology(topologyName)
 
+       if *IsUnconfiguring {
+               return
+       }
+
        for _, nc := range s.netConfigs {
                if err := nc.Configure(); err != nil {
                        s.T().Fatalf("network config error: %v", err)
@@ -242,7 +244,7 @@ func (s *HstSuite) configureNetworkTopology(topologyName string) {
 }
 
 func (s *HstSuite) unconfigureNetworkTopology() {
-       if IsPersistent() {
+       if *IsPersistent {
                return
        }
        for _, nc := range s.netConfigs {
@@ -250,47 +252,57 @@ func (s *HstSuite) unconfigureNetworkTopology() {
        }
 }
 
-type NamespaceAddresses struct {
-       namespace         string
-       numberOfAddresses int
+func (s *HstSuite) getTestId() string {
+       testName := s.T().Name()
+
+       if s.testIds == nil {
+               s.testIds = map[string]string{}
+       }
+
+       if _, ok := s.testIds[testName]; !ok {
+               s.testIds[testName] = time.Now().Format(time.RFC3339)
+       }
+
+       return s.testIds[testName]
 }
 
+type AddressCounter = int
+
 type Addresser struct {
-       namespaces []*NamespaceAddresses
-       suite      *HstSuite
+       networks map[int]AddressCounter
+       suite    *HstSuite
 }
 
-func (a *Addresser) AddNamespace(name string) {
-       var newNamespace = &NamespaceAddresses{
-               namespace:         name,
-               numberOfAddresses: 0,
-       }
-       a.namespaces = append(a.namespaces, newNamespace)
+func (a *Addresser) AddNetwork(networkNumber int) {
+       a.networks[networkNumber] = 1
 }
 
-func (a *Addresser) NewIp4Address() (string, error) {
-       return a.NewIp4AddressWithNamespace(defaultNamespaceName)
-}
+func (a *Addresser) NewIp4Address(inputNetworkNumber ...int) (string, error) {
+       var networkNumber int = 0
+       if len(inputNetworkNumber) > 0 {
+               networkNumber = inputNetworkNumber[0]
+       }
 
-func (a *Addresser) NewIp4AddressWithNamespace(namespace string) (string, error) {
-       for i, val := range a.namespaces {
-               if val.namespace != namespace {
-                       continue
-               }
-               if val.numberOfAddresses == 255 {
-                       return "", fmt.Errorf("no available IPv4 addresses")
-               }
-               address := fmt.Sprintf("10.10.%v.%v/24", i, val.numberOfAddresses+1)
-               val.numberOfAddresses++
-               return address, nil
+       if _, ok := a.networks[networkNumber]; !ok {
+               a.AddNetwork(networkNumber)
        }
-       a.AddNamespace(namespace)
-       return a.NewIp4AddressWithNamespace(namespace)
+
+       numberOfAddresses := a.networks[networkNumber]
+
+       if numberOfAddresses == 254 {
+               return "", fmt.Errorf("no available IPv4 addresses")
+       }
+
+       address := fmt.Sprintf("10.10.%v.%v/24", networkNumber, numberOfAddresses)
+       a.networks[networkNumber] = numberOfAddresses + 1
+
+       return address, nil
 }
 
 func NewAddresser(suite *HstSuite) *Addresser {
        var addresser = new(Addresser)
        addresser.suite = suite
-       addresser.AddNamespace(defaultNamespaceName)
+       addresser.networks = make(map[int]AddressCounter)
+       addresser.AddNetwork(0)
        return addresser
 }