diff --git a/meta/forbidden_words_test.go b/meta/forbidden_words_test.go new file mode 100644 index 000000000..4323a4cfe --- /dev/null +++ b/meta/forbidden_words_test.go @@ -0,0 +1,52 @@ +// Copyright (C) 2021 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/. + +package meta + +import ( + "bytes" + "os" + "path/filepath" + "strings" + "testing" +) + +// Checks for forbidden words in all .go files +func TestForbiddenWords(t *testing.T) { + checkDirs := []string{"../cmd", "../lib", "../test", "../script"} + forbiddenWords := []string{ + `"io/ioutil"`, // deprecated and should not be imported + } + + for _, dir := range checkDirs { + err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error { + if err != nil { + return err + } + if path == ".git" { + return filepath.SkipDir + } + if filepath.Ext(path) != ".go" || strings.HasSuffix(path, ".pb.go") { + return nil + } + + bs, err := os.ReadFile(path) + if err != nil { + return nil + } + + for _, word := range forbiddenWords { + if bytes.Contains(bs, []byte(word)) { + t.Errorf("%s: forbidden word %q", path, word) + } + } + return nil + }) + if err != nil { + t.Fatal(err) + } + } +} diff --git a/meta/gofmt_test.go b/meta/gofmt_test.go index 508ea7096..55cd8714a 100644 --- a/meta/gofmt_test.go +++ b/meta/gofmt_test.go @@ -4,7 +4,6 @@ // 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/. -// Checks for authors that are not mentioned in AUTHORS package meta import ( @@ -17,6 +16,7 @@ import ( var gofmtCheckDirs = []string{".", "../cmd", "../lib", "../test", "../script"} +// Checks that files are properly gofmt:ed. func TestCheckGoFmt(t *testing.T) { for _, dir := range gofmtCheckDirs { err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {