10 "github.com/edwarnicke/exechelper"
11 "github.com/stretchr/testify/assert"
12 "github.com/stretchr/testify/suite"
17 defaultNetworkNumber int = 1
20 var IsPersistent = flag.Bool("persist", false, "persists topology config")
21 var IsVerbose = flag.Bool("verbose", false, "verbose test output")
22 var IsUnconfiguring = flag.Bool("unconfigure", false, "remove topology")
23 var IsVppDebug = flag.Bool("debug", false, "attach gdb to vpp")
25 type HstSuite struct {
27 containers map[string]*Container
29 netConfigs []NetConfig
30 netInterfaces map[string]*NetInterface
32 testIds map[string]string
35 func (s *HstSuite) TearDownSuite() {
36 s.unconfigureNetworkTopology()
39 func (s *HstSuite) TearDownTest() {
47 func (s *HstSuite) skipIfUnconfiguring() {
49 s.skip("skipping to unconfigure")
53 func (s *HstSuite) SetupTest() {
54 s.skipIfUnconfiguring()
59 func (s *HstSuite) SetupVolumes() {
60 for _, volume := range s.volumes {
61 cmd := "docker volume create --name=" + volume
67 func (s *HstSuite) SetupContainers() {
68 for _, container := range s.containers {
69 if container.isOptional == false {
75 func (s *HstSuite) hstFail() {
79 func (s *HstSuite) assertNil(object interface{}, msgAndArgs ...interface{}) {
80 if !assert.Nil(s.T(), object, msgAndArgs...) {
85 func (s *HstSuite) assertNotNil(object interface{}, msgAndArgs ...interface{}) {
86 if !assert.NotNil(s.T(), object, msgAndArgs...) {
91 func (s *HstSuite) assertEqual(expected, actual interface{}, msgAndArgs ...interface{}) {
92 if !assert.Equal(s.T(), expected, actual, msgAndArgs...) {
97 func (s *HstSuite) assertNotEqual(expected, actual interface{}, msgAndArgs ...interface{}) {
98 if !assert.NotEqual(s.T(), expected, actual, msgAndArgs...) {
103 func (s *HstSuite) assertContains(testString, contains interface{}, msgAndArgs ...interface{}) {
104 if !assert.Contains(s.T(), testString, contains, msgAndArgs...) {
109 func (s *HstSuite) assertNotContains(testString, contains interface{}, msgAndArgs ...interface{}) {
110 if !assert.NotContains(s.T(), testString, contains, msgAndArgs...) {
115 func (s *HstSuite) assertNotEmpty(object interface{}, msgAndArgs ...interface{}) {
116 if !assert.NotEmpty(s.T(), object, msgAndArgs...) {
121 func (s *HstSuite) log(args ...any) {
128 func (s *HstSuite) skip(args ...any) {
133 func (s *HstSuite) ResetContainers() {
134 for _, container := range s.containers {
139 func (s *HstSuite) RemoveVolumes() {
140 for _, volumeName := range s.volumes {
141 cmd := "docker volume rm " + volumeName
143 os.RemoveAll(volumeName)
147 func (s *HstSuite) getContainerByName(name string) *Container {
148 return s.containers[name]
152 * Create a copy and return its address, so that individial tests which call this
153 * are not able to modify the original container and affect other tests by doing that
155 func (s *HstSuite) getTransientContainerByName(name string) *Container {
156 containerCopy := *s.containers[name]
157 return &containerCopy
160 func (s *HstSuite) loadContainerTopology(topologyName string) {
161 data, err := ioutil.ReadFile(ContainerTopologyDir + topologyName + ".yaml")
163 s.T().Fatalf("read error: %v", err)
165 var yamlTopo YamlTopology
166 err = yaml.Unmarshal(data, &yamlTopo)
168 s.T().Fatalf("unmarshal error: %v", err)
171 for _, elem := range yamlTopo.Volumes {
172 volumeMap := elem["volume"].(VolumeConfig)
173 hostDir := volumeMap["host-dir"].(string)
174 s.volumes = append(s.volumes, hostDir)
177 s.containers = make(map[string]*Container)
178 for _, elem := range yamlTopo.Containers {
179 newContainer, err := NewContainer(elem)
180 newContainer.suite = s
182 s.T().Fatalf("container config error: %v", err)
184 s.containers[newContainer.name] = newContainer
188 func (s *HstSuite) loadNetworkTopology(topologyName string) {
189 data, err := ioutil.ReadFile(NetworkTopologyDir + topologyName + ".yaml")
191 s.T().Fatalf("read error: %v", err)
193 var yamlTopo YamlTopology
194 err = yaml.Unmarshal(data, &yamlTopo)
196 s.T().Fatalf("unmarshal error: %v", err)
199 s.addresser = NewAddresser(s)
200 s.netInterfaces = make(map[string]*NetInterface)
201 for _, elem := range yamlTopo.Devices {
202 switch elem["type"].(string) {
205 if namespace, err := NewNetNamespace(elem); err == nil {
206 s.netConfigs = append(s.netConfigs, &namespace)
208 s.T().Fatalf("network config error: %v", err)
213 if netIf, err := NewNetworkInterface(elem, s.addresser); err == nil {
214 s.netConfigs = append(s.netConfigs, netIf)
215 s.netInterfaces[netIf.Name()] = netIf
217 s.T().Fatalf("network config error: %v", err)
222 if bridge, err := NewBridge(elem); err == nil {
223 s.netConfigs = append(s.netConfigs, &bridge)
225 s.T().Fatalf("network config error: %v", err)
232 func (s *HstSuite) configureNetworkTopology(topologyName string) {
233 s.loadNetworkTopology(topologyName)
235 if *IsUnconfiguring {
239 for _, nc := range s.netConfigs {
240 if err := nc.Configure(); err != nil {
241 s.T().Fatalf("network config error: %v", err)
246 func (s *HstSuite) unconfigureNetworkTopology() {
250 for _, nc := range s.netConfigs {
255 func (s *HstSuite) getTestId() string {
256 testName := s.T().Name()
258 if s.testIds == nil {
259 s.testIds = map[string]string{}
262 if _, ok := s.testIds[testName]; !ok {
263 s.testIds[testName] = time.Now().Format(time.RFC3339)
266 return s.testIds[testName]
269 type AddressCounter = int
271 type Addresser struct {
272 networks map[int]AddressCounter
276 func (a *Addresser) AddNetwork(networkNumber int) {
277 a.networks[networkNumber] = 1
280 func (a *Addresser) NewIp4Address(inputNetworkNumber ...int) (string, error) {
281 var networkNumber int = 0
282 if len(inputNetworkNumber) > 0 {
283 networkNumber = inputNetworkNumber[0]
286 if _, ok := a.networks[networkNumber]; !ok {
287 a.AddNetwork(networkNumber)
290 numberOfAddresses := a.networks[networkNumber]
292 if numberOfAddresses == 254 {
293 return "", fmt.Errorf("no available IPv4 addresses")
296 address := fmt.Sprintf("10.10.%v.%v/24", networkNumber, numberOfAddresses)
297 a.networks[networkNumber] = numberOfAddresses + 1
302 func NewAddresser(suite *HstSuite) *Addresser {
303 var addresser = new(Addresser)
304 addresser.suite = suite
305 addresser.networks = make(map[int]AddressCounter)
306 addresser.AddNetwork(0)