Skip to content

Commit ab59a6b

Browse files
franciscoovazevedofranciscoovazevedo
committed
analyze now receives initFlags and fetches config file if non existent
1 parent 579b70a commit ab59a6b

File tree

4 files changed

+310
-19
lines changed

4 files changed

+310
-19
lines changed

‎cmd/analyze.go‎

Lines changed: 65 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
package cmd
22

33
import (
4+
"codacy/cli-v2/cmd/cmdutils"
5+
"codacy/cli-v2/cmd/configsetup"
46
"codacy/cli-v2/config"
57
"codacy/cli-v2/domain"
68
"codacy/cli-v2/plugins"
@@ -39,6 +41,18 @@ type LanguagesConfig struct {
3941
} `yaml:"tools" json:"tools"`
4042
}
4143

44+
// toolConfigFileName maps tool names to their configuration filenames
45+
var toolConfigFileName = map[string]string{
46+
"eslint": "eslint.config.mjs",
47+
"trivy": "trivy.yaml",
48+
"pmd": "ruleset.xml",
49+
"pylint": "pylint.rc",
50+
"dartanalyzer": "analysis_options.yaml",
51+
"semgrep": "semgrep.yaml",
52+
"revive": "revive.toml",
53+
"lizard": "lizard.yaml",
54+
}
55+
4256
// LoadLanguageConfig loads the language configuration from the file
4357
func LoadLanguageConfig() (*LanguagesConfig, error) {
4458
// First, try to load the YAML config
@@ -217,6 +231,7 @@ func init() {
217231
analyzeCmd.Flags().StringVarP(&toolsToAnalyzeParam, "tool", "t", "", "Which tool to run analysis with. If not specified, all configured tools will be run")
218232
analyzeCmd.Flags().StringVar(&outputFormat, "format", "", "Output format (use 'sarif' for SARIF format)")
219233
analyzeCmd.Flags().BoolVar(&autoFix, "fix", false, "Apply auto fix to your issues when available")
234+
cmdutils.AddCloudFlags(analyzeCmd, &initFlags)
220235
rootCmd.AddCommand(analyzeCmd)
221236
}
222237

@@ -277,7 +292,41 @@ func validateToolName(toolName string) error {
277292
return nil
278293
}
279294

280-
func runToolByName(toolName string, workDirectory string, pathsToCheck []string, autoFix bool, outputFile string, outputFormat string, tool *plugins.ToolInfo, runtime *plugins.RuntimeInfo) error {
295+
func checkIfConfigExistsAndIsNeeded(toolName string, cliLocalMode bool) error {
296+
configFileName := toolConfigFileName[toolName]
297+
if configFileName == "" {
298+
// Tool doesn't use config file
299+
return nil
300+
}
301+
302+
// Use the configuration system to get the tools config directory
303+
toolsConfigDir := config.Config.ToolsConfigDirectory()
304+
toolConfigPath := filepath.Join(toolsConfigDir, configFileName)
305+
306+
// Check if the config file exists
307+
if _, err := os.Stat(toolConfigPath); os.IsNotExist(err) {
308+
// Only show error if we're in remote mode and need the config file
309+
if !cliLocalMode && initFlags.ApiToken != "" {
310+
fmt.Printf("Creating new config file for tool %s\n", toolName)
311+
configsetup.CreateToolConfigurationFile(toolName, initFlags)
312+
} else if !cliLocalMode {
313+
fmt.Printf("config file not found for tool %s: %s and no api token provided \n", toolName, toolConfigPath)
314+
} else {
315+
fmt.Printf("config file not found for tool %s: %s please add a config file to the tools-configs directory\n", toolName, toolConfigPath)
316+
}
317+
} else if err != nil {
318+
fmt.Printf("error checking config file for tool %s: %v\n", toolName, err)
319+
} else {
320+
fmt.Printf("Config file found for %s: %s\n", toolName, toolConfigPath)
321+
}
322+
return nil
323+
}
324+
325+
func runToolByName(toolName string, workDirectory string, pathsToCheck []string, autoFix bool, outputFile string, outputFormat string, tool *plugins.ToolInfo, runtime *plugins.RuntimeInfo, cliLocalMode bool) error {
326+
err := checkIfConfigExistsAndIsNeeded(toolName, cliLocalMode)
327+
if err != nil {
328+
return err
329+
}
281330
switch toolName {
282331
case "eslint":
283332
binaryPath := runtime.Binaries[tool.Runtime]
@@ -308,7 +357,7 @@ func runToolByName(toolName string, workDirectory string, pathsToCheck []string,
308357
return fmt.Errorf("unsupported tool: %s", toolName)
309358
}
310359

311-
func runTool(workDirectory string, toolName string, pathsToCheck []string, outputFile string, autoFix bool, outputFormat string) error {
360+
func runTool(workDirectory string, toolName string, pathsToCheck []string, outputFile string, autoFix bool, outputFormat string, cliLocalMode bool) error {
312361
err := validateToolName(toolName)
313362
if err != nil {
314363
return err
@@ -366,7 +415,7 @@ func runTool(workDirectory string, toolName string, pathsToCheck []string, outpu
366415
runtime = config.Config.Runtimes()[tool.Runtime]
367416
}
368417
}
369-
return runToolByName(toolName, workDirectory, pathsToCheck, autoFix, outputFile, outputFormat, tool, runtime)
418+
return runToolByName(toolName, workDirectory, pathsToCheck, autoFix, outputFile, outputFormat, tool, runtime, cliLocalMode)
370419
}
371420

372421
// validatePaths checks if all provided paths exist and returns an error if any don't
@@ -379,6 +428,13 @@ func validatePaths(paths []string) error {
379428
return nil
380429
}
381430

431+
func validateCloudMode(cliLocalMode bool) error {
432+
if cliLocalMode {
433+
fmt.Println("Warning: cannot run in cloud mode")
434+
}
435+
return nil
436+
}
437+
382438
var analyzeCmd = &cobra.Command{
383439
Use: "analyze",
384440
Short: "Analyze code using configured tools",
@@ -396,6 +452,10 @@ var analyzeCmd = &cobra.Command{
396452
log.Fatalf("Failed to get current working directory: %v", err)
397453
}
398454

455+
cliLocalMode := len(initFlags.ApiToken) == 0
456+
457+
validateCloudMode(cliLocalMode)
458+
399459
var toolsToRun map[string]*plugins.ToolInfo
400460

401461
if toolsToAnalyzeParam != "" {
@@ -432,7 +492,7 @@ var analyzeCmd = &cobra.Command{
432492
var sarifOutputs []string
433493
for toolName := range toolsToRun {
434494
tmpFile := filepath.Join(tmpDir, fmt.Sprintf("%s.sarif", toolName))
435-
if err := runTool(workDirectory, toolName, args, tmpFile, autoFix, outputFormat); err != nil {
495+
if err := runTool(workDirectory, toolName, args, tmpFile, autoFix, outputFormat, cliLocalMode); err != nil {
436496
log.Printf("Tool failed to run: %v\n", err)
437497
}
438498
sarifOutputs = append(sarifOutputs, tmpFile)
@@ -467,7 +527,7 @@ var analyzeCmd = &cobra.Command{
467527
} else {
468528
// Run tools without merging outputs
469529
for toolName := range toolsToRun {
470-
if err := runTool(workDirectory, toolName, args, outputFile, autoFix, outputFormat); err != nil {
530+
if err := runTool(workDirectory, toolName, args, outputFile, autoFix, outputFormat, cliLocalMode); err != nil {
471531
log.Printf("Tool failed to run: %v\n", err)
472532
}
473533
}

‎cmd/analyze_test.go‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@ package cmd
22

33
import (
44
"codacy/cli-v2/plugins"
5+
"os"
6+
"path/filepath"
57
"testing"
68

9+
"codacy/cli-v2/domain"
10+
711
"github.com/stretchr/testify/assert"
12+
"github.com/stretchr/testify/require"
813
)
914

1015
func TestGetFileExtension(t *testing.T) {
@@ -262,3 +267,145 @@ func TestValidatePaths(t *testing.T) {
262267
})
263268
}
264269
}
270+
271+
func TestCheckIfConfigExistsAndIsNeeded(t *testing.T) {
272+
// Save original initFlags
273+
originalFlags := initFlags
274+
defer func() { initFlags = originalFlags }()
275+
276+
tests := []struct {
277+
name string
278+
toolName string
279+
cliLocalMode bool
280+
apiToken string
281+
configFileExists bool
282+
expectError bool
283+
description string
284+
}{
285+
{
286+
name: "tool_without_config_file",
287+
toolName: "unsupported-tool",
288+
cliLocalMode: false,
289+
apiToken: "test-token",
290+
configFileExists: false,
291+
expectError: false,
292+
description: "Tool that doesn't use config files should return without error",
293+
},
294+
{
295+
name: "config_file_exists",
296+
toolName: "eslint",
297+
cliLocalMode: false,
298+
apiToken: "test-token",
299+
configFileExists: true,
300+
expectError: false,
301+
description: "When config file exists, should find it successfully",
302+
},
303+
{
304+
name: "remote_mode_with_token_no_config",
305+
toolName: "eslint",
306+
cliLocalMode: false,
307+
apiToken: "test-token",
308+
configFileExists: false,
309+
expectError: false,
310+
description: "Remote mode with token should attempt to create config",
311+
},
312+
{
313+
name: "remote_mode_without_token_no_config",
314+
toolName: "eslint",
315+
cliLocalMode: false,
316+
apiToken: "",
317+
configFileExists: false,
318+
expectError: false,
319+
description: "Remote mode without token should show appropriate message",
320+
},
321+
{
322+
name: "local_mode_no_config",
323+
toolName: "eslint",
324+
cliLocalMode: true,
325+
apiToken: "",
326+
configFileExists: false,
327+
expectError: false,
328+
description: "Local mode should show message about adding config file",
329+
},
330+
}
331+
332+
for _, tt := range tests {
333+
t.Run(tt.name, func(t *testing.T) {
334+
// Setup temporary directory
335+
tmpDir, err := os.MkdirTemp("", "codacy-test-*")
336+
require.NoError(t, err)
337+
defer os.RemoveAll(tmpDir)
338+
339+
// Create config file if needed
340+
if tt.configFileExists && toolConfigFileName[tt.toolName] != "" {
341+
configPath := filepath.Join(tmpDir, toolConfigFileName[tt.toolName])
342+
err := os.WriteFile(configPath, []byte("test config"), 0644)
343+
require.NoError(t, err)
344+
}
345+
346+
// Setup initFlags
347+
initFlags = domain.InitFlags{
348+
ApiToken: tt.apiToken,
349+
}
350+
351+
// Mock config directory (this would need actual mocking in real implementation)
352+
// For now, we'll create a simple test that verifies the function doesn't panic
353+
354+
// Execute the function
355+
err = checkIfConfigExistsAndIsNeeded(tt.toolName, tt.cliLocalMode)
356+
357+
// Verify results
358+
if tt.expectError {
359+
assert.Error(t, err, tt.description)
360+
} else {
361+
assert.NoError(t, err, tt.description)
362+
}
363+
})
364+
}
365+
}
366+
367+
func TestToolConfigFileNameMap(t *testing.T) {
368+
expectedTools := map[string]string{
369+
"eslint": "eslint.config.mjs",
370+
"trivy": "trivy.yaml",
371+
"pmd": "ruleset.xml",
372+
"pylint": "pylint.rc",
373+
"dartanalyzer": "analysis_options.yaml",
374+
"semgrep": "semgrep.yaml",
375+
"revive": "revive.toml",
376+
"lizard": "lizard.yaml",
377+
}
378+
379+
for toolName, expectedFileName := range expectedTools {
380+
t.Run(toolName, func(t *testing.T) {
381+
actualFileName, exists := toolConfigFileName[toolName]
382+
assert.True(t, exists, "Tool %s should exist in toolConfigFileName map", toolName)
383+
assert.Equal(t, expectedFileName, actualFileName, "Config filename for %s should match expected", toolName)
384+
})
385+
}
386+
}
387+
388+
func TestGetFileExtension(t *testing.T) {
389+
tests := []struct {
390+
filePath string
391+
expected string
392+
}{
393+
{"test.js", ".js"},
394+
{"test.jsx", ".jsx"},
395+
{"test.ts", ".ts"},
396+
{"test.tsx", ".tsx"},
397+
{"test.py", ".py"},
398+
{"test.java", ".java"},
399+
{"test", ""},
400+
{"test.JS", ".js"}, // Should be lowercase
401+
{"/path/to/test.py", ".py"},
402+
{"", ""},
403+
}
404+
405+
for _, tt := range tests {
406+
t.Run(tt.filePath, func(t *testing.T) {
407+
result := GetFileExtension(tt.filePath)
408+
assert.Equal(t, tt.expected, result)
409+
})
410+
}
411+
}

‎cmd/configsetup/setup.go‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -490,6 +490,34 @@ func createToolConfigurationFiles(tools []domain.Tool, flags domain.InitFlags) e
490490
return nil
491491
}
492492

493+
// CreateToolConfigurationFile creates a configuration file for a single tool
494+
func CreateToolConfigurationFile(toolName string, flags domain.InitFlags) error {
495+
// Find the tool UUID by tool name
496+
toolUuid := getToolUuidByName(toolName)
497+
if toolUuid == "" {
498+
return fmt.Errorf("tool '%s' not found in supported tools", toolName)
499+
}
500+
501+
patternsConfig, err := codacyclient.GetDefaultToolPatternsConfig(flags, toolUuid)
502+
if err != nil {
503+
return fmt.Errorf("failed to get default patterns: %w", err)
504+
}
505+
506+
// Get the tool object to pass to createToolFileConfiguration
507+
tool := domain.Tool{Uuid: toolUuid}
508+
return createToolFileConfiguration(tool, patternsConfig)
509+
}
510+
511+
// getToolUuidByName finds the UUID for a tool given its name
512+
func getToolUuidByName(toolName string) string {
513+
for uuid, toolInfo := range domain.SupportedToolsMetadata {
514+
if toolInfo.Name == toolName {
515+
return uuid
516+
}
517+
}
518+
return ""
519+
}
520+
493521
// createToolFileConfiguration creates a configuration file for a single tool using the registry
494522
func createToolFileConfiguration(tool domain.Tool, patternConfiguration []domain.PatternConfiguration) error {
495523
creator, exists := toolConfigRegistry[tool.Uuid]

0 commit comments

Comments
 (0)