fix lizard configuration parser

Author: franciscoovazevedo

codacy-client/client.go

@@ -12,6 +12,7 @@ import (
 
 const timeout = 10 * time.Second
 
+// CodacyApiBase is the base URL for the Codacy API
 var CodacyApiBase = "https://app.codacy.com"
 
 func getRequest(url string, apiToken string) ([]byte, error) {
@@ -113,17 +114,17 @@ func parsePatternConfigurations(response []byte) ([]domain.PatternConfiguration,
 		return nil, "", fmt.Errorf("failed to unmarshal response: %w", err)
 	}
 
-	var patterns []domain.PatternDefinition
-	if err := json.Unmarshal(objmap["data"], &patterns); err != nil {
+	var patternResponses []domain.PatternResponse
+	if err := json.Unmarshal(objmap["data"], &patternResponses); err != nil {
 		return nil, "", fmt.Errorf("failed to unmarshal patterns: %w", err)
 	}
 
-	patternConfigurations := make([]domain.PatternConfiguration, len(patterns))
-	for i, pattern := range patterns {
+	patternConfigurations := make([]domain.PatternConfiguration, len(patternResponses))
+	for i, patternResp := range patternResponses {
 		patternConfigurations[i] = domain.PatternConfiguration{
-			PatternDefinition: pattern,
-			Parameters:        pattern.Parameters,
-			Enabled:           pattern.Enabled,
+			PatternDefinition: patternResp.PatternDefinition,
+			Parameters:        patternResp.Parameters,
+			Enabled:           patternResp.Enabled,
 		}
 	}
 
@@ -137,21 +138,26 @@ func parsePatternConfigurations(response []byte) ([]domain.PatternConfiguration,
 	return patternConfigurations, pagination.Cursor, nil
 }
 
+// GetDefaultToolPatternsConfig fetches the default patterns for a tool
 func GetDefaultToolPatternsConfig(initFlags domain.InitFlags, toolUUID string) ([]domain.PatternConfiguration, error) {
 	baseURL := fmt.Sprintf("%s/api/v3/tools/%s/patterns?enabled=true", CodacyApiBase, toolUUID)
 	return getAllPages(baseURL, initFlags, parsePatternConfigurations)
 }
 
+// GetRepositoryToolPatterns fetches the patterns for a tool in a repository
 func GetRepositoryToolPatterns(initFlags domain.InitFlags, toolUUID string) ([]domain.PatternConfiguration, error) {
 	baseURL := fmt.Sprintf("%s/api/v3/analysis/organizations/%s/%s/repositories/%s/tools/%s/patterns?enabled=true",
 		CodacyApiBase,
 		initFlags.Provider,
 		initFlags.Organization,
 		initFlags.Repository,
 		toolUUID)
-	return getAllPages(baseURL, initFlags, parsePatternConfigurations)
+
+	result, err := getAllPages(baseURL, initFlags, parsePatternConfigurations)
+	return result, err
 }
 
+// GetRepositoryTools fetches the tools for a repository
 func GetRepositoryTools(initFlags domain.InitFlags) ([]domain.Tool, error) {
 	baseURL := fmt.Sprintf("%s/api/v3/analysis/organizations/%s/%s/repositories/%s/tools",
 		CodacyApiBase,
@@ -175,6 +181,7 @@ func GetRepositoryTools(initFlags domain.InitFlags) ([]domain.Tool, error) {
 	return toolsResponse.Data, nil
 }
 
+// GetToolsVersions fetches the tools versions
 func GetToolsVersions() ([]domain.Tool, error) {
 	baseURL := fmt.Sprintf("%s/api/v3/tools", CodacyApiBase)
 
@@ -192,6 +199,7 @@ func GetToolsVersions() ([]domain.Tool, error) {
 	return toolsResponse.Data, nil
 }
 
+// GetRepositoryLanguages fetches the languages for a repository
 func GetRepositoryLanguages(initFlags domain.InitFlags) ([]domain.Language, error) {
 	baseURL := fmt.Sprintf("%s/api/v3/organizations/%s/%s/repositories/%s/settings/languages",
 		CodacyApiBase,

domain/initFlags.go

@@ -1,5 +1,6 @@
 package domain
 
+// InitFlags represents the flags for the init command
 type InitFlags struct {
 	ApiToken     string
 	Provider     string

domain/language.go

@@ -1,5 +1,6 @@
 package domain
 
+// Language represents a language in the Codacy API
 type Language struct {
 	Name           string   `json:"name"`
 	CodacyDefaults []string `json:"codacyDefaults"`
@@ -8,6 +9,7 @@ type Language struct {
 	Detected       bool     `json:"detected"`
 }
 
+// LanguagesResponse represents the structure of the languages response
 type LanguagesResponse struct {
 	Languages []Language `json:"languages"`
 }

domain/pagination.go

@@ -1,5 +1,6 @@
 package domain
 
+// Pagination represents the structure of the pagination response
 type Pagination struct {
 	Cursor string `json:"cursor"`
 	Limit  int    `json:"limit"`

domain/patternConfiguration.go

@@ -1,11 +1,13 @@
 package domain
 
+// ParameterConfiguration represents the structure of a parameter in the Codacy API
 type ParameterConfiguration struct {
 	Name    string `json:"name"`
 	Value   string `json:"value,omitempty"`
 	Default string `json:"default,omitempty"`
 }
 
+// PatternDefinition represents the structure of a pattern in the Codacy API
 type PatternDefinition struct {
 	Id            string                   `json:"id"`
 	Category      string                   `json:"category"`
@@ -20,8 +22,17 @@ type PatternDefinition struct {
 	TimeToFix     int                      `json:"timeToFix"`
 }
 
+// PatternConfiguration represents the structure of a pattern in the Codacy API
 type PatternConfiguration struct {
 	PatternDefinition PatternDefinition `json:"patternDefinition"`
 	Parameters        []ParameterConfiguration
 	Enabled           bool `json:"enabled"`
 }
+
+// PatternResponse represents the structure of a pattern in the API response
+type PatternResponse struct {
+	PatternDefinition PatternDefinition        `json:"patternDefinition"`
+	Enabled           bool                     `json:"enabled"`
+	IsCustom          bool                     `json:"isCustom"`
+	Parameters        []ParameterConfiguration `json:"parameters"`
+}

domain/tool.go

@@ -1,9 +1,11 @@
 package domain
 
+// ToolsResponse represents the structure of the tools response
 type ToolsResponse struct {
 	Data []Tool `json:"data"`
 }
 
+// Tool represents a tool in the Codacy API
 type Tool struct {
 	Uuid     string `json:"uuid"`
 	Name     string `json:"name"`

tools/lizard/lizardConfigCreator.go

@@ -74,26 +74,23 @@ func getThresholdFromParams(params []domain.ParameterConfiguration) int {
 // getMetricTypeFromPatternId extracts the metric type from the pattern ID
 func getMetricTypeFromPatternId(patternID string) string {
 	// Pattern IDs are in the format "Lizard_metric-severity"
+
 	parts := strings.Split(patternID, "_")
 	if len(parts) != 2 {
 		fmt.Printf("Warning: Invalid pattern ID format: %s\n", patternID)
 		return ""
 	}
 
-	// Extract the metric type from the second part
-	// For patterns like "file-nloc-critical", we need to get "file-nloc"
+	// Extract the metric parts from the second part
 	metricParts := strings.Split(parts[1], "-")
 	if len(metricParts) < 2 {
 		fmt.Printf("Warning: Invalid metric format: %s\n", parts[1])
 		return ""
 	}
 
-	// Handle compound metric types
-	metricType := metricParts[0]
-	if len(metricParts) > 2 {
-		// For patterns like "file-nloc-critical", combine "file" and "nloc"
-		metricType = metricParts[0] + "-" + metricParts[1]
-	}
+	// The last part is always the severity (medium, critical, etc.)
+	// Everything before that is the metric type
+	metricType := strings.Join(metricParts[:len(metricParts)-1], "-")
 
 	// Validating that the metric type is one of the known types
 	switch metricType {