-
Notifications
You must be signed in to change notification settings - Fork 32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Magefile for easy testing #37
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ | |
| *.dylib | ||
| *.html | ||
| .vscode/* | ||
| .idea/ | ||
|
|
||
| # Test binary, built with `go test -c` | ||
| *.test | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,231 @@ | ||
| //+build mage | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "errors" | ||
| "fmt" | ||
| "io/ioutil" | ||
| "os" | ||
| "path/filepath" | ||
| "runtime" | ||
| "strings" | ||
| "sync" | ||
|
|
||
| "github.com/magefile/mage/mg" | ||
| "github.com/magefile/mage/sh" | ||
| ) | ||
|
|
||
| var ldflags = "" | ||
|
|
||
| // allow user to override go executable by running as GOEXE=xxx make ... on unix-like systems | ||
| var goexe = "go" | ||
|
|
||
| // Build is the default that fmt, vet, runs test and builds | ||
| var Default = Build | ||
|
|
||
| func init() { | ||
| if exe := os.Getenv("GOEXE"); exe != "" { | ||
| goexe = exe | ||
| } | ||
|
|
||
| // We want to use Go 1.11 modules even if the source lives inside GOPATH. | ||
| // The default is "auto". | ||
| os.Setenv("GO111MODULE", "on") | ||
| } | ||
|
|
||
| // Fmt run gofmt linter | ||
| func Fmt() error { | ||
| if !isGoLatest() { | ||
| return nil | ||
| } | ||
| pkgs, err := packages() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| failed := false | ||
| first := true | ||
| for _, pkg := range pkgs { | ||
| files, err := filepath.Glob(filepath.Join(pkg, "*.go")) | ||
| if err != nil { | ||
| return nil | ||
| } | ||
| for _, f := range files { | ||
| // gofmt doesn't exit with non-zero when it finds unformatted code | ||
| // so we have to explicitly look for output, and if we find any, we | ||
| // should fail this target. | ||
| s, err := sh.Output("gofmt", "-l", f) | ||
| if err != nil { | ||
| fmt.Printf("ERROR: running gofmt on %q: %v\n", f, err) | ||
| failed = true | ||
| } | ||
| if s != "" { | ||
| if first { | ||
| fmt.Println("The following files are not gofmt'ed:") | ||
| first = false | ||
| } | ||
| failed = true | ||
| fmt.Println(s) | ||
| } | ||
| } | ||
| } | ||
| if failed { | ||
| return errors.New("improperly formatted go files") | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // Vet run go vet linter | ||
| func Vet() error { | ||
| if err := sh.Run(goexe, "vet", "./..."); err != nil { | ||
| return fmt.Errorf("error running go vet: %v", err) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // Run tests | ||
| func Test() error { | ||
| env := map[string]string{"GOFLAGS": testGoFlags()} | ||
| return runCmd(env, goexe, "test", "./...", buildFlags(), "-tags", buildTags()) | ||
| } | ||
|
|
||
| // TestRace run tests with race detector | ||
| func TestRace() error { | ||
| env := map[string]string{"GOFLAGS": testGoFlags()} | ||
| return runCmd(env, goexe, "test", "-race", "./...", buildFlags(), "-tags", buildTags()) | ||
| } | ||
|
|
||
| // TestCoverHTML generates test coverage report | ||
| func TestCoverHTML() error { | ||
| const ( | ||
| coverAll = "coverage-all.out" | ||
| cover = "coverage.out" | ||
| ) | ||
| f, err := os.Create(coverAll) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer f.Close() | ||
| if _, err := f.Write([]byte("mode: count")); err != nil { | ||
| return err | ||
| } | ||
| pkgs, err := packages() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| for _, pkg := range pkgs { | ||
| if err := sh.Run(goexe, "test", "-coverprofile="+cover, pkg); err != nil { | ||
| return err | ||
| } | ||
| b, err := ioutil.ReadFile(cover) | ||
| if err != nil { | ||
| if os.IsNotExist(err) { | ||
| continue | ||
| } | ||
| return err | ||
| } | ||
| idx := bytes.Index(b, []byte{'\n'}) | ||
| b = b[idx+1:] | ||
| if _, err := f.Write(b); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| if err := f.Close(); err != nil { | ||
| return err | ||
| } | ||
| return sh.Run(goexe, "tool", "cover", "-html="+coverAll) | ||
| } | ||
|
|
||
| // Build run linters, vet and tests | ||
| func Build() error { | ||
| if strings.Contains(runtime.Version(), "1.8") { | ||
| // Go 1.8 doesn't play along with go test ./... and /vendor. | ||
| // We could fix that, but that would take time. | ||
| fmt.Printf("Skip Build on %s\n", runtime.Version()) | ||
| return nil | ||
| } | ||
|
|
||
| // TODO: Add lint after fixing errors | ||
| mg.Deps(Fmt, Vet, TestRace) | ||
| return nil | ||
| } | ||
|
|
||
| var ( | ||
| pkgPrefixLen = len("github.com/grafadruid/go-druid") | ||
| pkgs []string | ||
| pkgsInit sync.Once | ||
| ) | ||
|
|
||
| // testGoFlags returns test flags that need to be set | ||
| func testGoFlags() string { | ||
| return "-v" | ||
| } | ||
|
|
||
| func packages() ([]string, error) { | ||
| var err error | ||
| pkgsInit.Do(func() { | ||
| var s string | ||
| s, err = sh.Output(goexe, "list", "./...") | ||
| if err != nil { | ||
| return | ||
| } | ||
| pkgs = strings.Split(s, "\n") | ||
| for i := range pkgs { | ||
| pkgs[i] = "." + pkgs[i][pkgPrefixLen:] | ||
| } | ||
| }) | ||
| return pkgs, err | ||
| } | ||
|
|
||
| func buildFlags() []string { | ||
| if runtime.GOOS == "windows" { | ||
| return []string{"-buildmode", "exe"} | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func buildTags() string { | ||
| return "none" | ||
| } | ||
|
|
||
| func isGoLatest() bool { | ||
| return strings.Contains(runtime.Version(), "1.14") | ||
| } | ||
|
|
||
| func runCmd(env map[string]string, cmd string, args ...interface{}) error { | ||
| if mg.Verbose() { | ||
| return runWith(env, cmd, args...) | ||
| } | ||
| output, err := sh.OutputWith(env, cmd, argsToStrings(args...)...) | ||
| if err != nil { | ||
| fmt.Fprint(os.Stderr, output) | ||
| } | ||
|
|
||
| return err | ||
| } | ||
|
|
||
| func runWith(env map[string]string, cmd string, inArgs ...interface{}) error { | ||
| s := argsToStrings(inArgs...) | ||
| return sh.RunWith(env, cmd, s...) | ||
| } | ||
|
|
||
| func argsToStrings(v ...interface{}) []string { | ||
| var args []string | ||
| for _, arg := range v { | ||
| switch v := arg.(type) { | ||
| case string: | ||
| if v != "" { | ||
| args = append(args, v) | ||
| } | ||
| case []string: | ||
| if v != nil { | ||
| args = append(args, v...) | ||
| } | ||
| default: | ||
| panic("invalid type") | ||
| } | ||
| } | ||
|
|
||
| return args | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's name
testRaceastestThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
original had both: https://github.com/gohugoio/hugo/blob/master/magefile.go#L188
If we keep all of this, why not keeping both ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
would we ever need to run without race?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's keep both but default target should call
testRace