awslabs.terraform-mcp-server 0.0.1__tar.gz → 0.0.6__tar.gz

{awslabs_terraform_mcp_server-0.0.1 → awslabs_terraform_mcp_server-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: awslabs.terraform-mcp-server
-Version: 0.0.1
+Version: 0.0.6
 Summary: An AWS Labs Model Context Protocol (MCP) server for terraform
 Requires-Python: >=3.10
 Requires-Dist: beautifulsoup4>=4.12.0

{awslabs_terraform_mcp_server-0.0.1 → awslabs_terraform_mcp_server-0.0.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "awslabs.terraform-mcp-server"
-version = "0.0.1"
+version = "0.0.6"
 description = "An AWS Labs Model Context Protocol (MCP) server for terraform"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -24,6 +24,10 @@ dev = [
     "pre-commit>=4.1.0",
     "ruff>=0.9.7",
     "pyright>=1.1.399",
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.26.0",
+    "pytest-cov>=4.1.0",
+    "pytest-mock>=3.12.0",
 ]
 
 [build-system]
@@ -83,3 +87,6 @@ update_changelog_on_bump = true
 
 [tool.hatch.build.targets.wheel]
 packages = ["awslabs"]
+
+[tool.coverage.run]
+source = ["awslabs"]

awslabs_terraform_mcp_server-0.0.6/run_tests.sh

@@ -0,0 +1,206 @@
+#!/bin/bash
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
+# with the License. A copy of the License is located at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
+# OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
+# and limitations under the License.
+
+# Script to run tests for the Terraform MCP Server
+
+set -e
+
+# Set the Python path to include the current directory and the parent directory
+export PYTHONPATH=$PYTHONPATH:$(pwd):$(pwd)/..
+
+# Check if we're in a virtual environment
+if [ -z "$VIRTUAL_ENV" ]; then
+    echo "Warning: You are not running in a virtual environment."
+    echo "It's recommended to create and activate a virtual environment before running tests."
+    echo "You can create one with: python -m venv .venv"
+    echo "And activate it with: source .venv/bin/activate (Linux/Mac) or .venv\\Scripts\\activate (Windows)"
+    echo "Continuing without a virtual environment..."
+    echo ""
+fi
+
+# Check if pytest and other dependencies are installed
+echo "Checking for required packages..."
+MISSING_PACKAGES=()
+
+# Check for pytest and related packages
+python -c "import pytest" 2>/dev/null
+if [ $? -ne 0 ]; then
+    MISSING_PACKAGES+=("pytest pytest-asyncio pytest-cov")
+fi
+
+# Check for pydantic package
+python -c "import pydantic" 2>/dev/null
+if [ $? -ne 0 ]; then
+    MISSING_PACKAGES+=("pydantic")
+fi
+
+# Check for requests package
+python -c "import requests" 2>/dev/null
+if [ $? -ne 0 ]; then
+    MISSING_PACKAGES+=("requests")
+fi
+
+# Check for loguru package
+python -c "import loguru" 2>/dev/null
+if [ $? -ne 0 ]; then
+    MISSING_PACKAGES+=("loguru")
+fi
+
+# Check for beautifulsoup4 package
+python -c "import bs4" 2>/dev/null
+if [ $? -ne 0 ]; then
+    MISSING_PACKAGES+=("beautifulsoup4")
+fi
+
+# Check for checkov package
+python -c "import checkov" 2>/dev/null
+if [ $? -ne 0 ]; then
+    MISSING_PACKAGES+=("checkov")
+fi
+
+# Install missing packages
+if [ ${#MISSING_PACKAGES[@]} -gt 0 ]; then
+    echo "Installing missing packages: ${MISSING_PACKAGES[*]}"
+
+    # Try pip first (more reliable)
+    if command -v pip &> /dev/null; then
+        echo "Using pip to install packages..."
+        pip install ${MISSING_PACKAGES[*]} -v
+    # Try pip3 if pip is not available
+    elif command -v pip3 &> /dev/null; then
+        echo "Using pip3 to install packages..."
+        pip3 install ${MISSING_PACKAGES[*]} -v
+    # Try uv as a last resort
+    elif command -v uv &> /dev/null; then
+        echo "Using uv to install packages..."
+        uv pip install ${MISSING_PACKAGES[*]} -v
+    else
+        echo "Error: No package manager (pip, pip3, or uv) is available. Please install the missing packages manually."
+        exit 1
+    fi
+
+    # Verify installation with more verbose output
+    echo "Verifying package installations..."
+    for pkg in "pytest" "pydantic" "requests" "loguru" "bs4" "checkov"; do
+        echo "Checking for $pkg..."
+        python -c "import $pkg; print(f'$pkg installed successfully')" 2>/dev/null
+        if [ $? -ne 0 ]; then
+            echo "Failed to install $pkg. Trying to install it individually..."
+            pip install $pkg -v || pip3 install $pkg -v || echo "Failed to install $pkg. Please install it manually."
+
+            # Check again
+            python -c "import $pkg" 2>/dev/null
+            if [ $? -ne 0 ]; then
+                echo "Still failed to install $pkg. Please install it manually."
+                echo "You can try: pip install $pkg"
+                exit 1
+            fi
+        fi
+    done
+fi
+
+# Print debug information
+echo "Debug information:"
+echo "Python version: $(python --version)"
+echo "Python path: $PYTHONPATH"
+echo "Current directory: $(pwd)"
+echo "Python executable: $(which python)"
+echo "Pytest module location: $(python -c "import pytest; print(pytest.__file__)" 2>/dev/null || echo "Not found")"
+
+# Check if terraform_mcp_server module can be imported
+echo "Checking if terraform_mcp_server module can be imported..."
+python -c "import awslabs.terraform_mcp_server; print('terraform_mcp_server module found')" 2>/dev/null
+if [ $? -ne 0 ]; then
+    echo "Warning: terraform_mcp_server module cannot be imported. This may cause test failures."
+    echo "Installing the package in development mode..."
+
+    # Check if uv is available
+    if command -v uv &> /dev/null; then
+        uv pip install -e .
+    # Check if pip is available
+    elif command -v pip &> /dev/null; then
+        pip install -e .
+    else
+        echo "Neither uv nor pip is available. Creating a symbolic link instead..."
+        # Create a symbolic link to the module in the current directory
+        ln -sf $(pwd)/awslabs/terraform_mcp_server $(pwd)/terraform_mcp_server 2>/dev/null
+    fi
+
+    echo "Trying again..."
+    python -c "import awslabs.terraform_mcp_server; print('terraform_mcp_server module found')" 2>/dev/null
+    if [ $? -ne 0 ]; then
+        echo "Still cannot import terraform_mcp_server module. Tests may fail."
+        echo "Directory structure:"
+        ls -la
+        echo "awslabs directory:"
+        ls -la awslabs 2>/dev/null || echo "awslabs directory not found"
+    fi
+fi
+
+# Parse command line arguments
+COVERAGE=0
+REPORT=0
+VERBOSE=0
+SPECIFIC_TEST=""
+
+while [[ $# -gt 0 ]]; do
+  key="$1"
+  case $key in
+    --coverage)
+      COVERAGE=1
+      shift
+      ;;
+    --report)
+      REPORT=1
+      shift
+      ;;
+    --verbose)
+      VERBOSE=1
+      shift
+      ;;
+    *)
+      SPECIFIC_TEST="$1"
+      shift
+      ;;
+  esac
+done
+
+# Set up the command
+CMD="python -m pytest"
+
+if [ $VERBOSE -eq 1 ]; then
+  CMD="$CMD -v"
+fi
+
+if [ $COVERAGE -eq 1 ]; then
+  CMD="$CMD --cov=awslabs.terraform_mcp_server"
+
+  if [ $REPORT -eq 1 ]; then
+    CMD="$CMD --cov-report=html"
+  fi
+fi
+
+if [ -n "$SPECIFIC_TEST" ]; then
+  CMD="$CMD $SPECIFIC_TEST"
+else
+  CMD="$CMD tests/"
+fi
+
+# Run the tests
+echo "Running: $CMD"
+$CMD
+
+# If coverage report was generated, print the path
+if [ $COVERAGE -eq 1 ] && [ $REPORT -eq 1 ]; then
+  echo "Coverage report generated in htmlcov/ directory"
+  echo "Open htmlcov/index.html in your browser to view the report"
+fi

awslabs_terraform_mcp_server-0.0.6/tests/.gitignore

@@ -0,0 +1,38 @@
+# Pytest cache
+__pycache__/
+.pytest_cache/
+
+# Coverage reports
+.coverage
+htmlcov/
+
+# Temporary files
+*.pyc
+*.pyo
+*.pyd
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+venv/
+ENV/
+
+# IDE files
+.idea/
+.vscode/
+*.swp
+*.swo

awslabs_terraform_mcp_server-0.0.6/tests/README.md

@@ -0,0 +1,159 @@
+# Terraform MCP Server Tests
+
+This directory contains tests for the Terraform MCP Server.
+
+## Test Structure
+
+The tests are organized as follows:
+
+- `conftest.py`: Contains pytest fixtures used across multiple test files
+- `test_models.py`: Tests for the data models
+- `test_server.py`: Tests for the MCP server functionality
+- `test_command_impl.py`: Tests for the Terraform command execution implementation
+- `test_execute_terraform_command.py`: Dedicated tests for the execute_terraform_command implementation
+- `test_run_checkov_scan.py`: Dedicated tests for the run_checkov_scan implementation
+- `test_resources.py`: Tests for the resource implementations
+- `test_tool_implementations.py`: Tests for the tool implementations
+- `test_utils.py` and `test_utils_additional.py`: Tests for utility functions
+- `test_parameter_annotations.py`: Tests for parameter annotations
+
+## Running Tests
+
+To run the tests, you can use the following command from the root of the repository:
+
+```bash
+cd mcp/src/terraform-mcp-server
+pytest tests/
+```
+
+Or use the provided script:
+
+```bash
+cd mcp/src/terraform-mcp-server
+./run_tests.sh
+```
+
+To run a specific test file:
+
+```bash
+pytest tests/test_models.py
+```
+
+To run a specific test:
+
+```bash
+pytest tests/test_models.py::TestTerraformExecutionRequest::test_terraform_execution_request_creation
+```
+
+## Test Coverage
+
+To run the tests with coverage:
+
+```bash
+./run_tests.sh --coverage
+```
+
+To generate a coverage report:
+
+```bash
+./run_tests.sh --coverage --report
+```
+
+This will generate a coverage report in the `htmlcov` directory.
+
+## Verbose Output
+
+To run the tests with verbose output:
+
+```bash
+./run_tests.sh --verbose
+```
+
+## Mocking
+
+The tests use mocking to avoid making actual system calls. The mocks are defined in `conftest.py` and include:
+
+- `mock_terraform_command_output`: Mock outputs for Terraform commands
+- `mock_checkov_output`: Mock outputs for Checkov scans
+- `mock_subprocess`: Mock for subprocess module
+- `mock_os_path`: Mock for os.path module
+- `mock_aws_provider_docs`: Mock AWS provider documentation data
+- `mock_awscc_provider_docs`: Mock AWSCC provider documentation data
+- `mock_aws_ia_modules`: Mock AWS-IA modules data
+
+These mocks are used to simulate the behavior of the Terraform CLI, Checkov, and other external dependencies without making actual system calls.
+
+## Test Files
+
+### test_models.py
+
+Tests for the data models used in the Terraform MCP server, including:
+
+- `TerraformExecutionRequest`: Request model for Terraform command execution
+- `TerraformExecutionResult`: Result model for Terraform command execution
+- `CheckovScanRequest`: Request model for Checkov scan execution
+- `CheckovScanResult`: Result model for Checkov scan execution
+- `CheckovVulnerability`: Model for security vulnerabilities found by Checkov
+- `TerraformAWSProviderDocsResult`: Model for AWS provider documentation results
+- `TerraformAWSCCProviderDocsResult`: Model for AWSCC provider documentation results
+- `ModuleSearchResult`: Model for Terraform module search results
+- `SubmoduleInfo`: Model for Terraform submodule information
+- `TerraformVariable`: Model for Terraform variable definitions
+- `TerraformOutput`: Model for Terraform output definitions
+
+### test_server.py
+
+Tests for the MCP server functionality, including:
+
+- Server initialization
+- Tool registration
+- Resource registration
+- Command-line argument parsing
+
+### test_command_impl.py
+
+Tests for the Terraform command execution implementation, including:
+
+- Successful command execution
+- Error handling
+- Security checks
+- Output parsing
+
+### test_resources.py
+
+Tests for the resource implementations, including:
+
+- AWS provider resources listing
+- AWSCC provider resources listing
+- Terraform development workflow guide
+- AWS best practices
+
+### test_tool_implementations.py
+
+Tests for the tool implementations, including:
+
+- AWS provider documentation search
+- AWSCC provider documentation search
+- AWS-IA modules search
+
+### test_execute_terraform_command.py
+
+Dedicated tests for the execute_terraform_command implementation, including:
+
+- Testing the clean_output_text helper function
+- Testing AWS region environment variable setting
+- Testing exception handling
+- Testing output error handling
+- Testing JSON parsing error handling
+- Testing complex output structures with nested values
+
+### test_run_checkov_scan.py
+
+Dedicated tests for the run_checkov_scan implementation, including:
+
+- Testing the _clean_output_text function
+- Testing JSON output parsing
+- Testing with absolute and relative paths
+- Testing security checks for dangerous patterns
+- Testing CLI output parsing
+- Testing error handling and exception handling