Restructure tools folder

cmd/analyze.go

@@ -3,6 +3,9 @@ package cmd
 import (
 	"codacy/cli-v2/config"
 	"codacy/cli-v2/tools"
+	"codacy/cli-v2/tools/eslint"
+	"codacy/cli-v2/tools/pmd"
+	"codacy/cli-v2/tools/trivy"
 	"encoding/json"
 	"fmt"
 	"io"
@@ -187,29 +190,30 @@ func getToolName(toolName string, version string) string {
 }
 
 func runEslintAnalysis(workDirectory string, pathsToCheck []string, autoFix bool, outputFile string, outputFormat string) {
-	eslint := config.Config.Tools()["eslint"]
-	eslintInstallationDirectory := eslint.InstallDir
+	tool := config.Config.Tools()["eslint"]
+	eslintInstallationDirectory := tool.InstallDir
 	nodeRuntime := config.Config.Runtimes()["node"]
 	nodeBinary := nodeRuntime.Binaries["node"]
 
-	tools.RunEslint(workDirectory, eslintInstallationDirectory, nodeBinary, pathsToCheck, autoFix, outputFile, outputFormat)
+	//todo pass config file
+	eslint.RunEslint(workDirectory, eslintInstallationDirectory, nodeBinary, pathsToCheck, autoFix, outputFile, outputFormat, "")
 }
 
 func runTrivyAnalysis(workDirectory string, pathsToCheck []string, outputFile string, outputFormat string) {
-	trivy := config.Config.Tools()["trivy"]
-	trivyBinary := trivy.Binaries["trivy"]
+	tool := config.Config.Tools()["trivy"]
+	trivyBinary := tool.Binaries["trivy"]
 
-	err := tools.RunTrivy(workDirectory, trivyBinary, pathsToCheck, outputFile, outputFormat)
+	err := trivy.RunTrivy(workDirectory, trivyBinary, pathsToCheck, outputFile, outputFormat)
 	if err != nil {
 		log.Fatalf("Error running Trivy: %v", err)
 	}
 }
 
 func runPmdAnalysis(workDirectory string, pathsToCheck []string, outputFile string, outputFormat string) {
-	pmd := config.Config.Tools()["pmd"]
-	pmdBinary := pmd.Binaries["pmd"]
+	tool := config.Config.Tools()["pmd"]
+	pmdBinary := tool.Binaries["pmd"]
 
-	err := tools.RunPmd(workDirectory, pmdBinary, pathsToCheck, outputFile, outputFormat, pmdRulesetFile)
+	err := pmd.RunPmd(workDirectory, pmdBinary, pathsToCheck, outputFile, outputFormat, pmdRulesetFile)
 	if err != nil {
 		log.Fatalf("Error running PMD: %v", err)
 	}

cmd/init.go

@@ -3,6 +3,9 @@ package cmd
 import (
 	"codacy/cli-v2/config"
 	"codacy/cli-v2/tools"
+	"codacy/cli-v2/tools/eslint"
+	"codacy/cli-v2/tools/pmd"
+	"codacy/cli-v2/tools/trivy"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -171,7 +174,7 @@ func buildRepositoryConfigurationFiles(token string) error {
 	eslintApiConfiguration := extractESLintConfiguration(apiToolConfigurations)
 	if eslintApiConfiguration != nil {
 		eslintDomainConfiguration := convertAPIToolConfigurationToDomain(*eslintApiConfiguration)
-		eslintConfigurationString := tools.CreateEslintConfig(eslintDomainConfiguration)
+		eslintConfigurationString := eslint.CreateEslintConfig(eslintDomainConfiguration)
 
 		eslintConfigFile, err := os.Create("eslint.config.mjs")
 		if err != nil {
@@ -295,13 +298,13 @@ func extractPMDConfiguration(toolConfigurations []CodacyToolConfiguration) *Coda
 
 func createPMDConfigFile(config CodacyToolConfiguration) error {
 	pmdDomainConfiguration := convertAPIToolConfigurationToDomain(config)
-	pmdConfigurationString := tools.CreatePmdConfig(pmdDomainConfiguration)
+	pmdConfigurationString := pmd.CreatePmdConfig(pmdDomainConfiguration)
 	return os.WriteFile("pmd-ruleset.xml", []byte(pmdConfigurationString), 0644)
 }
 
 func createDefaultPMDConfigFile() error {
 	emptyConfig := tools.ToolConfiguration{}
-	content := tools.CreatePmdConfig(emptyConfig)
+	content := pmd.CreatePmdConfig(emptyConfig)
 	return os.WriteFile("pmd-ruleset.xml", []byte(content), 0644)
 }
 
@@ -327,7 +330,7 @@ func createTrivyConfigFile(config CodacyToolConfiguration) error {
 	trivyDomainConfiguration := convertAPIToolConfigurationForTrivy(config)
 
 	// Use the shared CreateTrivyConfig function to generate the config content
-	trivyConfigurationString := tools.CreateTrivyConfig(trivyDomainConfiguration)
+	trivyConfigurationString := trivy.CreateTrivyConfig(trivyDomainConfiguration)
 
 	// Write to file
 	return os.WriteFile("trivy.yaml", []byte(trivyConfigurationString), 0644)
@@ -377,7 +380,7 @@ func convertAPIToolConfigurationForTrivy(config CodacyToolConfiguration) tools.T
 func createDefaultTrivyConfigFile() error {
 	// Use empty tool configuration to get default settings
 	emptyConfig := tools.ToolConfiguration{}
-	content := tools.CreateTrivyConfig(emptyConfig)
+	content := trivy.CreateTrivyConfig(emptyConfig)
 
 	// Write to file
 	return os.WriteFile("trivy.yaml", []byte(content), 0644)
@@ -387,7 +390,7 @@ func createDefaultTrivyConfigFile() error {
 func createDefaultEslintConfigFile() error {
 	// Use empty tool configuration to get default settings
 	emptyConfig := tools.ToolConfiguration{}
-	content := tools.CreateEslintConfig(emptyConfig)
+	content := eslint.CreateEslintConfig(emptyConfig)
 
 	// Write to file
 	return os.WriteFile("eslint.config.mjs", []byte(content), 0644)

tools/eslintConfigCreator.go → tools/eslint/eslintConfigCreator.go

@@ -1,9 +1,11 @@
-package tools
+package eslint
 
 import (
 	"encoding/json"
 	"fmt"
 	"strings"
+
+	"codacy/cli-v2/tools"
 )
 
 func quoteWhenIsNotJson(value string) string {
@@ -18,7 +20,7 @@
 	}
 }
 
-func CreateEslintConfig(configuration ToolConfiguration) string {
+func CreateEslintConfig(configuration tools.ToolConfiguration) string {
 	result := `export default [
     {
         rules: {

tools/eslintRunner.go → tools/eslint/eslintRunner.go

@@ -1,4 +1,4 @@
-package tools
+package eslint
 
 import (
 	"os"
@@ -9,7 +9,7 @@
 // * Run from the root of the repo we want to analyse
 // * NODE_PATH="<the installed eslint path>/node_modules"
 // * The local installed ESLint should have the @microsoft/eslint-formatter-sarif installed
-func RunEslint(repositoryToAnalyseDirectory string, eslintInstallationDirectory string, nodeBinary string, pathsToCheck []string, autoFix bool, outputFile string, outputFormat string) {
+func RunEslint(repositoryToAnalyseDirectory string, eslintInstallationDirectory string, nodeBinary string, pathsToCheck []string, autoFix bool, outputFile string, outputFormat string, configFile string) {
 	eslintInstallationNodeModules := filepath.Join(eslintInstallationDirectory, "node_modules")
 	eslintJsPath := filepath.Join(eslintInstallationNodeModules, ".bin", "eslint")
 
@@ -19,13 +19,19 @@
 	}
 	if outputFormat == "sarif" {
 		//When outputting in SARIF format
-		cmd.Args = append(cmd.Args, "-f", "@microsoft/eslint-formatter-sarif")
+		cmd.Args = append(cmd.Args, "-f", filepath.Join(eslintInstallationNodeModules, "@microsoft", "eslint-formatter-sarif", "sarif.js"))
 	}
 
 	if outputFile != "" {
 		//When writing to file, use the output file option
 		cmd.Args = append(cmd.Args, "-o", outputFile)
 	}
+
+	// Add config file flag if provided
+	if configFile != "" {
+		cmd.Args = append(cmd.Args, "--config", configFile)
+	}
+
 	if len(pathsToCheck) > 0 {
 		cmd.Args = append(cmd.Args, pathsToCheck...)
 	} else {

tools/pmdConfigCreator.go → tools/pmd/pmdConfigCreator.go

@@ -1,13 +1,14 @@
-package tools
+package pmd
 
 import (
+	"codacy/cli-v2/tools"
 	_ "embed"
 	"encoding/xml"
 	"fmt"
 	"strings"
 )
 
-//go:embed pmd/default-ruleset.xml
+//go:embed default-ruleset.xml
 var defaultPMDRuleset string
 
 // Parameter represents a rule parameter
@@ -171,7 +172,7 @@
 }
 
 // CreatePmdConfig creates a PMD configuration from the provided tool configuration
-func CreatePmdConfig(configuration ToolConfiguration) string {
+func CreatePmdConfig(configuration tools.ToolConfiguration) string {
 	// If no patterns provided, return the default ruleset
 	if len(configuration.PatternsConfiguration) == 0 {
 		return defaultPMDRuleset

tools/pmdRunner.go → tools/pmd/pmdRunner.go

@@ -1,12 +1,11 @@
-package tools
+package pmd
 
 import (
 	"os"
 	"os/exec"
 	"strings"
 )
 
-// RunPmd executes PMD static code analyzer with the specified options
 func RunPmd(repositoryToAnalyseDirectory string, pmdBinary string, pathsToCheck []string, outputFile string, outputFormat string, rulesetFile string) error {
 	cmdArgs := []string{"pmd"}
 

tools/test/eslint/config.json

@@ -0,0 +1,18 @@
+{
+  "env": {},
+  "globals": {},
+  "parser": null,
+  "parserOptions": {},
+  "plugins": [],
+  "rules": {
+    "prefer-const": [
+      "error"
+    ],
+    "semi": [
+      "error",
+      "always"
+    ]
+  },
+  "settings": {},
+  "ignorePatterns": []
+}

tools/test/eslint/eslint.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  rules: {
+    semi: ["error", "always"]
+  }
+}; 

tools/eslintConfigCreator_test.go → tools/test/eslint/eslintConfigCreator_test.go

@@ -1,19 +1,22 @@
-package tools
+package eslint
 
 import (
 	"testing"
 
+	"codacy/cli-v2/tools"
+	"codacy/cli-v2/tools/eslint"
+
 	"github.com/stretchr/testify/assert"
 )
 
-func testConfig(t *testing.T, configuration ToolConfiguration, expected string) {
-	actual := CreateEslintConfig(configuration)
+func testConfig(t *testing.T, configuration tools.ToolConfiguration, expected string) {
+	actual := eslint.CreateEslintConfig(configuration)
 	assert.Equal(t, expected, actual)
 }
 
 func TestCreateEslintConfigEmptyConfig(t *testing.T) {
 	testConfig(t,
-		ToolConfiguration{},
+		tools.ToolConfiguration{},
 		`export default [
     {
         rules: {
@@ -24,8 +27,8 @@ func TestCreateEslintConfigEmptyConfig(t *testing.T) {
 
 func TestCreateEslintConfigConfig1(t *testing.T) {
 	testConfig(t,
-		ToolConfiguration{
-			PatternsConfiguration: []PatternConfiguration{
+		tools.ToolConfiguration{
+			PatternsConfiguration: []tools.PatternConfiguration{
 				{
 					PatternId: "ESLint8_semi",
 				},
@@ -42,11 +45,11 @@ func TestCreateEslintConfigConfig1(t *testing.T) {
 
 func TestCreateEslintConfigUnnamedParam(t *testing.T) {
 	testConfig(t,
-		ToolConfiguration{
-			PatternsConfiguration: []PatternConfiguration{
+		tools.ToolConfiguration{
+			PatternsConfiguration: []tools.PatternConfiguration{
 				{
 					PatternId: "ESLint8_semi",
-					ParameterConfigurations: []PatternParameterConfiguration{
+					ParameterConfigurations: []tools.PatternParameterConfiguration{
 						{
 							Name:  "unnamedParam",
 							Value: "never",
@@ -66,11 +69,11 @@ func TestCreateEslintConfigUnnamedParam(t *testing.T) {
 
 func TestCreateEslintConfigNamedParam(t *testing.T) {
 	testConfig(t,
-		ToolConfiguration{
-			PatternsConfiguration: []PatternConfiguration{
+		tools.ToolConfiguration{
+			PatternsConfiguration: []tools.PatternConfiguration{
 				{
 					PatternId: "consistent-return",
-					ParameterConfigurations: []PatternParameterConfiguration{
+					ParameterConfigurations: []tools.PatternParameterConfiguration{
 						{
 							Name:  "treatUndefinedAsUnspecified",
 							Value: "false",
@@ -90,11 +93,11 @@ func TestCreateEslintConfigNamedParam(t *testing.T) {
 
 func TestCreateEslintConfigUnnamedAndNamedParam(t *testing.T) {
 	testConfig(t,
-		ToolConfiguration{
-			PatternsConfiguration: []PatternConfiguration{
+		tools.ToolConfiguration{
+			PatternsConfiguration: []tools.PatternConfiguration{
 				{
 					PatternId: "consistent-return",
-					ParameterConfigurations: []PatternParameterConfiguration{
+					ParameterConfigurations: []tools.PatternParameterConfiguration{
 						{
 							Name:  "treatUndefinedAsUnspecified",
 							Value: "false",
@@ -118,8 +121,8 @@ func TestCreateEslintConfigUnnamedAndNamedParam(t *testing.T) {
 
 func TestCreateEslintConfigSupportPlugins(t *testing.T) {
 	testConfig(t,
-		ToolConfiguration{
-			PatternsConfiguration: []PatternConfiguration{
+		tools.ToolConfiguration{
+			PatternsConfiguration: []tools.PatternConfiguration{
 				{
 					PatternId: "plugin/consistent-return",
 				},