// Copyright (C) 2014 The Syncthing Authors. // // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this file, // You can obtain one at http://mozilla.org/MPL/2.0/. // +build ignore package main import ( "archive/tar" "archive/zip" "bytes" "compress/gzip" "flag" "fmt" "io" "io/ioutil" "log" "os" "os/exec" "os/user" "path/filepath" "regexp" "runtime" "strconv" "strings" "syscall" "text/template" "time" ) var ( versionRe = regexp.MustCompile(`-[0-9]{1,3}-g[0-9a-f]{5,10}`) goarch string goos string noupgrade bool version string goVersion float64 race bool ) type target struct { name string buildPkg string binaryName string archiveFiles []archiveFile debianFiles []archiveFile } type archiveFile struct { src string dst string perm os.FileMode } var targets = map[string]target{ "all": { // Only valid for the "build" and "install" commands as it lacks all // the archive creation stuff. buildPkg: "./cmd/...", }, "syncthing": { // The default target for "build", "install", "tar", "zip", "deb", etc. name: "syncthing", buildPkg: "./cmd/syncthing", binaryName: "syncthing", // .exe will be added automatically for Windows builds archiveFiles: []archiveFile{ {src: "{{binary}}", dst: "{{binary}}", perm: 0755}, {src: "README.md", dst: "README.txt", perm: 0644}, {src: "LICENSE", dst: "LICENSE.txt", perm: 0644}, {src: "AUTHORS", dst: "AUTHORS.txt", perm: 0644}, // All files from etc/ and extra/ added automatically in init(). }, debianFiles: []archiveFile{ {src: "{{binary}}", dst: "deb/usr/bin/{{binary}}", perm: 0755}, {src: "README.md", dst: "deb/usr/share/doc/syncthing/README.txt", perm: 0644}, {src: "LICENSE", dst: "deb/usr/share/doc/syncthing/LICENSE.txt", perm: 0644}, {src: "AUTHORS", dst: "deb/usr/share/doc/syncthing/AUTHORS.txt", perm: 0644}, {src: "man/syncthing.1", dst: "deb/usr/share/man/man1/syncthing.1", perm: 0644}, {src: "man/syncthing-config.5", dst: "deb/usr/share/man/man5/syncthing-config.5", perm: 0644}, {src: "man/syncthing-stignore.5", dst: "deb/usr/share/man/man5/syncthing-stignore.5", perm: 0644}, {src: "man/syncthing-device-ids.7", dst: "deb/usr/share/man/man7/syncthing-device-ids.7", perm: 0644}, {src: "man/syncthing-event-api.7", dst: "deb/usr/share/man/man7/syncthing-event-api.7", perm: 0644}, {src: "man/syncthing-faq.7", dst: "deb/usr/share/man/man7/syncthing-faq.7", perm: 0644}, {src: "man/syncthing-networking.7", dst: "deb/usr/share/man/man7/syncthing-networking.7", perm: 0644}, {src: "man/syncthing-rest-api.7", dst: "deb/usr/share/man/man7/syncthing-rest-api.7", perm: 0644}, {src: "man/syncthing-security.7", dst: "deb/usr/share/man/man7/syncthing-security.7", perm: 0644}, {src: "man/syncthing-versioning.7", dst: "deb/usr/share/man/man7/syncthing-versioning.7", perm: 0644}, {src: "etc/linux-systemd/system/syncthing@.service", dst: "deb/lib/systemd/system/syncthing@.service", perm: 0644}, {src: "etc/linux-systemd/system/syncthing-resume.service", dst: "deb/lib/systemd/system/syncthing-resume.service", perm: 0644}, {src: "etc/linux-systemd/user/syncthing.service", dst: "deb/usr/lib/systemd/user/syncthing.service", perm: 0644}, }, }, } func init() { // The "syncthing" target includes a few more files found in the "etc" // and "extra" dirs. syncthingPkg := targets["syncthing"] for _, file := range listFiles("etc") { syncthingPkg.archiveFiles = append(syncthingPkg.archiveFiles, archiveFile{src: file, dst: file, perm: 0644}) } for _, file := range listFiles("extra") { syncthingPkg.archiveFiles = append(syncthingPkg.archiveFiles, archiveFile{src: file, dst: file, perm: 0644}) } for _, file := range listFiles("extra") { syncthingPkg.debianFiles = append(syncthingPkg.debianFiles, archiveFile{src: file, dst: "deb/usr/share/doc/syncthing/" + filepath.Base(file), perm: 0644}) } targets["syncthing"] = syncthingPkg } const minGoVersion = 1.3 func main() { log.SetOutput(os.Stdout) log.SetFlags(0) if os.Getenv("GOPATH") == "" { setGoPath() } // We use Go 1.5+ vendoring. os.Setenv("GO15VENDOREXPERIMENT", "1") // Set path to $GOPATH/bin:$PATH so that we can for sure find tools we // might have installed during "build.go setup". os.Setenv("PATH", fmt.Sprintf("%s%cbin%c%s", os.Getenv("GOPATH"), os.PathSeparator, os.PathListSeparator, os.Getenv("PATH"))) parseFlags() switch goarch { case "386", "amd64", "arm", "arm64", "ppc64", "ppc64le": break default: log.Printf("Unknown goarch %q; proceed with caution!", goarch) } goVersion, _ = checkRequiredGoVersion() // Invoking build.go with no parameters at all is equivalent to "go run // build.go install all" as that builds everything (incrementally), // which is what you want for maximum error checking during development. if flag.NArg() == 0 { var tags []string if noupgrade { tags = []string{"noupgrade"} } install(targets["all"], tags) vet("cmd", "lib") lint("./cmd/...") lint("./lib/...") return } // Otherwise, with any command given but not a target, the target is // "syncthing". So "go run build.go install" is "go run build.go install // syncthing" etc. targetName := "syncthing" if flag.NArg() > 1 { targetName = flag.Arg(1) } target, ok := targets[targetName] if !ok { log.Fatalln("Unknown target", target) } cmd := flag.Arg(0) switch cmd { case "setup": setup() case "install": var tags []string if noupgrade { tags = []string{"noupgrade"} } install(target, tags) case "build": var tags []string if noupgrade { tags = []string{"noupgrade"} } build(target, tags) case "test": test("./lib/...", "./cmd/...") case "bench": bench("./lib/...", "./cmd/...") case "assets": rebuildAssets() case "xdr": xdr() case "translate": translate() case "transifex": transifex() case "tar": buildTar(target) case "zip": buildZip(target) case "deb": buildDeb(target) case "clean": clean() case "vet": vet("build.go") vet("cmd", "lib") case "lint": lint(".") lint("./cmd/...") lint("./lib/...") if isGometalinterInstalled() { dirs := []string{".", "./cmd/...", "./lib/..."} gometalinter("deadcode", dirs, "test/util.go") gometalinter("structcheck", dirs) gometalinter("varcheck", dirs) } default: log.Fatalf("Unknown command %q", cmd) } } // setGoPath sets GOPATH correctly with the assumption that we are // in $GOPATH/src/github.com/syncthing/syncthing. func setGoPath() { cwd, err := os.Getwd() if err != nil { log.Fatal(err) } gopath := filepath.Clean(filepath.Join(cwd, "../../../../")) log.Println("GOPATH is", gopath) os.Setenv("GOPATH", gopath) } func parseFlags() { flag.StringVar(&goarch, "goarch", runtime.GOARCH, "GOARCH") flag.StringVar(&goos, "goos", runtime.GOOS, "GOOS") flag.BoolVar(&noupgrade, "no-upgrade", noupgrade, "Disable upgrade functionality") flag.StringVar(&version, "version", getVersion(), "Set compiled in version string") flag.BoolVar(&race, "race", race, "Use race detector") flag.Parse() } func checkRequiredGoVersion() (float64, bool) { re := regexp.MustCompile(`go(\d+\.\d+)`) ver := runtime.Version() if m := re.FindStringSubmatch(ver); len(m) == 2 { vs := string(m[1]) // This is a standard go build. Verify that it's new enough. f, err := strconv.ParseFloat(vs, 64) if err != nil { log.Printf("*** Couldn't parse Go version out of %q.\n*** This isn't known to work, proceed on your own risk.", vs) return 0, false } if f < 1.5 { log.Printf("*** Go version %.01f doesn't support the vendoring mechanism.\n*** Ensure correct dependencies in your $GOPATH.", f) } else if f < minGoVersion { log.Fatalf("*** Go version %.01f is less than required %.01f.\n*** This is known not to work, not proceeding.", f, minGoVersion) } return f, true } log.Printf("*** Unknown Go version %q.\n*** This isn't known to work, proceed on your own risk.", ver) return 0, false } func setup() { runPrint("go", "get", "-v", "golang.org/x/tools/cmd/cover") runPrint("go", "get", "-v", "golang.org/x/net/html") runPrint("go", "get", "-v", "github.com/FiloSottile/gvt") runPrint("go", "get", "-v", "github.com/axw/gocov/gocov") runPrint("go", "get", "-v", "github.com/AlekSi/gocov-xml") runPrint("go", "get", "-v", "bitbucket.org/tebeka/go2xunit") runPrint("go", "get", "-v", "github.com/alecthomas/gometalinter") } func test(pkgs ...string) { lazyRebuildAssets() useRace := runtime.GOARCH == "amd64" switch runtime.GOOS { case "darwin", "linux", "freebsd", "windows": default: useRace = false } if useRace { runPrint("go", append([]string{"test", "-short", "-race", "-timeout", "60s"}, pkgs...)...) } else { runPrint("go", append([]string{"test", "-short", "-timeout", "60s"}, pkgs...)...) } } func bench(pkgs ...string) { lazyRebuildAssets() runPrint("go", append([]string{"test", "-run", "NONE", "-bench", "."}, pkgs...)...) } func install(target target, tags []string) { lazyRebuildAssets() cwd, err := os.Getwd() if err != nil { log.Fatal(err) } os.Setenv("GOBIN", filepath.Join(cwd, "bin")) args := []string{"install", "-v", "-ldflags", ldflags()} if len(tags) > 0 { args = append(args, "-tags", strings.Join(tags, ",")) } if race { args = append(args, "-race") } args = append(args, target.buildPkg) os.Setenv("GOOS", goos) os.Setenv("GOARCH", goarch) runPrint("go", args...) } func build(target target, tags []string) { lazyRebuildAssets() rmr(target.binaryName) args := []string{"build", "-i", "-v", "-ldflags", ldflags()} if len(tags) > 0 { args = append(args, "-tags", strings.Join(tags, ",")) } if race { args = append(args, "-race") } args = append(args, target.buildPkg) os.Setenv("GOOS", goos) os.Setenv("GOARCH", goarch) runPrint("go", args...) } func buildTar(target target) { name := archiveName(target) filename := name + ".tar.gz" var tags []string if noupgrade { tags = []string{"noupgrade"} name += "-noupgrade" } build(target, tags) if goos == "darwin" { macosCodesign(target.binaryName) } for i := range target.archiveFiles { target.archiveFiles[i].src = strings.Replace(target.archiveFiles[i].src, "{{binary}}", target.binaryName, 1) target.archiveFiles[i].dst = strings.Replace(target.archiveFiles[i].dst, "{{binary}}", target.binaryName, 1) target.archiveFiles[i].dst = name + "/" + target.archiveFiles[i].dst } tarGz(filename, target.archiveFiles) log.Println(filename) } func buildZip(target target) { target.binaryName += ".exe" name := archiveName(target) filename := name + ".zip" var tags []string if noupgrade { tags = []string{"noupgrade"} name += "-noupgrade" } build(target, tags) for i := range target.archiveFiles { target.archiveFiles[i].src = strings.Replace(target.archiveFiles[i].src, "{{binary}}", target.binaryName, 1) target.archiveFiles[i].dst = strings.Replace(target.archiveFiles[i].dst, "{{binary}}", target.binaryName, 1) target.archiveFiles[i].dst = name + "/" + target.archiveFiles[i].dst } zipFile(filename, target.archiveFiles) log.Println(filename) } func buildDeb(target target) { os.RemoveAll("deb") // "goarch" here is set to whatever the Debian packages expect. We correct // "it to what we actually know how to build and keep the Debian variant // "name in "debarch". debarch := goarch switch goarch { case "i386": goarch = "386" case "armel", "armhf": goarch = "arm" } build(target, []string{"noupgrade"}) for i := range target.debianFiles { target.debianFiles[i].src = strings.Replace(target.debianFiles[i].src, "{{binary}}", target.binaryName, 1) target.debianFiles[i].dst = strings.Replace(target.debianFiles[i].dst, "{{binary}}", target.binaryName, 1) } for _, af := range target.debianFiles { if err := copyFile(af.src, af.dst, af.perm); err != nil { log.Fatal(err) } } os.MkdirAll("deb/DEBIAN", 0755) data := map[string]string{ "name": target.name, "arch": debarch, "version": version[1:], "date": time.Now().Format(time.RFC1123), } debTemplateFiles := append(listFiles("debtpl/common"), listFiles("debtpl/"+target.name)...) for _, file := range debTemplateFiles { tpl, err := template.New(filepath.Base(file)).ParseFiles(file) if err != nil { log.Fatal(err) } outFile := filepath.Join("deb/DEBIAN", filepath.Base(file)) out, err := os.Create(outFile) if err != nil { log.Fatal(err) } if err := tpl.Execute(out, data); err != nil { log.Fatal(err) } if err := out.Close(); err != nil { log.Fatal(err) } info, _ := os.Lstat(file) os.Chmod(outFile, info.Mode()) } } func copyFile(src, dst string, perm os.FileMode) error { dstDir := filepath.Dir(dst) os.MkdirAll(dstDir, 0755) // ignore error srcFd, err := os.Open(src) if err != nil { return err } defer srcFd.Close() dstFd, err := os.OpenFile(dst, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, perm) if err != nil { return err } defer dstFd.Close() _, err = io.Copy(dstFd, srcFd) return err } func listFiles(dir string) []string { var res []string filepath.Walk(dir, func(path string, fi os.FileInfo, err error) error { if err != nil { return err } if fi.Mode().IsRegular() { res = append(res, path) } return nil }) return res } func rebuildAssets() { runPipe("lib/auto/gui.files.go", "go", "run", "script/genassets.go", "gui") } func lazyRebuildAssets() { if shouldRebuildAssets() { rebuildAssets() } } func shouldRebuildAssets() bool { info, err := os.Stat("lib/auto/gui.files.go") if err != nil { // If the file doesn't exist, we must rebuild it return true } // Check if any of the files in gui/ are newer than the asset file. If // so we should rebuild it. currentBuild := info.ModTime() assetsAreNewer := false filepath.Walk("gui", func(path string, info os.FileInfo, err error) error { if err != nil { return err } if assetsAreNewer { return nil } assetsAreNewer = info.ModTime().After(currentBuild) return nil }) return assetsAreNewer } func xdr() { runPrint("go", "generate", "./lib/discover", "./lib/db", "./lib/protocol", "./lib/relay/protocol") } func translate() { os.Chdir("gui/default/assets/lang") runPipe("lang-en-new.json", "go", "run", "../../../../script/translate.go", "lang-en.json", "../../../") os.Remove("lang-en.json") err := os.Rename("lang-en-new.json", "lang-en.json") if err != nil { log.Fatal(err) } os.Chdir("../../../..") } func transifex() { os.Chdir("gui/default/assets/lang") runPrint("go", "run", "../../../../script/transifexdl.go") } func clean() { rmr("bin") rmr(filepath.Join(os.Getenv("GOPATH"), fmt.Sprintf("pkg/%s_%s/github.com/syncthing", goos, goarch))) } func ldflags() string { sep := '=' if goVersion > 0 && goVersion < 1.5 { sep = ' ' } b := new(bytes.Buffer) b.WriteString("-w") fmt.Fprintf(b, " -X main.Version%c%s", sep, version) fmt.Fprintf(b, " -X main.BuildStamp%c%d", sep, buildStamp()) fmt.Fprintf(b, " -X main.BuildUser%c%s", sep, buildUser()) fmt.Fprintf(b, " -X main.BuildHost%c%s", sep, buildHost()) return b.String() } func rmr(paths ...string) { for _, path := range paths { log.Println("rm -r", path) os.RemoveAll(path) } } func getReleaseVersion() (string, error) { fd, err := os.Open("RELEASE") if err != nil { return "", err } defer fd.Close() bs, err := ioutil.ReadAll(fd) if err != nil { return "", err } return string(bytes.TrimSpace(bs)), nil } func getGitVersion() (string, error) { v, err := runError("git", "describe", "--always", "--dirty") if err != nil { return "", err } v = versionRe.ReplaceAllFunc(v, func(s []byte) []byte { s[0] = '+' return s }) return string(v), nil } func getVersion() string { // First try for a RELEASE file, if ver, err := getReleaseVersion(); err == nil { return ver } // ... then see if we have a Git tag. if ver, err := getGitVersion(); err == nil { if strings.Contains(ver, "-") { // The version already contains a hash and stuff. See if we can // find a current branch name to tack onto it as well. return ver + getBranchSuffix() } return ver } // This seems to be a dev build. return "unknown-dev" } func getBranchSuffix() string { bs, err := runError("git", "branch", "-a", "--contains") if err != nil { return "" } branches := strings.Split(string(bs), "\n") if len(branches) == 0 { return "" } branch := "" for i, candidate := range branches { if strings.HasPrefix(candidate, "*") { // This is the current branch. Select it! branch = strings.TrimLeft(candidate, " \t*") break } else if i == 0 { // Otherwise the first branch in the list will do. branch = strings.TrimSpace(branch) } } if branch == "" { return "" } // The branch name may be on the form "remotes/origin/foo" from which we // just want "foo". parts := strings.Split(branch, "/") if len(parts) == 0 || len(parts[len(parts)-1]) == 0 { return "" } branch = parts[len(parts)-1] if branch == "master" { // master builds are the default. return "" } validBranchRe := regexp.MustCompile(`^[a-zA-Z0-9_.-]+$`) if !validBranchRe.MatchString(branch) { // There's some odd stuff in the branch name. Better skip it. return "" } return "-" + branch } func buildStamp() int64 { bs, err := runError("git", "show", "-s", "--format=%ct") if err != nil { return time.Now().Unix() } s, _ := strconv.ParseInt(string(bs), 10, 64) return s } func buildUser() string { u, err := user.Current() if err != nil { return "unknown-user" } return strings.Replace(u.Username, " ", "-", -1) } func buildHost() string { h, err := os.Hostname() if err != nil { return "unknown-host" } return h } func buildArch() string { os := goos if os == "darwin" { os = "macosx" } return fmt.Sprintf("%s-%s", os, goarch) } func archiveName(target target) string { return fmt.Sprintf("%s-%s-%s", target.name, buildArch(), version) } func runError(cmd string, args ...string) ([]byte, error) { ecmd := exec.Command(cmd, args...) bs, err := ecmd.CombinedOutput() return bytes.TrimSpace(bs), err } func runPrint(cmd string, args ...string) { log.Println(cmd, strings.Join(args, " ")) ecmd := exec.Command(cmd, args...) ecmd.Stdout = os.Stdout ecmd.Stderr = os.Stderr err := ecmd.Run() if err != nil { log.Fatal(err) } } func runPipe(file, cmd string, args ...string) { log.Println(cmd, strings.Join(args, " "), ">", file) fd, err := os.Create(file) if err != nil { log.Fatal(err) } ecmd := exec.Command(cmd, args...) ecmd.Stdout = fd ecmd.Stderr = os.Stderr err = ecmd.Run() if err != nil { log.Fatal(err) } fd.Close() } func tarGz(out string, files []archiveFile) { fd, err := os.Create(out) if err != nil { log.Fatal(err) } gw := gzip.NewWriter(fd) tw := tar.NewWriter(gw) for _, f := range files { sf, err := os.Open(f.src) if err != nil { log.Fatal(err) } info, err := sf.Stat() if err != nil { log.Fatal(err) } h := &tar.Header{ Name: f.dst, Size: info.Size(), Mode: int64(info.Mode()), ModTime: info.ModTime(), } err = tw.WriteHeader(h) if err != nil { log.Fatal(err) } _, err = io.Copy(tw, sf) if err != nil { log.Fatal(err) } sf.Close() } err = tw.Close() if err != nil { log.Fatal(err) } err = gw.Close() if err != nil { log.Fatal(err) } err = fd.Close() if err != nil { log.Fatal(err) } } func zipFile(out string, files []archiveFile) { fd, err := os.Create(out) if err != nil { log.Fatal(err) } zw := zip.NewWriter(fd) for _, f := range files { sf, err := os.Open(f.src) if err != nil { log.Fatal(err) } info, err := sf.Stat() if err != nil { log.Fatal(err) } fh, err := zip.FileInfoHeader(info) if err != nil { log.Fatal(err) } fh.Name = f.dst fh.Method = zip.Deflate if strings.HasSuffix(f.dst, ".txt") { // Text file. Read it and convert line endings. bs, err := ioutil.ReadAll(sf) if err != nil { log.Fatal(err) } bs = bytes.Replace(bs, []byte{'\n'}, []byte{'\n', '\r'}, -1) fh.UncompressedSize = uint32(len(bs)) fh.UncompressedSize64 = uint64(len(bs)) of, err := zw.CreateHeader(fh) if err != nil { log.Fatal(err) } of.Write(bs) } else { // Binary file. Copy verbatim. of, err := zw.CreateHeader(fh) if err != nil { log.Fatal(err) } _, err = io.Copy(of, sf) if err != nil { log.Fatal(err) } } } err = zw.Close() if err != nil { log.Fatal(err) } err = fd.Close() if err != nil { log.Fatal(err) } } func vet(dirs ...string) { params := []string{"tool", "vet", "-all"} params = append(params, dirs...) bs, err := runError("go", params...) if len(bs) > 0 { log.Printf("%s", bs) } if err != nil { if exitStatus(err) == 3 { // Exit code 3, the "vet" tool is not installed return } // A genuine error exit from the vet tool. log.Fatal(err) } } func lint(pkg string) { bs, err := runError("golint", pkg) if err != nil { log.Println(`- No golint, not linting. Try "go get -u github.com/golang/lint/golint".`) return } analCommentPolicy := regexp.MustCompile(`exported (function|method|const|type|var) [^\s]+ should have comment`) for _, line := range bytes.Split(bs, []byte("\n")) { if analCommentPolicy.Match(line) { continue } if len(line) > 0 { log.Printf("%s", line) } } } func macosCodesign(file string) { if pass := os.Getenv("CODESIGN_KEYCHAIN_PASS"); pass != "" { bs, err := runError("security", "unlock-keychain", "-p", pass) if err != nil { log.Println("Codesign: unlocking keychain failed:", string(bs)) return } } if id := os.Getenv("CODESIGN_IDENTITY"); id != "" { bs, err := runError("codesign", "-s", id, file) if err != nil { log.Println("Codesign: signing failed:", string(bs)) return } log.Println("Codesign: successfully signed", file) } } func exitStatus(err error) int { if err, ok := err.(*exec.ExitError); ok { if ws, ok := err.ProcessState.Sys().(syscall.WaitStatus); ok { return ws.ExitStatus() } } return -1 } func isGometalinterInstalled() bool { if _, err := runError("gometalinter", "--disable-all"); err != nil { log.Println("gometalinter is not installed") return false } return true } func gometalinter(linter string, dirs []string, excludes ...string) { params := []string{"--disable-all"} params = append(params, fmt.Sprintf("--deadline=%ds", 60)) params = append(params, "--enable="+linter) for _, exclude := range excludes { params = append(params, "--exclude="+exclude) } for _, dir := range dirs { params = append(params, dir) } bs, err := runError("gometalinter", params...) if len(bs) > 0 { log.Printf("%s", bs) } if err != nil { log.Printf("%v", err) } }