Merge pull request #29782 from aabughosh/staticEntryTest

CNF-17748: Add a comparing between static entry test

Author: openshift-merge-bot[bot]

go.mod

@@ -93,6 +93,12 @@ require (
 	sigs.k8s.io/yaml v1.4.0
 )
 
+require (
+	github.com/evanphx/json-patch/v5 v5.9.0 // indirect
+	github.com/gocarina/gocsv v0.0.0-20231116093920-b87c2d0e983a // indirect
+	gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
+)
+
 require (
 	cel.dev/expr v0.18.0 // indirect
 	git.sr.ht/~sbinet/gg v0.5.0 // indirect
@@ -154,7 +160,6 @@ require (
 	github.com/emirpasic/gods v1.12.0 // indirect
 	github.com/euank/go-kmsg-parser v2.0.0+incompatible // indirect
 	github.com/evanphx/json-patch v5.9.0+incompatible // indirect
-	github.com/evanphx/json-patch/v5 v5.9.0 // indirect
 	github.com/exponent-io/jsonpath v0.0.0-20210407135951-1de76d718b3f // indirect
 	github.com/fatih/camelcase v1.0.0 // indirect
 	github.com/felixge/fgprof v0.9.4 // indirect
@@ -172,7 +177,6 @@ require (
 	github.com/go-openapi/swag v0.23.0 // indirect
 	github.com/go-pdf/fpdf v0.8.0 // indirect
 	github.com/go-task/slim-sprig/v3 v3.0.0 // indirect
-	github.com/gocarina/gocsv v0.0.0-20231116093920-b87c2d0e983a // indirect
 	github.com/godbus/dbus/v5 v5.1.0 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang-jwt/jwt/v4 v4.5.0 // indirect
@@ -290,7 +294,6 @@ require (
 	golang.org/x/text v0.23.0 // indirect
 	golang.org/x/time v0.7.0 // indirect
 	golang.org/x/tools v0.26.0 // indirect
-	gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
 	google.golang.org/genproto v0.0.0-20240123012728-ef4313101c80 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20240826202546-f6391c0de4c7 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20240924160255-9d4c2d233b61 // indirect

test/extended/networking/commatrix.go

@@ -60,15 +60,51 @@ var staticOpenPortsToIgnore = []types.ComDetails{
 	},
 }
 
+// port used only interanly just on ci.
+var staticOpenPortsToIgnoreInStaticEntry = []types.ComDetails{
+	{
+		Direction: "Ingress",
+		Protocol:  "TCP",
+		Port:      10250,
+		NodeRole:  "worker",
+		Optional:  false,
+	},
+	{
+		Direction: "Ingress",
+		Protocol:  "TCP",
+		Port:      10250,
+		NodeRole:  "master",
+		Optional:  false,
+	},
+	{
+		Direction: "Ingress",
+		Protocol:  "TCP",
+		Port:      6385,
+		NodeRole:  "master",
+		Optional:  false,
+	},
+}
+
+var (
+	cs                *client.ClientSet
+	epExporter        *endpointslices.EndpointSlicesExporter
+	isSNO             bool
+	infraType         configv1.PlatformType
+	deployment        types.Deployment
+	utilsHelpers      utils.UtilsInterface
+	artifactsDir      string
+	commMatrixCreator *commatrixcreator.CommunicationMatrixCreator
+)
+
 var _ = Describe("[sig-network][Feature:commatrix][apigroup:config.openshift.io][Serial]", func() {
-	It("generated communication matrix should be equal to documented communication matrix", func() {
+	BeforeEach(func() {
 		kubeconfig := os.Getenv("KUBECONFIG")
 		if kubeconfig == "" {
 			Fail("KUBECONFIG not set")
 		}
 
 		By("Creating output folder")
-		artifactsDir := os.Getenv("ARTIFACT_DIR")
+		artifactsDir = os.Getenv("ARTIFACT_DIR")
 		if artifactsDir == "" {
 			log.Println("env var ARTIFACT_DIR is not set, using default value")
 		}
@@ -78,47 +114,50 @@ var _ = Describe("[sig-network][Feature:commatrix][apigroup:config.openshift.io]
 		Expect(err).NotTo(HaveOccurred())
 
 		By("Creating the clients for the Generating step")
-		cs, err := client.New()
+		cs, err = client.New()
 		Expect(err).NotTo(HaveOccurred())
 
-		utilsHelpers := utils.New(cs)
-
-		epExporter, err := endpointslices.New(cs)
-		Expect(err).ToNot(HaveOccurred())
-
-		By("Get cluster's version and check if it's suitable for test")
-		clusterVersionStr, err := cluster.GetClusterVersion(cs)
+		utilsHelpers = utils.New(cs)
+		epExporter, err = endpointslices.New(cs)
 		Expect(err).NotTo(HaveOccurred())
-		clusterVersion, err := version.NewVersion(clusterVersionStr)
-		Expect(err).ToNot(HaveOccurred())
-
-		minimalDocCommatrixVersion, err := version.NewVersion(minimalDocCommatrixVersionStr)
-		Expect(err).ToNot(HaveOccurred())
-
-		if clusterVersion.LessThan(minimalDocCommatrixVersion) {
-			Skip(fmt.Sprintf("Cluster version is lower than the lowest version that has a documented communication matrix (%v)", minimalDocCommatrixVersionStr))
-		}
 
 		By("Get cluster's deployment and infrastructure types")
-		deployment := types.Standard
-		isSNO, err := utilsHelpers.IsSNOCluster()
+		deployment = types.Standard
+		isSNO, err = utilsHelpers.IsSNOCluster()
 		Expect(err).NotTo(HaveOccurred())
+
 		if isSNO {
 			deployment = types.SNO
 		}
 
-		platformType, err := utilsHelpers.GetPlatformType()
+		infraType, err = utilsHelpers.GetPlatformType()
 		Expect(err).NotTo(HaveOccurred())
 
 		// if cluster's type is not supported by the commatrix app, skip tests
-		if !slices.Contains(types.SupportedPlatforms, platformType) {
-			Skip(fmt.Sprintf("unsupported platform type: %s. Supported platform types are: %v", platformType, types.SupportedPlatforms))
+		if !slices.Contains(types.SupportedPlatforms, infraType) {
+			Skip(fmt.Sprintf("unsupported platform type: %s. Supported platform types are: %v", infraType, types.SupportedPlatforms))
 		}
 
-		By("Generating cluster's communication matrix")
-		commMatrixCreator, err := commatrixcreator.New(epExporter, "", "", platformType, deployment)
+		By("Generating cluster's communication matrix creator")
+		commMatrixCreator, err = commatrixcreator.New(epExporter, "", "", infraType, deployment)
+		Expect(err).NotTo(HaveOccurred())
+	})
+
+	It("generated communication matrix should be equal to documented communication matrix", func() {
+		By("Get cluster's version and check if it's suitable for test")
+		clusterVersionStr, err := cluster.GetClusterVersion(cs)
 		Expect(err).NotTo(HaveOccurred())
+		clusterVersion, err := version.NewVersion(clusterVersionStr)
+		Expect(err).ToNot(HaveOccurred())
+
+		minimalDocCommatrixVersion, err := version.NewVersion(minimalDocCommatrixVersionStr)
+		Expect(err).ToNot(HaveOccurred())
+
+		if clusterVersion.LessThan(minimalDocCommatrixVersion) {
+			Skip(fmt.Sprintf("Cluster version is lower than the lowest version that has a documented communication matrix (%v)", minimalDocCommatrixVersionStr))
+		}
 
+		By("Create endpoint matrix ")
 		commatrix, err := commMatrixCreator.CreateEndpointMatrix()
 		Expect(err).NotTo(HaveOccurred())
 
@@ -130,7 +169,7 @@ var _ = Describe("[sig-network][Feature:commatrix][apigroup:config.openshift.io]
 
 		// clusters with unsupported platform types had skip the test, so we assume the platform type is supported
 		var docType string
-		switch platformType {
+		switch infraType {
 		case configv1.AWSPlatformType:
 			docType = "aws"
 		case configv1.BareMetalPlatformType:
@@ -214,4 +253,40 @@ var _ = Describe("[sig-network][Feature:commatrix][apigroup:config.openshift.io]
 			Expect(err).ToNot(HaveOccurred())
 		}
 	})
+
+	It("Static entries should not overlap with those in the EndpointSlice; any shared entries must be removed", func() {
+		By("Get EndpointSlice matrix")
+		err := epExporter.LoadExposedEndpointSlicesInfo()
+		Expect(err).NotTo(HaveOccurred())
+
+		epSliceComDetails, err := epExporter.ToComDetails()
+		Expect(err).NotTo(HaveOccurred())
+
+		By("Get static entries list")
+		staticEntries, err := commMatrixCreator.GetStaticEntries()
+		Expect(err).NotTo(HaveOccurred())
+
+		staticEntriesMat := &types.ComMatrix{Matrix: staticEntries}
+		epSliceComDetailsMat := &types.ComMatrix{Matrix: epSliceComDetails}
+
+		By("Write the matrix to files")
+		err = staticEntriesMat.WriteMatrixToFileByType(utilsHelpers, "static-entry-matrix", types.FormatCSV, deployment, artifactsDir)
+		Expect(err).ToNot(HaveOccurred())
+
+		err = epSliceComDetailsMat.WriteMatrixToFileByType(utilsHelpers, "expose-communication-matrix", types.FormatCSV, deployment, artifactsDir)
+		Expect(err).ToNot(HaveOccurred())
+
+		By("Generating the Diff between the static entris and the expose communication matrix")
+		endpointslicesDiffWithstaticEntrieMat := matrixdiff.Generate(epSliceComDetailsMat, staticEntriesMat)
+		sharedEntries := endpointslicesDiffWithstaticEntrieMat.GetSharedEntries()
+
+		portsToIgnoreMat := &types.ComMatrix{Matrix: staticOpenPortsToIgnoreInStaticEntry}
+		sharedEntriesDiffWithIgnoredPorts := matrixdiff.Generate(sharedEntries, portsToIgnoreMat)
+		staticEntryNeedToRemove := sharedEntriesDiffWithIgnoredPorts.GetUniquePrimary()
+
+		if len(staticEntryNeedToRemove.Matrix) > 0 {
+			err := fmt.Errorf("the following ports must be removed from the static entry file, as they already exist in an EndpointSlice:\n%s", staticEntryNeedToRemove)
+			Expect(err).NotTo(HaveOccurred())
+		}
+	})
 })