tests: add suggested fixes

Author: ldez

tagalign_test.go

@@ -50,11 +50,9 @@ func TestAnalyzer(t *testing.T) {
 
 	for _, test := range testCases {
 		t.Run(test.desc, func(t *testing.T) {
-			t.Parallel()
-
 			a := NewAnalyzer(test.opts...)
 
-			analysistest.Run(t, analysistest.TestData(), a, test.dir)
+			analysistest.RunWithSuggestedFixes(t, analysistest.TestData(), a, test.dir)
 		})
 	}
 }

testdata/src/align_only/example.go.golden

@@ -0,0 +1,23 @@
+package testdata
+
+type FooBar struct {
+	Foo    int    `json:"foo"                 validate:"required"`           // want `tag is not aligned, should be: json:"foo"`
+	Bar    string `json:"___bar___,omitempty" validate:"required"`               // want `json:"___bar___,omitempty" validate:"required"`
+	FooFoo int8   `json:"foo_foo"             validate:"required" yaml:"fooFoo"` // want `tag is not aligned, should be: json:"foo_foo"`
+	BarBar int    `json:"bar_bar"             validate:"required"`               // want `tag is not aligned, should be: json:"bar_bar"`
+	FooBar struct {
+		Foo    int    `json:"foo"    yaml:"foo"          validate:"required"` // want `tag is not aligned, should be: json:"foo"    yaml:"foo"          validate:"required"`
+		Bar222 string `json:"bar222" validate:"required" yaml:"bar"`          // want `tag is not aligned, should be: json:"bar222" validate:"required" yaml:"bar"`
+	} `json:"foo_bar" validate:"required"`
+	FooFooFoo struct {
+		BarBarBar struct {
+			BarBarBarBar    string `json:"bar_bar_bar_bar"     validate:"required"`                     // want `json:"bar_bar_bar_bar"     validate:"required"`
+			BarBarBarFooBar string `json:"bar_bar_bar_foo_bar" yaml:"bar"          validate:"required"` // want `tag is not aligned, should be: json:"bar_bar_bar_foo_bar" yaml:"bar"          validate:"required"`
+		} `json:"bar_bar_bar" validate:"required"`
+	}
+	BarFooBarFoo struct{}
+	// test comment
+	// test commnet 2
+	BarFoo    string `json:"bar_foo"     validate:"required"` // want `tag is not aligned, should be: json:"bar_foo"     validate:"required"`
+	BarFooBar string `json:"bar_foo_bar" validate:"required"`
+}

testdata/src/alignsortorder/example.go.golden

@@ -0,0 +1,13 @@
+package alignsortorder
+
+type AlignAndSortWithOrderExample struct {
+    Foo    int `json:"foo,omitempty" yaml:"bar" xml:"baz" binding:"required" gorm:"column:foo" validate:"required" zip:"foo"` // want `tag is not aligned, should be: json:"foo,omitempty" yaml:"bar" xml:"baz" binding:"required" gorm:"column:foo" validate:"required" zip:"foo"`
+    Bar    int `json:"bar,omitempty" yaml:"foo" xml:"bar" binding:"required" gorm:"column:bar" validate:"required" zip:"bar"` // want `tag is not aligned, should be: json:"bar,omitempty" yaml:"foo" xml:"bar" binding:"required" gorm:"column:bar" validate:"required" zip:"bar"`
+    FooBar int `json:"bar,omitempty" yaml:"foo" xml:"bar" binding:"required" gorm:"column:bar" validate:"required" zip:"bar"` // want `tag is not aligned, should be: json:"bar,omitempty" yaml:"foo" xml:"bar" binding:"required" gorm:"column:bar" validate:"required" zip:"bar"`
+ }
+
+type AlignAndSortWithOrderExample2 struct {
+	Foo int `json:"foo,omitempty" yaml:"bar" xml:"baz" binding:"required" gorm:"column:foo" validate:"required" zip:"foo"` // want `tag is not aligned , should be: json:"foo,omitempty" yaml:"bar" xml:"baz" binding:"required" gorm:"column:foo" validate:"required" zip:"foo"`
+
+	Bar int `json:"bar,omitempty" yaml:"foo" xml:"bar" binding:"required" gorm:"column:bar" validate:"required" zip:"bar"` // want `tag is not aligned , should be: json:"bar,omitempty" yaml:"foo" xml:"bar" binding:"required" gorm:"column:bar" validate:"required" zip:"bar"`
+}

testdata/src/bad_syntax_tag/example.go.golden

@@ -0,0 +1,17 @@
+package issues6
+
+type FooBar struct {
+	Foo    int    `json: "foo"    validate:"required"` // want `bad syntax for struct tag value`
+	Bar    string `json:bar`                           // want `bad syntax for struct tag value`
+	FooFoo int8   `json:"foo_foo" validate:"required"`
+	BarBar int    `json:"bar_bar" validate:"required"`
+}
+
+type FooBar2 struct {
+	Foo int `json:"foo" validate:"required"`
+
+	FooFoo int8   `json:"foo_foo"`
+	BarBar int    `json:"bar_bar" validate:"required"`
+	XXX    int    `json:"xxx"     validate:"required"`
+	Bar    string `json:bar` // want `bad syntax for struct tag value`
+}

testdata/src/single_field/example.go.golden

@@ -0,0 +1,10 @@
+package singlefield
+
+type FooBar struct {
+	Foo int    `json:"foo" validate:"required"`
+	Bar string `json:"bar" validate:"required"`
+
+	FooFoo int8 `json:"foo_foo" validate:"required"` // want `json:"foo_foo" validate:"required"`
+
+	BarBar int `json:"bar_bar" validate:"required"`
+}

testdata/src/sort_only/example.go.golden

@@ -0,0 +1,13 @@
+package sort_only
+
+import "time"
+
+type TagAlignExampleSortOnlyKO struct {
+    Foo    time.Time `gorm:"column:foo" json:"foo,omitempty" validate:"required" xml:"foo" yaml:"foo" zip:"foo"`                // want `gorm:"column:foo" json:"foo,omitempty" validate:"required" xml:"foo" yaml:"foo" zip:"foo"`
+    FooBar struct{}  `gorm:"column:fooBar" json:"fooBar,omitempty" validate:"required" xml:"fooBar" yaml:"fooBar" zip:"fooBar"` // want `gorm:"column:fooBar" json:"fooBar,omitempty" validate:"required" xml:"fooBar" yaml:"fooBar" zip:"fooBar"`
+}
+
+type TagAlignExampleSortOnlyOK struct {
+	Foo    time.Time `gorm:"column:foo" json:"foo,omitempty" validate:"required" xml:"foo" yaml:"foo" zip:"foo"`
+	FooBar struct{}  `gorm:"column:fooBar" json:"fooBar,omitempty" validate:"required" xml:"fooBar" yaml:"fooBar" zip:"fooBar"`
+}

testdata/src/sortorder/example.go.golden

@@ -0,0 +1,12 @@
+package sortorder
+
+type SortWithOrderExample struct {
+	// not aligned but sorted, should not be reported
+	Foo    int `xml:"baz" json:"foo,omitempty"     yaml:"bar"     binding:"required"      gorm:"column:foo" validate:"required"     zip:"foo" `
+	Bar    int `xml:"bar"        json:"bar,omitempty" yaml:"foo"            gorm:"column:bar"  validate:"required"     zip:"bar" `
+	FooBar int `xml:"bar"           json:"bar,omitempty"             yaml:"foo"   gorm:"column:bar"   `
+	// aligned but not sorted, should be reported
+	BarFoo int `xml:"bar" json:"bar,omitempty" yaml:"foo" gorm:"column:bar" validate:"required" zip:"bar"` // want `xml:"bar" json:"bar,omitempty" yaml:"foo" gorm:"column:bar" validate:"required" zip:"bar"`
+	// not aligned but sorted, should trim spaces between tags
+	FooBarFoo int `xml:"bar" json:"bar,omitempty" yaml:"foo" gorm:"column:bar" validate:"required" zip:"bar"` // want `xml:"bar" json:"bar,omitempty" yaml:"foo" gorm:"column:bar" validate:"required" zip:"bar"`
+}

testdata/src/strict/example.go.golden

@@ -0,0 +1,18 @@
+package strict
+
+type AlignAndSortWithOrderExample struct {
+	Foo    int `json:"foo,omitempty" yaml:"bar" xml:"baz" binding:"required" gorm:"column:foo" validate:"required" zip:"foo"` // want `tag is not aligned, should be: json:"foo,omitempty" yaml:"bar" xml:"baz" binding:"required" gorm:"column:foo" validate:"required" zip:"foo"`
+	Bar    int `json:"bar,omitempty" yaml:"foo" xml:"bar" binding:"required" gorm:"column:bar" validate:"required" zip:"bar"` // want `tag is not aligned, should be: json:"bar,omitempty" yaml:"foo" xml:"bar" binding:"required" gorm:"column:bar" validate:"required" zip:"bar"`
+	FooBar int `json:"bar,omitempty" yaml:"foo" xml:"bar" binding:"required" gorm:"column:bar" validate:"required" zip:"bar"` // want `tag is not aligned, should be: json:"bar,omitempty" yaml:"foo" xml:"bar" binding:"required" gorm:"column:bar" validate:"required" zip:"bar"`
+}
+
+type AlignAndSortWithOrderExample2 struct {
+	Foo int `                     yaml:"bar" xml:"baz" binding:"required" gorm:"column:foo" validate:"required" zip:"foo"` // want `tag is not aligned, should be:                      yaml:"bar" xml:"baz" binding:"required" gorm:"column:foo" validate:"required" zip:"foo"`
+	Bar int `json:"bar,omitempty" yaml:"foo" xml:"bar" binding:"required" gorm:"column:bar" validate:"required"`           // want `tag is not aligned, should be: json:"bar,omitempty" yaml:"foo" xml:"bar" binding:"required" gorm:"column:bar" validate:"required"`
+}
+
+type AlignAndSortWithOrderExample3 struct {
+	Foo    int `                                                                         gorm:"column:foo"                     zip:"foo"` // want `tag is not aligned, should be:                                                                          gorm:"column:foo"                     zip:"foo"`
+	Bar    int `json:"bar,omitempty" yaml:"foo" xml:"barxxxxxxxxxxxx" binding:"required" gorm:"column:bar" validate:"required" zip:"bar"` // want `tag is not aligned, should be: json:"bar,omitempty" yaml:"foo" xml:"barxxxxxxxxxxxx" binding:"required" gorm:"column:bar" validate:"required" zip:"bar"`
+	FooBar int `json:"bar,omitempty" yaml:"foo"                       binding:"required" gorm:"column:bar" validate:"required" zip:"bar"` // want `tag is not aligned, should be: json:"bar,omitempty" yaml:"foo"                       binding:"required" gorm:"column:bar" validate:"required" zip:"bar"`
+}