Release v0.3.0

Author: rafaelherik

CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## [0.3.0] - 2025-06-16
+
+### 🚀 New Features
+
+- Added AI-driven plan analysis agent (PlanAnalysisAgent) with Azure context integration.
+- Introduced `replace` attribute capture in plan analyzer for accurate reporting of resource replacements.
+- Flattened single-element action lists in plan analysis to simplify actions representation.
+
+### 🐛 Bug Fixes
+
+- Skipped no-op changes properly in plan analyzer to avoid redundant entries.
+- Fixed reporting of replacement operations in plan reporter.
+
+### 📖 Documentation Improvements
+
+- Updated README and documentation for AI analysis and enhanced command-line usage.
+- Refreshed advanced usage and API docs to reflect new features and configurations.
+
+### ⬆️ Dependencies
+
+- Added `backoff` for improved retry and error handling.
+
+### ⚙️ Other Changes
+
+- Removed deprecated `scripts/install_ai_deps.sh`.
+- Refactored base reporter and context management for consistency.
+
+---
+
 ## [0.2.0] - 2024-06-15
 
 ### 🎨 Enhanced Output Formats and CLI Arguments

README.md

@@ -12,6 +12,7 @@ tfsumpy is a Python-based tool that summarizes Terraform plan files to provide a
 - 🔒 Automatic sensitive information redaction
 - 🎨 Color-coded output for better readability
 - 🔄 Detailed attribute change tracking
+- ♻️ Replacement detection: flags resources being recreated and shows enforcing attributes
 - 📝 Template-based markdown output
 - 🔧 Extensible plugin system
 - 🤖 AI-powered change summarization (OpenAI, Gemini, Anthropic)
@@ -35,10 +36,10 @@ terraform show -json tfplan > plan.json
 # Basic summary
 tfsumpy plan.json
 
-# Show detailed changes
-tfsumpy plan.json --hide-changes=false
+# Hide attribute changes (optional)
+tfsumpy plan.json --hide-changes
 
-# Show resource details
+# Show detailed resource information (with attribute changes)
 tfsumpy plan.json --detailed
 ```
 
@@ -57,17 +58,12 @@ tfsumpy plan.json --output json
 
 ## AI Summarization
 
-Enable AI-powered change summarization using OpenAI, Gemini, or Anthropic:
+Enable AI-powered change summarization using OpenAI:
 
 ```bash
 # Using OpenAI
 tfsumpy plan.json --output markdown --ai openai YOUR_API_KEY
 
-# Using Google Gemini
-tfsumpy plan.json --output markdown --ai gemini YOUR_API_KEY
-
-# Using Anthropic Claude
-tfsumpy plan.json --output markdown --ai anthropic YOUR_API_KEY
 ```
 
 ## Configuration

docs/api/models.md

@@ -23,6 +23,7 @@ class ResourceChange:
     module: str = 'root'  # Module path (e.g., 'root', 'network.vpc')
     before: Dict = None   # State before the change
     after: Dict = None    # State after the change
+    replace: List[str] = None  # Attributes enforcing resource replacement (if any)
 ```
 
 **Fields:**
@@ -32,7 +33,8 @@ class ResourceChange:
 - `changes`: List of changed attributes (may be empty)
 - `module`: Module path (default 'root')
 - `before`: Dictionary of the resource's state before the change
-- `after`: Dictionary of the resource's state after the change
+ - `after`: Dictionary of the resource's state after the change
+ - `replace`: List of attributes enforcing resource replacement (if any)
 
 ---
 

docs/api/reporters.md

@@ -48,20 +48,32 @@ from tfsumpy.plan.reporter import PlanReporter
 
 reporter = PlanReporter()
 
-# Console output
-reporter.print_report(plan_results, show_changes=True)
+# Console output (with optional AI and Azure integration)
+reporter.print_report(
+    plan_results,
+    show_changes=True,
+    ai_config=ai_config,      # AI settings dict or None
+    azure_config=azure_config  # Azure integration settings dict or None
+)
 
 # Markdown output
 reporter.print_report_markdown(plan_results, show_changes=True)
 
-# JSON output
-reporter.print_report_json(plan_results, show_changes=True)
+# JSON output (with optional AI and Azure integration)
+reporter.print_report_json(
+    plan_results,
+    show_changes=True,
+    ai_config=ai_config,
+    azure_config=azure_config
+)
 ```
 
 **Parameters:**
 - `data`: The analysis results (from `PlanAnalyzer`)
 - `show_changes`: Show detailed attribute changes (bool)
 - `show_details`: Show full resource details (bool)
+- `ai_config`: Optional AI configuration dict for summarization
+- `azure_config`: Optional Azure integration configuration dict for AI enrichment
 
 **Output Formats:**
 

docs/usage/advanced_usage.md

@@ -18,7 +18,27 @@ Template-based Markdown output with:
 - Summary statistics
 - Resource changes
 - Detailed attribute changes (if enabled)
-- Timestamp and metadata
++ Timestamp and metadata
+  
+## AI Analysis with Azure
+When Azure integration is enabled via the `--azure` flag, tfsumpy will retrieve Azure resource details before performing AI summarization.
+Ensure your Azure credentials (e.g., via Azure CLI login or environment variables) and subscription ID are configured.
+
+Example:
+```bash
+tfsumpy plan.json \
+  --output markdown \
+  --ai openai YOUR_API_KEY \
+  --azure
+```
+
+For JSON output with AI and Azure:
+```bash
+tfsumpy plan.json \
+  --output json \
+  --ai openai YOUR_API_KEY \
+  --azure
+```
 
 ### JSON Output
 ```bash
@@ -89,7 +109,7 @@ This enables:
 
 ### Deprecated Options
 The following options are deprecated and will be removed in a future version:
-- `--changes` → Use `--hide-changes=false` instead
+- `--changes`: (deprecated; attribute changes are shown by default)
 - `--details` → Use `--detailed` instead
 - `--markdown` → Use `--output markdown` instead
 
@@ -98,19 +118,20 @@ The following options are deprecated and will be removed in a future version:
 - `--plugin-dir`: Directory to load plugins from
 - `--debug`: Enable debug logging
 
-## Markdown Output (Beta)
+## Markdown Output
 
-You can generate a Markdown summary of your Terraform plan with:
+Generate a Markdown summary of your Terraform plan with:
 
 ```bash
-tfsumpy plan.json --markdown > plan_summary.md
+tfsumpy plan.json --output markdown > plan_summary.md
 ```
 
-This will create a Markdown file with:
-- A summary section
-- Sections for created, updated, and destroyed resources
-- JSON code blocks for each resource change
-
-For updates, both before and after states are shown. For creates and deletes, only the relevant state is shown.
+You can further control the content with:
+- `--detailed`: Show detailed resource information and attribute changes
+- `--hide-changes`: Hide detailed attribute changes
 
-> **Note:** Markdown output is a beta feature. Please report any issues or suggestions! 
+The generated Markdown includes:
+- Summary statistics
+- Resource changes formatted as HCL code blocks
+- Replacement enforcement attributes (for recreate operations)
+- Timestamp and metadata

docs/usage/command_line.md

@@ -34,11 +34,18 @@ tfsumpy [OPTIONS] PLAN_FILE
 - `--ai-temperature N`: Control response creativity (0.0-1.0)
 - `--ai-system-prompt PROMPT`: Custom system prompt
 
+### Azure Integration Options
+
+- `--azure`: Enable Azure integration for AI analysis (requires Azure credentials)
+- `--azure-subscription-id`: Azure Subscription ID for resource queries (default from AZURE_SUBSCRIPTION_ID env var)
+- `--azure-resource-groups`: List of Azure resource group names to filter (default: all)
+- `--azure-include-resources`: Include Azure resources information for analysis
+
 ### Deprecated Options
 
 > **Warning**: These options are deprecated and will be removed in a future version.
 
-- `--changes`: Use `--hide-changes=false` instead
+- `--changes`: (deprecated; attribute changes are shown by default)
 - `--details`: Use `--detailed` instead
 - `--markdown`: Use `--output markdown` instead
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tfsumpy"
-version = "0.2.0"
+version = "0.3.0"
 description = "A Python tool for analyzing Terraform plan files"
 authors = ["Rafael H de Carvalho <[email protected]>"]
 readme = "README.md"
@@ -30,10 +30,13 @@ python = "^3.9"
 click = "^8.1.7"
 rich = "^13.7.0"
 jinja2 = "^3.1.2"
+colorama = "^0.4.6"
 openai = "^1.12.0"
 google-generativeai = "^0.3.2"
 anthropic = "^0.18.1"
 backoff = "^2.2.1"
+azure-identity = "^1.12.0"
+azure-mgmt-resource = "^20.1.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.3"

pytest.ini

@@ -1,4 +1,5 @@
 [pytest]
 testpaths = tests
 python_files = test_*.py
-addopts = --verbose 
+addopts = --verbose 
+pythonpath = .

scripts/install_ai_deps.sh

@@ -0,0 +1,46 @@
+import sys
+import warnings
+import re
+import pytest
+from pathlib import Path
+from tfsumpy.__main__ import main
+
+
+@pytest.fixture
+def sample_plan():
+    """Path to the sample Terraform plan JSON file."""
+    # Locate repository root from this test file
+    project_root = Path(__file__).parents[2]
+    plan_path = project_root / "samples" / "sample1.json"
+    return str(plan_path)
+
+def test_cli_shows_all_changes(capsys, monkeypatch, sample_plan):
+    """Test that running with --detailed shows all resource changes."""
+    monkeypatch.setattr(sys, "argv", ["tfsumpy", sample_plan, "--detailed"])
+    # Run CLI and capture output
+    main()
+    out = capsys.readouterr().out
+    # Strip ANSI color codes for assertions
+    plain = re.compile(r'\x1b\[[0-9;]*m').sub('', out)
+    # Verify each action type and symbol appears
+    assert "CREATE aws_s3_bucket" in plain
+    assert "+" in plain
+    assert "UPDATE aws_instance" in plain
+    assert "~" in plain
+    assert "DELETE aws_security_group" in plain
+    assert "-" in plain
+
+def test_cli_alias_details_shows_all_changes(capsys, monkeypatch, sample_plan):
+    """Test that deprecated --details alias shows resource changes."""
+    # Suppress deprecation warnings in stderr
+    warnings.filterwarnings("ignore", category=DeprecationWarning)
+    monkeypatch.setattr(sys, "argv", ["tfsumpy", sample_plan, "--details"])
+    main()
+    out = capsys.readouterr().out
+    plain = re.compile(r'\x1b\[[0-9;]*m').sub('', out)
+    assert "CREATE aws_s3_bucket" in plain
+    assert "+" in plain
+    assert "UPDATE aws_instance" in plain
+    assert "~" in plain
+    assert "DELETE aws_security_group" in plain
+    assert "-" in plain