Pluto 1423 refactor (#154)

* Refactor: Centralize tool configuration file names into constants

- Introduced a new constants package to store tool configuration file names, reducing duplication across the codebase.
- Updated references in the analyze and config setup files to use the new constants for improved maintainability.
- Adjusted tests to align with the new constants structure, ensuring consistency in tool configuration handling.

* fix test

Author: andrzej-janczak

cmd/analyze.go

@@ -4,6 +4,7 @@ import (
 	"codacy/cli-v2/cmd/cmdutils"
 	"codacy/cli-v2/cmd/configsetup"
 	"codacy/cli-v2/config"
+	"codacy/cli-v2/constants"
 	"codacy/cli-v2/domain"
 	"codacy/cli-v2/plugins"
 	"codacy/cli-v2/tools"
@@ -43,22 +44,10 @@ type LanguagesConfig struct {
 	} `yaml:"tools" json:"tools"`
 }
 
-// toolConfigFileName maps tool names to their configuration filenames
-var toolConfigFileName = map[string]string{
-	"eslint":       "eslint.config.mjs",
-	"trivy":        "trivy.yaml",
-	"pmd":          "ruleset.xml",
-	"pylint":       "pylint.rc",
-	"dartanalyzer": "analysis_options.yaml",
-	"semgrep":      "semgrep.yaml",
-	"revive":       "revive.toml",
-	"lizard":       "lizard.yaml",
-}
-
 // LoadLanguageConfig loads the language configuration from the file
 func LoadLanguageConfig() (*LanguagesConfig, error) {
 	// First, try to load the YAML config
-	yamlPath := filepath.Join(config.Config.ToolsConfigDirectory(), "languages-config.yaml")
+	yamlPath := filepath.Join(config.Config.ToolsConfigDirectory(), constants.LanguagesConfigFileName)
 
 	// Check if the YAML file exists
 	if _, err := os.Stat(yamlPath); err == nil {
@@ -295,7 +284,7 @@ func validateToolName(toolName string) error {
 }
 
 func checkIfConfigExistsAndIsNeeded(toolName string, cliLocalMode bool) error {
-	configFileName := toolConfigFileName[toolName]
+	configFileName := constants.ToolConfigFileNames[toolName]
 	if configFileName == "" {
 		// Tool doesn't use config file
 		return nil

cmd/analyze_integration_test.go

@@ -7,6 +7,7 @@ import (
 	"testing"
 
 	"codacy/cli-v2/config"
+	"codacy/cli-v2/constants"
 	"codacy/cli-v2/domain"
 
 	"github.com/stretchr/testify/assert"
@@ -103,28 +104,28 @@ func TestCheckIfConfigExistsAndIsNeededBehavior(t *testing.T) {
 // TestToolConfigFileNameMapCompleteness ensures all expected tools have config mappings
 func TestToolConfigFileNameMapCompleteness(t *testing.T) {
 	expectedTools := map[string]string{
-		"eslint":       "eslint.config.mjs",
-		"trivy":        "trivy.yaml",
-		"pmd":          "ruleset.xml",
-		"pylint":       "pylint.rc",
-		"dartanalyzer": "analysis_options.yaml",
-		"semgrep":      "semgrep.yaml",
-		"revive":       "revive.toml",
-		"lizard":       "lizard.yaml",
+		"eslint":       constants.ESLintConfigFileName,
+		"trivy":        constants.TrivyConfigFileName,
+		"pmd":          constants.PMDConfigFileName,
+		"pylint":       constants.PylintConfigFileName,
+		"dartanalyzer": constants.DartAnalyzerConfigFileName,
+		"semgrep":      constants.SemgrepConfigFileName,
+		"revive":       constants.ReviveConfigFileName,
+		"lizard":       constants.LizardConfigFileName,
 	}
 
 	t.Run("all_expected_tools_present", func(t *testing.T) {
 		for toolName, expectedFileName := range expectedTools {
-			actualFileName, exists := toolConfigFileName[toolName]
-			assert.True(t, exists, "Tool %s should exist in toolConfigFileName map", toolName)
+			actualFileName, exists := constants.ToolConfigFileNames[toolName]
+			assert.True(t, exists, "Tool %s should exist in constants.ToolConfigFileNames map", toolName)
 			assert.Equal(t, expectedFileName, actualFileName, "Config filename for %s should match expected", toolName)
 		}
 	})
 
 	t.Run("no_unexpected_tools", func(t *testing.T) {
-		for toolName := range toolConfigFileName {
+		for toolName := range constants.ToolConfigFileNames {
 			_, expected := expectedTools[toolName]
-			assert.True(t, expected, "Unexpected tool %s found in toolConfigFileName map", toolName)
+			assert.True(t, expected, "Unexpected tool %s found in constants.ToolConfigFileNames map", toolName)
 		}
 	})
 
@@ -139,7 +140,7 @@ func TestToolConfigFileNameMapCompleteness(t *testing.T) {
 			".toml": true,
 		}
 
-		for toolName, fileName := range toolConfigFileName {
+		for toolName, fileName := range constants.ToolConfigFileNames {
 			ext := filepath.Ext(fileName)
 			assert.True(t, validExtensions[ext], "Tool %s has config file %s with unexpected extension %s", toolName, fileName, ext)
 		}

cmd/analyze_test.go

@@ -1,13 +1,14 @@
 package cmd
 
 import (
-	"codacy/cli-v2/plugins"
+	"codacy/cli-v2/config"
+	"codacy/cli-v2/constants"
+	"codacy/cli-v2/domain"
 	"os"
 	"path/filepath"
 	"testing"
 
-	"codacy/cli-v2/config"
-	"codacy/cli-v2/domain"
+	"codacy/cli-v2/plugins"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -342,13 +343,13 @@ func TestCheckIfConfigExistsAndIsNeeded(t *testing.T) {
 			config.Config = *config.NewConfigType(tmpDir, tmpDir, tmpDir)
 
 			// Create config file if needed - using the same path logic as the function under test
-			if tt.configFileExists && toolConfigFileName[tt.toolName] != "" {
+			if tt.configFileExists && constants.ToolConfigFileNames[tt.toolName] != "" {
 				// Use config.Config.ToolsConfigDirectory() to get the exact same path the function will use
 				toolsConfigDir := config.Config.ToolsConfigDirectory()
 				err := os.MkdirAll(toolsConfigDir, 0755)
 				require.NoError(t, err)
 
-				configPath := filepath.Join(toolsConfigDir, toolConfigFileName[tt.toolName])
+				configPath := filepath.Join(toolsConfigDir, constants.ToolConfigFileNames[tt.toolName])
 				err = os.WriteFile(configPath, []byte("test config"), 0644)
 				require.NoError(t, err)
 
@@ -366,9 +367,9 @@ func TestCheckIfConfigExistsAndIsNeeded(t *testing.T) {
 			err = checkIfConfigExistsAndIsNeeded(tt.toolName, tt.cliLocalMode)
 
 			// Clean up any files that might have been created by the function under test
-			if !tt.configFileExists && toolConfigFileName[tt.toolName] != "" {
+			if !tt.configFileExists && constants.ToolConfigFileNames[tt.toolName] != "" {
 				toolsConfigDir := config.Config.ToolsConfigDirectory()
-				configPath := filepath.Join(toolsConfigDir, toolConfigFileName[tt.toolName])
+				configPath := filepath.Join(toolsConfigDir, constants.ToolConfigFileNames[tt.toolName])
 				if _, statErr := os.Stat(configPath); statErr == nil {
 					os.Remove(configPath)
 				}
@@ -386,20 +387,20 @@ func TestCheckIfConfigExistsAndIsNeeded(t *testing.T) {
 
 func TestToolConfigFileNameMap(t *testing.T) {
 	expectedTools := map[string]string{
-		"eslint":       "eslint.config.mjs",
-		"trivy":        "trivy.yaml",
-		"pmd":          "ruleset.xml",
-		"pylint":       "pylint.rc",
-		"dartanalyzer": "analysis_options.yaml",
-		"semgrep":      "semgrep.yaml",
-		"revive":       "revive.toml",
-		"lizard":       "lizard.yaml",
+		"eslint":       constants.ESLintConfigFileName,
+		"trivy":        constants.TrivyConfigFileName,
+		"pmd":          constants.PMDConfigFileName,
+		"pylint":       constants.PylintConfigFileName,
+		"dartanalyzer": constants.DartAnalyzerConfigFileName,
+		"semgrep":      constants.SemgrepConfigFileName,
+		"revive":       constants.ReviveConfigFileName,
+		"lizard":       constants.LizardConfigFileName,
 	}
 
 	for toolName, expectedFileName := range expectedTools {
 		t.Run(toolName, func(t *testing.T) {
-			actualFileName, exists := toolConfigFileName[toolName]
-			assert.True(t, exists, "Tool %s should exist in toolConfigFileName map", toolName)
+			actualFileName, exists := constants.ToolConfigFileNames[toolName]
+			assert.True(t, exists, "Tool %s should exist in constants.ToolConfigFileNames map", toolName)
 			assert.Equal(t, expectedFileName, actualFileName, "Config filename for %s should match expected", toolName)
 		})
 	}

cmd/configsetup/setup.go

@@ -22,17 +22,6 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
-// Configuration file names - extracted as constants to avoid duplication
-const (
-	LanguagesConfigFileName    = "languages-config.yaml"
-	GitIgnoreFileName          = ".gitignore"
-	PMDConfigFileName          = "ruleset.xml"
-	PylintConfigFileName       = "pylint.rc"
-	TrivyConfigFileName        = "trivy.yaml"
-	DartAnalyzerConfigFileName = "analysis_options.yaml"
-	SemgrepConfigFileName      = "semgrep.yaml"
-)
-
 // ToolConfigCreator defines the interface for tool configuration creators
 type ToolConfigCreator interface {
 	CreateConfig(toolsConfigDir string, patterns []domain.PatternConfiguration) error
@@ -78,71 +67,73 @@ type trivyConfigCreator struct{}
 
 func (t *trivyConfigCreator) CreateConfig(toolsConfigDir string, patterns []domain.PatternConfiguration) error {
 	configString := tools.CreateTrivyConfig(patterns)
-	err := writeConfigFile(filepath.Join(toolsConfigDir, TrivyConfigFileName), []byte(configString))
+	err := writeConfigFile(filepath.Join(toolsConfigDir, constants.TrivyConfigFileName), []byte(configString))
 	if err == nil {
 		fmt.Println("Trivy configuration created based on Codacy settings")
 	}
 	return err
 }
 
-func (t *trivyConfigCreator) GetConfigFileName() string { return TrivyConfigFileName }
+func (t *trivyConfigCreator) GetConfigFileName() string { return constants.TrivyConfigFileName }
 func (t *trivyConfigCreator) GetToolName() string       { return "Trivy" }
 
 // pmdConfigCreator implements ToolConfigCreator for PMD
 type pmdConfigCreator struct{}
 
 func (p *pmdConfigCreator) CreateConfig(toolsConfigDir string, patterns []domain.PatternConfiguration) error {
 	configString := tools.CreatePmd6Config(patterns)
-	return writeConfigFile(filepath.Join(toolsConfigDir, PMDConfigFileName), []byte(configString))
+	return writeConfigFile(filepath.Join(toolsConfigDir, constants.PMDConfigFileName), []byte(configString))
 }
 
-func (p *pmdConfigCreator) GetConfigFileName() string { return PMDConfigFileName }
+func (p *pmdConfigCreator) GetConfigFileName() string { return constants.PMDConfigFileName }
 func (p *pmdConfigCreator) GetToolName() string       { return "PMD" }
 
 // pmd7ConfigCreator implements ToolConfigCreator for PMD7
 type pmd7ConfigCreator struct{}
 
 func (p *pmd7ConfigCreator) CreateConfig(toolsConfigDir string, patterns []domain.PatternConfiguration) error {
 	configString := tools.CreatePmd7Config(patterns)
-	err := writeConfigFile(filepath.Join(toolsConfigDir, PMDConfigFileName), []byte(configString))
+	err := writeConfigFile(filepath.Join(toolsConfigDir, constants.PMDConfigFileName), []byte(configString))
 	if err == nil {
 		fmt.Println("PMD7 configuration created based on Codacy settings")
 	}
 	return err
 }
 
-func (p *pmd7ConfigCreator) GetConfigFileName() string { return PMDConfigFileName }
+func (p *pmd7ConfigCreator) GetConfigFileName() string { return constants.PMDConfigFileName }
 func (p *pmd7ConfigCreator) GetToolName() string       { return "PMD7" }
 
 // pylintConfigCreator implements ToolConfigCreator for Pylint
 type pylintConfigCreator struct{}
 
 func (p *pylintConfigCreator) CreateConfig(toolsConfigDir string, patterns []domain.PatternConfiguration) error {
 	configString := pylint.GeneratePylintRC(patterns)
-	err := writeConfigFile(filepath.Join(toolsConfigDir, PylintConfigFileName), []byte(configString))
+	err := writeConfigFile(filepath.Join(toolsConfigDir, constants.PylintConfigFileName), []byte(configString))
 	if err == nil {
 		fmt.Println("Pylint configuration created based on Codacy settings")
 	}
 	return err
 }
 
-func (p *pylintConfigCreator) GetConfigFileName() string { return PylintConfigFileName }
+func (p *pylintConfigCreator) GetConfigFileName() string { return constants.PylintConfigFileName }
 func (p *pylintConfigCreator) GetToolName() string       { return "Pylint" }
 
 // dartAnalyzerConfigCreator implements ToolConfigCreator for Dart Analyzer
 type dartAnalyzerConfigCreator struct{}
 
 func (d *dartAnalyzerConfigCreator) CreateConfig(toolsConfigDir string, patterns []domain.PatternConfiguration) error {
 	configString := tools.CreateDartAnalyzerConfig(patterns)
-	err := writeConfigFile(filepath.Join(toolsConfigDir, DartAnalyzerConfigFileName), []byte(configString))
+	err := writeConfigFile(filepath.Join(toolsConfigDir, constants.DartAnalyzerConfigFileName), []byte(configString))
 	if err == nil {
 		fmt.Println("Dart configuration created based on Codacy settings")
 	}
 	return err
 }
 
-func (d *dartAnalyzerConfigCreator) GetConfigFileName() string { return DartAnalyzerConfigFileName }
-func (d *dartAnalyzerConfigCreator) GetToolName() string       { return "Dart Analyzer" }
+func (d *dartAnalyzerConfigCreator) GetConfigFileName() string {
+	return constants.DartAnalyzerConfigFileName
+}
+func (d *dartAnalyzerConfigCreator) GetToolName() string { return "Dart Analyzer" }
 
 // semgrepConfigCreator implements ToolConfigCreator for Semgrep
 type semgrepConfigCreator struct{}
@@ -152,14 +143,14 @@ func (s *semgrepConfigCreator) CreateConfig(toolsConfigDir string, patterns []do
 	if err != nil {
 		return fmt.Errorf("failed to create Semgrep config: %v", err)
 	}
-	err = writeConfigFile(filepath.Join(toolsConfigDir, SemgrepConfigFileName), configData)
+	err = writeConfigFile(filepath.Join(toolsConfigDir, constants.SemgrepConfigFileName), configData)
 	if err == nil {
 		fmt.Println("Semgrep configuration created based on Codacy settings")
 	}
 	return err
 }
 
-func (s *semgrepConfigCreator) GetConfigFileName() string { return SemgrepConfigFileName }
+func (s *semgrepConfigCreator) GetConfigFileName() string { return constants.SemgrepConfigFileName }
 func (s *semgrepConfigCreator) GetToolName() string       { return "Semgrep" }
 
 // lizardConfigCreator implements ToolConfigCreator for Lizard
@@ -217,7 +208,7 @@ func CreateLanguagesConfigFileLocal(toolsConfigDir string) error {
 }
 
 func CreateGitIgnoreFile() error {
-	gitIgnorePath := filepath.Join(config.Config.LocalCodacyDirectory(), GitIgnoreFileName)
+	gitIgnorePath := filepath.Join(config.Config.LocalCodacyDirectory(), constants.GitIgnoreFileName)
 	content := "# Codacy CLI\ntools-configs/\n.gitignore\ncli-config.yaml\nlogs/\n"
 	return writeConfigFile(gitIgnorePath, []byte(content))
 }

constants/tool_configs.go

@@ -0,0 +1,30 @@
+package constants
+
+// Tool configuration file names - shared constants to avoid duplication
+const (
+	// Language and project configuration files
+	LanguagesConfigFileName = "languages-config.yaml"
+	GitIgnoreFileName       = ".gitignore"
+
+	// Tool-specific configuration files
+	ESLintConfigFileName       = "eslint.config.mjs"
+	TrivyConfigFileName        = "trivy.yaml"
+	PMDConfigFileName          = "ruleset.xml"
+	PylintConfigFileName       = "pylint.rc"
+	DartAnalyzerConfigFileName = "analysis_options.yaml"
+	SemgrepConfigFileName      = "semgrep.yaml"
+	ReviveConfigFileName       = "revive.toml"
+	LizardConfigFileName       = "lizard.yaml"
+)
+
+// ToolConfigFileNames maps tool names to their configuration filenames
+var ToolConfigFileNames = map[string]string{
+	"eslint":       ESLintConfigFileName,
+	"trivy":        TrivyConfigFileName,
+	"pmd":          PMDConfigFileName,
+	"pylint":       PylintConfigFileName,
+	"dartanalyzer": DartAnalyzerConfigFileName,
+	"semgrep":      SemgrepConfigFileName,
+	"revive":       ReviveConfigFileName,
+	"lizard":       LizardConfigFileName,
+}