-
Notifications
You must be signed in to change notification settings - Fork 0
/
lscan.go
311 lines (284 loc) · 9.95 KB
/
lscan.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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
// main entry to lscan a Go language source file literal scanner utility
package main
import (
"flag"
"fmt"
"go/scanner"
"go/token"
"io"
"log"
"os"
"regexp"
"strconv"
"strings"
)
/*
Program: lscan.go
Component: dm - demo programs
Language: go
Support: david - nzkiwi1g@gmail.com
Author: David A. Fahey - whome God preserve.
Purpose: To scan a Go language source file literal scanner utility.
History: 14May2021 Initial coding DAF
Notes: Regular expression solver: https://regexr.com/
Golang regexp: https://golang.org/pkg/regexp/
Golang token: https://golang.org/pkg/go/token/
Build and run:
cd .../src/github.com/x0ray/lscan
go mod init github.com/x0ray/lscan
go: creating new go.mod: module github.com/x0ray/lscan
go install ./..
./lscan
Testing:
cd .../src/github.com/x0ray/lscan
go test . -v
Output:
❯ ./lscan -x xxx.go -s yyy.go -list
2021/05/14 02:51:28 WARN index key: '.log.initial.id.not.valid.log' at: xxx.go:70:60 was not added, already occurs at: xxx.go:63:60
2021/05/14 02:51:28 Index file keys from: 'lscan.go' follow
Num Location Matched Literal
0001 lscan.go:65:60 .log.client.extract.failed.log
0002 lscan.go:66:60 .log.file.uri.short.error.log
0003 lscan.go:67:60 .log.uri.prefix.not.valid.log
0004 lscan.go:69:60 .log.name.not.valid.log
0005 lscan.go:71:60 .log.id.not.valid.type.log
0006 lscan.go:63:60 .log.initial.id.not.valid.log
0007 lscan.go:64:60 .log.unmarshal.failed.error.log
0008 lscan.go:72:60 .log.id.not.valid.number.dependencies.log
0009 lscan.go:62:60 .log.expected.status.error.log
0010 lscan.go:68:60 .log.invalid.dependency.ID.log
2021/05/14 02:51:28 Scan file keys from: 'testinput.go' follow
Num Location Matched Literal
0001 testinput.go:5:18+0 .log.expected.status.error.log
0002 testinput.go:5:18+3 .log.uri.prefix.not.valid.log
0003 testinput.go:5:18+4 .log.invalid.dependency.ID.log
0004 testinput.go:5:18+5 .log.name.notvalid.log
0005 testinput.go:5:18+6 .log.initial.id.not.valid.log
0006 testinput.go:5:18+8 .log.id.not.valid.number.dependencies.log
0007 testinput.go:5:18+1 .log.unmarshal.failed.error.log
0008 testinput.go:5:18+2 .log.client.extract.failed.log
0009 testinput.go:5:18+7 .log.id.not.valid.type.log
2021/05/14 02:51:28 WARN index key: '.log.file.uri.short.error.log' at: xxx.go:66:60 not found in scan file: 'yyy.go'
2021/05/14 02:51:28 WARN index key: '.log.name.not.valid.log' at: xxx.go:69:60 not found in scan file: 'yyy.go'
*/
const (
note = `
This command compares selected literal strings between two Go language source
code files. The literals are selected using a regular expression pattern. If
the literal strings from the first file are all found in the second files no
messages are produced and the return code is zero, otherwise a non zero return
code is produced along with messages on stderr.
`
pgm = "LScan"
ver = "0.0.10"
verdate = "16Aug2021"
)
var opt struct {
indexFile string // input Go source file to create literal index from
scanFile string // file to scan for occurrences of index values
indexRx string // regular expression used to identify index file literals
scanRx string // regular expression used to identify scan file literals
debug bool // debug flag
listIndex bool // only list the index
verbose bool // display progress information
version bool // display program version and stop
help bool // display the help text and stop
}
func init() {
// setup flag options
flag.StringVar(&opt.indexFile, "index", "", "Input Go source file to used to create literal index")
flag.StringVar(&opt.indexFile, "x", "", "Alias for -index option")
flag.StringVar(&opt.scanFile, "scan", "", "File to scan for occurrences of index values")
flag.StringVar(&opt.scanFile, "s", "", "Alias for -scan option")
flag.StringVar(&opt.indexRx, "indexrx", `\A\.[a-zA-Z0-9\.]+`, "Regular expression used to identify index file literals")
flag.StringVar(&opt.indexRx, "i", `\A\.[a-zA-Z0-9\.]+`, "Alias for -indexrx option")
flag.StringVar(&opt.scanRx, "scanrx", `\.[a-zA-Z0-9\.]+`, "Regular expression used to identify scan file literals")
flag.StringVar(&opt.scanRx, "c", `\.[a-zA-Z0-9\.]+`, "Alias for -scanrx option")
flag.BoolVar(&opt.debug, "debug", false, "Provide debugging trace output")
flag.BoolVar(&opt.listIndex, "list", false, "List the contents of the index and scan index")
flag.BoolVar(&opt.verbose, "verbose", false, "Display progress information on the log")
flag.BoolVar(&opt.version, "version", false, "Display program version information")
flag.BoolVar(&opt.version, "v", false, "Alias for -version option")
flag.BoolVar(&opt.help, "help", false, "Display program help text")
flag.BoolVar(&opt.help, "h", false, "Alias for -help option")
}
func initOpt() {
opt.indexFile = ""
opt.scanFile = ""
opt.indexRx = ""
opt.scanRx = ""
opt.debug = false
opt.listIndex = false
opt.verbose = false
opt.version = false
opt.help = false
}
func main() {
rc := body()
os.Exit(rc) // us RC outside body to allow lscan_log.go to test body()
}
func body() int {
var (
err error
scanRx *regexp.Regexp
indexRx *regexp.Regexp
file *os.File
inBytes []byte
scnr scanner.Scanner
fset *token.FileSet
tokenFile *token.File
index map[string]string
scan map[string]string
rc int
)
initOpt()
flag.Parse()
if opt.version {
fmt.Printf("Program %s version %s as of %s\n", pgm, ver, verdate)
rc = 0
goto theend
}
if opt.help {
fmt.Printf("Program %s \n", pgm)
fmt.Printf("%s\n", note)
flag.Usage()
rc = 0
goto theend
}
if opt.verbose {
log.Printf("%s started.\n", pgm)
}
indexRx, err = regexp.Compile(opt.indexRx)
if err != nil {
log.Printf("ERROR Invalid option regular expression value: '%s' for -indexrx, %v\n", opt.indexRx, err)
rc = 4
goto theend
}
scanRx, err = regexp.Compile(opt.scanRx)
if err != nil {
log.Printf("ERROR Invalid option regular expression value: '%s' for -scanrx, %v\n", opt.scanRx, err)
rc = 8
goto theend
}
// tokenize index file and create a map of the selected literal tokens
file, err = os.Open(opt.indexFile) // For read access.
if err != nil {
log.Printf("ERROR Open failed for index file: '%s', %v\n", opt.indexFile, err)
rc = 12
goto theend
}
inBytes, err = io.ReadAll(file)
if err != nil {
log.Printf("ERROR Read failed for index file: '%s', %v\n", opt.indexFile, err)
rc = 16
goto theend
}
file.Close()
index = make(map[string]string)
fset = token.NewFileSet() // positions are relative to fset
tokenFile = fset.AddFile(opt.indexFile, fset.Base(), len(inBytes)) // register input "file"
scnr.Init(tokenFile, inBytes, nil /* no error handler */, scanner.ScanComments)
if opt.debug {
log.Printf("Token stream from index file: '%s' follows\n", opt.indexFile)
log.Printf("Location\tToken\tValue\n")
}
for {
// Repeated calls to Scan yield the token sequence found in the input.
pos, tok, lit := scnr.Scan()
if tok == token.EOF {
break
}
if opt.debug {
log.Printf("%s\t%s\t%s\n", fset.Position(pos), tok, lit)
}
if tok == token.STRING {
lit = strings.Trim(lit, "\"") // strip "" of literal tokens
if matched := indexRx.MatchString(lit); matched {
posn := fset.Position(pos).String()
if ep, ok := index[lit]; ok { // check already there == duplicate
log.Printf("WARN Key: '%s' Loc: %s already indexed. Not adding new key Loc: %s \n",
lit, posn, ep)
rc = 1
} else {
index[lit] = posn
}
}
}
}
// optionally list out the map of literals found in the index file
if opt.listIndex {
log.Printf("Index file keys from: '%s' follow\n", opt.indexFile)
fmt.Printf("Num\tLocation\tMatched Literal\n")
i := 0
for k, v := range index {
i++
fmt.Printf("%04d\t%s\t%s\n", i, v, k)
}
}
// optionally tokenize scan scan file and create a map of the selected literal tokens
if opt.scanFile != "" {
file, err = os.Open(opt.scanFile) // For read access.
if err != nil {
log.Printf("ERROR Open failed for scan file: '%s', %v\n", opt.scanFile, err)
rc = 20
goto theend
}
inBytes, err = io.ReadAll(file)
if err != nil {
log.Printf("ERROR Read failed for scan file: '%s', %v\n", opt.scanFile, err)
rc = 24
goto theend
}
file.Close()
scan = make(map[string]string)
fset = token.NewFileSet() // positions are relative to fset
tokenFile = fset.AddFile(opt.scanFile, fset.Base(), len(inBytes)) // register input "file"
scnr.Init(tokenFile, inBytes, nil /* no error handler */, scanner.ScanComments)
// Repeated calls to Scan yield the token sequence found in the input.
if opt.debug {
log.Printf("Token stream from scan file: '%s' follows\n", opt.scanFile)
log.Printf("Location\tToken\tValue\n")
}
for {
pos, tok, lit := scnr.Scan()
if tok == token.EOF {
break
}
if opt.debug {
log.Printf("%s\t%s\t%s\n", fset.Position(pos), tok, lit)
}
if tok == token.STRING {
lit = strings.Trim(lit, "\"")
if matched := scanRx.MatchString(lit); matched {
// check literal to determine if it has multiple matches
all := scanRx.FindAllString(lit, -1)
for i, v := range all {
scan[v] = fset.Position(pos).String() + "+" + strconv.Itoa(i)
}
}
}
}
// optionally list out the map of literals found in the scan file
if opt.listIndex {
log.Printf("Scan file keys from: '%s' follow\n", opt.scanFile)
fmt.Printf("Num\tLocation\tMatched Literal\n")
i := 0
for k, v := range scan {
i++
fmt.Printf("%04d\t%s\t%s\n", i, v, k)
}
}
// check scan file contains all values from index file
for k, v := range index {
if _, ok := scan[k]; !ok {
log.Printf("WARN Key: '%s' Loc: %s not found in scan file: '%s'\n", k, v, opt.scanFile)
rc = 2
}
}
}
theend:
if opt.verbose {
log.Printf("%s ended.\n", pgm)
}
return rc
}