diff options
author | Jakob Borg <jakob@kastelo.net> | 2017-07-07 20:43:26 +0000 |
---|---|---|
committer | Jakob Borg <jakob@kastelo.net> | 2017-07-07 20:43:26 +0000 |
commit | 200a7fc844895ad4f12cce66bf54deff9583460d (patch) | |
tree | dad2993819130f70b34aa5733a0acf9307009fe3 /script | |
parent | 5a38e0ba3f44143d0eef51724ad44b499a5f0c6d (diff) |
meta: Move metadata checks into meta directory, make them tests
This moves a few things from script/ to a new directory meta/, and makes
them real Go tests. These are the authors, copyright, metalint and gofmt
checks. That means that they can now be run by
go test -v ./meta
and optionally filtered by the usual -run thing to go test. Also -short
will cut down on the metalint stuff and exclude the authors check (which
is slow because it runs git lots of times).
Mainly this makes everything easier on things like build servers where
we can now just run tests instead of do a bunch of scripting.
GitHub-Pull-Request: https://github.com/syncthing/syncthing/pull/4252
Diffstat (limited to 'script')
-rw-r--r-- | script/check-authors.go | 149 | ||||
-rw-r--r-- | script/check-copyright.go | 73 |
2 files changed, 0 insertions, 222 deletions
diff --git a/script/check-authors.go b/script/check-authors.go deleted file mode 100644 index a1b71e672c..0000000000 --- a/script/check-authors.go +++ /dev/null @@ -1,149 +0,0 @@ -// Copyright (C) 2015 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 https://mozilla.org/MPL/2.0/. - -// +build ignore - -// Checks for authors that are not mentioned in AUTHORS -package main - -import ( - "bytes" - "io/ioutil" - "log" - "os" - "os/exec" - "regexp" - "strings" -) - -// list of commits that we don't include in our checks; because they are -// legacy things that don't check code, are committed with incorrect address, -// or for other reasons. -var excludeCommits = stringSetFromStrings([]string{ - "63bd0136fb40a91efaa279cb4b4159d82e8e6904", - "4e2feb6fbc791bb8a2daf0ab8efb10775d66343e", - "f2459ef3319b2f060dbcdacd0c35a1788a94b8bd", - "b61f418bf2d1f7d5a9d7088a20a2a448e5e66801", - "a9339d0627fff439879d157c75077f02c9fac61b", - "254c63763a3ad42fd82259f1767db526cff94a14", - "4b76ec40c07078beaa2c5e250ed7d9bd6276a718", - "32a76901a91ff0f663db6f0830e0aedec946e4d0", - "3626003f680bad3e63677982576d3a05421e88e9", - "342036408e65bd25bb6afbcc705e2e2c013bb01f", - "e37cefdbee1c1cd95ad095b5da6d1252723f103b", - "bcc5d7c00f52552303b463d43a636f27b7f7e19b", -}) - -func init() { - log.SetOutput(os.Stdout) - log.SetFlags(0) -} - -func main() { - actual := actualAuthorEmails("cmd/", "lib/", "gui/", "test/", "script/") - listed := listedAuthorEmails() - missing := actual.except(listed) - if len(missing) > 0 { - log.Println("Missing authors:") - for author := range missing { - log.Println(" ", author) - } - os.Exit(1) - } -} - -// actualAuthorEmails returns the set of author emails found in the actual git -// commit log, except those in excluded commits. -func actualAuthorEmails(paths ...string) stringSet { - args := append([]string{"log", "--format=%H %ae"}, paths...) - cmd := exec.Command("git", args...) - bs, err := cmd.Output() - if err != nil { - log.Fatal("authorEmails:", err) - } - - authors := newStringSet() - for _, line := range bytes.Split(bs, []byte{'\n'}) { - fields := strings.Fields(string(line)) - if len(fields) != 2 { - continue - } - - hash, author := fields[0], fields[1] - if excludeCommits.has(hash) { - continue - } - - if strings.Contains(strings.ToLower(body(hash)), "skip-check: authors") { - continue - } - - authors.add(author) - } - - return authors -} - -// listedAuthorEmails returns the set of author emails mentioned in AUTHORS -func listedAuthorEmails() stringSet { - bs, err := ioutil.ReadFile("AUTHORS") - if err != nil { - log.Fatal("listedAuthorEmails:", err) - } - - emailRe := regexp.MustCompile(`<([^>]+)>`) - matches := emailRe.FindAllStringSubmatch(string(bs), -1) - - authors := newStringSet() - for _, match := range matches { - authors.add(match[1]) - } - return authors -} - -func body(hash string) string { - cmd := exec.Command("git", "show", "--pretty=format:%b", "-s", hash) - bs, err := cmd.Output() - if err != nil { - log.Fatal("body:", err) - } - return string(bs) -} - -// A simple string set type - -type stringSet map[string]struct{} - -func newStringSet() stringSet { - return make(stringSet) -} - -func stringSetFromStrings(ss []string) stringSet { - s := newStringSet() - for _, e := range ss { - s.add(e) - } - return s -} - -func (s stringSet) add(e string) { - s[e] = struct{}{} -} - -func (s stringSet) has(e string) bool { - _, ok := s[e] - return ok -} - -func (s stringSet) except(other stringSet) stringSet { - diff := newStringSet() - for e := range s { - if !other.has(e) { - diff.add(e) - } - } - return diff -} diff --git a/script/check-copyright.go b/script/check-copyright.go deleted file mode 100644 index 056ae41dc0..0000000000 --- a/script/check-copyright.go +++ /dev/null @@ -1,73 +0,0 @@ -// Copyright (C) 2015 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 https://mozilla.org/MPL/2.0/. - -// +build ignore - -// Checks for files missing copyright notice -package main - -import ( - "bufio" - "flag" - "fmt" - "os" - "path/filepath" - "regexp" - "strings" -) - -// File extensions to check -var checkExts = map[string]bool{ - ".go": true, -} - -// Valid copyright headers, searched for in the top five lines in each file. -var copyrightRegexps = []string{ - `Copyright`, - `package auto`, - `automatically generated by genxdr`, - `generated by protoc`, -} - -var copyrightRe = regexp.MustCompile(strings.Join(copyrightRegexps, "|")) - -func main() { - flag.Parse() - for _, dir := range flag.Args() { - err := filepath.Walk(dir, checkCopyright) - if err != nil { - fmt.Println(err) - os.Exit(1) - } - } -} - -func checkCopyright(path string, info os.FileInfo, err error) error { - if err != nil { - return err - } - if !info.Mode().IsRegular() { - return nil - } - if !checkExts[filepath.Ext(path)] { - return nil - } - - fd, err := os.Open(path) - if err != nil { - return err - } - defer fd.Close() - - scanner := bufio.NewScanner(fd) - for i := 0; scanner.Scan() && i < 5; i++ { - if copyrightRe.MatchString(scanner.Text()) { - return nil - } - } - - return fmt.Errorf("Missing copyright in %s?", path) -} |