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
|
// Copyright 2016 CoreOS, Inc.
//
// 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.
// gofail is a tool for enabling/disabling failpoints in go code.
package main
import (
"fmt"
"io"
"os"
"path"
"path/filepath"
"runtime"
"strings"
"go.etcd.io/gofail/code"
)
var (
// Git SHA Value will be set during build
GitSHA = "Not provided (use ./build.sh instead of go build)"
Version = "0.1.0"
)
var usageLine = `Usage:
gofail enable [list of files or directories]
Enable the failpoints
gofail disable [list of files or directories]
Disable the checkpoints
gofail --version
Show the version of gofail`
type xfrmFunc func(io.Writer, io.Reader) ([]*code.Failpoint, error)
func xfrmFile(xfrm xfrmFunc, path string) ([]*code.Failpoint, error) {
src, serr := os.Open(path)
if serr != nil {
return nil, serr
}
defer src.Close()
dst, derr := os.OpenFile(path+".tmp", os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0600)
if derr != nil {
return nil, derr
}
defer dst.Close()
fps, xerr := xfrm(dst, src)
if xerr != nil || len(fps) == 0 {
os.Remove(dst.Name())
return nil, xerr
}
rerr := os.Rename(dst.Name(), path)
if rerr != nil {
os.Remove(dst.Name())
return nil, rerr
}
return fps, nil
}
func dir2files(dir, ext string) (ret []string, err error) {
if dir, err = filepath.Abs(dir); err != nil {
return nil, err
}
f, ferr := os.Open(dir)
if ferr != nil {
return nil, ferr
}
defer f.Close()
names, rerr := f.Readdirnames(0)
if rerr != nil {
return nil, rerr
}
for _, f := range names {
if path.Ext(f) != ext {
continue
}
ret = append(ret, path.Join(dir, f))
}
return ret, nil
}
func paths2files(paths []string) (files []string) {
// no paths => use cwd
if len(paths) == 0 {
wd, gerr := os.Getwd()
if gerr != nil {
fmt.Println(gerr)
os.Exit(1)
}
return paths2files([]string{wd})
}
for _, p := range paths {
s, serr := os.Stat(p)
if serr != nil {
fmt.Println(serr)
os.Exit(1)
}
if s.IsDir() {
fs, err := dir2files(p, ".go")
if err != nil {
fmt.Println(err)
os.Exit(1)
}
files = append(files, fs...)
} else if path.Ext(s.Name()) == ".go" {
abs, err := filepath.Abs(p)
if err != nil {
fmt.Println(err)
os.Exit(1)
}
files = append(files, abs)
}
}
return files
}
func writeBinding(file string, fps []*code.Failpoint) {
if len(fps) == 0 {
return
}
fname := strings.Split(path.Base(file), ".go")[0] + ".fail.go"
out, err := os.Create(path.Join(path.Dir(file), fname))
if err != nil {
fmt.Println(err)
os.Exit(1)
}
// XXX: support "package main"
pkgAbsDir := path.Dir(file)
pkg := path.Base(pkgAbsDir)
code.NewBinding(pkg, fps).Write(out)
out.Close()
}
func main() {
if len(os.Args) < 2 {
fmt.Println(usageLine)
os.Exit(1)
}
var xfrm xfrmFunc
enable := false
switch os.Args[1] {
case "enable":
xfrm = code.ToFailpoints
enable = true
case "disable":
xfrm = code.ToComments
case "--version":
showVersion()
default:
fmt.Println(usageLine)
os.Exit(1)
}
files := paths2files(os.Args[2:])
fps := [][]*code.Failpoint{}
for _, path := range files {
curfps, err := xfrmFile(xfrm, path)
if err != nil {
fmt.Println(err)
os.Exit(1)
}
fps = append(fps, curfps)
}
if enable {
// build runtime bindings <FILE>.fail.go
for i := range files {
writeBinding(files[i], fps[i])
}
} else {
// remove all runtime bindings
for i := range files {
fname := strings.Split(path.Base(files[i]), ".go")[0] + ".fail.go"
os.Remove(path.Join(path.Dir(files[i]), fname))
}
}
}
func showVersion() {
fmt.Println("Git SHA: ", GitSHA)
fmt.Println("Go Version: ", runtime.Version())
fmt.Println("gofail Version: ", Version)
fmt.Printf("Go OS/Arch: %s/%s\n", runtime.GOOS, runtime.GOARCH)
os.Exit(0)
}
|
