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")
24 type HstSuite struct {
26 containers map[string]*Container
28 netConfigs []NetConfig
29 netInterfaces map[string]*NetInterface
31 testIds map[string]string
34 func (s *HstSuite) TearDownSuite() {
35 s.unconfigureNetworkTopology()
38 func (s *HstSuite) TearDownTest() {
46 func (s *HstSuite) skipIfUnconfiguring() {
48 s.skip("skipping to unconfigure")
52 func (s *HstSuite) SetupTest() {
53 s.skipIfUnconfiguring()
58 func (s *HstSuite) SetupVolumes() {
59 for _, volume := range s.volumes {
60 cmd := "docker volume create --name=" + volume
66 func (s *HstSuite) SetupContainers() {
67 for _, container := range s.containers {
68 if container.isOptional == false {
74 func (s *HstSuite) hstFail() {
78 func (s *HstSuite) assertNil(object interface{}, msgAndArgs ...interface{}) {
79 if !assert.Nil(s.T(), object, msgAndArgs...) {
84 func (s *HstSuite) assertNotNil(object interface{}, msgAndArgs ...interface{}) {
85 if !assert.NotNil(s.T(), object, msgAndArgs...) {
90 func (s *HstSuite) assertEqual(expected, actual interface{}, msgAndArgs ...interface{}) {
91 if !assert.Equal(s.T(), expected, actual, msgAndArgs...) {
96 func (s *HstSuite) assertNotEqual(expected, actual interface{}, msgAndArgs ...interface{}) {
97 if !assert.NotEqual(s.T(), expected, actual, msgAndArgs...) {
102 func (s *HstSuite) assertContains(testString, contains interface{}, msgAndArgs ...interface{}) {
103 if !assert.Contains(s.T(), testString, contains, msgAndArgs...) {
108 func (s *HstSuite) assertNotContains(testString, contains interface{}, msgAndArgs ...interface{}) {
109 if !assert.NotContains(s.T(), testString, contains, msgAndArgs...) {
114 func (s *HstSuite) assertNotEmpty(object interface{}, msgAndArgs ...interface{}) {
115 if !assert.NotEmpty(s.T(), object, msgAndArgs...) {
120 func (s *HstSuite) log(args ...any) {
127 func (s *HstSuite) skip(args ...any) {
132 func (s *HstSuite) ResetContainers() {
133 for _, container := range s.containers {
138 func (s *HstSuite) RemoveVolumes() {
139 for _, volumeName := range s.volumes {
140 cmd := "docker volume rm " + volumeName
142 os.RemoveAll(volumeName)
146 func (s *HstSuite) getContainerByName(name string) *Container {
147 return s.containers[name]
151 * Create a copy and return its address, so that individial tests which call this
152 * are not able to modify the original container and affect other tests by doing that
154 func (s *HstSuite) getTransientContainerByName(name string) *Container {
155 containerCopy := *s.containers[name]
156 return &containerCopy
159 func (s *HstSuite) loadContainerTopology(topologyName string) {
160 data, err := ioutil.ReadFile(ContainerTopologyDir + topologyName + ".yaml")
162 s.T().Fatalf("read error: %v", err)
164 var yamlTopo YamlTopology
165 err = yaml.Unmarshal(data, &yamlTopo)
167 s.T().Fatalf("unmarshal error: %v", err)
170 for _, elem := range yamlTopo.Volumes {
171 volumeMap := elem["volume"].(VolumeConfig)
172 hostDir := volumeMap["host-dir"].(string)
173 s.volumes = append(s.volumes, hostDir)
176 s.containers = make(map[string]*Container)
177 for _, elem := range yamlTopo.Containers {
178 newContainer, err := NewContainer(elem)
179 newContainer.suite = s
181 s.T().Fatalf("container config error: %v", err)
183 s.containers[newContainer.name] = newContainer
187 func (s *HstSuite) loadNetworkTopology(topologyName string) {
188 data, err := ioutil.ReadFile(NetworkTopologyDir + topologyName + ".yaml")
190 s.T().Fatalf("read error: %v", err)
192 var yamlTopo YamlTopology
193 err = yaml.Unmarshal(data, &yamlTopo)
195 s.T().Fatalf("unmarshal error: %v", err)
198 s.addresser = NewAddresser(s)
199 s.netInterfaces = make(map[string]*NetInterface)
200 for _, elem := range yamlTopo.Devices {
201 switch elem["type"].(string) {
204 if namespace, err := NewNetNamespace(elem); err == nil {
205 s.netConfigs = append(s.netConfigs, &namespace)
207 s.T().Fatalf("network config error: %v", err)
212 if netIf, err := NewNetworkInterface(elem, s.addresser); err == nil {
213 s.netConfigs = append(s.netConfigs, netIf)
214 s.netInterfaces[netIf.Name()] = netIf
216 s.T().Fatalf("network config error: %v", err)
221 if bridge, err := NewBridge(elem); err == nil {
222 s.netConfigs = append(s.netConfigs, &bridge)
224 s.T().Fatalf("network config error: %v", err)
231 func (s *HstSuite) configureNetworkTopology(topologyName string) {
232 s.loadNetworkTopology(topologyName)
234 if *IsUnconfiguring {
238 for _, nc := range s.netConfigs {
239 if err := nc.Configure(); err != nil {
240 s.T().Fatalf("network config error: %v", err)
245 func (s *HstSuite) unconfigureNetworkTopology() {
249 for _, nc := range s.netConfigs {
254 func (s *HstSuite) getTestId() string {
255 testName := s.T().Name()
257 if s.testIds == nil {
258 s.testIds = map[string]string{}
261 if _, ok := s.testIds[testName]; !ok {
262 s.testIds[testName] = time.Now().Format(time.RFC3339)
265 return s.testIds[testName]
268 type AddressCounter = int
270 type Addresser struct {
271 networks map[int]AddressCounter
275 func (a *Addresser) AddNetwork(networkNumber int) {
276 a.networks[networkNumber] = 1
279 func (a *Addresser) NewIp4Address(inputNetworkNumber ...int) (string, error) {
280 var networkNumber int = 0
281 if len(inputNetworkNumber) > 0 {
282 networkNumber = inputNetworkNumber[0]
285 if _, ok := a.networks[networkNumber]; !ok {
286 a.AddNetwork(networkNumber)
289 numberOfAddresses := a.networks[networkNumber]
291 if numberOfAddresses == 254 {
292 return "", fmt.Errorf("no available IPv4 addresses")
295 address := fmt.Sprintf("10.10.%v.%v/24", networkNumber, numberOfAddresses)
296 a.networks[networkNumber] = numberOfAddresses + 1
301 func NewAddresser(suite *HstSuite) *Addresser {
302 var addresser = new(Addresser)
303 addresser.suite = suite
304 addresser.networks = make(map[int]AddressCounter)
305 addresser.AddNetwork(0)