TEST: add checking maps over runtime

Check maps over runtime is done only with go build tag test_todo and executed in a job allowed to fails.
Without the tag, with check only the map file content.

Author: hdurand0710

.aspell.yml

@@ -73,6 +73,7 @@ allowed:
   - tcp
   - tls
   - tlsv
+  - todo
   - ubuntu
   - unix
   - usr

.gitlab/unit-tests.yml

@@ -91,26 +91,3 @@ unit-tests-todo:
       - junit-report.xml
     reports:
       junit: junit-report.xml
-
-unit-tests-todo_nowait:
-  allow_failure: true
-  needs: ["diff", "tidy"]
-  rules:
-    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
-    - if: "$CI_PROJECT_NAMESPACE != 'haproxy-controller/community' && $CI_PIPELINE_SOURCE == 'push'"
-  stage: unit-tests
-  image:
-    name: $CI_REGISTRY_GO/haproxy-alpine:3.2-go$GO_VERSION
-    entrypoint: [""]
-  tags:
-    - go
-  before_script:
-    - export PATH=$PATH:/root/go/bin
-  script:
-    - task test-todo_nowait
-  artifacts:
-    when: always
-    paths:
-      - junit-report.xml
-    reports:
-      junit: junit-report.xml

cmd/generate-gwapi/main.go

@@ -320,29 +320,6 @@ unit-tests-todo:
       - junit-report.xml
     reports:
       junit: junit-report.xml
-
-unit-tests-todo_nowait:
-  allow_failure: true
-  needs: ["diff", "tidy"]
-  rules:
-    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
-    - if: "$CI_PROJECT_NAMESPACE != 'haproxy-controller/community' && $CI_PIPELINE_SOURCE == 'push'"
-  stage: unit-tests
-  image:
-    name: $CI_REGISTRY_GO/haproxy-alpine:3.2-go$GO_VERSION
-    entrypoint: [""]
-  tags:
-    - go
-  before_script:
-    - export PATH=$PATH:/root/go/bin
-  script:
-    - task test-todo_nowait
-  artifacts:
-    when: always
-    paths:
-      - junit-report.xml
-    reports:
-      junit: junit-report.xml
 `
 
 var conditionsKOTmpl = `# Code generated by cmd/generate-gwapi; DO NOT EDIT.

taskfile.yml

@@ -54,13 +54,6 @@ tasks:
         vars:
           TEST_TAGS: "test_todo"
 
-  test-todo_nowait:
-    desc: "run Go tests"
-    cmds:
-      - task: test
-        vars:
-          TEST_TAGS: "test_todo_nowait"
-
   test:
     desc: "run Go tests"
     deps:

test/integration/base/base.go

@@ -92,7 +92,7 @@ func (b *BaseSuite) CreateFixtures(fixturePath string, manifestNames []string) {
 // Note that CleanupFixturesCheckMapFiles will wait until the map file is empty before
 // returning. This is to ensure that the test does not finish before the cleanup
 // has finished.
-func (b *BaseSuite) CleanupFixturesCheckMapFiles(fixturePath string, manifestNames []string, mapFileRelativePath string) {
+func (b *BaseSuite) CleanupFixturesCheckMapFiles(fixturePath string, manifestNames []string, mapFileRelativePaths []string) {
 	b.T().Logf("Cleaning up fixtures in %s", fixturePath)
 	defer b.T().Logf("End of cleaning up fixtures in %s", fixturePath)
 	params := utils.RuntimeYamlParams{
@@ -105,13 +105,9 @@ func (b *BaseSuite) CleanupFixturesCheckMapFiles(fixturePath string, manifestNam
 	}
 	err := utils.DeleteRuntimeObjectsFromYAMLFiles(params)
 	b.Require().NoError(err)
-	b.Eventually(func() bool {
-		emptyMapFile := b.CheckMapContents(mapFileRelativePath, "")
-		if !emptyMapFile {
-			return false
-		}
-		return b.CheckRuntimeMapContents(mapFileRelativePath, "")
-	}, timeout, interval, fmt.Sprintf("maps in %s were not emptied", mapFileRelativePath))
+	for _, mapFileRelativePath := range mapFileRelativePaths {
+		b.ExpectMapContents(mapFileRelativePath, "")
+	}
 }
 
 func (b *BaseSuite) CreateFixturesInNamespace(fixturePath, namespace string, manifestNames []string) {
@@ -414,19 +410,25 @@ var StandardMaps = []string{
 }
 
 func (b *BaseSuite) ExpectMapContents(mapFilePath, expectedMapPath string) {
-	res := b.Eventually(func() bool {
+	b.Require().Eventually(func() bool {
 		check := b.CheckMapContents(mapFilePath, expectedMapPath)
 		return check
 	}, timeout, interval, fmt.Sprintf("maps in %s did not match expected contents", mapFilePath))
-	if !res {
-		msg := fmt.Sprintf("maps in %s did not match expected contents", mapFilePath)
-		b.T().Fatal(msg)
-	}
 }
 
 func (b *BaseSuite) CheckMapContents(mapFileRelativePath, expectedMapPath string) bool {
-	b.T().Logf("Checking map contents in %s", mapFileRelativePath)
-	b.T().Logf("with expected map path %s", expectedMapPath)
+	checkFile := b.CheckMapFileContents(mapFileRelativePath, expectedMapPath)
+	if !checkFile {
+		return false
+	}
+	if TestMapThroughRuntime {
+		return b.CheckRuntimeMapContents(mapFileRelativePath, expectedMapPath)
+	}
+	return true
+}
+
+func (b *BaseSuite) CheckMapFileContents(mapFileRelativePath, expectedMapPath string) bool {
+	b.T().Logf("Checking map [file] in %s with expected map path %s", mapFileRelativePath, expectedMapPath)
 	for _, mapName := range StandardMaps {
 		expectedFilePath := path.Join(expectedMapPath, mapName)
 
@@ -446,18 +448,18 @@ func (b *BaseSuite) CheckMapContents(mapFileRelativePath, expectedMapPath string
 		if expectationExists {
 			// Check if content matches
 			if string(expectedContent) != actualString {
-				b.T().Logf("Map mismatch for %s: \nexpected %q, \ngot      %q", mapName, string(expectedContent), actualString)
+				b.T().Logf("  map [file] mismatch for %s: \nexpected %q, \ngot      %q", mapName, string(expectedContent), actualString)
 				return false
 			}
 		} else {
 			// Check if actual is empty
 			if strings.TrimSpace(actualString) != "" {
-				b.T().Logf("Map %s should be empty but has content: %q", mapName, actualString)
+				b.T().Logf("   map [file] %s should be empty but has content: %q", mapName, actualString)
 				return false
 			}
 		}
 	}
-	b.T().Logf("Map contents correct for %s", mapFileRelativePath)
+	b.T().Logf("  map [file] correct for %s", mapFileRelativePath)
 	return true
 }
 
@@ -636,8 +638,7 @@ func (b *BaseSuite) ConsistentlyNoReload(oldPid string, duration time.Duration)
 }
 
 func (b *BaseSuite) CheckRuntimeMapContents(mapFileRelativePath, expectedMapPath string) bool {
-	b.T().Logf("Checking runtime map contents for %s with expected map path %s", mapFileRelativePath, expectedMapPath)
-	defer b.T().Logf("End of checking runtime map contents for %s with expected map path %s", mapFileRelativePath, expectedMapPath)
+	b.T().Logf("Checking map [runtime] for %s with expected map path %s", mapFileRelativePath, expectedMapPath)
 	socketPath := filepath.Join(b.test.HaproxyCfgDir, "haproxy-runtime-api.sock")
 
 	for _, mapName := range StandardMaps {
@@ -669,11 +670,11 @@ func (b *BaseSuite) CheckRuntimeMapContents(mapFileRelativePath, expectedMapPath
 		}
 
 		if expectationExists {
-			b.T().Logf("Runtime map contents: %s", actualNormalized)
-			b.T().Logf("Expected runtime map contents: %s", expectedNormalized)
+			b.T().Logf("map [runtime] contents: %s", actualNormalized)
+			b.T().Logf("Expected map [runtime] contents: %s", expectedNormalized)
 			if expectedNormalized != actualNormalized {
 				b.T().Logf(
-					"Runtime map mismatch for %s:\nexpected:\n%q\ngot:\n%q",
+					"  map [runtime] mismatch for %s:\nexpected:\n%q\ngot:\n%q",
 					mapName,
 					expectedNormalized,
 					actualNormalized,
@@ -683,14 +684,15 @@ func (b *BaseSuite) CheckRuntimeMapContents(mapFileRelativePath, expectedMapPath
 		} else {
 			if strings.TrimSpace(actualNormalized) != "" {
 				b.T().Logf(
-					"Runtime map %s should be empty but has content: %q",
+					"   map [runtime] %s should be empty but has content: %q",
 					mapName,
 					actualNormalized,
 				)
 				return false
 			}
 		}
 	}
+	b.T().Logf("  map [runtime] correct for %s", mapFileRelativePath)
 
 	return true
 }

test/integration/base/base_wihtout_map_runtime.go

@@ -0,0 +1,21 @@
+//go:build !test_todo
+
+// Copyright 2019 HAProxy Technologies 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 base
+
+const (
+	TestMapThroughRuntime = false
+)

test/integration/base/base_with_map_runtime.go

@@ -0,0 +1,21 @@
+//go:build test_todo
+
+// Copyright 2019 HAProxy Technologies 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 base
+
+const (
+	TestMapThroughRuntime = true
+)

test/integration/hostnames-matchtype/1-gw-exact-route-exact-match-exact/hostnames_matchtype_test.go

@@ -15,7 +15,6 @@
 package hostnames_matchtype1
 
 import (
-	"fmt"
 	"path"
 
 	"github.com/haproxytech/haproxy-unified-gateway/test/integration/utils"
@@ -27,7 +26,9 @@ func (s *HostnamesMatchtypeSuite1) Test_1_Exact_Route_Exact_Match_Exact() {
 
 	fixturePath := path.Join(fixtureDirPath, fixtureDir)
 	s.CreateFixtures(fixturePath, nil)
-	defer s.CleanupFixtures(fixturePath, nil)
+	mapFilePath1 := "hug_http_31081"
+	mapFilePath2 := "hug_https_31444"
+	defer s.CleanupFixturesCheckMapFiles(fixturePath, nil, []string{mapFilePath1, mapFilePath2})
 
 	// Expected Conditions
 	expectationsPath := path.Join(fixturePath, "expectations")
@@ -45,14 +46,8 @@ func (s *HostnamesMatchtypeSuite1) Test_1_Exact_Route_Exact_Match_Exact() {
 	expectedMapsPath := path.Join("expectations", "maps")
 
 	// For FE http
-	mapFilePath := "hug_http_31081"
-	s.Eventually(func() bool {
-		return s.CheckMapContents(mapFilePath, expectedMapsPath)
-	}, timeout, interval, fmt.Sprintf("maps in %s did not match expected contents", mapFilePath))
+	s.ExpectMapContents(mapFilePath1, expectedMapsPath)
 
 	// For FE https
-	mapFilePath = "hug_https_31444"
-	s.Eventually(func() bool {
-		return s.CheckMapContents(mapFilePath, expectedMapsPath)
-	}, timeout, interval, fmt.Sprintf("maps in %s did not match expected contents", mapFilePath))
+	s.ExpectMapContents(mapFilePath2, expectedMapsPath)
 }

test/integration/hostnames-matchtype/1-gw-exact-route-exact-match-exact/suite_test.go

@@ -16,18 +16,12 @@ package hostnames_matchtype1
 
 import (
 	"testing"
-	"time"
 
 	"github.com/haproxytech/haproxy-unified-gateway/test/integration/base"
 
 	"github.com/stretchr/testify/suite"
 )
 
-const (
-	timeout  = time.Second * 30
-	interval = time.Second * 1
-)
-
 type HostnamesMatchtypeSuite1 struct {
 	base.BaseSuite
 }

test/integration/hostnames-matchtype/10-gw-exact-route-empty-match-prefix/hostnames_matchtype_test.go

@@ -15,7 +15,6 @@
 package hostnames_matchtype10
 
 import (
-	"fmt"
 	"path"
 
 	"github.com/haproxytech/haproxy-unified-gateway/test/integration/utils"
@@ -27,7 +26,9 @@ func (s *HostnamesMatchtypeSuite10) Test_10_Exact_Route_Empty_Match_Prefix() {
 
 	fixturePath := path.Join(fixtureDirPath, fixtureDir)
 	s.CreateFixtures(fixturePath, nil)
-	defer s.CleanupFixtures(fixturePath, nil)
+	mapFilePath1 := "hug_http_31081"
+	mapFilePath2 := "hug_https_31444"
+	defer s.CleanupFixturesCheckMapFiles(fixturePath, nil, []string{mapFilePath1, mapFilePath2})
 
 	// Expected Conditions
 	expectationsPath := path.Join(fixturePath, "expectations")
@@ -45,14 +46,8 @@ func (s *HostnamesMatchtypeSuite10) Test_10_Exact_Route_Empty_Match_Prefix() {
 	expectedMapsPath := path.Join("expectations", "maps")
 
 	// For FE http
-	mapFilePath := "hug_http_31081"
-	s.Eventually(func() bool {
-		return s.CheckMapContents(mapFilePath, expectedMapsPath)
-	}, timeout, interval, fmt.Sprintf("maps in %s did not match expected contents", mapFilePath))
+	s.ExpectMapContents(mapFilePath1, expectedMapsPath)
 
 	// For FE https
-	mapFilePath = "hug_https_31444"
-	s.Eventually(func() bool {
-		return s.CheckMapContents(mapFilePath, expectedMapsPath)
-	}, timeout, interval, fmt.Sprintf("maps in %s did not match expected contents", mapFilePath))
+	s.ExpectMapContents(mapFilePath2, expectedMapsPath)
 }