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
|
// Copyright 2019 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package nogo
import (
"encoding/json"
"fmt"
"go/token"
"io/ioutil"
"sort"
)
// Finding is a single finding.
type Finding struct {
Category AnalyzerName
Position token.Position
Message string
}
// String implements fmt.Stringer.String.
func (f *Finding) String() string {
return fmt.Sprintf("%s: %s: %s", f.Category, f.Position.String(), f.Message)
}
// WriteFindingsToFile writes findings to a file.
func WriteFindingsToFile(findings []Finding, filename string) error {
content, err := WriteFindingsToBytes(findings)
if err != nil {
return err
}
return ioutil.WriteFile(filename, content, 0644)
}
// WriteFindingsToBytes serializes findings as bytes.
func WriteFindingsToBytes(findings []Finding) ([]byte, error) {
// N.B. Sort all the findings in order to maximize cacheability.
sort.Slice(findings, func(i, j int) bool {
switch {
case findings[i].Position.Filename < findings[j].Position.Filename:
return true
case findings[i].Position.Filename > findings[j].Position.Filename:
return false
case findings[i].Position.Line < findings[j].Position.Line:
return true
case findings[i].Position.Line > findings[j].Position.Line:
return false
case findings[i].Position.Column < findings[j].Position.Column:
return true
case findings[i].Position.Column > findings[j].Position.Column:
return false
case findings[i].Category < findings[j].Category:
return true
case findings[i].Category > findings[j].Category:
return false
case findings[i].Message < findings[j].Message:
return true
case findings[i].Message > findings[j].Message:
return false
default:
return false
}
})
return json.Marshal(findings)
}
// ExtractFindingsFromFile loads findings from a file.
func ExtractFindingsFromFile(filename string) ([]Finding, error) {
content, err := ioutil.ReadFile(filename)
if err != nil {
return nil, err
}
return ExtractFindingsFromBytes(content)
}
// ExtractFindingsFromBytes loads findings from bytes.
func ExtractFindingsFromBytes(content []byte) (findings []Finding, err error) {
err = json.Unmarshal(content, &findings)
return findings, err
}
|
