[PLUTO-1431] Revive/go installation/running (#144)

* [PLUTO-1431] Fix it test sorting

Author: zhamborova

.codacy/codacy.yaml

@@ -1,5 +1,6 @@
 runtimes:
     - [email protected]
+    - [email protected]
     - [email protected]
     - [email protected]
     - [email protected]
@@ -10,5 +11,6 @@ tools:
     - [email protected]
     - [email protected]
     - [email protected]
+    - [email protected]
     - [email protected]
     - [email protected]

cmd/analyze.go

@@ -6,6 +6,7 @@ import (
 	"codacy/cli-v2/plugins"
 	"codacy/cli-v2/tools"
 	"codacy/cli-v2/tools/lizard"
+	reviveTool "codacy/cli-v2/tools/revive"
 	"encoding/json"
 	"fmt"
 	"io"
@@ -412,6 +413,16 @@ func runEnigmaAnalysis(workDirectory string, pathsToCheck []string, outputFile s
 	return tools.RunEnigma(workDirectory, enigma.InstallDir, enigma.Binaries["codacy-enigma-cli"], pathsToCheck, outputFile, outputFormat)
 }
 
+func runReviveAnalysis(workDirectory string, pathsToCheck []string, outputFile string, outputFormat string) error {
+	revive := config.Config.Tools()["revive"]
+	if revive == nil {
+		log.Fatal("Revive tool configuration not found")
+	}
+	reviveBinary := revive.Binaries["revive"]
+
+	return reviveTool.RunRevive(workDirectory, reviveBinary, pathsToCheck, outputFile, outputFormat)
+}
+
 var analyzeCmd = &cobra.Command{
 	Use:   "analyze",
 	Short: "Runs all configured linters.",
@@ -522,6 +533,8 @@ func runTool(workDirectory string, toolName string, args []string, outputFile st
 		return runLizardAnalysis(workDirectory, args, outputFile, outputFormat)
 	case "codacy-enigma-cli":
 		return runEnigmaAnalysis(workDirectory, args, outputFile, outputFormat)
+	case "revive":
+		return runReviveAnalysis(workDirectory, args, outputFile, outputFormat)
 	default:
 		return fmt.Errorf("unsupported tool: %s", toolName)
 	}

cmd/configsetup/setup.go

@@ -15,6 +15,7 @@ import (
 	"codacy/cli-v2/tools"
 	"codacy/cli-v2/tools/lizard"
 	"codacy/cli-v2/tools/pylint"
+	reviveTool "codacy/cli-v2/tools/revive"
 	"codacy/cli-v2/utils"
 )
 
@@ -374,6 +375,11 @@ func createToolFileConfigurations(tool domain.Tool, patternConfiguration []domai
 			return fmt.Errorf("failed to create Lizard config: %v", err)
 		}
 		fmt.Println("Lizard configuration created based on Codacy settings")
+	case domain.Revive:
+		if err := createReviveConfigFile(patternConfiguration, toolsConfigDir); err != nil {
+			return fmt.Errorf("failed to write revive config: %v", err)
+		}
+		fmt.Println("Revive configuration created based on Codacy settings")
 	}
 	return nil
 }
@@ -466,6 +472,11 @@ func createLizardConfigFile(toolsConfigDir string, patternConfiguration []domain
 	return nil
 }
 
+func createReviveConfigFile(config []domain.PatternConfiguration, toolsConfigDir string) error {
+	reviveConfigurationString := reviveTool.GenerateReviveConfig(config)
+	return os.WriteFile(filepath.Join(toolsConfigDir, "revive.toml"), []byte(reviveConfigurationString), utils.DefaultFilePerms)
+}
+
 // buildDefaultConfigurationFiles creates default configuration files for all tools
 func BuildDefaultConfigurationFiles(toolsConfigDir string, flags domain.InitFlags) error {
 	// Get all supported tool UUIDs
@@ -671,6 +682,8 @@ func createToolConfigurationFile(uuid string, patternsConfig []domain.PatternCon
 		return createSemgrepConfigFile(patternsConfig, toolsConfigDir)
 	case domain.Lizard:
 		return createLizardConfigFile(toolsConfigDir, patternsConfig)
+	case domain.Revive:
+		return createReviveConfigFile(patternsConfig, toolsConfigDir)
 	default:
 		if meta, ok := domain.SupportedToolsMetadata[uuid]; ok {
 			return fmt.Errorf("configuration creation not implemented for tool %s", meta.Name)

config/tools-installer.go

@@ -167,6 +167,13 @@ func installRuntimeTool(name string, toolInfo *plugins.ToolInfo, registry string
 	// Execute the installation command using the package manager
 	cmd := exec.Command(packageManagerBinary, strings.Split(installCmd, " ")...)
 
+	// Special handling for Go tools: set GOBIN so the binary is installed in the tool's install directory
+	if toolInfo.Runtime == "go" {
+		env := os.Environ()
+		env = append(env, "GOBIN="+toolInfo.InstallDir)
+		cmd.Env = env
+	}
+
 	// Special handling for ESLint installation in Linux (WSL) environment
 	if toolInfo.Name == "eslint" && runtime.GOOS == "linux" {
 		// Get node binary directory to add to PATH

domain/tool.go

@@ -27,6 +27,7 @@ const (
 	DartAnalyzer string = "d203d615-6cf1-41f9-be5f-e2f660f7850f"
 	Semgrep      string = "6792c561-236d-41b7-ba5e-9d6bee0d548b"
 	Lizard       string = "76348462-84b3-409a-90d3-955e90abfb87"
+	Revive       string = "bd81d1f4-1406-402d-9181-1274ee09f1aa"
 )
 
 type ToolInfo struct {
@@ -45,4 +46,5 @@ var SupportedToolsMetadata = map[string]ToolInfo{
 	DartAnalyzer: {Name: "dartanalyzer", Priority: 0},
 	Lizard:       {Name: "lizard", Priority: 0},
 	Semgrep:      {Name: "semgrep", Priority: 0},
+	Revive:       {Name: "revive", Priority: 0},
 }

integration-tests/init-without-token/expected/codacy.yaml

@@ -1,5 +1,6 @@
 runtimes:
     - [email protected]
+    - [email protected]
     - [email protected]
     - [email protected]
     - [email protected]
@@ -9,5 +10,6 @@ tools:
     - [email protected]
     - [email protected]
     - [email protected]
+    - [email protected]
     - [email protected]
     - [email protected]

integration-tests/init-without-token/expected/tools-configs/eslint.config.mjs

@@ -9,8 +9,8 @@ export default [
           "no-class-assign": ["error"],
           "no-compare-neg-zero": ["error"],
           "no-cond-assign": ["error", "except-parens"],
-          "no-const-assign": ["error"],
           "no-constant-condition": ["error", {"checkLoops": true}],
+          "no-const-assign": ["error"],
           "no-control-regex": ["error"],
           "no-debugger": ["error"],
           "no-delete-var": ["error"],
@@ -31,7 +31,7 @@ export default [
           "no-import-assign": ["error"],
           "no-inner-declarations": ["error", "functions"],
           "no-invalid-regexp": ["error"],
-          "no-irregular-whitespace": ["error", {"skipStrings": true, "skipJSXText": false, "skipRegExps": false, "skipComments": false, "skipTemplates": false}],
+          "no-irregular-whitespace": ["error", {"skipComments": false, "skipJSXText": false, "skipRegExps": false, "skipStrings": true, "skipTemplates": false}],
           "no-loss-of-precision": ["error"],
           "no-misleading-character-class": ["error"],
           "no-mixed-spaces-and-tabs": ["error"],
@@ -60,7 +60,7 @@ export default [
           "no-useless-escape": ["error"],
           "no-with": ["error"],
           "require-yield": ["error"],
-          "use-isnan": ["error", {"enforceForSwitchCase": true, "enforceForIndexOf": false}],
+          "use-isnan": ["error", {"enforceForIndexOf": false, "enforceForSwitchCase": true}],
           "valid-typeof": ["error", {"requireStringLiterals": false}],
         }
     }

integration-tests/init-without-token/expected/tools-configs/lizard.yaml

@@ -1,7 +1,7 @@
 patterns:
     Lizard_ccn-medium:
         category: Complexity
-        description: Check the Cyclomatic Complexity value of a function or logic block. If the threshold is not met, raise a Medium issue. The default threshold is 8.
+        description: Checks if the cyclomatic complexity of a function or logic block exceeds the medium threshold (default is 8).
         explanation: |-
             # Medium Cyclomatic Complexity control
 
@@ -11,20 +11,20 @@ patterns:
         severityLevel: Warning
         threshold: 8
         timeToFix: 5
-        title: Medium Cyclomatic Complexity control
+        title: Enforce Medium Cyclomatic Complexity Threshold
     Lizard_file-nloc-medium:
         category: Complexity
-        description: Check the number of lines of code (without comments) in a file. If the threshold is not met, raise a Medium issue. The default threshold is 500.
+        description: This rule checks if the number of lines of code (excluding comments) in a file exceeds a medium threshold, typically 500 lines.
         explanation: ""
         id: Lizard_file-nloc-medium
         level: Warning
         severityLevel: Warning
         threshold: 500
         timeToFix: 5
-        title: Medium File NLOC control - Number of Lines of Code (without comments)
+        title: Enforce Medium File Length Limit Based on Number of Lines of Code
     Lizard_nloc-medium:
         category: Complexity
-        description: Check the number of lines of code (without comments) in a function. If the threshold is not met, raise a Medium issue. The default threshold is 50.
+        description: Checks if the number of lines of code (excluding comments) in a function exceeds a medium threshold (default 50 lines).
         explanation: |-
             # Medium NLOC control - Number of Lines of Code (without comments)
 
@@ -34,10 +34,10 @@ patterns:
         severityLevel: Warning
         threshold: 50
         timeToFix: 5
-        title: Medium NLOC control - Number of Lines of Code (without comments)
+        title: Enforce Medium Number of Lines of Code (NLOC) Limit
     Lizard_parameter-count-medium:
         category: Complexity
-        description: Check the number of parameters sent to a function. If the threshold is not met, raise a Medium issue. The default threshold is 8.
+        description: This rule checks the number of parameters passed to a function and raises an issue if it exceeds a medium threshold, which by default is 8 parameters.
         explanation: |-
             # Medium Parameter count control
 
@@ -47,4 +47,4 @@ patterns:
         severityLevel: Warning
         threshold: 8
         timeToFix: 5
-        title: Medium Parameter count control
+        title: Enforce Medium Parameter Count Limit

integration-tests/init-without-token/expected/tools-configs/revive.toml

@@ -0,0 +1,56 @@
+[revive]
+ignoreGeneratedHeader = true
+severity = "warning"
+confidence = 0.8
+errorCode = 0
+warningCode = 0
+
+rules = ["blank-imports", "context-as-argument", "context-keys-type", "dot-imports", "empty-block", "error-naming", "error-return", "error-strings", "errorf", "exported", "increment-decrement", "indent-error-flow", "package-comments", "range", "receiver-naming", "redefines-builtin-id", "superfluous-else", "time-naming", "unexported-return", "unreachable-code", "unused-parameter", "var-declaration", "var-naming"]
+
+[rule.blank-imports]
+
+[rule.context-as-argument]
+
+[rule.context-keys-type]
+
+[rule.dot-imports]
+
+[rule.empty-block]
+
+[rule.error-naming]
+
+[rule.error-return]
+
+[rule.error-strings]
+
+[rule.errorf]
+
+[rule.exported]
+
+[rule.increment-decrement]
+
+[rule.indent-error-flow]
+
+[rule.package-comments]
+
+[rule.range]
+
+[rule.receiver-naming]
+
+[rule.redefines-builtin-id]
+
+[rule.superfluous-else]
+arguments = [""]
+
+[rule.time-naming]
+
+[rule.unexported-return]
+
+[rule.unreachable-code]
+
+[rule.unused-parameter]
+
+[rule.var-declaration]
+
+[rule.var-naming]
+

integration-tests/init-without-token/expected/tools-configs/ruleset.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0"?>
 <ruleset name="Codacy PMD Ruleset"
-         xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+    xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
     <description>Codacy PMD Ruleset</description>
     <rule ref="category/apex/design.xml/AvoidDeeplyNestedIfStmts"/>
     <rule ref="category/apex/design.xml/ExcessiveClassLength"/>
@@ -13,8 +13,8 @@
     <rule ref="category/apex/security.xml/ApexDangerousMethods"/>
     <rule ref="category/apex/security.xml/ApexInsecureEndpoint"/>
     <rule ref="category/apex/security.xml/ApexOpenRedirect"/>
-    <rule ref="category/apex/security.xml/ApexSOQLInjection"/>
     <rule ref="category/apex/security.xml/ApexSharingViolations"/>
+    <rule ref="category/apex/security.xml/ApexSOQLInjection"/>
     <rule ref="category/apex/security.xml/ApexSuggestUsingNamedCred"/>
     <rule ref="category/apex/security.xml/ApexXSSFromEscapeFalse"/>
     <rule ref="category/apex/security.xml/ApexXSSFromURLParam"/>
@@ -23,12 +23,12 @@
     <rule ref="category/ecmascript/bestpractices.xml/UseBaseWithParseInt"/>
     <rule ref="category/ecmascript/codestyle.xml/AssignmentInOperand">
         <properties>
-            <property name="allowWhile" value="false"/>
-            <property name="allowIf" value="false"/>
-            <property name="allowTernaryResults" value="false"/>
-            <property name="allowTernary" value="false"/>
             <property name="allowFor" value="false"/>
+            <property name="allowIf" value="false"/>
             <property name="allowIncrementDecrement" value="false"/>
+            <property name="allowTernary" value="false"/>
+            <property name="allowTernaryResults" value="false"/>
+            <property name="allowWhile" value="false"/>
         </properties>
     </rule>
     <rule ref="category/ecmascript/codestyle.xml/UnnecessaryBlock"/>
@@ -49,13 +49,13 @@
     <rule ref="category/java/bestpractices.xml/UnusedPrivateMethod"/>
     <rule ref="category/java/codestyle.xml/ClassNamingConventions">
         <properties>
-            <property name="testClassPattern" value="^Test.*$|^[A-Z][a-zA-Z0-9]*Test(s|Case)?$"/>
             <property name="abstractClassPattern" value="[A-Z][a-zA-Z0-9]*"/>
-            <property name="classPattern" value="[A-Z][a-zA-Z0-9]*"/>
-            <property name="utilityClassPattern" value="[A-Z][a-zA-Z0-9]*"/>
             <property name="annotationPattern" value="[A-Z][a-zA-Z0-9]*"/>
+            <property name="classPattern" value="[A-Z][a-zA-Z0-9]*"/>
             <property name="enumPattern" value="[A-Z][a-zA-Z0-9]*"/>
             <property name="interfacePattern" value="[A-Z][a-zA-Z0-9]*"/>
+            <property name="testClassPattern" value="^Test.*$|^[A-Z][a-zA-Z0-9]*Test(s|Case)?$"/>
+            <property name="utilityClassPattern" value="[A-Z][a-zA-Z0-9]*"/>
         </properties>
     </rule>
     <rule ref="category/java/codestyle.xml/ExtendsObject"/>
@@ -64,11 +64,11 @@
     <rule ref="category/java/codestyle.xml/MethodNamingConventions">
         <properties>
             <property name="junit3TestPattern" value="test[A-Z0-9][a-zA-Z0-9]*"/>
+            <property name="junit4TestPattern" value="[a-z][a-zA-Z0-9]*"/>
             <property name="junit5TestPattern" value="[a-z][a-zA-Z0-9]*"/>
-            <property name="staticPattern" value="[a-z][a-zA-Z0-9]*"/>
             <property name="methodPattern" value="[a-z][a-zA-Z0-9]*"/>
-            <property name="junit4TestPattern" value="[a-z][a-zA-Z0-9]*"/>
             <property name="nativePattern" value="[a-z][a-zA-Z0-9]*"/>
+            <property name="staticPattern" value="[a-z][a-zA-Z0-9]*"/>
         </properties>
     </rule>
     <rule ref="category/java/codestyle.xml/NoPackage"/>
@@ -104,9 +104,9 @@
     <rule ref="category/java/errorprone.xml/DontUseFloatTypeForLoopIndices"/>
     <rule ref="category/java/errorprone.xml/EmptyFinalizer"/>
     <rule ref="category/java/errorprone.xml/EqualsNull"/>
+    <rule ref="category/java/errorprone.xml/JumbledIncrementer"/>
     <rule ref="category/java/errorprone.xml/JUnitSpelling"/>
     <rule ref="category/java/errorprone.xml/JUnitStaticSuite"/>
-    <rule ref="category/java/errorprone.xml/JumbledIncrementer"/>
     <rule ref="category/java/errorprone.xml/MethodWithSameNameAsEnclosingClass"/>
     <rule ref="category/java/errorprone.xml/MisplacedNullCheck"/>
     <rule ref="category/java/errorprone.xml/MissingStaticMethodInNonInstantiatableClass">
@@ -152,8 +152,8 @@
             <property name="maxmethods" value="1"/>
         </properties>
     </rule>
-    <rule ref="category/plsql/errorprone.xml/TO_DATEWithoutDateFormat"/>
     <rule ref="category/plsql/errorprone.xml/TO_DATE_TO_CHAR"/>
+    <rule ref="category/plsql/errorprone.xml/TO_DATEWithoutDateFormat"/>
     <rule ref="category/plsql/errorprone.xml/TO_TIMESTAMPWithoutDateFormat"/>
     <rule ref="category/pom/errorprone.xml/InvalidDependencyTypes">
         <properties>