Merge pull request #2 from codacy/eslint-to-file

feature: run Eslint to file

Author: machadoit

eslintRunner.go

@@ -1,25 +1,37 @@
 package main
 
 import (
-	"fmt"
 	"os"
 	"os/exec"
 	"path/filepath"
 )
 
+func RunEslintToFile(repositoryToAnalyseDirectory string, eslintInstallationDirectory string, nodeBinary string, outputFolder string) error {
+	_, err := runEslint(repositoryToAnalyseDirectory, eslintInstallationDirectory, nodeBinary, outputFolder)
+	return err
+}
+
+func RunEslintToString(repositoryToAnalyseDirectory string, eslintInstallationDirectory string, nodeBinary string) (string, error) {
+	return runEslint(repositoryToAnalyseDirectory, eslintInstallationDirectory, nodeBinary, "")
+}
+
 // * Run from the root of the repo we want to analyse
 // * NODE_PATH="<the installed eslint path>/node_modules"
 // * The local installed ESLint should have the @microsoft/eslint-formatter-sarif installed
-func runEslint(repositoryToAnalyseDirectory string, eslintInstallationDirectory string, nodeBinary string) (string, error) {
+func runEslint(repositoryToAnalyseDirectory string, eslintInstallationDirectory string, nodeBinary string, outputFolder string) (string, error) {
 	eslintInstallationNodeModules := filepath.Join(eslintInstallationDirectory, "node_modules")
 	eslintJsPath := filepath.Join(eslintInstallationNodeModules, ".bin/eslint")
 
-	cmd := exec.Command(nodeBinary, eslintJsPath, "-f", "@microsoft/eslint-formatter-sarif", ".")
+	cmd := exec.Command(nodeBinary, eslintJsPath, "-f", "@microsoft/eslint-formatter-sarif")
+
+	if outputFolder != "" {
+		outputFile := filepath.Join(outputFolder, "eslint.sarif")
+		cmd.Args = append(cmd.Args, "-o", outputFile)
+	}
+
 	cmd.Dir = repositoryToAnalyseDirectory
 	cmd.Stderr = os.Stderr
 
-	fmt.Println(repositoryToAnalyseDirectory)
-
 	nodePathEnv := "NODE_PATH=" + eslintInstallationNodeModules
 	cmd.Env = append(cmd.Env, nodePathEnv)
 

eslintRunner_test.go

@@ -10,7 +10,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestRunEslint(t *testing.T) {
+func TestRunEslintToString(t *testing.T) {
 	homeDirectory, err := os.UserHomeDir()
 	if err != nil {
 		log.Fatal(err.Error())
@@ -25,7 +25,7 @@ func TestRunEslint(t *testing.T) {
 	eslintInstallationDirectory := filepath.Join(homeDirectory, ".cache/codacy-cli-v2/tools/eslint")
 	nodeBinary := "node"
 
-	eslintOutput, err := runEslint(repositoryToAnalyze, eslintInstallationDirectory, nodeBinary)
+	eslintOutput, err := RunEslintToString(repositoryToAnalyze, eslintInstallationDirectory, nodeBinary)
 	if err != nil {
 		log.Fatal(err.Error())
 	}
@@ -42,3 +42,46 @@ func TestRunEslint(t *testing.T) {
 
 	assert.Equal(t, expectedSarif, actualSarif, "output did not match expected")
 }
+
+func TestRunEslintToFile(t *testing.T) {
+	homeDirectory, err := os.UserHomeDir()
+	if err != nil {
+		log.Fatal(err.Error())
+	}
+	currentDirectory, err := os.Getwd()
+	if err != nil {
+		log.Fatal(err.Error())
+	}
+	testDirectory := "testdata/repositories/test1"
+	tempDir := os.TempDir()
+	defer os.RemoveAll(tempDir)
+
+	repositoryToAnalyze := filepath.Join(testDirectory, "src")
+	sarifOutputFile := filepath.Join(testDirectory, "sarif.json")
+	eslintInstallationDirectory := filepath.Join(homeDirectory, ".cache/codacy-cli-v2/tools/eslint")
+	nodeBinary := "node"
+
+	err = RunEslintToFile(repositoryToAnalyze, eslintInstallationDirectory, nodeBinary, tempDir)
+	if err != nil {
+		log.Fatal(err.Error())
+	}
+
+	expectedSarifBytes, err := os.ReadFile(sarifOutputFile)
+	if err != nil {
+		log.Fatal(err.Error())
+	}
+
+	eslintOutputPath := filepath.Join(tempDir, "eslint.sarif")
+
+	eslintOutputBytes, err := os.ReadFile(eslintOutputPath)
+	if err != nil {
+		log.Fatal(err.Error())
+	}
+	eslintOutput := string(eslintOutputBytes)
+	filePrefix := "file://" + currentDirectory + "/"
+	actualSarif := strings.ReplaceAll(eslintOutput, filePrefix, "")
+
+	expectedSarif := strings.TrimSpace(string(expectedSarifBytes))
+
+	assert.Equal(t, expectedSarif, actualSarif, "output did not match expected")
+}