Skip to content

Commit 8df48f9

Browse files
gcmurphygcmurphy
committed
Fix to reporting to use output formats
1 parent 9b08174 commit 8df48f9

File tree

3 files changed

+36
-32
lines changed

3 files changed

+36
-32
lines changed

‎core/analyzer.go‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -181,12 +181,7 @@ func (gas *Analyzer) ProcessPackage(prog *loader.Program, pkg *loader.PackageInf
181181
}
182182
ast.Walk(gas, file)
183183
gas.Stats.NumFiles++
184-
185-
count := func(f *token.File) bool {
186-
gas.Stats.NumLines += f.LineCount()
187-
return true
188-
}
189-
prog.Fset.Iterate(count)
184+
gas.Stats.NumLines += prog.Fset.File(file.Pos()).LineCount()
190185
return nil
191186
}
192187

‎main.go‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import (
2828
"strings"
2929

3030
gas "github.com/GoASTScanner/gas/core"
31+
"github.com/GoASTScanner/gas/output"
3132
"golang.org/x/tools/go/loader"
3233
)
3334

@@ -151,7 +152,7 @@ func usage() {
151152
}
152153

153154
// TODO(gm) This needs to be refactored (potentially included in Analyzer)
154-
func analyzePackage(packageDirectory string, config map[string]interface{}, logger *log.Logger) ([]*gas.Issue, error) {
155+
func analyzePackage(packageDirectory string, metrics *gas.Metrics, config map[string]interface{}, logger *log.Logger) ([]*gas.Issue, error) {
155156

156157
basePackage, err := build.Default.ImportDir(packageDirectory, build.ImportComment)
157158
if err != nil {
@@ -178,7 +179,12 @@ func analyzePackage(packageDirectory string, config map[string]interface{}, logg
178179
analyzer.ProcessPackage(builtPackage, pkg, file)
179180
}
180181
issues = append(issues, analyzer.Issues...)
182+
metrics.NumFiles += analyzer.Stats.NumFiles
183+
metrics.NumFound += analyzer.Stats.NumFound
184+
metrics.NumLines += analyzer.Stats.NumLines
185+
metrics.NumNosec += analyzer.Stats.NumNosec
181186
}
187+
182188
return issues, nil
183189
}
184190

@@ -223,6 +229,8 @@ func main() {
223229

224230
config := buildConfig(incRules, excRules)
225231
issues := make([]*gas.Issue, 0)
232+
metrics := &gas.Metrics{}
233+
226234
for _, arg := range flag.Args() {
227235
if arg == "./..." {
228236
baseDirectory, err := os.Getwd()
@@ -238,7 +246,7 @@ func main() {
238246
log.Printf("Skipping %s\n", path)
239247
return filepath.SkipDir
240248
}
241-
newIssues, err := analyzePackage(path, config, logger)
249+
newIssues, err := analyzePackage(path, metrics, config, logger)
242250
if err != nil {
243251
log.Println(err)
244252
} else {
@@ -248,7 +256,7 @@ func main() {
248256
return nil
249257
})
250258
} else {
251-
newIssues, err := analyzePackage(arg, config, logger)
259+
newIssues, err := analyzePackage(arg, metrics, config, logger)
252260
if err != nil {
253261
log.Fatal(err)
254262
}
@@ -262,25 +270,17 @@ func main() {
262270
os.Exit(0)
263271
}
264272

265-
// TODO(gm) - Report output is borken...
266-
/*
267-
for _, issue := range issues {
268-
log.Println(issue)
273+
// Create output report
274+
if *flagOutput != "" {
275+
outfile, err := os.Create(*flagOutput)
276+
if err != nil {
277+
logger.Fatalf("Couldn't open: %s for writing. Reason - %s", *flagOutput, err)
269278
}
270-
271-
// Create output report
272-
if *flagOutput != "" {
273-
outfile, err := os.Create(*flagOutput)
274-
if err != nil {
275-
logger.Fatalf("Couldn't open: %s for writing. Reason - %s", *flagOutput, err)
276-
}
277-
defer outfile.Close()
278-
output.CreateReport(outfile, *flagFormat, &analyzer)
279-
} else {
280-
output.CreateReport(os.Stdout, *flagFormat, &analyzer)
281-
}
282-
283-
*/
279+
defer outfile.Close()
280+
output.CreateReport(outfile, *flagFormat, issues, metrics)
281+
} else {
282+
output.CreateReport(os.Stdout, *flagFormat, issues, metrics)
283+
}
284284

285285
// Do we have an issue? If so exit 1
286286
if issuesFound {

‎output/formatter.go‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,16 @@ Summary:
4848
4949
`
5050

51-
func CreateReport(w io.Writer, format string, data *gas.Analyzer) error {
51+
type reportInfo struct {
52+
Issues []*gas.Issue
53+
Stats *gas.Metrics
54+
}
55+
56+
func CreateReport(w io.Writer, format string, issues []*gas.Issue, metrics *gas.Metrics) error {
57+
data := &reportInfo{
58+
Issues: issues,
59+
Stats: metrics,
60+
}
5261
var err error
5362
switch format {
5463
case "json":
@@ -65,7 +74,7 @@ func CreateReport(w io.Writer, format string, data *gas.Analyzer) error {
6574
return err
6675
}
6776

68-
func reportJSON(w io.Writer, data *gas.Analyzer) error {
77+
func reportJSON(w io.Writer, data *reportInfo) error {
6978
raw, err := json.MarshalIndent(data, "", "\t")
7079
if err != nil {
7180
panic(err)
@@ -78,7 +87,7 @@ func reportJSON(w io.Writer, data *gas.Analyzer) error {
7887
return err
7988
}
8089

81-
func reportCSV(w io.Writer, data *gas.Analyzer) error {
90+
func reportCSV(w io.Writer, data *reportInfo) error {
8291
out := csv.NewWriter(w)
8392
defer out.Flush()
8493
for _, issue := range data.Issues {
@@ -97,7 +106,7 @@ func reportCSV(w io.Writer, data *gas.Analyzer) error {
97106
return nil
98107
}
99108

100-
func reportFromPlaintextTemplate(w io.Writer, reportTemplate string, data *gas.Analyzer) error {
109+
func reportFromPlaintextTemplate(w io.Writer, reportTemplate string, data *reportInfo) error {
101110
t, e := plainTemplate.New("gas").Parse(reportTemplate)
102111
if e != nil {
103112
return e
@@ -106,7 +115,7 @@ func reportFromPlaintextTemplate(w io.Writer, reportTemplate string, data *gas.A
106115
return t.Execute(w, data)
107116
}
108117

109-
func reportFromHTMLTemplate(w io.Writer, reportTemplate string, data *gas.Analyzer) error {
118+
func reportFromHTMLTemplate(w io.Writer, reportTemplate string, data *reportInfo) error {
110119
t, e := htmlTemplate.New("gas").Parse(reportTemplate)
111120
if e != nil {
112121
return e

0 commit comments

Comments
 (0)