Merge pull request #56 from codacy/feature/add-dartanalyzer

heliocodacy · web-flow · commit aa756706ae91 · 2025-04-15T14:33:34.000+01:00
add dart analyzer
diff --git a/.codacy/codacy.yaml b/.codacy/codacy.yaml
@@ -1,8 +1,10 @@
 runtimes:
     - node@22.2.0
     - python@3.11.11
+    - dart@3.7.2
 tools:
     - eslint@9.3.0
     - trivy@0.59.1
     - pylint@3.3.6
     - pmd@6.55.0
+    - dartanalyzer@3.7.2
diff --git a/.gitignore b/.gitignore
@@ -27,3 +27,7 @@ go.work.sum
 # Codacy CLI 
 cli-v2
 codacy-cli
+
+
+#Ignore cursor AI rules
+.cursor/rules/codacy.mdc
diff --git a/cmd/analyze.go b/cmd/analyze.go
@@ -217,6 +217,11 @@ func runPylintAnalysis(workDirectory string, pathsToCheck []string, outputFile s
 	return tools.RunPylint(workDirectory, pylint, pathsToCheck, outputFile, outputFormat)
 }
 
+func runDartAnalyzer(workDirectory string, pathsToCheck []string, outputFile string, outputFormat string) error {
+	dartanalyzer := config.Config.Tools()["dartanalyzer"]
+	return tools.RunDartAnalyzer(workDirectory, dartanalyzer.InstallDir, dartanalyzer.Binaries["dart"], pathsToCheck, outputFile, outputFormat)
+}
+
 var analyzeCmd = &cobra.Command{
 	Use:   "analyze",
 	Short: "Runs all configured linters.",
@@ -307,6 +312,8 @@ func runTool(workDirectory string, toolName string, args []string, outputFile st
 		return runPmdAnalysis(workDirectory, args, outputFile, outputFormat)
 	case "pylint":
 		return runPylintAnalysis(workDirectory, args, outputFile, outputFormat)
+	case "dartanalyzer":
+		return runDartAnalyzer(workDirectory, args, outputFile, outputFormat)
 	default:
 		return fmt.Errorf("unsupported tool: %s", toolName)
 	}
diff --git a/cmd/init.go b/cmd/init.go
@@ -138,13 +138,14 @@ func configFileTemplate(tools []tools.Tool) string {
 	// Track needed runtimes
 	needsNode := false
 	needsPython := false
-
+	needsDart := false
 	// Default versions
 	defaultVersions := map[string]string{
-		ESLint: "9.3.0",
-		Trivy:  "0.59.1",
-		PyLint: "3.3.6",
-		PMD:    "6.55.0",
+		ESLint:       "9.3.0",
+		Trivy:        "0.59.1",
+		PyLint:       "3.3.6",
+		PMD:          "6.55.0",
+		DartAnalyzer: "3.7.2",
 	}
 
 	// Build map of enabled tools with their versions
@@ -161,6 +162,8 @@ func configFileTemplate(tools []tools.Tool) string {
 			needsNode = true
 		} else if tool.Uuid == PyLint {
 			needsPython = true
+		} else if tool.Uuid == DartAnalyzer {
+			needsDart = true
 		}
 	}
 
@@ -176,10 +179,14 @@ func configFileTemplate(tools []tools.Tool) string {
 		if needsPython {
 			sb.WriteString("    - python@3.11.11\n")
 		}
+		if needsDart {
+			sb.WriteString("    - dart@3.7.2\n")
+		}
 	} else {
 		// In local mode with no tools specified, include all runtimes
 		sb.WriteString("    - node@22.2.0\n")
 		sb.WriteString("    - python@3.11.11\n")
+		sb.WriteString("    - dart@3.7.2\n")
 	}
 
 	sb.WriteString("tools:\n")
@@ -188,10 +195,11 @@ func configFileTemplate(tools []tools.Tool) string {
 	if len(tools) > 0 {
 		// Add only the tools that are in the API response (enabled tools)
 		uuidToName := map[string]string{
-			ESLint: "eslint",
-			Trivy:  "trivy",
-			PyLint: "pylint",
-			PMD:    "pmd",
+			ESLint:       "eslint",
+			Trivy:        "trivy",
+			PyLint:       "pylint",
+			PMD:          "pmd",
+			DartAnalyzer: "dartanalyzer",
 		}
 
 		for uuid, name := range uuidToName {
@@ -205,6 +213,7 @@ func configFileTemplate(tools []tools.Tool) string {
 		sb.WriteString(fmt.Sprintf("    - trivy@%s\n", defaultVersions[Trivy]))
 		sb.WriteString(fmt.Sprintf("    - pylint@%s\n", defaultVersions[PyLint]))
 		sb.WriteString(fmt.Sprintf("    - pmd@%s\n", defaultVersions[PMD]))
+		sb.WriteString(fmt.Sprintf("    - dartanalyzer@%s\n", defaultVersions[DartAnalyzer]))
 	}
 
 	return sb.String()
@@ -380,6 +389,13 @@ func createToolFileConfigurations(tool tools.Tool, patternConfiguration []domain
 			}
 		}
 		fmt.Println("Pylint configuration created based on Codacy settings")
+	case DartAnalyzer:
+		if len(patternConfiguration) > 0 {
+			err := createDartAnalyzerConfigFile(patternConfiguration, toolsConfigDir)
+			if err != nil {
+				return fmt.Errorf("failed to create Dart Analyzer config: %v", err)
+			}
+		}
 	}
 	return nil
 }
@@ -414,6 +430,12 @@ func createTrivyConfigFile(config []domain.PatternConfiguration, toolsConfigDir
 	return os.WriteFile(filepath.Join(toolsConfigDir, "trivy.yaml"), []byte(trivyConfigurationString), utils.DefaultFilePerms)
 }
 
+func createDartAnalyzerConfigFile(config []domain.PatternConfiguration, toolsConfigDir string) error {
+
+	dartAnalyzerConfigurationString := tools.CreateDartAnalyzerConfig(config)
+	return os.WriteFile(filepath.Join(toolsConfigDir, "analysis_options.yaml"), []byte(dartAnalyzerConfigurationString), utils.DefaultFilePerms)
+}
+
 // createDefaultTrivyConfigFile creates a default trivy.yaml configuration file
 func createDefaultTrivyConfigFile(toolsConfigDir string) error {
 	// Use empty tool configuration to get default settings
@@ -462,8 +484,9 @@ func cleanConfigDirectory(toolsConfigDir string) error {
 }
 
 const (
-	ESLint string = "f8b29663-2cb2-498d-b923-a10c6a8c05cd"
-	Trivy  string = "2fd7fbe0-33f9-4ab3-ab73-e9b62404e2cb"
-	PMD    string = "9ed24812-b6ee-4a58-9004-0ed183c45b8f"
-	PyLint string = "31677b6d-4ae0-4f56-8041-606a8d7a8e61"
+	ESLint       string = "f8b29663-2cb2-498d-b923-a10c6a8c05cd"
+	Trivy        string = "2fd7fbe0-33f9-4ab3-ab73-e9b62404e2cb"
+	PMD          string = "9ed24812-b6ee-4a58-9004-0ed183c45b8f"
+	PyLint       string = "31677b6d-4ae0-4f56-8041-606a8d7a8e61"
+	DartAnalyzer string = "d203d615-6cf1-41f9-be5f-e2f660f7850f"
 )
diff --git a/config-file/configFile.go b/config-file/configFile.go
@@ -3,8 +3,9 @@ package config_file
 import (
 	"codacy/cli-v2/config"
 	"codacy/cli-v2/plugins"
-	"gopkg.in/yaml.v3"
 	"os"
+
+	"gopkg.in/yaml.v3"
 )
 
 type configFile struct {
diff --git a/config/config.go b/config/config.go
@@ -82,7 +82,7 @@ func (c *ConfigType) Tools() map[string]*plugins.ToolInfo {
 
 func (c *ConfigType) AddTools(configs []plugins.ToolConfig) error {
 	// Process the tool configurations using the plugins.ProcessTools function
-	toolInfoMap, err := plugins.ProcessTools(configs, c.toolsDirectory)
+	toolInfoMap, err := plugins.ProcessTools(configs, c.toolsDirectory, c.runtimes)
 	if err != nil {
 		return err
 	}
diff --git a/config/tools-installer.go b/config/tools-installer.go
@@ -35,6 +35,7 @@ func InstallTool(name string, toolInfo *plugins.ToolInfo, registry string) error
 	}
 
 	// Make sure the installation directory exists
+
 	err := os.MkdirAll(toolInfo.InstallDir, 0755)
 	if err != nil {
 		return fmt.Errorf("failed to create installation directory: %w", err)
diff --git a/domain/patternConfiguration.go b/domain/patternConfiguration.go
@@ -6,7 +6,9 @@ type ParameterConfiguration struct {
 }
 
 type PatternDefinition struct {
-	Id string `json:"id"`
+	Id       string `json:"id"`
+	Category string `json:"category"`
+	Level    string `json:"level"`
 }
 
 type PatternConfiguration struct {
diff --git a/plugins/runtimes/dart/plugin.yaml b/plugins/runtimes/dart/plugin.yaml
@@ -0,0 +1,19 @@
+name: dart
+description: Dart runtime
+download:
+  url_template: "https://storage.googleapis.com/dart-archive/channels/stable/release/{{.Version}}/sdk/dartsdk-{{.OS}}-{{.Arch}}-release.{{.Extension}}"
+  file_name_template: "dart-sdk"
+  extension:
+    default: "zip"
+  arch_mapping:
+    "386": "ia32"
+    "amd64": "x64"
+    "arm": "arm"
+    "arm64": "arm64"
+  os_mapping:
+    "darwin": "macos"
+    "linux": "linux"
+    "windows": "windows"
+binaries:
+  - name: dart
+    path: "bin/dart"
diff --git a/plugins/runtimes/flutter/plugin.yaml b/plugins/runtimes/flutter/plugin.yaml
@@ -0,0 +1,19 @@
+name: flutter
+description: Dart Flutterruntime
+download:
+  url_template: "https://storage.googleapis.com/flutter_infra_release/releases/stable/{{.OS}}/flutter_{{.OS}}_{{.Arch}}_{{.Version}}-stable.zip"
+  file_name_template: "flutter"
+  extension:
+    default: "zip"
+  arch_mapping:
+    "386": "ia32"
+    "amd64": "x64"
+    "arm": "arm"
+    "arm64": "arm64"
+  os_mapping:
+    "darwin": "macos"
+    "linux": "linux"
+    "windows": "windows"
+binaries:
+  - name: dart
+    path: "bin/dart"
diff --git a/plugins/tool-utils.go b/plugins/tool-utils.go
@@ -110,7 +110,7 @@ type ToolInfo struct {
 }
 
 // ProcessTools processes a list of tool configurations and returns a map of tool information
-func ProcessTools(configs []ToolConfig, toolDir string) (map[string]*ToolInfo, error) {
+func ProcessTools(configs []ToolConfig, toolDir string, runtimes map[string]*RuntimeInfo) (map[string]*ToolInfo, error) {
 	result := make(map[string]*ToolInfo)
 
 	for _, config := range configs {
@@ -122,21 +122,30 @@ func ProcessTools(configs []ToolConfig, toolDir string) (map[string]*ToolInfo, e
 		if err != nil {
 			return nil, fmt.Errorf("error reading plugin.yaml for %s: %w", config.Name, err)
 		}
-
 		var pluginConfig ToolPluginConfig
 		err = yaml.Unmarshal(data, &pluginConfig)
 		if err != nil {
 			return nil, fmt.Errorf("error parsing plugin.yaml for %s: %w", config.Name, err)
 		}
-
 		// Create the install directory path
 		installDir := path.Join(toolDir, fmt.Sprintf("%s@%s", config.Name, config.Version))
 
+		// Handle special case for dartanalyzer since it can be used with either dart or flutter
+		toolRuntime := pluginConfig.Runtime
+		if config.Name == "dartanalyzer" {
+			if runtimes["flutter"] != nil {
+				installDir = runtimes["flutter"].InstallDir
+				toolRuntime = "flutter"
+			} else {
+				installDir = runtimes["dart"].InstallDir
+				toolRuntime = "dart"
+			}
+		}
 		// Create ToolInfo with basic information
 		info := &ToolInfo{
 			Name:        config.Name,
 			Version:     config.Version,
-			Runtime:     pluginConfig.Runtime,
+			Runtime:     toolRuntime,
 			InstallDir:  installDir,
 			Binaries:    make(map[string]string),
 			Formatters:  make(map[string]string),
diff --git a/plugins/tool-utils_test.go b/plugins/tool-utils_test.go
@@ -21,7 +21,7 @@ func TestProcessTools(t *testing.T) {
 	toolDir := "/test/tools"
 
 	// Process the tools
-	toolInfos, err := ProcessTools(configs, toolDir)
+	toolInfos, err := ProcessTools(configs, toolDir, nil)
 
 	// Assert no errors occurred
 	assert.NoError(t, err, "ProcessTools should not return an error")
@@ -81,7 +81,7 @@ func TestProcessToolsWithDownload(t *testing.T) {
 	toolDir := "/test/tools"
 
 	// Process the tools
-	toolInfos, err := ProcessTools(configs, toolDir)
+	toolInfos, err := ProcessTools(configs, toolDir, nil)
 
 	// Assert no errors occurred
 	assert.NoError(t, err, "ProcessTools should not return an error")
@@ -166,6 +166,7 @@ func TestGetSupportedTools(t *testing.T) {
 				"pmd",
 				"pylint",
 				"trivy",
+				"dartanalyzer",
 			},
 			expectedError: false,
 		},
diff --git a/plugins/tools/dartanalyzer/plugin.yaml b/plugins/tools/dartanalyzer/plugin.yaml
@@ -0,0 +1,9 @@
+name: dartanalyzer
+description: Dart Analyzer
+runtime: "{{.Runtime}}"
+runtime_binaries:
+  package_manager: dart
+  execution: dart
+installation:
+  command: "pub add --dev flutter_lints"
+
diff --git a/tools/dartanalyzerConfigCreator.go b/tools/dartanalyzerConfigCreator.go
@@ -0,0 +1,41 @@
+package tools
+
+import (
+	"codacy/cli-v2/domain"
+	"slices"
+	"strings"
+
+	"gopkg.in/yaml.v3"
+)
+
+func CreateDartAnalyzerConfig(configuration []domain.PatternConfiguration) string {
+
+	// Find Dart Analyzer patterns
+	errorPatterns := []string{"ErrorProne", "Security", "Performance"}
+	// Create analysis_options.yaml content
+	config := map[string]interface{}{
+		"analyzer": map[string]interface{}{
+			"errors": map[string]string{},
+		},
+		"linter": map[string]interface{}{
+			"rules": map[string]string{},
+		},
+	}
+
+	errorsMap := config["analyzer"].(map[string]interface{})["errors"].(map[string]string)
+	lintsMap := config["linter"].(map[string]interface{})["rules"].(map[string]string)
+	for _, pattern := range configuration {
+		if slices.Contains(errorPatterns, pattern.PatternDefinition.Category) {
+			errorsMap[strings.TrimPrefix(pattern.PatternDefinition.Id, patternPrefix)] = strings.ToLower(pattern.PatternDefinition.Level)
+		} else {
+			lintsMap[strings.TrimPrefix(pattern.PatternDefinition.Id, patternPrefix)] = "true"
+		}
+	}
+
+	// Write config to file
+	yamlData, err := yaml.Marshal(config)
+	if err != nil {
+		return ""
+	}
+	return string(yamlData)
+}
diff --git a/tools/dartanalyzerRunner.go b/tools/dartanalyzerRunner.go
diff --git a/tools/dartanalyzerRunner_test.go b/tools/dartanalyzerRunner_test.go
diff --git a/tools/getTools.go b/tools/getTools.go
diff --git a/tools/testdata/repositories/dartanalizer/expected.sarif b/tools/testdata/repositories/dartanalizer/expected.sarif
diff --git a/tools/testdata/repositories/dartanalizer/src/main.dart b/tools/testdata/repositories/dartanalizer/src/main.dart

Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ func (c ConfigType) Tools() map[string]plugins.ToolInfo {`
`82`	`82`
`83`	`83`	`func (c *ConfigType) AddTools(configs []plugins.ToolConfig) error {`
`84`	`84`	`// Process the tool configurations using the plugins.ProcessTools function`
`85`		`- toolInfoMap, err := plugins.ProcessTools(configs, c.toolsDirectory)`
	`85`	`+ toolInfoMap, err := plugins.ProcessTools(configs, c.toolsDirectory, c.runtimes)`
`86`	`86`	`if err != nil {`
`87`	`87`	`return err`
`88`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ func InstallTool(name string, toolInfo *plugins.ToolInfo, registry string) error`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`// Make sure the installation directory exists`
	`38`	`+`
`38`	`39`	`err := os.MkdirAll(toolInfo.InstallDir, 0755)`
`39`	`40`	`if err != nil {`
`40`	`41`	`return fmt.Errorf("failed to create installation directory: %w", err)`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,9 @@ type ParameterConfiguration struct {`
`6`	`6`	`}`
`7`	`7`
`8`	`8`	`type PatternDefinition struct {`
`9`		- Id string `json:"id"`
	`9`	+ Id string `json:"id"`
	`10`	+ Category string `json:"category"`
	`11`	+ Level string `json:"level"`
`10`	`12`	`}`
`11`	`13`
`12`	`14`	`type PatternConfiguration struct {`