Merge pull request #42 from codacy/refactor-node-plugin-try-2

refactor: implement runtime plugins with declarative configuration PLUTO-1369

Author: machadoit

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)
 	}

config/runtime.go

@@ -0,0 +1,102 @@
+package config
+
+import (
+	"codacy/cli-v2/plugins"
+	"codacy/cli-v2/utils"
+	"fmt"
+	"log"
+	"os"
+	"path/filepath"
+	"strings"
+)
+
+// InstallRuntimes installs all runtimes defined in the configuration
+func InstallRuntimes() error {
+	for name, runtimeInfo := range Config.Runtimes() {
+		err := InstallRuntime(name, runtimeInfo)
+		if err != nil {
+			return fmt.Errorf("failed to install runtime %s: %w", name, err)
+		}
+	}
+	return nil
+}
+
+// InstallRuntime installs a specific runtime
+func InstallRuntime(name string, runtimeInfo *plugins.RuntimeInfo) error {
+	// Check if the runtime is already installed
+	if isRuntimeInstalled(runtimeInfo) {
+		fmt.Printf("Runtime %s v%s is already installed\n", name, runtimeInfo.Version)
+		return nil
+	}
+
+	// Download and extract the runtime
+	err := downloadAndExtractRuntime(runtimeInfo)
+	if err != nil {
+		return fmt.Errorf("failed to download and extract runtime %s: %w", name, err)
+	}
+
+	return nil
+}
+
+// isRuntimeInstalled checks if a runtime is already installed by checking for the binary
+func isRuntimeInstalled(runtimeInfo *plugins.RuntimeInfo) bool {
+	// If there are no binaries, check the install directory
+	if len(runtimeInfo.Binaries) == 0 {
+		_, err := os.Stat(runtimeInfo.InstallDir)
+		return err == nil
+	}
+
+	// Check if at least one binary exists
+	for _, binaryPath := range runtimeInfo.Binaries {
+		_, err := os.Stat(binaryPath)
+		if err == nil {
+			return true
+		}
+	}
+
+	return false
+}
+
+// downloadAndExtractRuntime downloads and extracts a runtime 
+func downloadAndExtractRuntime(runtimeInfo *plugins.RuntimeInfo) error {
+	// Create a file name for the downloaded archive
+	fileName := filepath.Base(runtimeInfo.DownloadURL)
+	downloadPath := filepath.Join(Config.RuntimesDirectory(), fileName)
+
+	// Check if the file already exists
+	_, err := os.Stat(downloadPath)
+	if os.IsNotExist(err) {
+		// Download the file
+		log.Printf("Downloading %s v%s...\n", runtimeInfo.Name, runtimeInfo.Version)
+		downloadPath, err = utils.DownloadFile(runtimeInfo.DownloadURL, Config.RuntimesDirectory())
+		if err != nil {
+			return fmt.Errorf("failed to download runtime: %w", err)
+		}
+	} else if err != nil {
+		return fmt.Errorf("error checking for existing download: %w", err)
+	} else {
+		log.Printf("Using existing download for %s v%s\n", runtimeInfo.Name, runtimeInfo.Version)
+	}
+
+	// Open the downloaded file
+	file, err := os.Open(downloadPath)
+	if err != nil {
+		return fmt.Errorf("failed to open downloaded file: %w", err)
+	}
+	defer file.Close()
+
+	// Extract based on file extension
+	log.Printf("Extracting %s v%s...\n", runtimeInfo.Name, runtimeInfo.Version)
+	if strings.HasSuffix(fileName, ".zip") {
+		err = utils.ExtractZip(file.Name(), Config.RuntimesDirectory())
+	} else {
+		err = utils.ExtractTarGz(file, Config.RuntimesDirectory())
+	}
+
+	if err != nil {
+		return fmt.Errorf("failed to extract runtime: %w", err)
+	}
+
+	log.Printf("Successfully installed %s v%s\n", runtimeInfo.Name, runtimeInfo.Version)
+	return nil
+}