codacy-cli-v2/run-tool-tests.sh at main · codacy/codacy-cli-v2 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
#!/bin/bash

# Function to normalize paths in a file
normalize_paths() {
  local file=$1
  # Get the repository root directory (5 levels up from current test/src directory)
  local repo_root=$(cd ../../../../.. && pwd)

  # Normalize absolute paths to relative ones for consistent testing
  if [[ "$OSTYPE" == "darwin"* ]]; then
    # Replace absolute paths with relative paths in URI contexts
    sed -i '' "s#file://${repo_root}/plugins/tools/#file:///plugins/tools/#g" "$file"
    sed -i '' "s#${repo_root}/plugins/tools/#/plugins/tools/#g" "$file"
    # Handle CI runner paths for macOS
    sed -i '' "s#file:///Users/runner/work/codacy-cli-v2/codacy-cli-v2/plugins/tools/#file:///plugins/tools/#g" "$file"
    sed -i '' "s#/Users/runner/work/codacy-cli-v2/codacy-cli-v2/plugins/tools/#/plugins/tools/#g" "$file"
  else
    # Replace absolute paths with relative paths in URI contexts
    sed -i "s#file://${repo_root}/plugins/tools/#file:///plugins/tools/#g" "$file"
    sed -i "s#${repo_root}/plugins/tools/#/plugins/tools/#g" "$file"
    # Handle CI runner paths for Linux
    sed -i "s#file:///home/runner/work/codacy-cli-v2/codacy-cli-v2/plugins/tools/#file:///plugins/tools/#g" "$file"
    sed -i "s#/home/runner/work/codacy-cli-v2/codacy-cli-v2/plugins/tools/#/plugins/tools/#g" "$file"
  fi
}

# Function to sort SARIF file

sort_sarif() {
  local input=$1
  local output=$2
  jq --sort-keys '
    if .runs[0].tool.driver.rules == null then . else .runs[0].tool.driver.rules |= sort_by(.id) end
    | .runs[0].results |= sort_by(.ruleId, .message.text, .locations[0].physicalLocation.region.startLine, .locations[0].physicalLocation.region.startColumn)
  ' "$input" > "$output"
}

# Check if tool name is provided
if [ -z "$1" ]; then
  echo "Usage: $0 <tool_name>"
  exit 1
fi

TOOL_NAME=$1
TOOL_DIR="plugins/tools/$TOOL_NAME/test/src"
TEST_DIR="plugins/tools/$TOOL_NAME/test"
CLI_PATH="$(pwd)/cli-v2"
EXPECTED_SARIF="$(pwd)/$TEST_DIR/expected.sarif"

# Validate environment
if [ ! -d "$TOOL_DIR" ]; then
  echo "Error: Tool directory $TOOL_DIR does not exist"
  exit 1
fi

if [ ! -f "$CLI_PATH" ]; then
  echo "Error: CLI binary not found at $CLI_PATH"
  exit 1
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

# Process SARIF files
normalize_paths actual.sarif
sort_sarif "$EXPECTED_SARIF" expected.sorted.json
sort_sarif actual.sarif actual.sorted.json
normalize_paths expected.sorted.json
normalize_paths actual.sorted.json

# Compare results
if ! diff expected.sorted.json actual.sorted.json; then
  echo "❌ Test output does not match expected output for $TOOL_NAME"
  echo -e "\nExpected SARIF output:"
  cat expected.sorted.json
  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"
fi

# Return to original directory
cd ../../../../.. || exit 1