Merge branch 'main' into add-tests

Author: nfcodacy

.github/workflows/go.yml

@@ -4,6 +4,31 @@ permissions:
   contents: write
 
 jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v4
+      - name: Build CLI for Linux
+        run: |
+          GOOS=linux GOARCH=amd64 go build -o cli-v2-linux ./cli-v2.go
+      - name: Build CLI for Windows
+        run: |
+          GOOS=windows GOARCH=amd64 go build -o cli-v2.exe ./cli-v2.go
+      - name: Build CLI for macOS
+        run: |
+          GOOS=darwin GOARCH=amd64 go build -o cli-v2-macos ./cli-v2.go
+      - name: Upload CLI binaries
+        uses: actions/upload-artifact@v4
+        with:
+          name: cli-binaries
+          path: |
+            cli-v2-linux
+            cli-v2.exe
+            cli-v2-macos
+
   test:
     runs-on: ubuntu-latest
     steps:
@@ -24,8 +49,53 @@ jobs:
         run: |
           bash <(curl -Ls https://coverage.codacy.com/get.sh) report --force-coverage-parser go -r unit.coverage.out
 
+  ittest:
+    needs: build
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Download CLI binaries
+        uses: actions/download-artifact@v4
+        with:
+          name: cli-binaries
+          path: .
+      - name: Select correct binary
+        shell: bash
+        run: |
+          if [ "${{ matrix.os }}" = "windows-latest" ]; then
+            # Keep the .exe extension for Windows
+            echo "Using Windows binary with .exe extension"
+          elif [ "${{ matrix.os }}" = "macos-latest" ]; then
+            mv cli-v2-macos cli-v2
+          else
+            mv cli-v2-linux cli-v2
+          fi
+      - name: Make binary executable
+        if: matrix.os != 'windows-latest'
+        run: chmod +x cli-v2
+      - name: Install dependencies from .codacy/codacy.yaml
+        if: matrix.os != 'windows-latest'
+        run: |
+          ./cli-v2 install
+      # Disable windows it test for now.    
+      # - name: Install dependencies from .codacy/codacy.yaml (Windows)
+      #   if: matrix.os == 'windows-latest' 
+      #   shell: pwsh
+      #   run: |
+      #     Get-ChildItem
+      #     Write-Host "Current directory contents:"
+      #     dir
+      #     Write-Host "Node.js version:"
+      #     node --version
+      #     Write-Host "Attempting to run CLI..."
+      #     .\cli-v2.exe install
+
   release:
-    needs: test
+    needs: [test, ittest]
     if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch) && github.event_name == 'push'
     runs-on: ubuntu-latest
     steps:

cmd/analyze.go

@@ -207,7 +207,7 @@ var analyzeCmd = &cobra.Command{
 		eslint := config.Config.Tools()["eslint"]
 		eslintInstallationDirectory := eslint.Info()["installDir"]
 		nodeRuntime := config.Config.Runtimes()["node"]
-		nodeBinary := nodeRuntime.Info()["node"]
+		nodeBinary := nodeRuntime.Binaries["node"]
 
 		log.Printf("Running %s...\n", toolToAnalyze)
 		if outputFormat == "sarif" {

cmd/install.go

@@ -20,28 +20,19 @@ var installCmd = &cobra.Command{
 	Short: "Installs the tools specified in the project's config-file.",
 	Long:  "Installs all runtimes and tools specified in the project's config-file file.",
 	Run: func(cmd *cobra.Command, args []string) {
-		// install runtimes
-		fetchRuntimes(&cfg.Config)
-		// install tools
-		fetchTools(&cfg.Config)
+		installRuntimes(&cfg.Config)
+		installTools(&cfg.Config)
 	},
 }
 
-func fetchRuntimes(config *cfg.ConfigType) {
-	for _, r := range config.Runtimes() {
-		switch r.Name() {
-		case "node":
-			err := cfg.InstallNode(r)
-			if err != nil {
-				log.Fatal(err)
-			}
-		default:
-			log.Fatal("Unknown runtime:", r.Name())
-		}
+func installRuntimes(config *cfg.ConfigType) {
+	err := cfg.InstallRuntimes()
+	if err != nil {
+		log.Fatal(err)
 	}
 }
 
-func fetchTools(config *cfg.ConfigType) {
+func installTools(config *cfg.ConfigType) {
 	for _, tool := range config.Tools() {
 		switch tool.Name() {
 		case "eslint":

config-file/configFile.go

@@ -2,6 +2,7 @@ package config_file
 
 import (
 	"codacy/cli-v2/config"
+	"codacy/cli-v2/plugins"
 	"gopkg.in/yaml.v3"
 	"os"
 )
@@ -17,12 +18,22 @@ func parseConfigFile(configContents []byte) error {
 		return err
 	}
 
+	// Convert the runtime strings to RuntimeConfig objects
+	runtimeConfigs := make([]plugins.RuntimeConfig, 0, len(configFile.RUNTIMES))
 	for _, rt := range configFile.RUNTIMES {
 		ct, err := parseConfigTool(rt)
 		if err != nil {
 			return err
 		}
-		config.Config.AddRuntime(config.NewRuntime(ct.name, ct.version))
+		runtimeConfigs = append(runtimeConfigs, plugins.RuntimeConfig{
+			Name:    ct.name,
+			Version: ct.version,
+		})
+	}
+
+	// Add all runtimes at once
+	if err := config.Config.AddRuntimes(runtimeConfigs); err != nil {
+		return err
 	}
 
 	for _, tl := range configFile.TOOLS {

config/config.go

@@ -4,6 +4,8 @@ import (
 	"log"
 	"os"
 	"path/filepath"
+
+	"codacy/cli-v2/plugins"
 )
 
 type ConfigType struct {
@@ -14,7 +16,7 @@ type ConfigType struct {
 	localCodacyDirectory string
 	projectConfigFile    string
 
-	runtimes map[string]*Runtime
+	runtimes map[string]*plugins.RuntimeInfo
 	tools    map[string]*Runtime
 }
 
@@ -42,12 +44,23 @@ func (c *ConfigType) ProjectConfigFile() string {
 	return c.projectConfigFile
 }
 
-func (c *ConfigType) Runtimes() map[string]*Runtime {
+func (c *ConfigType) Runtimes() map[string]*plugins.RuntimeInfo {
 	return c.runtimes
 }
 
-func (c *ConfigType) AddRuntime(r *Runtime) {
-	c.runtimes[r.Name()] = r
+func (c *ConfigType) AddRuntimes(configs []plugins.RuntimeConfig) error {
+	// Process the runtime configurations using the plugins.ProcessRuntimes function
+	runtimeInfoMap, err := plugins.ProcessRuntimes(configs, c.runtimesDirectory)
+	if err != nil {
+		return err
+	}
+
+	// Store the runtime information in the config
+	for name, info := range runtimeInfoMap {
+		c.runtimes[name] = info
+	}
+
+	return nil
 }
 
 // TODO do inheritance with tool
@@ -103,7 +116,7 @@ func Init() {
 
 	Config.initCodacyDirs()
 
-	Config.runtimes = make(map[string]*Runtime)
+	Config.runtimes = make(map[string]*plugins.RuntimeInfo)
 	Config.tools = make(map[string]*Runtime)
 }
 

config/eslint-utils.go

@@ -5,6 +5,7 @@ import (
 	"log"
 	"os/exec"
 	"path"
+	"codacy/cli-v2/plugins"
 )
 
 func genInfoEslint(r *Runtime) map[string]string {
@@ -20,20 +21,20 @@ func genInfoEslint(r *Runtime) map[string]string {
 /*
  * This installs eslint using node's npm alongside its sarif extension
  */
-func InstallEslint(nodeRuntime *Runtime, eslint *Runtime, registry string) error {
+func InstallEslint(nodeRuntime *plugins.RuntimeInfo, eslint *Runtime, registry string) error {
 	log.Println("Installing ESLint")
 
 	eslintInstallArg := fmt.Sprintf("%s@%s", eslint.Name(), eslint.Version())
 	if registry != "" {
 		fmt.Println("Using registry:", registry)
-		configCmd := exec.Command(nodeRuntime.Info()["npm"], "config", "set", "registry", registry)
+		configCmd := exec.Command(nodeRuntime.Binaries["npm"], "config", "set", "registry", registry)
 		if configOut, err := configCmd.Output(); err != nil {
 			fmt.Println("Error setting npm registry:", err)
 			fmt.Println(string(configOut))
 			return err
 		}
 	}
-	cmd := exec.Command(nodeRuntime.Info()["npm"], "install", "--prefix", eslint.Info()["installDir"],
+	cmd := exec.Command(nodeRuntime.Binaries["npm"], "install", "--prefix", eslint.Info()["installDir"],
 		eslintInstallArg, "@microsoft/eslint-formatter-sarif")
 	fmt.Println(cmd.String())
 	// to use the chdir command we needed to create the folder before, we can change this after

config/node-utils.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 )
 
+// Note that this is only used by tools
 type Runtime struct {
 	name    string
 	version string
@@ -26,10 +27,9 @@ func (r *Runtime) Info() map[string]string {
 	return r.info
 }
 
+// populateInfo populates the runtime info
 func (r *Runtime) populateInfo() {
 	switch r.Name() {
-	case "node":
-		r.info = genInfoNode(r)
 	case "eslint":
 		r.info = genInfoEslint(r)
 	}