hacks required to get license-sim running for board demo

Author: kendrickcurtis

cmd/analyze.go

@@ -94,35 +94,41 @@ func GetFileExtension(filePath string) string {
 func IsToolSupportedForFile(toolName string, filePath string, langConfig *LanguagesConfig) bool {
 	if langConfig == nil {
 		// If no language config is available, assume all tools are supported
+		fmt.Printf("[DEBUG] No language config, assuming tool %s supports file %s\n", toolName, filePath)
 		return true
 	}
 
 	fileExt := GetFileExtension(filePath)
 	if fileExt == "" {
 		// If file has no extension, assume tool is supported
+		fmt.Printf("[DEBUG] File %s has no extension, assuming tool %s supports it\n", filePath, toolName)
 		return true
 	}
 
 	for _, tool := range langConfig.Tools {
 		if tool.Name == toolName {
 			// If tool has no extensions defined, assume it supports all files
 			if len(tool.Extensions) == 0 {
+				fmt.Printf("[DEBUG] Tool %s has no extensions defined, supports all files. File: %s\n", toolName, filePath)
 				return true
 			}
 
-			// Check if file extension is supported by this tool
+			fmt.Printf("[DEBUG] Checking if tool %s supports file %s (ext: %s). Tool extensions: %v\n", toolName, filePath, fileExt, tool.Extensions)
 			for _, ext := range tool.Extensions {
 				if strings.EqualFold(ext, fileExt) {
+					fmt.Printf("[DEBUG] Tool %s supports file %s (matched ext: %s)\n", toolName, filePath, fileExt)
 					return true
 				}
 			}
 
+			fmt.Printf("[DEBUG] Tool %s does NOT support file %s (ext: %s)\n", toolName, filePath, fileExt)
 			// Extension not found in tool's supported extensions
 			return false
 		}
 	}
 
 	// If tool not found in config, assume it's supported
+	fmt.Printf("[DEBUG] Tool %s not found in language config, assuming it supports file %s\n", toolName, filePath)
 	return true
 }
 

tools/licenseSimRunner.go

@@ -62,7 +62,7 @@ func RunLicenseSim(workDirectory string, binary string, files []string, outputFi
 			return fmt.Errorf("failed to read license-sim output: %w", err)
 		}
 
-		sarifOutput := utils.ConvertLicenseSimToSarif(jsonOutput)
+		sarifOutput := utils.ConvertLicenseSimToSarifWithFile(jsonOutput, fileToCheck)
 
 		if outputFile != "" {
 			err = os.WriteFile(outputFile, sarifOutput, 0644)

utils/sarif.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
+	"strings"
 )
 
 // PylintIssue represents a single issue in Pylint's JSON output
@@ -80,6 +81,7 @@ type ArtifactLocation struct {
 type Region struct {
 	StartLine   int `json:"startLine"`
 	StartColumn int `json:"startColumn"`
+	EndLine     int `json:"endLine,omitempty"`
 }
 
 type MessageText struct {
@@ -290,7 +292,7 @@ type LicenseSimIssue struct {
 }
 
 // ConvertLicenseSimToSarif converts license-sim JSON output to SARIF format
-func ConvertLicenseSimToSarif(licenseSimOutput []byte) []byte {
+func ConvertLicenseSimToSarifWithFile(licenseSimOutput []byte, scannedFile string) []byte {
 	var issues []LicenseSimIssue
 
 	// Try to unmarshal as {"results": [...]}
@@ -307,6 +309,21 @@ func ConvertLicenseSimToSarif(licenseSimOutput []byte) []byte {
 		}
 	}
 
+	if scannedFile == "" {
+		// Try to detect the scanned file from the input (first issue's file_path or fallback)
+		if len(issues) > 0 {
+			for _, issue := range issues {
+				if !strings.HasPrefix(issue.FilePath, "../") && issue.FilePath != "" {
+					scannedFile = issue.FilePath
+					break
+				}
+			}
+		}
+		if scannedFile == "" {
+			scannedFile = "license-sim-test.php" // fallback, ideally should be passed in
+		}
+	}
+
 	sarifReport := SarifReport{
 		Version: "2.1.0",
 		Schema:  "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json",
@@ -325,13 +342,24 @@ func ConvertLicenseSimToSarif(licenseSimOutput []byte) []byte {
 	}
 
 	for _, issue := range issues {
+		referenceFile := issue.FilePath
 		ruleId := issue.License
 		if ruleId == "" {
 			ruleId = "license-sim-match"
 		}
 		msg := issue.Message
 		if msg == "" {
-			msg = "code similar to licensed code"
+			msg = "code similar to licensed code in " + referenceFile
+		} else {
+			msg = msg + " (reference: " + referenceFile + ")"
+		}
+		startLine := issue.Line
+		if startLine <= 0 {
+			startLine = 1
+		}
+		endLine := startLine
+		if endLine <= 0 {
+			endLine = startLine
 		}
 		result := Result{
 			RuleID:  ruleId,
@@ -340,9 +368,10 @@ func ConvertLicenseSimToSarif(licenseSimOutput []byte) []byte {
 			Locations: []Location{
 				{
 					PhysicalLocation: PhysicalLocation{
-						ArtifactLocation: ArtifactLocation{URI: issue.FilePath},
+						ArtifactLocation: ArtifactLocation{URI: scannedFile},
 						Region: Region{
-							StartLine: issue.Line,
+							StartLine: startLine,
+							EndLine:   endLine,
 						},
 					},
 				},
@@ -358,3 +387,8 @@ func ConvertLicenseSimToSarif(licenseSimOutput []byte) []byte {
 
 	return sarifData
 }
+
+// Backward compatible wrapper
+func ConvertLicenseSimToSarif(licenseSimOutput []byte) []byte {
+	return ConvertLicenseSimToSarifWithFile(licenseSimOutput, "")
+}