/
main.go
322 lines (280 loc) · 7.81 KB
/
main.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
312
313
314
315
316
317
318
319
320
321
322
package main
import (
"flag"
"fmt"
"io/ioutil"
"os"
"os/exec"
"os/signal"
"path/filepath"
"strconv"
"strings"
"syscall"
"github.com/caddyserver/buildsrv/features"
"github.com/caddyserver/caddydev/caddybuild"
"github.com/mholt/custombuild"
)
const (
usage = `Usage: caddydev [options] directive [caddy flags] [go [build flags]]
options:
-s, --source="." Source code directory or go get path.
-a, --after="" Priority. After which directive should our new directive be placed.
-u, --update=false Pull latest caddy source code before building.
-o, --output="" Path to save custom build. If set, the binary will only be generated, not executed.
Set GOOS, GOARCH, GOARM environment variables to generate for other platforms.
-h, --help=false Show this usage.
directive:
directive of the middleware being developed.
caddy flags:
flags to pass to the resulting custom caddy binary.
go build flags:
flags to pass to 'go build' while building custom binary prefixed with 'go'.
go keyword is used to differentiate caddy flags from go build flags.
e.g. go -race -x -v.
`
)
type cliArgs struct {
directive string
after string
source string
output string
update bool
caddyArgs []string
goArgs []string
}
func main() {
// parse cli arguments.
args, err := parseArgs()
exitIfErr(err)
// read config file.
config, err := readConfig(args)
exitIfErr(err)
fetched := false
// if caddy source does not exits, pull source.
if !isLocalPkg(caddybuild.CaddyPackage) {
fmt.Print("Caddy source not found. Fetching...")
err := fetchCaddy()
exitIfErr(err)
fmt.Println(" done.")
fetched = true
}
// if update flag is set, pull source.
if args.update && !fetched {
fmt.Print("Updating caddy source...")
err := fetchCaddy()
exitIfErr(err)
fmt.Println(" done.")
}
caddybuild.SetConfig(config)
var builder custombuild.Builder
var f *os.File
var caddyProcess *os.Process
// remove temp files.
addCleanUpFunc(func() {
if caddyProcess != nil {
caddyProcess.Kill()
}
builder.Teardown()
if f != nil {
os.Remove(f.Name())
}
})
builder, err = caddybuild.PrepareBuild(features.Middlewares{config.Middleware})
exitIfErr(err)
// if output is set, generate binary only.
if args.output != "" {
err := saveCaddy(builder, args.output, args.goArgs)
exitIfErr(err)
return
}
// create temporary file for binary
f, err = ioutil.TempFile("", "caddydev")
exitIfErr(err)
f.Close()
// perform custom build
err = builder.Build("", "", f.Name(), args.goArgs...)
exitIfErr(err)
fmt.Println("Starting caddy...")
// trap os interrupts to ensure cleaning up temp files.
done := trapInterrupts()
// start custom caddy.
go func() {
cmd, err := startCaddy(f.Name(), args.caddyArgs)
exitIfErr(err)
caddyProcess = cmd.Process
err = cmd.Wait()
cleanUp()
exitIfErr(err)
done <- struct{}{}
}()
// wait for exit signal
<-done
}
// parseArgs parses cli arguments. This caters for parsing extra flags to caddy.
func parseArgs() (cliArgs, error) {
args := cliArgs{source: "."}
fs := flag.FlagSet{}
fs.SetOutput(ioutil.Discard)
h := false
fs.StringVar(&args.after, "a", args.after, "")
fs.StringVar(&args.after, "after", args.after, "")
fs.StringVar(&args.source, "s", args.source, "")
fs.StringVar(&args.source, "source", args.source, "")
fs.StringVar(&args.output, "o", args.output, "")
fs.StringVar(&args.output, "output", args.output, "")
fs.BoolVar(&args.update, "u", args.update, "")
fs.BoolVar(&args.update, "update", args.update, "")
fs.BoolVar(&h, "h", h, "")
fs.BoolVar(&h, "help", h, "")
err := fs.Parse(os.Args[1:])
if h || err != nil {
return args, fmt.Errorf(usage)
}
if fs.NArg() < 1 {
return args, usageError(fmt.Errorf("directive not set."))
}
args.directive = fs.Arg(0)
// extract caddy and go args
if fs.NArg() > 1 {
remArgs := fs.Args()[1:]
for i, arg := range remArgs {
if arg == "go" {
if len(remArgs) > i+1 {
args.goArgs = remArgs[i+1:]
}
break
}
args.caddyArgs = append(args.caddyArgs, arg)
}
}
return args, err
}
// readConfig reads configs from the cli arguments.
func readConfig(args cliArgs) (caddybuild.Config, error) {
var config = caddybuild.Config{
Middleware: features.Middleware{Directive: args.directive},
After: args.after,
}
if args.source != "" {
if src := pkgFromDir(args.source); src != "" {
config.Middleware.Package = src
return config, nil
}
}
return config, fmt.Errorf("Invalid source directory.")
}
// pkgFromDir extracts package import path from dir. dir can be a path on file system
// or go get path.
func pkgFromDir(dir string) string {
gopaths := strings.Split(os.Getenv("GOPATH"), string(filepath.ListSeparator))
// if directory exits, infer import path from dir relative to GOPATH.
if stat, err := os.Stat(dir); err == nil && stat.IsDir() {
for _, gopath := range gopaths {
absgopath, _ := filepath.Abs(gopath)
gosrc := filepath.Join(absgopath, "src") + string(filepath.Separator)
absdir, _ := filepath.Abs(dir)
if strings.HasPrefix(absdir, gosrc) {
return strings.TrimPrefix(absdir, gosrc)
}
}
// not in GOPATH, create symlink to fake GOPATH.
if newpath, err := symlinkGOPATH(dir); err == nil {
return filepath.Base(newpath)
}
}
return ""
}
// startCaddy starts custom caddy.
func startCaddy(file string, args []string) (*exec.Cmd, error) {
cmd := exec.Command(file, args...)
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
err := cmd.Run()
return cmd, err
}
func saveCaddy(builder custombuild.Builder, file string, buildArgs []string) error {
goos := os.Getenv("GOOS")
goarch := os.Getenv("GOARCH")
goarm, _ := strconv.Atoi(os.Getenv("GOARM"))
if goarch == "arm" {
return builder.BuildARM(goos, goarm, file, buildArgs...)
}
return builder.Build(goos, goarch, file, buildArgs...)
}
func fetchCaddy() error {
_, err := exec.Command("go", "get", "-u", caddybuild.CaddyPackage).Output()
return err
}
// isLocalPkg takes a go package name and validate if it exists on the filesystem.
func isLocalPkg(p string) bool {
gopaths := strings.Split(os.Getenv("GOPATH"), string(filepath.ListSeparator))
for _, gopath := range gopaths {
absPath := filepath.Join(gopath, "src", p)
if _, err := os.Stat(absPath); err == nil {
return true
}
}
return false
}
// symlinkGOPATH creates a symlink to the source directory in a valid GOPATH.
func symlinkGOPATH(dir string) (string, error) {
var gopath string
var err error
if gopath, err = ioutil.TempDir("", "caddydev"); err != nil {
return "", err
}
src := filepath.Join(gopath, "src")
if err := os.MkdirAll(src, os.FileMode(0700)); err != nil {
return "", err
}
if dir, err = filepath.Abs(dir); err != nil {
return "", err
}
newpath := filepath.Join(src, "caddyaddon")
if err = os.Symlink(dir, newpath); err != nil {
return "", err
}
err = os.Setenv("GOPATH", gopath+string(filepath.ListSeparator)+os.Getenv("GOPATH"))
if err == nil {
addCleanUpFunc(func() {
os.Remove(newpath)
})
}
return newpath, err
}
// trapInterrupts traps OS interrupt signals.
func trapInterrupts() chan struct{} {
done := make(chan struct{})
c := make(chan os.Signal, 1)
signal.Notify(c, os.Interrupt)
signal.Notify(c, syscall.SIGTERM)
go func() {
<-c
fmt.Print("OS Interrupt signal received. Performing cleanup...")
cleanUp()
fmt.Println(" done.")
done <- struct{}{}
}()
return done
}
// cleanUpFuncs is list of functions to call before application exits.
var cleanUpFuncs []func()
// addCleanUpFunc adds a function to cleanUpFuncs.
func addCleanUpFunc(f func()) {
cleanUpFuncs = append(cleanUpFuncs, f)
}
// cleanUp calls all functions in cleanUpFuncs.
func cleanUp() {
for i := range cleanUpFuncs {
cleanUpFuncs[i]()
}
}
func exitIfErr(err error) {
if err != nil {
fmt.Println(err)
os.Exit(1)
}
}
func usageError(err error) error {
return fmt.Errorf("Error: %v\n\n%v", err, usage)
}