go/revive
1
0
Fork 0
mirror of https://github.com/mgechev/revive.git synced 2024-11-24 08:32:22 +02:00
Code Issues Releases Activity

Fixes issue #619 imports-blacklist support regex (#684)

Browse Source 
* Fixes issue #619 imports-blacklist support regex

* refactors method name and error message

* restores original test cases

Co-authored-by: chavacava <salvadorcavadini+github@gmail.com>
This commit is contained in:
Yudai Takada 2022-04-21 23:04:00 +09:00 committed by GitHub
parent a67ecdd7ba
commit e10678fea5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 55 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
RULES_DESCRIPTIONS.md
View File

@ -432,13 +432,13 @@ _Configuration_: N/A
_Description_: Warns when importing black-listed packages.
_Configuration_: black-list of package names
_Configuration_: black-list of package names (or regular expression package names).
Example:
```toml
[imports-blacklist]
arguments =["crypto/md5", "crypto/sha1"]
arguments =["crypto/md5", "crypto/sha1", "crypto/**/pkix"]
```
## import-shadowing

29
rule/imports-blacklist.go
View File

@ -2,6 +2,7 @@ package rule
import (
"fmt"
"regexp"
"sync"
"github.com/mgechev/revive/lint"
@ -9,28 +10,40 @@ import (
// ImportsBlacklistRule lints given else constructs.
type ImportsBlacklistRule struct {
blacklist map[string]bool
blacklist []*regexp.Regexp
sync.Mutex
}
var replaceRegexp = regexp.MustCompile(`/?\*\*/?`)
func (r *ImportsBlacklistRule) configure(arguments lint.Arguments) {
r.Lock()
defer r.Unlock()
if r.blacklist == nil {
r.blacklist = make(map[string]bool, len(arguments))
r.blacklist = make([]*regexp.Regexp, 0)
for _, arg := range arguments {
argStr, ok := arg.(string)
if !ok {
panic(fmt.Sprintf("Invalid argument to the imports-blacklist rule. Expecting a string, got %T", arg))
}
// we add quotes if not present, because when parsed, the value of the AST node, will be quoted
if len(argStr) > 2 && argStr[0] != '"' && argStr[len(argStr)-1] != '"' {
argStr = fmt.Sprintf(`%q`, argStr)
regStr, err := regexp.Compile(fmt.Sprintf(`(?m)"%s"$`, replaceRegexp.ReplaceAllString(argStr, `(\W|\w)*`)))
if err != nil {
panic(fmt.Sprintf("Invalid argument to the imports-blacklist rule. Expecting %q to be a valid regular expression, got: %v", argStr, err))
}
r.blacklist[argStr] = true
r.blacklist = append(r.blacklist, regStr)
}
}
r.Unlock()
}
func (r *ImportsBlacklistRule) isBlacklisted(path string) bool {
for _, regex := range r.blacklist {
if regex.MatchString(path) {
return true
}
}
return false
}
// Apply applies the rule to given file.
@ -45,7 +58,7 @@ func (r *ImportsBlacklistRule) Apply(file *lint.File, arguments lint.Arguments)
for _, is := range file.AST.Imports {
path := is.Path
if path != nil && r.blacklist[path.Value] {
if path != nil && r.isBlacklisted(path.Value) {
failures = append(failures, lint.Failure{
Confidence: 1,
Failure: "should not use the following blacklisted import: " + path.Value,

12
test/import-blacklist_test.go
View File

@ -7,16 +7,24 @@ import (
"github.com/mgechev/revive/rule"
)
func TestImportsBlacklist(t *testing.T) {
func TestImportsBlacklistOriginal(t *testing.T) {
args := []interface{}{"crypto/md5", "crypto/sha1"}
testRule(t, "imports-blacklist-original", &rule.ImportsBlacklistRule{}, &lint.RuleConfig{
Arguments: args,
})
}
func TestImportsBlacklist(t *testing.T) {
args := []interface{}{"github.com/full/match", "wildcard/**/between", "wildcard/backward/**", "**/wildcard/forward", "full"}
testRule(t, "imports-blacklist", &rule.ImportsBlacklistRule{}, &lint.RuleConfig{
Arguments: args,
})
}
func BenchmarkImportsBlacklist(b *testing.B) {
args := []interface{}{"crypto/md5", "crypto/sha1"}
args := []interface{}{"github.com/full/match", "wildcard/**/between", "wildcard/backward/**", "**/wildcard/forward", "full"}
var t *testing.T
for i := 0; i <= b.N; i++ {
testRule(t, "imports-blacklist", &rule.ImportsBlacklistRule{}, &lint.RuleConfig{

8
testdata/imports-blacklist-original.go vendored Normal file
View File

@ -0,0 +1,8 @@
package fixtures
import (
"crypto/md5" // MATCH /should not use the following blacklisted import: "crypto/md5"/
"crypto/sha1" // MATCH /should not use the following blacklisted import: "crypto/sha1"/
"strings"
)

16
testdata/imports-blacklist.go vendored
View File

@ -1,7 +1,19 @@
package fixtures
import (
"crypto/md5" // MATCH /should not use the following blacklisted import: "crypto/md5"/
"crypto/sha1" // MATCH /should not use the following blacklisted import: "crypto/sha1"/
"github.com/full/match" // MATCH /should not use the following blacklisted import: "github.com/full/match"/
"bithub.com/full/match"
"github.com/full/matche"
"wildcard/between" // MATCH /should not use the following blacklisted import: "wildcard/between"/
"wildcard/pkg1/between" // MATCH /should not use the following blacklisted import: "wildcard/pkg1/between"/
"wildcard/pkg1/pkg2/between" // MATCH /should not use the following blacklisted import: "wildcard/pkg1/pkg2/between"/
"wildcard/backward" // MATCH /should not use the following blacklisted import: "wildcard/backward"/
"wildcard/backward/pkg" // MATCH /should not use the following blacklisted import: "wildcard/backward/pkg"/
"wildcard/backward/pkg/pkg1" // MATCH /should not use the following blacklisted import: "wildcard/backward/pkg/pkg1"/
"wildcard/forward" // MATCH /should not use the following blacklisted import: "wildcard/forward"/
"pkg/wildcard/forward" // MATCH /should not use the following blacklisted import: "pkg/wildcard/forward"/
"pkg/pkg1/wildcard/forward" // MATCH /should not use the following blacklisted import: "pkg/pkg1/wildcard/forward"/
"full" // MATCH /should not use the following blacklisted import: "full"/
"github.com/partical/match/fully"
"strings"
)