765 test seperation (#875)

have different structs for different tests (report, diff, explain, lint); have a dedicated package for tests functionality

Author: ShiriMoran

pkg/awsvpc/analysis_output_test.go

@@ -10,61 +10,73 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/np-guard/vpc-network-config-analyzer/pkg/commonvpc"
+	"github.com/np-guard/vpc-network-config-analyzer/pkg/commonvpc/testfunc"
 	"github.com/np-guard/vpc-network-config-analyzer/pkg/vpcmodel"
 )
 
 const analysisOut = "analysis_out"
 
-var tests = []*commonvpc.VpcGeneralTest{
+var tests = []*testfunc.VpcAnalysisTest{
 	{
-		InputConfig: "basic_config_with_sg",
-		UseCases:    []vpcmodel.OutputUseCase{vpcmodel.AllEndpoints, vpcmodel.AllSubnets},
-		Format:      vpcmodel.Text,
+		VpcTestCommon: testfunc.VpcTestCommon{
+			InputConfig: "basic_config_with_sg",
+			UseCases:    []vpcmodel.OutputUseCase{vpcmodel.AllEndpoints, vpcmodel.AllSubnets},
+			Format:      vpcmodel.Text,
+		},
 	},
 	{
-		InputConfig: "aws_sg_1",
-		UseCases:    []vpcmodel.OutputUseCase{vpcmodel.AllEndpoints, vpcmodel.AllSubnets},
-		Format:      vpcmodel.Text,
+		VpcTestCommon: testfunc.VpcTestCommon{
+			InputConfig: "aws_sg_1",
+			UseCases:    []vpcmodel.OutputUseCase{vpcmodel.AllEndpoints, vpcmodel.AllSubnets},
+			Format:      vpcmodel.Text,
+		},
 	},
 	{
-		InputConfig: "aws_sg_1",
-		UseCases:    []vpcmodel.OutputUseCase{vpcmodel.AllEndpoints},
-		Format:      vpcmodel.HTML,
+		VpcTestCommon: testfunc.VpcTestCommon{
+			InputConfig: "aws_sg_1",
+			UseCases:    []vpcmodel.OutputUseCase{vpcmodel.AllEndpoints},
+			Format:      vpcmodel.HTML,
+		},
 	},
 	{
-		InputConfig: "aws_acl_1",
-		UseCases:    []vpcmodel.OutputUseCase{vpcmodel.AllEndpoints, vpcmodel.AllSubnets},
-		Format:      vpcmodel.Text,
+		VpcTestCommon: testfunc.VpcTestCommon{
+			InputConfig: "aws_acl_1",
+			UseCases:    []vpcmodel.OutputUseCase{vpcmodel.AllEndpoints, vpcmodel.AllSubnets},
+			Format:      vpcmodel.Text,
+		},
 	},
 	{
-		InputConfig: "aws_mixed",
-		UseCases:    []vpcmodel.OutputUseCase{vpcmodel.AllEndpoints, vpcmodel.AllSubnets},
-		Format:      vpcmodel.Text,
+		VpcTestCommon: testfunc.VpcTestCommon{
+			InputConfig: "aws_mixed",
+			UseCases:    []vpcmodel.OutputUseCase{vpcmodel.AllEndpoints, vpcmodel.AllSubnets},
+			Format:      vpcmodel.Text,
+		},
 	},
 	{
-		InputConfig: "aws_mixed",
-		UseCases:    []vpcmodel.OutputUseCase{vpcmodel.AllEndpoints},
-		Format:      vpcmodel.HTML,
+		VpcTestCommon: testfunc.VpcTestCommon{
+			InputConfig: "aws_mixed",
+			UseCases:    []vpcmodel.OutputUseCase{vpcmodel.AllEndpoints},
+			Format:      vpcmodel.HTML,
+		},
 	},
 }
 
 // uncomment the function below to run for updating the expected output
-/*
-func TestAllWithGeneration(t *testing.T) {
+
+/*func TestReportWithGeneration(t *testing.T) {
 	// tests is the list of tests to run
 	for testIdx := range tests {
 		tt := tests[testIdx]
-		commonvpc.TestAll(tt, t, commonvpc.OutputGeneration, &AWSresourcesContainer{}, analysisOut, tt.InputConfig)
+		tt.TestAnalysisSingleTest(t, testfunc.OutputGeneration, &AWSresourcesContainer{}, analysisOut, tt.InputConfig)
 	}
 	fmt.Println("done")
-}
-*/
-func TestAllWithComparison(t *testing.T) {
+}*/
+
+func TestReportWithComparison(t *testing.T) {
 	// tests is the list of tests to run
 	for testIdx := range tests {
 		tt := tests[testIdx]
-		commonvpc.TestAll(tt, t, commonvpc.OutputComparison, &AWSresourcesContainer{}, analysisOut, tt.InputConfig)
+		tt.TestAnalysisSingleTest(t, testfunc.OutputComparison, &AWSresourcesContainer{}, analysisOut, tt.InputConfig)
 	}
 	fmt.Println("done")
 }

pkg/awsvpc/explainability_test.go

@@ -10,111 +10,109 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/np-guard/vpc-network-config-analyzer/pkg/commonvpc"
-	"github.com/np-guard/vpc-network-config-analyzer/pkg/vpcmodel"
+	"github.com/np-guard/vpc-network-config-analyzer/pkg/commonvpc/testfunc"
 )
 
-var explainTests = []*commonvpc.VpcGeneralTest{
+var explainTests = []*testfunc.VpcExplainTest{
 	// existing connection between two endpoints of different subnets
 	{
-		Name:          "ip_to_ip",
-		InputConfig:   "aws_sg_1",
+		VpcTestCommon: testfunc.VpcTestCommon{
+			Name:        "ip_to_ip",
+			InputConfig: "aws_sg_1",
+		},
 		ESrc:          "10.240.40.217",
 		EDst:          "10.240.20.43",
-		Format:        vpcmodel.Text,
 		DetailExplain: true,
 	},
 	// non-existing connection between two endpoints of different subnets due to one of the nacls
 	{
-		Name:          "nacl_blocking",
-		InputConfig:   "aws_mixed",
+		VpcTestCommon: testfunc.VpcTestCommon{
+			Name:        "nacl_blocking",
+			InputConfig: "aws_mixed",
+		},
 		ESrc:          "10.240.2.28",
 		EDst:          "10.240.32.122",
-		Format:        vpcmodel.Text,
 		DetailExplain: true,
 	},
 	// existing sub-connection between two endpoints of the same subnet
 	// todo: https://github.com/np-guard/vpc-network-config-analyzer/issues/859
 	{
-		Name:          "same_subnet_partial_connection",
-		InputConfig:   "aws_mixed",
+		VpcTestCommon: testfunc.VpcTestCommon{
+			Name:        "same_subnet_partial_connection",
+			InputConfig: "aws_mixed",
+		},
 		ESrc:          "10.240.32.122",
 		EDst:          "10.240.32.91",
-		Format:        vpcmodel.Text,
 		DetailExplain: true,
 	},
 	// no connection between two endpoints of the same subnet
 	{
-		Name:          "subnet_to_subnet",
-		InputConfig:   "aws_mixed",
+		VpcTestCommon: testfunc.VpcTestCommon{
+			Name:        "subnet_to_subnet",
+			InputConfig: "aws_mixed",
+		},
 		ESrc:          "private2",
 		EDst:          "private1",
-		Format:        vpcmodel.Text,
 		DetailExplain: true,
 	},
 	// connection to the public internet blocked by sg and private subnet
 	{
-		Name:          "to_external_private_subnet",
-		InputConfig:   "aws_sg_1",
+		VpcTestCommon: testfunc.VpcTestCommon{
+			Name:        "to_external_private_subnet",
+			InputConfig: "aws_sg_1",
+		},
 		ESrc:          "10.240.20.245",
 		EDst:          "161.26.0.0",
-		Format:        vpcmodel.Text,
 		DetailExplain: true,
 	},
 	// existing connection to the public internet
 	{
-		Name:          "to_external_public_subnet",
-		InputConfig:   "aws_sg_1",
+		VpcTestCommon: testfunc.VpcTestCommon{
+			Name:        "to_external_public_subnet",
+			InputConfig: "aws_sg_1",
+		},
 		ESrc:          "10.240.10.42",
 		EDst:          "161.26.0.0",
-		Format:        vpcmodel.Text,
 		DetailExplain: true,
 	},
 	// existing connection from the public internet
 	{
-		Name:          "from_external_public_subnet",
-		InputConfig:   "aws_mixed",
+		VpcTestCommon: testfunc.VpcTestCommon{
+			Name:        "from_external_public_subnet",
+			InputConfig: "aws_mixed",
+		},
 		ESrc:          "147.235.0.0/16",
 		EDst:          "10.240.0.96",
-		Format:        vpcmodel.Text,
 		DetailExplain: true,
 	},
 	// connection to the public internet blocked only by private subnet
 	{
-		Name:          "to_external_blocked_only_private_subnet",
-		InputConfig:   "aws_sg_1_allow_sg_private",
+		VpcTestCommon: testfunc.VpcTestCommon{
+			Name:        "to_external_blocked_only_private_subnet",
+			InputConfig: "aws_sg_1_allow_sg_private",
+		},
 		ESrc:          "10.240.20.245",
 		EDst:          "161.26.0.0",
-		Format:        vpcmodel.Text,
 		DetailExplain: true,
 	},
 }
 
-func TestAll(t *testing.T) {
+func TestExplainWithComparsion(t *testing.T) {
 	// explainTests is the list of tests to run
 	for testIdx := range explainTests {
 		tt := explainTests[testIdx]
-		t.Run(tt.Name, func(t *testing.T) {
-			t.Parallel()
-			rc := &AWSresourcesContainer{}
-			commonvpc.RunExplainTest(tt, t, rc)
-		})
+		tt.TestSingleExplain(t, testfunc.OutputComparison, &AWSresourcesContainer{}, tt.Name)
 	}
 	fmt.Println("done")
 }
 
 // uncomment the function below for generating the expected output files instead of comparing
-/*
-func TestAllWithGeneration(t *testing.T) {
+
+/*func TestExplainWithGeneration(t *testing.T) {
 	// tests is the list of tests to run
 	for testIdx := range explainTests {
 		tt := explainTests[testIdx]
-		tt.Mode = commonvpc.OutputGeneration
-		t.Run(tt.Name, func(t *testing.T) {
-			t.Parallel()
-			rc := &AWSresourcesContainer{}
-			commonvpc.RunExplainTest(tt, t,rc)
-		})
+		tt.TestSingleExplain(t, commonvpc.OutputGeneration, &AWSresourcesContainer{}, tt.Name)
 	}
 	fmt.Println("done")
 }*/

pkg/awsvpc/lint_test.go

@@ -10,39 +10,45 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/np-guard/vpc-network-config-analyzer/pkg/commonvpc"
+	"github.com/np-guard/vpc-network-config-analyzer/pkg/commonvpc/testfunc"
 )
 
-var lintTests = []*commonvpc.VpcGeneralTest{
+var lintTests = []*testfunc.VpcLintTest{
 	{
-		Name:        "aws_acl1",
-		InputConfig: "aws_acl_1",
-		Enable:      []string{"sg-split-subnet"},
+		VpcTestCommon: testfunc.VpcTestCommon{
+			Name:        "aws_acl1",
+			InputConfig: "aws_acl_1",
+		},
+		Enable: []string{"sg-split-subnet"},
 	},
 	{
-		Name:        "aws_mixed",
-		InputConfig: "aws_mixed",
-		Enable:      []string{"sg-split-subnet"},
+		VpcTestCommon: testfunc.VpcTestCommon{
+			Name:        "aws_mixed",
+			InputConfig: "aws_mixed",
+		},
+		Enable: []string{"sg-split-subnet"},
 	},
 	{
-		Name:        "aws_sg_1",
-		InputConfig: "aws_sg_1",
-		Enable:      []string{"sg-split-subnet"},
+		VpcTestCommon: testfunc.VpcTestCommon{
+			Name:        "aws_sg_1",
+			InputConfig: "aws_sg_1",
+		},
+		Enable: []string{"sg-split-subnet"},
 		Disable: []string{"nacl-split-subnet", "subnet-cidr-overlap", "nacl-unattached",
 			"sg-unattached", "sg-rule-cidr-out-of-range", "nacl-rule-cidr-out-of-range",
 			"tcp-response-blocked", "sg-rule-implied", "nacl-rule-shadowed"},
 	},
 }
 
-func TestAllLint(t *testing.T) {
+func TestLintWithComparsion(t *testing.T) {
 	// lintTests is the list of tests to run
 	for testIdx := range lintTests {
 		tt := lintTests[testIdx]
-		tt.Mode = commonvpc.OutputComparison
+		tt.Mode = testfunc.OutputComparison
 		t.Run(tt.Name, func(t *testing.T) {
 			t.Parallel()
 			rc := &AWSresourcesContainer{}
-			commonvpc.RunLintTest(tt, t, rc)
+			tt.TestSingleLint(t, rc)
 		})
 	}
 	fmt.Println("done")
@@ -54,11 +60,11 @@ func TestAllLint(t *testing.T) {
 	// tests is the list of tests to run
 	for testIdx := range lintTests {
 		tt := lintTests[testIdx]
-		tt.Mode = commonvpc.OutputGeneration
+		tt.Mode = testfunc.OutputGeneration
 		t.Run(tt.Name, func(t *testing.T) {
 			t.Parallel()
 			rc := &AWSresourcesContainer{}
-			commonvpc.RunLintTest(tt, t, rc)
+			tt.TestSingleLint(t, rc)
 		})
 	}
 	fmt.Println("done")

pkg/commonvpc/testfunc/analysis_output_test_functionality.go

@@ -0,0 +1,29 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package testfunc
+
+import (
+	_ "embed"
+	"testing"
+
+	"github.com/np-guard/vpc-network-config-analyzer/pkg/commonvpc"
+)
+
+type VpcAnalysisTest struct {
+	VpcTestCommon
+	Grouping     bool
+	NoLbAbstract bool
+}
+
+func (tt *VpcAnalysisTest) TestAnalysisSingleTest(t *testing.T, mode testMode, rc commonvpc.ResourcesContainer, testDir, testName string) {
+	tt.Name = testName
+	tt.setMode(mode)
+	t.Run(tt.Name, func(t *testing.T) {
+		t.Parallel()
+		tt.runSingleCommonTest(t, testDir, rc, tt.Grouping, tt.NoLbAbstract, nil)
+	})
+}