Enhance cleanup functionality in run-tool-tests.sh and test-tools.sh

- Updated run-tool-tests.sh to include a cleanup function that restores the original Codacy configuration and removes generated files after tests.
- Added a new cleanup_all_test_files function in test-tools.sh to remove generated test files across all tool test directories and restore original configurations.
- Implemented traps in both scripts to ensure cleanup occurs even if the script fails.

Author: andrzej-janczak

integration-tests/test-tools.sh

@@ -1,5 +1,24 @@
 #!/bin/bash
 
+# Function to cleanup all generated test files
+cleanup_all_test_files() {
+    echo "🧹 Cleaning up test files..."
+    
+    # Remove generated SARIF and sorted files from all tool test directories
+    find plugins/tools/*/test/src -name "actual.sarif" -o -name "actual.sorted.json" -o -name "expected.sorted.json" -o -name "codacy.yaml.backup" | xargs rm -f 2>/dev/null || true
+    
+    # Restore original codacy.yaml files if they were modified
+    git checkout -- plugins/tools/*/test/src/.codacy/codacy.yaml 2>/dev/null || true
+    
+    # Clean up any empty .codacy directories that were created during testing
+    find plugins/tools/*/test/src -name ".codacy" -type d -empty | xargs rmdir 2>/dev/null || true
+    
+    echo "✅ Cleanup completed"
+}
+
+# Set up trap to ensure cleanup happens even if script fails
+trap cleanup_all_test_files EXIT
+
 # Initialize failed tools file
 rm -f /tmp/failed_tools.txt
 touch /tmp/failed_tools.txt

run-tool-tests.sh

@@ -25,6 +25,7 @@ normalize_paths() {
 }
 
 # Function to sort SARIF file
+
 sort_sarif() {
   local input=$1
   local output=$2
@@ -60,6 +61,35 @@ fi
 # Change to the tool's test directory
 cd "$TOOL_DIR" || exit 1
 
+# Store initial state for cleanup
+initial_codacy_config=""
+if [ -f .codacy/codacy.yaml ]; then
+  # Backup existing config if it exists
+  cp .codacy/codacy.yaml .codacy/codacy.yaml.backup
+  initial_codacy_config="exists"
+fi
+
+# Function to cleanup generated files
+cleanup_test_files() {
+  # Remove generated SARIF and sorted files
+  rm -f actual.sarif actual.sorted.json expected.sorted.json
+  
+  # Restore or clean up .codacy/codacy.yaml
+  if [ "$initial_codacy_config" = "exists" ] && [ -f .codacy/codacy.yaml.backup ]; then
+    # Restore original config
+    mv .codacy/codacy.yaml.backup .codacy/codacy.yaml
+  elif [ "$initial_codacy_config" != "exists" ]; then
+    # Remove generated config and directory if they didn't exist initially
+    rm -f .codacy/codacy.yaml
+    if [ -d .codacy ]; then
+      rmdir .codacy 2>/dev/null || true  # Only remove if empty
+    fi
+  fi
+}
+
+# Set trap to ensure cleanup happens even if script fails
+trap cleanup_test_files EXIT
+
 # Run analysis
 "$CLI_PATH" install
 "$CLI_PATH" analyze --tool "$TOOL_NAME" --format sarif --output actual.sarif
@@ -79,6 +109,8 @@ if ! diff expected.sorted.json actual.sorted.json; then
   echo -e "\nActual SARIF output:"
   cat actual.sorted.json
   echo "$TOOL_NAME" >> /tmp/failed_tools.txt
+  # Return to original directory before exit
+  cd ../../../../.. || exit 1
   exit 1
 else
   echo "✅ Tests passed successfully for $TOOL_NAME"