extras/hs-test/hst_suite.go

   1 package main
   2
   3 import (
   4         "fmt"
   5         "io/ioutil"
   6         "os"
   7
   8         "github.com/edwarnicke/exechelper"
   9         "github.com/stretchr/testify/assert"
  10         "github.com/stretchr/testify/suite"
  11         "gopkg.in/yaml.v3"
  12 )
  13
  14 const (
  15         defaultNetworkNumber int = 1
  16 )
  17
  18 func IsPersistent() bool {
  19         return os.Getenv("HST_PERSIST") == "1"
  20 }
  21
  22 func IsVerbose() bool {
  23         return os.Getenv("HST_VERBOSE") == "1"
  24 }
  25
  26 type HstSuite struct {
  27         suite.Suite
  28         containers    map[string]*Container
  29         volumes       []string
  30         netConfigs    []NetConfig
  31         netInterfaces map[string]NetInterface
  32         addresser     *Addresser
  33 }
  34
  35 func (s *HstSuite) TearDownSuite() {
  36         s.unconfigureNetworkTopology()
  37 }
  38
  39 func (s *HstSuite) TearDownTest() {
  40         if IsPersistent() {
  41                 return
  42         }
  43         s.ResetContainers()
  44         s.RemoveVolumes()
  45 }
  46
  47 func (s *HstSuite) SetupTest() {
  48         s.SetupVolumes()
  49         s.SetupContainers()
  50 }
  51
  52 func (s *HstSuite) SetupVolumes() {
  53         for _, volume := range s.volumes {
  54                 cmd := "docker volume create --name=" + volume
  55                 s.log(cmd)
  56                 exechelper.Run(cmd)
  57         }
  58 }
  59
  60 func (s *HstSuite) SetupContainers() {
  61         for _, container := range s.containers {
  62                 if container.isOptional == false {
  63                         container.run()
  64                 }
  65         }
  66 }
  67
  68 func (s *HstSuite) hstFail() {
  69         s.T().FailNow()
  70 }
  71
  72 func (s *HstSuite) assertNil(object interface{}, msgAndArgs ...interface{}) {
  73         if !assert.Nil(s.T(), object, msgAndArgs...) {
  74                 s.hstFail()
  75         }
  76 }
  77
  78 func (s *HstSuite) assertNotNil(object interface{}, msgAndArgs ...interface{}) {
  79         if !assert.NotNil(s.T(), object, msgAndArgs...) {
  80                 s.hstFail()
  81         }
  82 }
  83
  84 func (s *HstSuite) assertEqual(expected, actual interface{}, msgAndArgs ...interface{}) {
  85         if !assert.Equal(s.T(), expected, actual, msgAndArgs...) {
  86                 s.hstFail()
  87         }
  88 }
  89
  90 func (s *HstSuite) assertNotEqual(expected, actual interface{}, msgAndArgs ...interface{}) {
  91         if !assert.NotEqual(s.T(), expected, actual, msgAndArgs...) {
  92                 s.hstFail()
  93         }
  94 }
  95
  96 func (s *HstSuite) assertContains(testString, contains interface{}, msgAndArgs ...interface{}) {
  97         if !assert.Contains(s.T(), testString, contains, msgAndArgs...) {
  98                 s.hstFail()
  99         }
 100 }
 101
 102 func (s *HstSuite) assertNotContains(testString, contains interface{}, msgAndArgs ...interface{}) {
 103         if !assert.NotContains(s.T(), testString, contains, msgAndArgs...) {
 104                 s.hstFail()
 105         }
 106 }
 107
 108 func (s *HstSuite) assertNotEmpty(object interface{}, msgAndArgs ...interface{}) {
 109         if !assert.NotEmpty(s.T(), object, msgAndArgs...) {
 110                 s.hstFail()
 111         }
 112 }
 113
 114 func (s *HstSuite) log(args ...any) {
 115         if IsVerbose() {
 116                 s.T().Log(args...)
 117         }
 118 }
 119
 120 func (s *HstSuite) skip(args ...any) {
 121         s.log(args...)
 122         s.T().SkipNow()
 123 }
 124
 125 func (s *HstSuite) ResetContainers() {
 126         for _, container := range s.containers {
 127                 container.stop()
 128         }
 129 }
 130
 131 func (s *HstSuite) RemoveVolumes() {
 132         for _, volumeName := range s.volumes {
 133                 cmd := "docker volume rm " + volumeName
 134                 exechelper.Run(cmd)
 135                 os.RemoveAll(volumeName)
 136         }
 137 }
 138
 139 func (s *HstSuite) getContainerByName(name string) *Container {
 140         return s.containers[name]
 141 }
 142
 143 /*
 144  * Create a copy and return its address, so that individial tests which call this
 145  * are not able to modify the original container and affect other tests by doing that
 146  */
 147 func (s *HstSuite) getTransientContainerByName(name string) *Container {
 148         containerCopy := *s.containers[name]
 149         return &containerCopy
 150 }
 151
 152 func (s *HstSuite) loadContainerTopology(topologyName string) {
 153         data, err := ioutil.ReadFile(ContainerTopologyDir + topologyName + ".yaml")
 154         if err != nil {
 155                 s.T().Fatalf("read error: %v", err)
 156         }
 157         var yamlTopo YamlTopology
 158         err = yaml.Unmarshal(data, &yamlTopo)
 159         if err != nil {
 160                 s.T().Fatalf("unmarshal error: %v", err)
 161         }
 162
 163         for _, elem := range yamlTopo.Volumes {
 164                 volumeMap := elem["volume"].(VolumeConfig)
 165                 hostDir := volumeMap["host-dir"].(string)
 166                 s.volumes = append(s.volumes, hostDir)
 167         }
 168
 169         s.containers = make(map[string]*Container)
 170         for _, elem := range yamlTopo.Containers {
 171                 newContainer, err := NewContainer(elem)
 172                 newContainer.suite = s
 173                 if err != nil {
 174                         s.T().Fatalf("container config error: %v", err)
 175                 }
 176                 s.containers[newContainer.name] = newContainer
 177         }
 178 }
 179
 180 func (s *HstSuite) loadNetworkTopology(topologyName string) {
 181         data, err := ioutil.ReadFile(NetworkTopologyDir + topologyName + ".yaml")
 182         if err != nil {
 183                 s.T().Fatalf("read error: %v", err)
 184         }
 185         var yamlTopo YamlTopology
 186         err = yaml.Unmarshal(data, &yamlTopo)
 187         if err != nil {
 188                 s.T().Fatalf("unmarshal error: %v", err)
 189         }
 190
 191         s.addresser = NewAddresser(s)
 192         s.netInterfaces = make(map[string]NetInterface)
 193         for _, elem := range yamlTopo.Devices {
 194                 switch elem["type"].(string) {
 195                 case NetNs:
 196                         {
 197                                 if namespace, err := NewNetNamespace(elem); err == nil {
 198                                         s.netConfigs = append(s.netConfigs, &namespace)
 199                                 } else {
 200                                         s.T().Fatalf("network config error: %v", err)
 201                                 }
 202                         }
 203                 case Veth:
 204                         {
 205                                 if veth, err := NewVeth(elem, s.addresser); err == nil {
 206                                         s.netConfigs = append(s.netConfigs, &veth)
 207                                         s.netInterfaces[veth.Name()] = &veth
 208                                 } else {
 209                                         s.T().Fatalf("network config error: %v", err)
 210                                 }
 211                         }
 212                 case Tap:
 213                         {
 214                                 if tap, err := NewTap(elem, s.addresser); err == nil {
 215                                         s.netConfigs = append(s.netConfigs, &tap)
 216                                         s.netInterfaces[tap.Name()] = &tap
 217                                 } else {
 218                                         s.T().Fatalf("network config error: %v", err)
 219                                 }
 220                         }
 221                 case Bridge:
 222                         {
 223                                 if bridge, err := NewBridge(elem); err == nil {
 224                                         s.netConfigs = append(s.netConfigs, &bridge)
 225                                 } else {
 226                                         s.T().Fatalf("network config error: %v", err)
 227                                 }
 228                         }
 229                 }
 230         }
 231 }
 232
 233 func (s *HstSuite) configureNetworkTopology(topologyName string) {
 234         s.loadNetworkTopology(topologyName)
 235
 236         for _, nc := range s.netConfigs {
 237                 if err := nc.Configure(); err != nil {
 238                         s.T().Fatalf("network config error: %v", err)
 239                 }
 240         }
 241 }
 242
 243 func (s *HstSuite) unconfigureNetworkTopology() {
 244         if IsPersistent() {
 245                 return
 246         }
 247         for _, nc := range s.netConfigs {
 248                 nc.Unconfigure()
 249         }
 250 }
 251
 252 type NetworkAddresses struct {
 253         network           int
 254         numberOfAddresses int
 255 }
 256
 257 type AddressCounter = int
 258
 259 type Addresser struct {
 260         networks map[int]AddressCounter
 261         suite    *HstSuite
 262 }
 263
 264 func (a *Addresser) AddNetwork(networkNumber int) {
 265         a.networks[networkNumber] = 1
 266 }
 267
 268 func (a *Addresser) NewIp4Address(inputNetworkNumber ...int) (string, error) {
 269         var networkNumber int = 0
 270         if len(inputNetworkNumber) > 0 {
 271                 networkNumber = inputNetworkNumber[0]
 272         }
 273
 274         if _, ok := a.networks[networkNumber]; !ok {
 275                 a.AddNetwork(networkNumber)
 276         }
 277
 278         numberOfAddresses := a.networks[networkNumber]
 279
 280         if numberOfAddresses == 254 {
 281                 return "", fmt.Errorf("no available IPv4 addresses")
 282         }
 283
 284         address := fmt.Sprintf("10.10.%v.%v/24", networkNumber, numberOfAddresses)
 285         a.networks[networkNumber] = numberOfAddresses + 1
 286
 287         return address, nil
 288 }
 289
 290 func NewAddresser(suite *HstSuite) *Addresser {
 291         var addresser = new(Addresser)
 292         addresser.suite = suite
 293         addresser.networks = make(map[int]AddressCounter)
 294         addresser.AddNetwork(0)
 295         return addresser
 296 }