refactor Name() and ExtendedName(c) methods (#865)

* refactor Name() and ExtendedName(c) methods * remove extendedPrefix method * remove ExtendedName() method * fix * pass config param where possible
np-guard · Sep 29, 2024 · 7497375 · 7497375
1 parent 1fd0169
commit 7497375
Show file tree

Hide file tree

Showing 30 changed files with 222 additions and 212 deletions.
diff --git a/pkg/awsvpc/parser.go b/pkg/awsvpc/parser.go
@@ -446,15 +446,15 @@ func printConfig(c *vpcmodel.VPCConfig) {
 		if n.IsExternal() {
 			continue
 		}
-		logging.Debug(strings.Join([]string{n.Kind(), n.CidrOrAddress(), n.Name(), n.UID()}, separator))
+		logging.Debug(strings.Join([]string{n.Kind(), n.CidrOrAddress(), n.NameForAnalyzerOut(c), n.UID()}, separator))
 	}
 	logging.Debug("Subnets:")
 	for _, n := range c.Subnets {
-		logging.Debug(strings.Join([]string{n.Kind(), n.CIDR(), n.Name(), n.UID()}, separator))
+		logging.Debug(strings.Join([]string{n.Kind(), n.CIDR(), n.NameForAnalyzerOut(c), n.UID()}, separator))
 	}
 	logging.Debug("NodeSets:")
 	for _, n := range c.NodeSets {
-		logging.Debug(strings.Join([]string{n.Kind(), n.AddressRange().ToIPRanges(), n.Name(), n.UID()}, separator))
+		logging.Debug(strings.Join([]string{n.Kind(), n.AddressRange().ToIPRanges(), n.NameForAnalyzerOut(c), n.UID()}, separator))
 	}
 	logging.Debug("FilterResources:")
 	for _, f := range c.FilterResources {

diff --git a/pkg/commonvpc/vpc.go b/pkg/commonvpc/vpc.go
@@ -90,12 +90,8 @@ func (ni *NetworkInterface) VsiName() string {
 	return ni.Vsi
 }
 
-func (ni *NetworkInterface) Name() string {
-	return nameWithBracketsInfo(ni.Vsi, ni.Address())
-}
-
-func (ni *NetworkInterface) ExtendedName(c *vpcmodel.VPCConfig) string {
-	return ni.ExtendedPrefix(c) + ni.Name()
+func (ni *NetworkInterface) NameForAnalyzerOut(c *vpcmodel.VPCConfig) string {
+	return MultipleVPCsConfigPrefix(c, &ni.VPCResource) + nameWithBracketsInfo(ni.Vsi, ni.Address())
 }
 
 func nameWithBracketsInfo(name, inBrackets string) string {
@@ -737,3 +733,11 @@ func getTableConnEffect(connQuery, conn *connection.Set) (*connection.Set, vpcmo
 		return conn.Intersect(connQuery), vpcmodel.PartlyAllow
 	}
 }
+
+// MultipleVPCsConfigPrefix returns the vpcName of the passed resource when config is multi-vpc
+func MultipleVPCsConfigPrefix(c *vpcmodel.VPCConfig, resource *vpcmodel.VPCResource) string {
+	if c != nil && resource.VPC() != nil {
+		return c.MultipleVPCsConfigPrefix(resource.VPC().Name())
+	}
+	return ""
+}
diff --git a/pkg/ibmvpc/examples/out/synthesis_out/acl_testing3_all_vpcs_.json b/pkg/ibmvpc/examples/out/synthesis_out/acl_testing3_all_vpcs_.json
@@ -4,6 +4,36 @@
         "external-1": "161.26.0.0/16"
     },
     "required-connections": [
+        {
+            "allowed-protocols": [
+                {
+                    "protocol": "ANY"
+                }
+            ],
+            "dst": {
+                "name": "test-vpc1-ky/vsi1-ky",
+                "type": "instance"
+            },
+            "src": {
+                "name": "test-vpc1-ky/vsi2-ky",
+                "type": "instance"
+            }
+        },
+        {
+            "allowed-protocols": [
+                {
+                    "protocol": "ICMP"
+                }
+            ],
+            "dst": {
+                "name": "external-0",
+                "type": "external"
+            },
+            "src": {
+                "name": "test-vpc1-ky/vsi2-ky",
+                "type": "instance"
+            }
+        },
         {
             "allowed-protocols": [
                 {
@@ -16,8 +46,8 @@
                 "type": "instance"
             },
             "src": {
-                "name": "test-vpc1-ky/vsi3c-ky",
-                "type": "instance"
+                "name": "test-vpc1-ky/db-endpoint-gateway-ky",
+                "type": "vpe"
             }
         },
         {
@@ -32,8 +62,8 @@
                 "type": "instance"
             },
             "src": {
-                "name": "test-vpc1-ky/vsi3c-ky",
-                "type": "instance"
+                "name": "test-vpc1-ky/db-endpoint-gateway-ky",
+                "type": "vpe"
             }
         },
         {
@@ -47,8 +77,8 @@
                 "type": "instance"
             },
             "src": {
-                "name": "test-vpc1-ky/vsi3c-ky",
-                "type": "instance"
+                "name": "test-vpc1-ky/db-endpoint-gateway-ky",
+                "type": "vpe"
             }
         },
         {
@@ -65,8 +95,8 @@
                 "type": "instance"
             },
             "src": {
-                "name": "test-vpc1-ky/vsi3c-ky",
-                "type": "instance"
+                "name": "test-vpc1-ky/db-endpoint-gateway-ky",
+                "type": "vpe"
             }
         },
         {
@@ -77,12 +107,12 @@
             ],
             "bidirectional": true,
             "dst": {
-                "name": "test-vpc1-ky/db-endpoint-gateway-ky",
-                "type": "vpe"
-            },
-            "src": {
                 "name": "test-vpc1-ky/vsi3c-ky",
                 "type": "instance"
+            },
+            "src": {
+                "name": "test-vpc1-ky/db-endpoint-gateway-ky",
+                "type": "vpe"
             }
         },
         {
@@ -142,8 +172,8 @@
             ],
             "bidirectional": true,
             "dst": {
-                "name": "test-vpc1-ky/db-endpoint-gateway-ky",
-                "type": "vpe"
+                "name": "test-vpc1-ky/vsi3c-ky",
+                "type": "instance"
             },
             "src": {
                 "name": "test-vpc1-ky/vsi3b-ky",
@@ -191,41 +221,11 @@
             ],
             "bidirectional": true,
             "dst": {
-                "name": "test-vpc1-ky/db-endpoint-gateway-ky",
-                "type": "vpe"
-            },
-            "src": {
-                "name": "test-vpc1-ky/vsi3a-ky",
-                "type": "instance"
-            }
-        },
-        {
-            "allowed-protocols": [
-                {
-                    "protocol": "ANY"
-                }
-            ],
-            "dst": {
-                "name": "test-vpc1-ky/vsi1-ky",
-                "type": "instance"
-            },
-            "src": {
-                "name": "test-vpc1-ky/vsi2-ky",
+                "name": "test-vpc1-ky/vsi3c-ky",
                 "type": "instance"
-            }
-        },
-        {
-            "allowed-protocols": [
-                {
-                    "protocol": "ICMP"
-                }
-            ],
-            "dst": {
-                "name": "external-0",
-                "type": "external"
             },
             "src": {
-                "name": "test-vpc1-ky/vsi2-ky",
+                "name": "test-vpc1-ky/vsi3a-ky",
                 "type": "instance"
             }
         },
@@ -273,8 +273,8 @@
                 "type": "instance"
             },
             "src": {
-                "name": "test-vpc1-ky/db-endpoint-gateway-ky",
-                "type": "vpe"
+                "name": "test-vpc1-ky/vsi3c-ky",
+                "type": "instance"
             }
         },
         {
@@ -291,8 +291,8 @@
                 "type": "instance"
             },
             "src": {
-                "name": "test-vpc1-ky/db-endpoint-gateway-ky",
-                "type": "vpe"
+                "name": "test-vpc1-ky/vsi3c-ky",
+                "type": "instance"
             }
         }
     ]

diff --git a/pkg/ibmvpc/examples/out/synthesis_out/experiments_env_all_vpcs_.json b/pkg/ibmvpc/examples/out/synthesis_out/experiments_env_all_vpcs_.json
@@ -11,11 +11,11 @@
             ],
             "bidirectional": true,
             "dst": {
-                "name": "test-vpc1-ky/vsi1-ky",
+                "name": "test-vpc1-ky/vsi2-ky",
                 "type": "instance"
             },
             "src": {
-                "name": "test-vpc1-ky/vsi2-ky",
+                "name": "test-vpc1-ky/vsi1-ky",
                 "type": "instance"
             }
         },
@@ -31,7 +31,7 @@
                 "type": "instance"
             },
             "src": {
-                "name": "test-vpc1-ky/vsi2-ky",
+                "name": "test-vpc1-ky/vsi1-ky",
                 "type": "instance"
             }
         },
@@ -43,8 +43,8 @@
             ],
             "bidirectional": true,
             "dst": {
-                "name": "external-0",
-                "type": "external"
+                "name": "test-vpc1-ky/vsi0-ky",
+                "type": "instance"
             },
             "src": {
                 "name": "test-vpc1-ky/vsi2-ky",
@@ -59,11 +59,11 @@
             ],
             "bidirectional": true,
             "dst": {
-                "name": "test-vpc1-ky/vsi0-ky",
-                "type": "instance"
+                "name": "external-0",
+                "type": "external"
             },
             "src": {
-                "name": "test-vpc1-ky/vsi1-ky",
+                "name": "test-vpc1-ky/vsi2-ky",
                 "type": "instance"
             }
         },

diff --git a/pkg/ibmvpc/ibmDrawioGenerator.go b/pkg/ibmvpc/ibmDrawioGenerator.go
@@ -72,8 +72,7 @@ func (lb *LoadBalancer) GenerateDrawioTreeNode(gen *vpcmodel.DrawioGenerator) dr
 		}
 	}
 	vpcTn := gen.TreeNode(lb.VPC()).(drawio.SquareTreeNodeInterface)
-	// here we do not call lb.Name() because lb.Name() add the kind to the name
-	return drawio.GroupPrivateIPsWithLoadBalancer(vpcTn, lb.ResourceName, privateIPs)
+	return drawio.GroupPrivateIPsWithLoadBalancer(vpcTn, lb.Name(), privateIPs)
 }
 func (pip *PrivateIP) GenerateDrawioTreeNode(gen *vpcmodel.DrawioGenerator) drawio.TreeNodeInterface {
 	if gen.LBAbstraction() {

diff --git a/pkg/ibmvpc/implicit_routing.go b/pkg/ibmvpc/implicit_routing.go
@@ -111,7 +111,8 @@ func (rt *systemImplicitRT) getIngressPath(dest *ipblock.IPBlock) (vpcmodel.Path
 	// traffic from some source is by default simply routed to dest node
 	path := rt.destAsPath(dest)
 	if len(path) == 0 {
-		return nil, fmt.Errorf("getIngressPath: failed to find path to dest resource address %s in VPC %s", dest.String(), rt.vpc.Name())
+		return nil, fmt.Errorf("getIngressPath: failed to find path to dest resource address %s in VPC %s",
+			dest.String(), rt.vpc.Name())
 	}
 	return path, nil
 }

diff --git a/pkg/ibmvpc/parser.go b/pkg/ibmvpc/parser.go
@@ -1517,19 +1517,19 @@ func printConfig(c *vpcmodel.VPCConfig) {
 		if n.IsExternal() {
 			continue
 		}
-		logging.Debug(strings.Join([]string{n.Kind(), n.CidrOrAddress(), n.Name(), n.UID()}, separator))
+		logging.Debug(strings.Join([]string{n.Kind(), n.CidrOrAddress(), n.NameForAnalyzerOut(c), n.UID()}, separator))
 	}
 	logging.Debug("Subnets:")
 	for _, n := range c.Subnets {
-		logging.Debug(strings.Join([]string{n.Kind(), n.CIDR(), n.Name(), n.UID()}, separator))
+		logging.Debug(strings.Join([]string{n.Kind(), n.CIDR(), n.NameForAnalyzerOut(c), n.UID()}, separator))
 	}
 	logging.Debug("LoadBalancers:")
 	for _, lb := range c.LoadBalancers {
-		logging.Debug(strings.Join([]string{lb.Kind(), lb.Name(), lb.AddressRange().ToIPRanges(), lb.UID()}, separator))
+		logging.Debug(strings.Join([]string{lb.Kind(), lb.NameForAnalyzerOut(c), lb.AddressRange().ToIPRanges(), lb.UID()}, separator))
 	}
 	logging.Debug("NodeSets:")
 	for _, n := range c.NodeSets {
-		logging.Debug(strings.Join([]string{n.Kind(), n.AddressRange().ToIPRanges(), n.Name(), n.UID()}, separator))
+		logging.Debug(strings.Join([]string{n.Kind(), n.AddressRange().ToIPRanges(), n.NameForAnalyzerOut(c), n.UID()}, separator))
 	}
 	logging.Debug("FilterResources:")
 	for _, f := range c.FilterResources {
@@ -1554,14 +1554,14 @@ func printConfig(c *vpcmodel.VPCConfig) {
 	}
 	logging.Debug("RoutingResources:")
 	for _, r := range c.RoutingResources {
-		logging.Debug(strings.Join([]string{r.Kind(), r.Name(), r.UID()}, separator))
+		logging.Debug(strings.Join([]string{r.Kind(), r.NameForAnalyzerOut(c), r.UID()}, separator))
 		if tgw, ok := r.(*TransitGateway); ok {
 			printTGWAvailableRoutes(tgw)
 		}
 	}
 	logging.Debug("RoutingTables:")
 	for _, r := range c.RoutingTables {
-		logging.Debug(strings.Join([]string{r.Kind(), r.Name(), r.UID(), "vpc:", r.VPC().UID()}, separator))
+		logging.Debug(strings.Join([]string{r.Kind(), r.NameForAnalyzerOut(c), r.UID(), "vpc:", r.VPC().UID()}, separator))
 		if rt, ok := r.(*ingressRoutingTable); ok {
 			logging.Debug("ingress routing table")
 			logging.Debug(rt.string())
@@ -1572,7 +1572,7 @@ func printConfig(c *vpcmodel.VPCConfig) {
 			logging.Debug("subnets:")
 			subnetsList := make([]string, len(rt.subnets))
 			for i := range rt.subnets {
-				subnetsList[i] = rt.subnets[i].Name()
+				subnetsList[i] = rt.subnets[i].NameForAnalyzerOut(c)
 			}
 			logging.Debug(strings.Join(subnetsList, ","))
 		}

diff --git a/pkg/ibmvpc/routing_tables_analysis.go b/pkg/ibmvpc/routing_tables_analysis.go
@@ -618,7 +618,8 @@ func (irt *ingressRoutingTable) advertiseRoutes(vpcConfig *vpcmodel.VPCConfig) {
 		var tgwAB *TransitGateway
 		for _, tgw := range tgws {
 			for _, vpc := range tgw.vpcs {
-				logging.Debugf("check tgw %s with vpc %s, AP %s", tgw.Name(), vpc.Name(), vpc.AddressPrefixesIPBlock.ToCidrListString())
+				logging.Debugf("check tgw %s with vpc %s, AP %s", tgw.Name(),
+					vpc.Name(), vpc.AddressPrefixesIPBlock.ToCidrListString())
 				// TODO: shouldn't be containment rather than intersection?? (works with intersection on hub-n-spoke config object)
 				if vpc.UID() != irt.vpc.UID() && routeCidr.Overlap(vpc.AddressPrefixesIPBlock) {
 					vpcB = vpc