-
Notifications
You must be signed in to change notification settings - Fork 18
/
utils.go
237 lines (191 loc) · 6.41 KB
/
utils.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
package list
import (
"fmt"
"os"
"path/filepath"
"strings"
"github.com/deepsourcelabs/cli/deepsource/issues"
"github.com/owenrumney/go-sarif/v2/sarif"
)
type ExportData struct {
Occurences []IssueJSON `json:"occurences"`
Summary Summary `json:"summary"`
}
type Summary struct {
TotalOccurences int `json:"total_occurences"`
UniqueIssues int `json:"unique_issues"`
}
///////////////////////
// Filtering utilities
///////////////////////
// Filters issues based on a path, works for both directories and files
func filterIssuesByPath(path string, issuesData []issues.Issue) ([]issues.Issue, error) {
var filteredIssues []issues.Issue
for _, issue := range issuesData {
up := ".." + string(os.PathSeparator)
// get relative path
rel, err := filepath.Rel(path, issue.Location.Path)
if err != nil {
return nil, err
}
// handle files
if rel == "." {
filteredIssues = append(filteredIssues, issue)
}
// check if the relative path has a parent directory
if !strings.HasPrefix(rel, up) && rel != ".." {
filteredIssues = append(filteredIssues, issue)
}
}
return getUniqueIssues(filteredIssues), nil
}
// Filters issues based on the analyzer shortcode.
func filterIssuesByAnalyzer(analyzer []string, issuesData []issues.Issue) ([]issues.Issue, error) {
var filteredIssues []issues.Issue
// maintain a map of analyzer shortcodes
analyzerMap := make(map[string]bool)
for _, shortcode := range analyzer {
analyzerMap[shortcode] = true
}
for _, issue := range issuesData {
if analyzerMap[issue.Analyzer.Shortcode] {
filteredIssues = append(filteredIssues, issue)
}
}
return getUniqueIssues(filteredIssues), nil
}
// Returns de-duplicated issues.
func getUniqueIssues(fetchedIssues []issues.Issue) []issues.Issue {
var uniqueIssues []issues.Issue
// inUnique is a map which is used for checking whether an issue exists already or not
inUnique := make(map[issues.Issue]bool)
for _, issue := range fetchedIssues {
// if the issue isn't present in inUnique, append the issue to uniqueIssues and update inUnique
if _, ok := inUnique[issue]; !ok {
inUnique[issue] = true
uniqueIssues = append(uniqueIssues, issue)
}
}
return uniqueIssues
}
///////////////////////
// Conversion utilities
///////////////////////
// Converts issueData to a JSON-compatible struct
func convertJSON(issueData []issues.Issue) ExportData {
var occurences []IssueJSON
var issueExport ExportData
set := make(map[string]string)
total_occurences := 0
for _, issue := range issueData {
issueNew := IssueJSON{
Analyzer: issue.Analyzer.Shortcode,
IssueCode: issue.IssueCode,
IssueTitle: issue.IssueText,
OccurenceTitle: issue.IssueText,
IssueCategory: "",
Location: LocationJSON{
Path: issue.Location.Path,
Position: PositionJSON{
Begin: LineColumn{
Line: issue.Location.Position.BeginLine,
Column: 0,
},
End: LineColumn{
Line: issue.Location.Position.EndLine,
Column: 0,
},
},
},
}
total_occurences += 1
set[issue.IssueCode] = ""
occurences = append(occurences, issueNew)
}
issueExport.Occurences = occurences
issueExport.Summary.TotalOccurences = total_occurences
issueExport.Summary.UniqueIssues = len(set)
return issueExport
}
// Converts issueData to a CSV records
func convertCSV(issueData []issues.Issue) [][]string {
records := [][]string{{"analyzer", "issue_code", "issue_title", "occurence_title", "issue_category", "path", "begin_line", "begin_column", "end_line", "end_column"}}
for _, issue := range issueData {
issueNew := []string{issue.Analyzer.Shortcode, issue.IssueCode, issue.IssueText, issue.IssueText, "", issue.Location.Path, fmt.Sprint(issue.Location.Position.BeginLine), "0", fmt.Sprint(issue.Location.Position.EndLine), "0"}
records = append(records, issueNew)
}
return records
}
// Converts issueData to a SARIF report
func convertSARIF(issueData []issues.Issue) *sarif.Report {
report, err := sarif.New(sarif.Version210)
if err != nil {
return nil
}
// use a map of shortcodes to append rules and results
type boolIndex struct {
exists bool
index int
}
shortcodes := make(map[string]boolIndex)
var runs []*sarif.Run
count := 0
// Adding the tools data to the SARIF report corresponding to the number of analyzers activated
for _, issue := range issueData {
if !shortcodes[issue.Analyzer.Shortcode].exists {
driverName := "DeepSource " + strings.Title(issue.Analyzer.Shortcode) + " Analyzer"
informationURI := "https://deepsource.io/directory/analyzers/" + string(issue.Analyzer.Shortcode)
tool := sarif.Tool{
Driver: &sarif.ToolComponent{
Name: driverName,
InformationURI: &informationURI,
},
}
run := sarif.NewRun(tool)
runs = append(runs, run)
// update boolIndex
shortcodes[issue.Analyzer.Shortcode] = boolIndex{exists: true, index: count}
count += 1
}
}
// use an index map for updating rule index value
idxMap := make(map[int]int)
// Adding the results data for each analyzer in the report
for _, issue := range issueData {
// TODO: Fetch issue description from the API and populate here
textDescription := ""
fullDescription := sarif.MultiformatMessageString{
Text: &textDescription,
}
// check if the shortcode exists in the map
if shortcodes[issue.Analyzer.Shortcode].exists {
// fetch shortcode index
idx := shortcodes[issue.Analyzer.Shortcode].index
// TODO: fetch category and recommended fields
pb := sarif.NewPropertyBag()
pb.Add("category", "")
pb.Add("recommended", "")
helpURI := "https://deepsource.io/directory/analyzers/" + string(issue.Analyzer.Shortcode) + "/issues/" + string(issue.IssueCode)
// add rule
runs[idx].AddRule(issue.IssueCode).WithName(issue.IssueText).WithFullDescription(&fullDescription).WithHelpURI(helpURI).WithProperties(pb.Properties)
// add result
runs[idx].CreateResultForRule(issue.IssueCode).WithLevel("error").WithKind("fail").WithMessage(sarif.NewTextMessage(
issue.IssueText,
)).WithRuleIndex(idxMap[idx]).AddLocation(
sarif.NewLocationWithPhysicalLocation(
sarif.NewPhysicalLocation().WithArtifactLocation(
sarif.NewSimpleArtifactLocation(issue.Location.Path),
).WithRegion(
sarif.NewSimpleRegion(issue.Location.Position.BeginLine, issue.Location.Position.EndLine),
),
),
)
idxMap[idx] += 1
}
}
// add all runs to report
for _, run := range runs {
report.AddRun(run)
}
return report
}