Skip to content

Commit 9759612

Browse files
franciscoovazevedofranciscoovazevedo
authored
Merge pull request #79 from codacy/PLUTO-1399-run-tools-for-supported-languages
Fix: Run only tools which support anylezed file type [PLUTO-1399]
2 parents 9e718c3 + e14fa31 commit 9759612

File tree

6 files changed

+518
-1
lines changed

6 files changed

+518
-1
lines changed

‎cmd/analyze.go‎

Lines changed: 139 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@ import (
1111
"net/http"
1212
"os"
1313
"path/filepath"
14+
"strings"
1415

1516
"codacy/cli-v2/utils"
1617

1718
"github.com/spf13/cobra"
19+
"gopkg.in/yaml.v3"
1820
)
1921

2022
var outputFile string
@@ -25,6 +27,134 @@ var sarifPath string
2527
var commitUuid string
2628
var projectToken string
2729

30+
// LanguagesConfig represents the structure of the languages configuration file
31+
type LanguagesConfig struct {
32+
Tools []struct {
33+
Name string `yaml:"name" json:"name"`
34+
Languages []string `yaml:"languages" json:"languages"`
35+
Extensions []string `yaml:"extensions" json:"extensions"`
36+
} `yaml:"tools" json:"tools"`
37+
}
38+
39+
// LoadLanguageConfig loads the language configuration from the file
40+
func LoadLanguageConfig() (*LanguagesConfig, error) {
41+
// First, try to load the YAML config
42+
yamlPath := filepath.Join(config.Config.ToolsConfigDirectory(), "languages-config.yaml")
43+
44+
// Check if the YAML file exists
45+
if _, err := os.Stat(yamlPath); err == nil {
46+
data, err := os.ReadFile(yamlPath)
47+
if err != nil {
48+
return nil, fmt.Errorf("failed to read languages configuration file: %w", err)
49+
}
50+
51+
var config LanguagesConfig
52+
if err := yaml.Unmarshal(data, &config); err != nil {
53+
return nil, fmt.Errorf("failed to parse YAML languages configuration file: %w", err)
54+
}
55+
56+
return &config, nil
57+
}
58+
59+
// If YAML file doesn't exist, try the JSON config for backward compatibility
60+
jsonPath := filepath.Join(config.Config.ToolsConfigDirectory(), "languages-config.json")
61+
62+
// Check if the JSON file exists
63+
if _, err := os.Stat(jsonPath); os.IsNotExist(err) {
64+
return nil, fmt.Errorf("languages configuration file not found: neither %s nor %s exists", yamlPath, jsonPath)
65+
}
66+
67+
data, err := os.ReadFile(jsonPath)
68+
if err != nil {
69+
return nil, fmt.Errorf("failed to read JSON languages configuration file: %w", err)
70+
}
71+
72+
var config LanguagesConfig
73+
if err := json.Unmarshal(data, &config); err != nil {
74+
return nil, fmt.Errorf("failed to parse JSON languages configuration file: %w", err)
75+
}
76+
77+
return &config, nil
78+
}
79+
80+
// GetFileExtension extracts the file extension from a path
81+
func GetFileExtension(filePath string) string {
82+
return strings.ToLower(filepath.Ext(filePath))
83+
}
84+
85+
// IsToolSupportedForFile checks if a tool supports a given file based on its extension
86+
func IsToolSupportedForFile(toolName string, filePath string, langConfig *LanguagesConfig) bool {
87+
if langConfig == nil {
88+
// If no language config is available, assume all tools are supported
89+
return true
90+
}
91+
92+
fileExt := GetFileExtension(filePath)
93+
if fileExt == "" {
94+
// If file has no extension, assume tool is supported
95+
return true
96+
}
97+
98+
for _, tool := range langConfig.Tools {
99+
if tool.Name == toolName {
100+
// If tool has no extensions defined, assume it supports all files
101+
if len(tool.Extensions) == 0 {
102+
return true
103+
}
104+
105+
// Check if file extension is supported by this tool
106+
for _, ext := range tool.Extensions {
107+
if strings.EqualFold(ext, fileExt) {
108+
return true
109+
}
110+
}
111+
112+
// Extension not found in tool's supported extensions
113+
return false
114+
}
115+
}
116+
117+
// If tool not found in config, assume it's supported
118+
return true
119+
}
120+
121+
// FilterToolsByLanguageSupport filters tools by language support for the given files
122+
func FilterToolsByLanguageSupport(tools map[string]*plugins.ToolInfo, files []string) map[string]*plugins.ToolInfo {
123+
124+
if len(files) == 0 || files[0] == "." {
125+
// If no files specified or current directory, return all tools
126+
return tools
127+
}
128+
129+
langConfig, err := LoadLanguageConfig()
130+
if err != nil {
131+
log.Printf("Warning: Failed to load language configuration: %v. Running all tools.", err)
132+
return tools
133+
}
134+
135+
result := make(map[string]*plugins.ToolInfo)
136+
137+
// For each tool, check if it supports at least one of the files
138+
for toolName, toolInfo := range tools {
139+
supported := false
140+
141+
for _, file := range files {
142+
if IsToolSupportedForFile(toolName, file, langConfig) {
143+
supported = true
144+
break
145+
}
146+
}
147+
148+
if supported {
149+
result[toolName] = toolInfo
150+
} else {
151+
log.Printf("Skipping %s as it doesn't support the specified file(s)", toolName)
152+
}
153+
}
154+
155+
return result
156+
}
157+
28158
type Sarif struct {
29159
Runs []struct {
30160
Tool struct {
@@ -256,7 +386,15 @@ var analyzeCmd = &cobra.Command{
256386
log.Fatal("No tools configured. Please run 'codacy-cli init' and 'codacy-cli install' first")
257387
}
258388

259-
log.Println("Running all configured tools...")
389+
// Filter tools by language support
390+
toolsToRun = FilterToolsByLanguageSupport(toolsToRun, args)
391+
392+
if len(toolsToRun) == 0 {
393+
log.Println("No tools support the specified file(s). Skipping analysis.")
394+
return
395+
}
396+
397+
log.Println("Running tools for the specified file(s)...")
260398

261399
if outputFormat == "sarif" {
262400
// Create temporary directory for individual tool outputs

‎cmd/analyze_test.go‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
package cmd
2+
3+
import (
4+
"testing"
5+
)
6+
7+
func TestGetFileExtension(t *testing.T) {
8+
tests := []struct {
9+
name string
10+
filePath string
11+
want string
12+
}{
13+
{
14+
name: "Python file",
15+
filePath: "test.py",
16+
want: ".py",
17+
},
18+
{
19+
name: "C++ file",
20+
filePath: "test.cpp",
21+
want: ".cpp",
22+
},
23+
{
24+
name: "File with path",
25+
filePath: "/path/to/file.js",
26+
want: ".js",
27+
},
28+
{
29+
name: "File without extension",
30+
filePath: "noextension",
31+
want: "",
32+
},
33+
{
34+
name: "File with uppercase extension",
35+
filePath: "test.PY",
36+
want: ".py",
37+
},
38+
}
39+
40+
for _, tt := range tests {
41+
t.Run(tt.name, func(t *testing.T) {
42+
if got := GetFileExtension(tt.filePath); got != tt.want {
43+
t.Errorf("GetFileExtension() = %v, want %v", got, tt.want)
44+
}
45+
})
46+
}
47+
}
48+
49+
func TestIsToolSupportedForFile(t *testing.T) {
50+
langConfig := &LanguagesConfig{
51+
Tools: []struct {
52+
Name string `yaml:"name" json:"name"`
53+
Languages []string `yaml:"languages" json:"languages"`
54+
Extensions []string `yaml:"extensions" json:"extensions"`
55+
}{
56+
{
57+
Name: "pylint",
58+
Languages: []string{"Python"},
59+
Extensions: []string{".py"},
60+
},
61+
{
62+
Name: "cppcheck",
63+
Languages: []string{"C", "CPP"},
64+
Extensions: []string{".c", ".cpp", ".h", ".hpp"},
65+
},
66+
{
67+
Name: "trivy",
68+
Languages: []string{"Multiple"},
69+
Extensions: []string{},
70+
},
71+
},
72+
}
73+
74+
tests := []struct {
75+
name string
76+
toolName string
77+
filePath string
78+
config *LanguagesConfig
79+
want bool
80+
}{
81+
{
82+
name: "Pylint with Python file",
83+
toolName: "pylint",
84+
filePath: "test.py",
85+
config: langConfig,
86+
want: true,
87+
},
88+
{
89+
name: "Pylint with C++ file",
90+
toolName: "pylint",
91+
filePath: "test.cpp",
92+
config: langConfig,
93+
want: false,
94+
},
95+
{
96+
name: "Cppcheck with C++ file",
97+
toolName: "cppcheck",
98+
filePath: "test.cpp",
99+
config: langConfig,
100+
want: true,
101+
},
102+
{
103+
name: "Tool with no extensions specified",
104+
toolName: "trivy",
105+
filePath: "any.file",
106+
config: langConfig,
107+
want: true,
108+
},
109+
{
110+
name: "Unknown tool",
111+
toolName: "unknown",
112+
filePath: "test.py",
113+
config: langConfig,
114+
want: true,
115+
},
116+
{
117+
name: "Nil config",
118+
toolName: "pylint",
119+
filePath: "test.cpp",
120+
config: nil,
121+
want: true,
122+
},
123+
}
124+
125+
for _, tt := range tests {
126+
t.Run(tt.name, func(t *testing.T) {
127+
if got := IsToolSupportedForFile(tt.toolName, tt.filePath, tt.config); got != tt.want {
128+
t.Errorf("IsToolSupportedForFile() = %v, want %v", got, tt.want)
129+
}
130+
})
131+
}
132+
}

‎cmd/init.go‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,20 @@ func buildRepositoryConfigurationFiles(token string) error {
258258
return err
259259
}
260260

261+
// Map UUID to tool shortname for lookup
262+
uuidToName := map[string]string{
263+
ESLint: "eslint",
264+
Trivy: "trivy",
265+
PyLint: "pylint",
266+
PMD: "pmd",
267+
DartAnalyzer: "dartanalyzer",
268+
}
269+
270+
// Generate languages configuration based on API tools response
271+
if err := tools.CreateLanguagesConfigFile(apiTools, toolsConfigDir, uuidToName); err != nil {
272+
return fmt.Errorf("failed to create languages configuration file: %w", err)
273+
}
274+
261275
// Filter out any tools that use configuration file
262276
configuredToolsWithUI := tools.FilterToolsByConfigUsage(apiTools)
263277

0 commit comments

Comments
 (0)