Check jsontags

Author: theobarberbany

pkg/analysis/nophase/analyzer.go

@@ -5,14 +5,18 @@ import (
 	"go/ast"
 	"strings"
 
+	"github.com/JoelSpeed/kal/pkg/analysis/helpers/extractjsontags"
 	"golang.org/x/tools/go/analysis"
 	"golang.org/x/tools/go/analysis/passes/inspect"
 	"golang.org/x/tools/go/ast/inspector"
 )
 
 const name = "nophase"
 
-var errCouldNotGetInspector = errors.New("could not get inspector")
+var (
+	errCouldNotGetInspector = errors.New("could not get inspector")
+	errCouldNotGetJSONTags  = errors.New("could not get json tags")
+)
 
 // Analyzer is the analyzer for the nophase package.
 // It checks that no struct fields named 'phase', or that contain phase as a
@@ -21,7 +25,7 @@ var Analyzer = &analysis.Analyzer{
 	Name:     name,
 	Doc:      "phase fields are deprecated and conditions should be preferred, avoid phase like enum fields",
 	Run:      run,
-	Requires: []*analysis.Analyzer{inspect.Analyzer},
+	Requires: []*analysis.Analyzer{inspect.Analyzer, extractjsontags.Analyzer},
 }
 
 func run(pass *analysis.Pass) (interface{}, error) {
@@ -30,6 +34,11 @@ func run(pass *analysis.Pass) (interface{}, error) {
 		return nil, errCouldNotGetInspector
 	}
 
+	jsonTags, ok := pass.ResultOf[extractjsontags.Analyzer].(extractjsontags.StructFieldTags)
+	if !ok {
+		return nil, errCouldNotGetJSONTags
+	}
+
 	// Filter to structs so that we can iterate over fields in a struct.
 	nodeFilter := []ast.Node{
 		(*ast.StructType)(nil),
@@ -56,11 +65,25 @@ func run(pass *analysis.Pass) (interface{}, error) {
 
 			fieldName := field.Names[0].Name
 
+			// First check if the struct field name contains 'phase'
 			if strings.Contains(strings.ToLower(fieldName), "phase") {
 				pass.Reportf(field.Pos(),
 					"field %s: phase fields are deprecated and conditions should be preferred, avoid phase like enum fields",
 					fieldName,
 				)
+
+				continue
+			}
+
+			// Then check if the json serialization of the field contains 'phase'
+			tagInfo := jsonTags.FieldTags(sTyp, fieldName)
+
+			if strings.Contains(strings.ToLower(tagInfo.Name), "phase") {
+				pass.Reportf(field.Pos(),
+					"field %s: phase fields are deprecated and conditions should be preferred, avoid phase like enum fields",
+					fieldName,
+				)
+
 			}
 		}
 	})

pkg/analysis/nophase/testdata/src/a/a.go

@@ -11,3 +11,9 @@ type NoSubPhaseTestStruct struct {
 	FooPhase *string `json:"fooPhase,omitempty"` // want "field FooPhase: phase fields are deprecated and conditions should be preferred, avoid phase like enum fields"
 
 }
+
+type SerializedPhaseTeststruct struct {
+	// +optional
+	FooField *string `json:"fooPhase,omitempty"` // want "field FooField: phase fields are deprecated and conditions should be preferred, avoid phase like enum fields"
+
+}

pkg/analysis/registry.go

@@ -52,9 +52,9 @@ func NewRegistry() Registry {
 		initializers: []AnalyzerInitializer{
 			commentstart.Initializer(),
 			jsontags.Initializer(),
+			nophase.Initializer(),
 			optionalorrequired.Initializer(),
 			requiredfields.Initializer(),
-			nophase.Initializer(),
 		},
 	}
 }

pkg/analysis/registry_test.go

@@ -18,9 +18,9 @@ var _ = Describe("Registry", func() {
 			Expect(r.DefaultLinters().UnsortedList()).To(ConsistOf(
 				"commentstart",
 				"jsontags",
+				"nophase",
 				"optionalorrequired",
 				"requiredfields",
-				"nophase",
 			))
 		})
 	})
@@ -31,9 +31,9 @@ var _ = Describe("Registry", func() {
 			Expect(r.AllLinters().UnsortedList()).To(ConsistOf(
 				"commentstart",
 				"jsontags",
+				"nophase",
 				"optionalorrequired",
 				"requiredfields",
-				"nophase",
 			))
 		})
 	})