Merge pull request #159 from Cloud-Architects/diagrams_net

#97 adjusted report, added docs

Author: leandrodamascena

README.md

@@ -130,7 +130,7 @@ To further increase security, you can add a block to check `aws:MultiFactorAuthP
 Cloudiscovery provides a CLI to easily perform desired actions.
 
 ### AWS VPC
-Example of a diagram:
+Example of a diagram ([diagrams.net](https://www.diagrams.net/) supported):
 
 ![diagrams logo](docs/assets/aws-vpc.png)
 

cloudiscovery/provider/vpc/resource/network.py

@@ -99,7 +99,7 @@ def get_resources(self) -> List[Resource]:
 
         for data in response["NatGateways"]:
 
-            if data["VpcId"] == self.vpc_options.vpc_id:
+            if data["VpcId"] == self.vpc_options.vpc_id and data["State"] != "deleted":
                 nametag = get_name_tag(data)
 
                 name = data["NatGatewayId"] if nametag is None else nametag

cloudiscovery/shared/diagram.py

@@ -404,6 +404,9 @@ def generate_diagram(
         with open(output_filename, "w") as diagram_file:
             diagram_file.write(diagram)
 
+        message_handler("\n\nDiagrams.net diagram generated", "HEADER")
+        message_handler("Check your diagram: " + output_filename, "OKBLUE")
+
     @staticmethod
     def decode_inflate(value: str):
         decoded = base64.b64decode(value)
@@ -442,20 +445,22 @@ def build_diagram(
 
         added_resources: List[ResourceDigest] = []
 
+        vpc_box_height = 56565656
+        subnet_box_height = 424242
         vpc_cell = (
             '<mxCell id="zB3y0Dp3mfEUP9Fxs3Er-{0}" value="{1}" style="points=[[0,0],[0.25,0],[0.5,0],'
             "[0.75,0],[1,0],[1,0.25],[1,0.5],[1,0.75],[1,1],[0.75,1],[0.5,1],[0.25,1],[0,1],[0,0.75],"
             "[0,0.5],[0,0.25]];outlineConnect=0;gradientColor=none;html=1;whiteSpace=wrap;fontSize=12;"
             "fontStyle=0;shape=mxgraph.aws4.group;grIcon=mxgraph.aws4.group_vpc;strokeColor=#248814;"
             'fillColor=none;verticalAlign=top;align=left;spacingLeft=30;fontColor=#AAB7B8;dashed=0;" '
-            'parent="1" vertex="1"><mxGeometry x="0" y="0" width="1040" height="1000" as="geometry" />'
-            "</mxCell>".format(cell_id, vpc_resource.name)
+            'parent="1" vertex="1"><mxGeometry x="0" y="0" width="960" height="{2}" as="geometry" />'
+            "</mxCell>".format(cell_id, vpc_resource.name, vpc_box_height)
         )
         cell_id += 1
         mx_graph_model += vpc_cell
 
-        public_subnet_x = 80
-        public_subnet_y = 80
+        public_subnet_x = 40
+        public_subnet_y = 40
         cell_id += 1
         # pylint: disable=line-too-long
         public_subnet = (
@@ -465,13 +470,17 @@ def build_diagram(
             "fontStyle=0;shape=mxgraph.aws4.group;grIcon=mxgraph.aws4.group_security_group;grStroke=0;"
             "strokeColor=#248814;fillColor=#E9F3E6;verticalAlign=top;align=left;spacingLeft=30;"
             'fontColor=#248814;dashed=0;" vertex="1" parent="1"><mxGeometry x="{X}" y="{Y}" width="420" '
-            'height="500" as="geometry" /></mxCell>'.format_map(
-                {"X": str(public_subnet_x), "Y": str(public_subnet_y)}
+            'height="{H}" as="geometry" /></mxCell>'.format_map(
+                {
+                    "X": str(public_subnet_x),
+                    "Y": str(public_subnet_y),
+                    "H": subnet_box_height,
+                }
             )
         )
         mx_graph_model += public_subnet
 
-        mx_graph_model = self.render_subnet_items(
+        (mx_graph_model, public_rows) = self.render_subnet_items(
             added_resources,
             mx_graph_model,
             "{public subnet}",
@@ -481,8 +490,8 @@ def build_diagram(
             resources,
         )
 
-        private_subnet_x = 580
-        private_subnet_y = 80
+        private_subnet_x = 480
+        private_subnet_y = 40
         cell_id += 1
         private_subnet = (
             '<mxCell id="private_area_id" value="Private subnet" style="points=[[0,0],[0.25,0],'
@@ -491,13 +500,17 @@ def build_diagram(
             "fontSize=12;fontStyle=0;shape=mxgraph.aws4.group;grIcon=mxgraph.aws4.group_security_group;"
             "grStroke=0;strokeColor=#147EBA;fillColor=#E6F2F8;verticalAlign=top;align=left;"
             'spacingLeft=30;fontColor=#147EBA;dashed=0;" vertex="1" parent="1"><mxGeometry '
-            'x="{X}" y="{Y}" width="420" height="500" as="geometry" /></mxCell>'.format_map(
-                {"X": str(private_subnet_x), "Y": str(private_subnet_y)}
+            'x="{X}" y="{Y}" width="420" height="{H}" as="geometry" /></mxCell>'.format_map(
+                {
+                    "X": str(private_subnet_x),
+                    "Y": str(private_subnet_y),
+                    "H": subnet_box_height,
+                }
             )
         )
         mx_graph_model += private_subnet
 
-        mx_graph_model = self.render_subnet_items(
+        (mx_graph_model, private_rows) = self.render_subnet_items(
             added_resources,
             mx_graph_model,
             "{private subnet}",
@@ -506,6 +519,12 @@ def build_diagram(
             resource_relations,
             resources,
         )
+        subnet_rows = max(public_rows, private_rows)
+        new_subnet_box_height = subnet_rows * 100 + 80
+
+        mx_graph_model = mx_graph_model.replace(
+            str(subnet_box_height), str(new_subnet_box_height)
+        )
 
         count = 0
         row = 0
@@ -524,7 +543,7 @@ def build_diagram(
                         {
                             "CELL_IDX": resource.digest.to_string(),
                             "X": str(count * 140 + public_subnet_x + 40),
-                            "Y": str(580 + row * 100 + 40),
+                            "Y": str(new_subnet_box_height + row * 100 + 60),
                             "STYLE": style.replace("fontSize=12", "fontSize=8"),
                             "TITLE": resource.name,
                         }
@@ -535,6 +554,11 @@ def build_diagram(
                         row += 1
                         count = 0
 
+        new_vpc_box_height = new_subnet_box_height + 100 * row + 180
+        mx_graph_model = mx_graph_model.replace(
+            str(vpc_box_height), str(new_vpc_box_height)
+        )
+
         mx_graph_model += DIAGRAM_SUFFIX
         return MX_FILE.replace("<MX_GRAPH>", self.deflate_encode(mx_graph_model))
 
@@ -548,7 +572,7 @@ def render_subnet_items(
         subnet_y,
         resource_relations,
         resources,
-    ):
+    ) -> (str, int):
         count = 0
         row = 0
         # pylint: disable=too-many-nested-blocks
@@ -581,4 +605,4 @@ def render_subnet_items(
                             if count % 3 == 0:
                                 row += 1
                                 count = 0
-        return mx_graph_model
+        return mx_graph_model, row

cloudiscovery/shared/report.py

@@ -117,6 +117,13 @@ def html_report(
                 with open(image_name, "rb") as image_file:
                     diagram_image = base64.b64encode(image_file.read()).decode("utf-8")
 
+        """generate diagrams.net link"""
+        diagramsnet_image = None
+        if filename is not None:
+            image_name = PATH_DIAGRAM_OUTPUT + filename + ".drawio"
+            if os.path.exists(image_name):
+                diagramsnet_image = f"..{os.path.sep}..{os.path.sep}" + image_name
+
         group_title = "Group"
         if resources:
             if resources[0].limits:
@@ -131,6 +138,7 @@ def html_report(
                     resources_found=resources,
                     resources_relations=resource_relations,
                     diagram_image=diagram_image,
+                    diagramsnet_image=diagramsnet_image,
                     group_title=group_title,
                 )
 

cloudiscovery/templates/report_html.html

@@ -58,5 +58,9 @@
     {% set base64img = "data:image/png;base64," + diagram_image %}
     <img src={{ base64img }} widht="1024" height="768">
 {%endif %}
+{% if diagramsnet_image is not none %}
+    <p>Diagram file for <a href="https://diagrams.net/">diagrams.net</a></p>
+    <a href={{ diagramsnet_image }}>diagrams.net diagram</a>
+{%endif %}
 
 <p>&nbsp;</p>