Merge pull request #194 from dflook/move-summary

Add number of resource moves to plan summary

Author: dflook

image/src/github_pr_comment/__main__.py

@@ -1,6 +1,7 @@
 import hashlib
 import json
 import os
+import re
 import sys
 from pathlib import Path
 from typing import (NewType, Optional, cast)
@@ -108,18 +109,26 @@ def format_classic_description(action_inputs: PlanPrInputs) -> str:
 def create_summary(plan: Plan) -> Optional[str]:
     summary = None
 
+    to_move = 0
+
     for line in plan.splitlines():
         if line.startswith('No changes') or line.startswith('Error'):
             return line
 
+        if re.match(r'  # \S+ has moved to \S+$', line):
+            to_move += 1
+
         if line.startswith('Plan:'):
             summary = line
 
+            if to_move and 'move' not in summary:
+                summary = summary.rstrip('.') + f', {to_move} to move.'
+
         if line.startswith('Changes to Outputs'):
             if summary:
                 return summary + ' Changes to Outputs.'
             else:
-                return 'Changes to Outputs'
+                return 'Changes to Outputs.'
 
     return summary
 

tests/github_pr_comment/test_summary.py

@@ -158,3 +158,27 @@ def test_summary_unknown():
 This is not anything like terraform output we know. We don't want to generate a summary for this.
 """
     assert create_summary(plan) is None
+
+def test_summary_move_only():
+    plan = """Terraform will perform the following actions:
+
+  # random_string.your_string has moved to random_string.my_string
+    resource "random_string" "my_string" {
+        id          = "Iyh3jLKc"
+        length      = 8
+        # (8 unchanged attributes hidden)
+    }
+    
+  # random_string.blah_string has moved to random_string.my_string2
+    resource "random_string" "my_string2" {
+        id          = "Iyh3jLKc"
+        length      = 8
+        # (8 unchanged attributes hidden)
+    }    
+
+Plan: 0 to add, 0 to change, 0 to destroy.
+"""
+
+    expected = "Plan: 0 to add, 0 to change, 0 to destroy, 2 to move."
+
+    assert create_summary(plan) == expected

tests/test_compact_plan.py

@@ -226,7 +226,7 @@ def test_plan_15():
     output = '\n'.join(compact_plan(input.splitlines()))
     assert output == expected_output
 
-def test_plan_refresh_on_changes_11():
+def test_plan_refresh_no_changes_11():
     input = """
 Refreshing Terraform state in-memory prior to plan...    
 The refreshed state will be used to calculate this plan, but will not be
@@ -510,7 +510,7 @@ def test_plan_refresh_changes_15():
     output = '\n'.join(compact_plan(input.splitlines()))
     assert output == expected_output
 
-def test_plan_refresh_changes_16():
+def test_plan_move_only():
     input = """
 random_string.my_string: Refreshing state... [id=Iyh3jLKc]