Skip to content

Commit

Permalink
Merge pull request #3 from Antonboom/feat/improvements-not-breaking
Browse files Browse the repository at this point in the history 
Feat/improvements not breaking
  • Loading branch information
@ghostiam
ghostiam committed Oct 7, 2023
2 parents f08a8db + 793868d commit 2b140db
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 105 deletions.
16 changes: 5 additions & 11 deletions protogetter.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const (
GolangciLintMode
)

const msgFormat = "avoid direct access to proto field %q use %q"
const msgFormat = "avoid direct access to proto field %s, use %s instead"

func NewAnalyzer() *analysis.Analyzer {
return &analysis.Analyzer{
Expand All @@ -42,10 +42,10 @@ func Run(pass *analysis.Pass, mode Mode) []Issue {
(*ast.UnaryExpr)(nil),
}

// Skip generated files.
// Skip protoc-generated files.
var files []*ast.File
for _, f := range pass.Files {
if !isGeneratedFile(f) {
if !isProtocGeneratedFile(f) {
files = append(files, f)

// ast.Print(pass.Fset, f)
Expand Down Expand Up @@ -168,14 +168,8 @@ func (r *Report) ToIssue(fset *token.FileSet) Issue {
}
}

func isGeneratedFile(f *ast.File) bool {
for _, c := range f.Comments {
if strings.HasPrefix(c.Text(), "Code generated") {
return true
}
}

return false
func isProtocGeneratedFile(f *ast.File) bool {
return len(f.Comments) > 0 && strings.HasPrefix(f.Comments[0].Text(), "// Code generated by protoc-gen-go")
}

func formatNode(node ast.Node) string {
Expand Down
94 changes: 47 additions & 47 deletions testdata/test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,74 +11,74 @@ type Test struct {
}

func testInvalid(t *proto.Test) {
func(...interface{}) {}(t.B, t.D) // want "avoid direct access to proto field" "avoid direct access to proto field"
func(...interface{}) {}(t.GetB(), t.D) // want "avoid direct access to proto field"
func(...interface{}) {}(t.B, t.GetD()) // want "avoid direct access to proto field"

_ = t.D // want "avoid direct access to proto field"
_ = t.F // want "avoid direct access to proto field"
_ = t.I32 // want "avoid direct access to proto field"
_ = t.I64 // want "avoid direct access to proto field"
_ = t.U32 // want "avoid direct access to proto field"
_ = t.U64 // want "avoid direct access to proto field"
_ = t.T // want "avoid direct access to proto field"
_ = t.B // want "avoid direct access to proto field"
_ = t.S // want "avoid direct access to proto field"
_ = t.Embedded // want "avoid direct access to proto field"
_ = t.Embedded.S // want "avoid direct access to proto field"
_ = t.GetEmbedded().S // want "avoid direct access to proto field"
_ = t.Embedded.Embedded // want "avoid direct access to proto field"
_ = t.GetEmbedded().Embedded // want "avoid direct access to proto field"
_ = t.Embedded.Embedded.S // want "avoid direct access to proto field"
_ = t.GetEmbedded().GetEmbedded().S // want "avoid direct access to proto field"
_ = t.RepeatedEmbeddeds // want "avoid direct access to proto field"
_ = t.RepeatedEmbeddeds[0] // want "avoid direct access to proto field"
_ = t.RepeatedEmbeddeds[0].S // want "avoid direct access to proto field"
_ = t.GetRepeatedEmbeddeds()[0].S // want "avoid direct access to proto field"
_ = t.RepeatedEmbeddeds[0].Embedded // want "avoid direct access to proto field"
_ = t.GetRepeatedEmbeddeds()[0].Embedded // want "avoid direct access to proto field"
_ = t.RepeatedEmbeddeds[0].Embedded.S // want "avoid direct access to proto field"
_ = t.GetRepeatedEmbeddeds()[0].GetEmbedded().S // want "avoid direct access to proto field"
_ = t.RepeatedEmbeddeds[t.I64].Embedded.S // want "avoid direct access to proto field"
_ = t.GetRepeatedEmbeddeds()[t.I64].GetEmbedded().S // want "avoid direct access to proto field"
func(...interface{}) {}(t.B, t.D) // want `avoid direct access to proto field t\.B, use t\.GetB\(\) instead` `avoid direct access to proto field t\.D, use t\.GetD\(\) instead`
func(...interface{}) {}(t.GetB(), t.D) // want `avoid direct access to proto field t\.D, use t\.GetD\(\) instead`
func(...interface{}) {}(t.B, t.GetD()) // want `avoid direct access to proto field t\.B, use t\.GetB\(\) instead`

_ = t.D // want `avoid direct access to proto field t\.D, use t\.GetD\(\) instead`
_ = t.F // want `avoid direct access to proto field t\.F, use t\.GetF\(\) instead`
_ = t.I32 // want `avoid direct access to proto field t\.I32, use t\.GetI32\(\) instead`
_ = t.I64 // want `avoid direct access to proto field t\.I64, use t\.GetI64\(\) instead`
_ = t.U32 // want `avoid direct access to proto field t\.U32, use t\.GetU32\(\) instead`
_ = t.U64 // want `avoid direct access to proto field t\.U64, use t\.GetU64\(\) instead`
_ = t.T // want `avoid direct access to proto field t\.T, use t\.GetT\(\) instead`
_ = t.B // want `avoid direct access to proto field t\.B, use t\.GetB\(\) instead`
_ = t.S // want `avoid direct access to proto field t\.S, use t\.GetS\(\) instead`
_ = t.Embedded // want `avoid direct access to proto field t\.Embedded, use t\.GetEmbedded\(\) instead`
_ = t.Embedded.S // want `avoid direct access to proto field t\.Embedded\.S, use t\.GetEmbedded\(\)\.GetS\(\) instead`
_ = t.GetEmbedded().S // want `avoid direct access to proto field t\.GetEmbedded\(\)\.S, use t\.GetEmbedded\(\)\.GetS\(\) instead`
_ = t.Embedded.Embedded // want `avoid direct access to proto field t\.Embedded\.Embedded, use t\.GetEmbedded\(\)\.GetEmbedded\(\) instead`
_ = t.GetEmbedded().Embedded // want `avoid direct access to proto field t\.GetEmbedded\(\)\.Embedded, use t\.GetEmbedded\(\)\.GetEmbedded\(\) instead`
_ = t.Embedded.Embedded.S // want `avoid direct access to proto field t\.Embedded\.Embedded\.S, use t\.GetEmbedded\(\)\.GetEmbedded\(\).GetS\(\) instead`
_ = t.GetEmbedded().GetEmbedded().S // want `avoid direct access to proto field t\.GetEmbedded\(\)\.GetEmbedded\(\)\.S, use t\.GetEmbedded\(\)\.GetEmbedded\(\)\.GetS\(\) instead`
_ = t.RepeatedEmbeddeds // want `avoid direct access to proto field t\.RepeatedEmbeddeds, use t\.GetRepeatedEmbeddeds\(\) instead`
_ = t.RepeatedEmbeddeds[0] // want `avoid direct access to proto field t\.RepeatedEmbeddeds, use t\.GetRepeatedEmbeddeds\(\) instead`
_ = t.RepeatedEmbeddeds[0].S // want `avoid direct access to proto field t\.RepeatedEmbeddeds\[0\]\.S, use t\.GetRepeatedEmbeddeds\(\)\[0\]\.GetS\(\) instead`
_ = t.GetRepeatedEmbeddeds()[0].S // want `avoid direct access to proto field t\.GetRepeatedEmbeddeds\(\)\[0\]\.S, use t\.GetRepeatedEmbeddeds\(\)\[0\]\.GetS\(\) instead`
_ = t.RepeatedEmbeddeds[0].Embedded // want `avoid direct access to proto field t\.RepeatedEmbeddeds\[0\]\.Embedded, use t\.GetRepeatedEmbeddeds\(\)\[0\]\.GetEmbedded\(\) instead`
_ = t.GetRepeatedEmbeddeds()[0].Embedded // want `avoid direct access to proto field t\.GetRepeatedEmbeddeds\(\)\[0\]\.Embedded, use t\.GetRepeatedEmbeddeds\(\)\[0\]\.GetEmbedded\(\) instead`
_ = t.RepeatedEmbeddeds[0].Embedded.S // want `avoid direct access to proto field t\.RepeatedEmbeddeds\[0\]\.Embedded\.S, use t\.GetRepeatedEmbeddeds\(\)\[0\].GetEmbedded\(\).GetS\(\) instead`
_ = t.GetRepeatedEmbeddeds()[0].GetEmbedded().S // want `avoid direct access to proto field t\.GetRepeatedEmbeddeds\(\)\[0\].GetEmbedded\(\).S, use t\.GetRepeatedEmbeddeds\(\)\[0\].GetEmbedded\(\).GetS\(\) instead`
_ = t.RepeatedEmbeddeds[t.I64].Embedded.S // want `avoid direct access to proto field t\.RepeatedEmbeddeds\[t.I64\]\.Embedded\.S, use t\.GetRepeatedEmbeddeds\(\)\[t\.GetI64\(\)\].GetEmbedded\(\).GetS\(\) instead`
_ = t.GetRepeatedEmbeddeds()[t.I64].GetEmbedded().S // want `avoid direct access to proto field t\.GetRepeatedEmbeddeds\(\)\[t\.I64\]\.GetEmbedded\(\)\.S, use t\.GetRepeatedEmbeddeds\(\)\[t\.GetI64\(\)\]\.GetEmbedded\(\).GetS\(\) instead`

var many []*proto.Test
manyIndex := 42

_ = many[0].T // want "avoid direct access to proto field"
_ = many[1].Embedded.S // want "avoid direct access to proto field"
_ = many[2].GetEmbedded().S // want "avoid direct access to proto field"
_ = many[3].Embedded.Embedded.S // want "avoid direct access to proto field"
_ = many[manyIndex].S // want "avoid direct access to proto field"
_ = many[0].T // want `avoid direct access to proto field many\[0\]\.T, use many\[0\]\.GetT\(\) instead`
_ = many[1].Embedded.S // want `avoid direct access to proto field many\[1\]\.Embedded\.S, use many\[1\]\.GetEmbedded\(\)\.GetS\(\) instead`
_ = many[2].GetEmbedded().S // want `avoid direct access to proto field many\[2\]\.GetEmbedded\(\)\.S, use many\[2\].GetEmbedded\(\)\.GetS\(\) instead`
_ = many[3].Embedded.Embedded.S // want `avoid direct access to proto field many\[3\]\.Embedded\.Embedded\.S, use many\[3\].GetEmbedded\(\)\.GetEmbedded\(\)\.GetS\(\) instead`
_ = many[manyIndex].S // want `avoid direct access to proto field many\[manyIndex\]\.S, use many\[manyIndex\]\.GetS\(\) instead`

test := many[0].Embedded.S == "" || t.Embedded.CustomMethod() == nil || t.S == "" || t.Embedded == nil // want "avoid direct access to proto field" "avoid direct access to proto field" "avoid direct access to proto field" "avoid direct access to proto field"
test := many[0].Embedded.S == "" || t.Embedded.CustomMethod() == nil || t.S == "" || t.Embedded == nil // want `avoid direct access to proto field many\[0\]\.Embedded\.S, use many\[0\]\.GetEmbedded\(\).GetS\(\) instead` `avoid direct access to proto field t\.Embedded\.CustomMethod\(\), use t\.GetEmbedded\(\)\.CustomMethod\(\) instead` `avoid direct access to proto field t\.S, use t\.GetS\(\) instead` `avoid direct access to proto field t\.Embedded, use t\.GetEmbedded\(\) instead`
_ = test

other := proto.Other{}
_ = other.MyMethod(nil).S // want "avoid direct access to proto field"
_ = other.MyMethod(nil).S // want `avoid direct access to proto field other\.MyMethod\(nil\)\.S, use other\.MyMethod\(nil\)\.GetS\(\) instead`

ems := t.RepeatedEmbeddeds // want "avoid direct access to proto field"
_ = ems[len(ems)-1].S // want "avoid direct access to proto field"
ems := t.RepeatedEmbeddeds // want `avoid direct access to proto field t\.RepeatedEmbeddeds, use t\.GetRepeatedEmbeddeds\(\) instead`
_ = ems[len(ems)-1].S // want `avoid direct access to proto field ems\[len\(ems\)-1\]\.S, use ems\[len\(ems\)-1\]\.GetS\(\) instead`

ch := make(chan string)
ch <- t.S // want "avoid direct access to proto field"
ch <- t.S // want `avoid direct access to proto field t\.S, use t\.GetS\(\) instead`

for _, v := range t.RepeatedEmbeddeds { // want "avoid direct access to proto field"
for _, v := range t.RepeatedEmbeddeds { // want `avoid direct access to proto field t\.RepeatedEmbeddeds, use t\.GetRepeatedEmbeddeds\(\) instead`
_ = v
}

fn := func(...interface{}) bool { return false }
fn((*proto.Test)(nil).S) // want "avoid direct access to proto field"
fn((*proto.Test)(nil).S) // want `avoid direct access to proto field \(\*proto\.Test\)\(nil\)\.S, use \(\*proto\.Test\)\(nil\)\.GetS\(\) instead`

var ptrs *[]proto.Test
_ = (*ptrs)[42].RepeatedEmbeddeds // want "avoid direct access to proto field"
_ = (*ptrs)[t.I64].RepeatedEmbeddeds // want "avoid direct access to proto field"
_ = (*ptrs)[42].RepeatedEmbeddeds // want `avoid direct access to proto field \(\*ptrs\)\[42\]\.RepeatedEmbeddeds, use \(\*ptrs\)\[42\].GetRepeatedEmbeddeds\(\) instead`
_ = (*ptrs)[t.I64].RepeatedEmbeddeds // want `avoid direct access to proto field \(\*ptrs\)\[t\.I64\]\.RepeatedEmbeddeds, use \(\*ptrs\)\[t\.GetI64\(\)\].GetRepeatedEmbeddeds\(\) instead`

var anyType interface{}
_ = anyType.(*proto.Test).S // want "avoid direct access to proto field"
_ = anyType.(*proto.Test).S // want `avoid direct access to proto field anyType\.\(\*proto\.Test\)\.S, use anyType\.\(\*proto\.Test\)\.GetS\(\) instead`

t.Embedded.SetS("test") // want "avoid direct access to proto field"
t.Embedded.SetMap(map[string]string{"test": "test"}) // want "avoid direct access to proto field"
t.Embedded.SetS("test") // want `avoid direct access to proto field t\.Embedded\.SetS\("test"\), use t\.GetEmbedded\(\)\.SetS\("test"\) instead`
t.Embedded.SetMap(map[string]string{"test": "test"}) // want `avoid direct access to proto field t\.Embedded\.SetMap\(map\[string\]string{"test": "test"}\), use t\.GetEmbedded\(\)\.SetMap\(map\[string\]string{"test": "test"}\) instead`
}

func testValid(t *proto.Test) {
Expand Down
Loading

0 comments on commit 2b140db

Please sign in to comment.