Add enigma-cli to cli v2

Author: heliocodacy

.codacy/codacy.yaml

@@ -9,4 +9,5 @@ tools:
     - [email protected]
     - [email protected]
     - [email protected]
-    - [email protected]
+    - [email protected]
+    - [email protected]

cmd/analyze.go

@@ -411,6 +411,15 @@ func runLizardAnalysis(workDirectory string, pathsToCheck []string, outputFile s
 	return lizard.RunLizard(workDirectory, lizardBinary, pathsToCheck, outputFile, outputFormat, patterns)
 }
 
+func runEnigmaAnalysis(workDirectory string, pathsToCheck []string, outputFile string, outputFormat string) error {
+	enigma := config.Config.Tools()["codacy-enigma-cli"]
+	if enigma == nil {
+		log.Fatal("Enigma tool configuration not found")
+	}
+
+	return tools.RunEnigma(workDirectory, enigma.InstallDir, enigma.Binaries["codacy-enigma-cli"], pathsToCheck, outputFile, outputFormat)
+}
+
 var analyzeCmd = &cobra.Command{
 	Use:   "analyze",
 	Short: "Runs all configured linters.",
@@ -516,6 +525,8 @@ func runTool(workDirectory string, toolName string, args []string, outputFile st
 		return runDartAnalyzer(workDirectory, args, outputFile, outputFormat)
 	case "lizard":
 		return runLizardAnalysis(workDirectory, args, outputFile, outputFormat)
+	case "codacy-enigma-cli":
+		return runEnigmaAnalysis(workDirectory, args, outputFile, outputFormat)
 	default:
 		return fmt.Errorf("unsupported tool: %s", toolName)
 	}

plugins/tool-utils_test.go

@@ -169,6 +169,7 @@ func TestGetSupportedTools(t *testing.T) {
 				"dartanalyzer",
 				"semgrep",
 				"lizard",
+				"codacy-enigma-cli",
 			},
 			expectedError: false,
 		},

plugins/tools/codacy-enigma-cli/plugin.yaml

@@ -0,0 +1,12 @@
+name: codacy-enigma-cli
+description: Enigma CLI
+download:
+  url_template: "https://github.com/codacy/codacy-enigma-cli-releases/releases/download/{{.Version}}/codacy-enigma-cli-releases_{{.Version}}_{{.OS}}_{{.Arch}}.tar.gz"
+binaries:
+  - name: codacy-enigma-cli
+    path: "codacy-enigma-cli-releases"
+formatters:
+  - name: json
+    flag: "-f json"
+  - name: sarif
+    flag: "-f sarif"

tools/enigmaRunner.go

@@ -0,0 +1,63 @@
+package tools
+
+import (
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+)
+
+func RunEnigma(workDirectory string, installationDirectory string, binary string, files []string, outputFile string, outputFormat string) error {
+
+	configFiles := []string{"enigma.yaml", "enigma.yml"}
+
+	if outputFormat == "" {
+		outputFormat = "text"
+	}
+
+	args := []string{"analyze", "--format", outputFormat}
+
+	if len(files) > 0 {
+		args = append(args, append([]string{"--paths"}, files...)...)
+	} else {
+		args = append(args, "--paths", ".")
+	}
+
+	configExists := ""
+	for _, configFile := range configFiles {
+		if _, err := os.Stat(filepath.Join(workDirectory, configFile)); err == nil {
+			configExists = filepath.Join(workDirectory, configFile)
+			break
+		}
+	}
+
+	if configExists != "" {
+		println("Config file found, using it")
+		args = append(args, "--configuration-file", configExists)
+	} else {
+		println("No config file found, using tool defaults")
+
+	}
+
+	cmd := exec.Command(binary, args...)
+	cmd.Dir = workDirectory
+	cmd.Stderr = os.Stderr
+	if outputFile != "" {
+		// If output file is specified, create it and redirect output
+		var outputWriter *os.File
+		var err error
+		outputWriter, err = os.Create(filepath.Clean(outputFile))
+		if err != nil {
+			return fmt.Errorf("failed to create output file: %w", err)
+		}
+		defer outputWriter.Close()
+		cmd.Stdout = outputWriter
+	} else {
+		cmd.Stdout = os.Stdout
+	}
+	err := cmd.Run()
+	if err != nil {
+		return fmt.Errorf("failed to run Enigma: %w", err)
+	}
+	return nil
+}

tools/enigmaRunner_test.go

@@ -0,0 +1,57 @@
+package tools
+
+import (
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRunEnigma_NoConfig_NoOutputFile(t *testing.T) {
+	tempDir := t.TempDir()
+	fakeBinary := "/bin/echo"
+	err := RunEnigma(tempDir, tempDir, fakeBinary, []string{"foo.go"}, "", "text")
+	assert.NoError(t, err)
+}
+
+func TestRunEnigma_WithConfig_NoOutputFile(t *testing.T) {
+	tempDir := t.TempDir()
+	configPath := filepath.Join(tempDir, "enigma.yaml")
+	ioutil.WriteFile(configPath, []byte("config: true"), 0644)
+	fakeBinary := "/bin/echo"
+	err := RunEnigma(tempDir, tempDir, fakeBinary, []string{"foo.go"}, "", "text")
+	assert.NoError(t, err)
+}
+
+func TestRunEnigma_NoConfig_WithOutputFile(t *testing.T) {
+	tempDir := t.TempDir()
+	outputFile := filepath.Join(tempDir, "output.txt")
+	fakeBinary := "/bin/echo"
+	err := RunEnigma(tempDir, tempDir, fakeBinary, []string{"foo.go"}, outputFile, "text")
+	assert.NoError(t, err)
+	_, err = os.Stat(outputFile)
+	assert.NoError(t, err)
+}
+
+func TestRunEnigma_WithConfig_WithOutputFile(t *testing.T) {
+	tempDir := t.TempDir()
+	configPath := filepath.Join(tempDir, "enigma.yaml")
+	ioutil.WriteFile(configPath, []byte("config: true"), 0644)
+	outputFile := filepath.Join(tempDir, "output.txt")
+	fakeBinary := "/bin/echo"
+	err := RunEnigma(tempDir, tempDir, fakeBinary, []string{"foo.go"}, outputFile, "text")
+	assert.NoError(t, err)
+	_, err = os.Stat(outputFile)
+	assert.NoError(t, err)
+}
+
+func TestRunEnigma_CreateOutputFileError(t *testing.T) {
+	tempDir := t.TempDir()
+	fakeBinary := "/bin/echo"
+	// Use a directory as output file to force error
+	outputFile := tempDir
+	err := RunEnigma(tempDir, tempDir, fakeBinary, []string{"foo.go"}, outputFile, "text")
+	assert.Error(t, err)
+}