feat: Add PMD analysis support and enhance binary path processing

Author: andrzej-janczak

cmd/analyze.go

@@ -203,6 +203,16 @@ func runTrivyAnalysis(workDirectory string, pathsToCheck []string, outputFile st
 	}
 }
 
+func runPmdAnalysis(workDirectory string, pathsToCheck []string, outputFile string, outputFormat string) {
+	pmd := config.Config.Tools()["pmd"]
+	pmdBinary := pmd.Binaries["pmd"]
+
+	err := tools.RunPmd(workDirectory, pmdBinary, pathsToCheck, outputFile, outputFormat)
+	if err != nil {
+		log.Fatalf("Error running PMD: %v", err)
+	}
+}
+
 var analyzeCmd = &cobra.Command{
 	Use:   "analyze",
 	Short: "Runs all linters.",
@@ -226,6 +236,8 @@ var analyzeCmd = &cobra.Command{
 			runEslintAnalysis(workDirectory, args, autoFix, outputFile, outputFormat)
 		case "trivy":
 			runTrivyAnalysis(workDirectory, args, outputFile, outputFormat)
+		case "pmd":
+			runPmdAnalysis(workDirectory, args, outputFile, outputFormat)
 		case "":
 			log.Fatal("You need to specify a tool to run analysis with, e.g., '--tool eslint'")
 		default:

plugins/tool-utils.go

@@ -174,7 +174,23 @@ func ProcessTools(configs []ToolConfig, toolDir string) (map[string]*ToolInfo, e
 
 		// Process binary paths
 		for _, binary := range pluginConfig.Binaries {
-			binaryPath := path.Join(installDir, binary.Path)
+			// Process template variables in binary path
+			tmpl, err := template.New("binary_path").Parse(binary.Path)
+			if err != nil {
+				return nil, fmt.Errorf("error parsing binary path template for %s: %w", config.Name, err)
+			}
+
+			var buf bytes.Buffer
+			err = tmpl.Execute(&buf, struct {
+				Version string
+			}{
+				Version: config.Version,
+			})
+			if err != nil {
+				return nil, fmt.Errorf("error executing binary path template for %s: %w", config.Name, err)
+			}
+
+			binaryPath := path.Join(installDir, buf.String())
 			info.Binaries[binary.Name] = binaryPath
 		}
 

tools/pmdRunner.go

@@ -0,0 +1,33 @@
+package tools
+
+import (
+	"os"
+	"os/exec"
+)
+
+// RunPmd executes PMD static code analyzer with the specified options
+func RunPmd(repositoryToAnalyseDirectory string, pmdBinary string, pathsToCheck []string, outputFile string, outputFormat string) error {
+	cmd := exec.Command(pmdBinary, "check")
+
+	// Add format options
+	if outputFormat == "sarif" {
+		cmd.Args = append(cmd.Args, "--format", "sarif")
+	}
+
+	if outputFile != "" {
+		cmd.Args = append(cmd.Args, "--report-file", outputFile)
+	}
+
+	// Add specific targets or use current directory
+	if len(pathsToCheck) > 0 {
+		cmd.Args = append(cmd.Args, pathsToCheck...)
+	} else {
+		cmd.Args = append(cmd.Args, ".")
+	}
+
+	cmd.Dir = repositoryToAnalyseDirectory
+	cmd.Stderr = os.Stderr
+	cmd.Stdout = os.Stdout
+
+	return cmd.Run()
+}

tools/pmdRunner_test.go

@@ -0,0 +1,56 @@
+package tools
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"path/filepath"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRunPmdToFile(t *testing.T) {
+	homeDirectory, err := os.UserHomeDir()
+	if err != nil {
+		log.Fatal(err.Error())
+	}
+	currentDirectory, err := os.Getwd()
+	if err != nil {
+		log.Fatal(err.Error())
+	}
+
+	testDirectory := "testdata/repositories/pmd"
+	tempResultFile := filepath.Join(os.TempDir(), "pmd.sarif")
+	defer os.Remove(tempResultFile)
+
+	repositoryToAnalyze := filepath.Join(testDirectory, "src")
+
+	pmdBinary := filepath.Join(homeDirectory, ".cache/codacy/tools/[email protected]/pmd-bin-7.12.0/bin/pmd")
+
+	err = RunPmd(repositoryToAnalyze, pmdBinary, nil, tempResultFile, "sarif")
+	if err != nil {
+		t.Fatalf("Failed to run PMD: %v", err)
+	}
+
+	// Check if the output file was created
+	obtainedSarifBytes, err := os.ReadFile(tempResultFile)
+	if err != nil {
+		t.Fatalf("Failed to read output file: %v", err)
+	}
+	obtainedSarif := string(obtainedSarifBytes)
+	filePrefix := "file://" + currentDirectory + "/"
+	fmt.Println(filePrefix)
+	actualSarif := strings.ReplaceAll(obtainedSarif, filePrefix, "")
+
+	// Read the expected SARIF
+	expectedSarifFile := filepath.Join(testDirectory, "expected.sarif")
+	expectedSarifBytes, err := os.ReadFile(expectedSarifFile)
+	if err != nil {
+		log.Fatal(err)
+	}
+	expectedSarif := strings.TrimSpace(string(expectedSarifBytes))
+
+	assert.Equal(t, expectedSarif, actualSarif, "output did not match expected")
+}