CM-3937 - Extend tfplan scan result with module path (#246)

Author: avishaiamiel

cycode/cli/files_collector/iac/tf_content_generator.py

@@ -1,6 +1,5 @@
 import json
 import time
-import uuid
 from typing import List
 
 from cycode.cli import consts
@@ -44,14 +43,25 @@ def _generate_tf_content(resource_changes: List[ResourceChange]) -> str:
 
 
 def _generate_resource_content(resource_change: ResourceChange) -> str:
-    resource_content = f'resource "{resource_change.resource_type}" "{resource_change.name}-{uuid.uuid4()}" {{\n'
+    resource_content = f'resource "{resource_change.resource_type}" "{_get_resource_name(resource_change)}" {{\n'
     if resource_change.values is not None:
         for key, value in resource_change.values.items():
             resource_content += f'  {key} = {json.dumps(value)}\n'
     resource_content += '}\n\n'
     return resource_content
 
 
+def _get_resource_name(resource_change: ResourceChange) -> str:
+    parts = [resource_change.module_address, resource_change.name]
+
+    if resource_change.index is not None:
+        parts.append(str(resource_change.index))
+
+    valid_parts = [part for part in parts if part]
+
+    return '-'.join(valid_parts).replace('.', '-')
+
+
 def _extract_resources(tfplan: str, filename: str) -> List[ResourceChange]:
     tfplan_json = load_json(tfplan)
     resources: List[ResourceChange] = []
@@ -60,8 +70,10 @@ def _extract_resources(tfplan: str, filename: str) -> List[ResourceChange]:
         for resource_change in resource_changes:
             resources.append(
                 ResourceChange(
+                    module_address=resource_change.get('module_address'),
                     resource_type=resource_change['type'],
                     name=resource_change['name'],
+                    index=resource_change.get('index'),
                     actions=resource_change['change']['actions'],
                     values=resource_change['change']['after'],
                 )

cycode/cli/models.py

@@ -76,8 +76,10 @@ class LocalScanResult(NamedTuple):
 
 @dataclass
 class ResourceChange:
+    module_address: Optional[str]
     resource_type: str
     name: str
+    index: Optional[int]
     actions: List[str]
     values: Dict[str, str]
 

tests/cli/files_collector/iac/test_tf_content_generator.py

@@ -1,5 +1,4 @@
 import os
-import re
 
 from cycode.cli.files_collector.iac import tf_content_generator
 from cycode.cli.utils.path_utils import get_file_content, get_immediate_subdirectories
@@ -15,5 +14,4 @@ def test_generate_tf_content_from_tfplan() -> None:
         tf_expected_content = get_file_content(os.path.join(_PATH_TO_EXAMPLES, example, 'tf_content.txt'))
         tf_content = tf_content_generator.generate_tf_content_from_tfplan(example, tfplan_content)
 
-        cleaned_tf_content = re.sub(r'-[a-fA-F0-9\-]{36}', '', tf_content)
-        assert cleaned_tf_content == tf_expected_content
+        assert tf_content == tf_expected_content

tests/test_files/tf_content_generator_files/tfplan-create-example/tf_content.txt

@@ -79,7 +79,7 @@ resource "aws_sfn_state_machine" "terra_ci_runner" {
   type = "STANDARD"
 }
 
-resource "aws_route" "private" {
+resource "aws_route" "private-1" {
   carrier_gateway_id = null
   destination_cidr_block = "172.25.16.0/20"
   destination_ipv6_cidr_block = null
@@ -95,7 +95,7 @@ resource "aws_route" "private" {
   vpc_peering_connection_id = null
 }
 
-resource "aws_route" "private" {
+resource "aws_route" "private-rtb-00cf8381520103cfb" {
   carrier_gateway_id = null
   destination_cidr_block = "172.25.16.0/20"
   destination_ipv6_cidr_block = null