Add base optionalfields linter

Author: JoelSpeed

pkg/analysis/helpers/markers/analyzer.go

@@ -385,6 +385,13 @@ func (ms MarkerSet) HasWithExpressions(identifier string, expressions map[string
 	return false
 }
 
+// Get returns the markers associated with the given identifier.
+// If no markers are found, an empty slice is returned.
+// The returned slice may contain multiple markers with the same identifier.
+func (ms MarkerSet) Get(identifier string) []Marker {
+	return ms[identifier]
+}
+
 // UnsortedList returns a list of the markers, in no particular order.
 func (ms MarkerSet) UnsortedList() []Marker {
 	markers := []Marker{}

pkg/analysis/optionalfields/analyzer.go

@@ -0,0 +1,37 @@
+package optionalfields_test
+
+import (
+	"testing"
+
+	"golang.org/x/tools/go/analysis/analysistest"
+	requiredfields "sigs.k8s.io/kube-api-linter/pkg/analysis/optionalfields"
+	"sigs.k8s.io/kube-api-linter/pkg/config"
+)
+
+func TestDefaultConfiguration(t *testing.T) {
+	testdata := analysistest.TestData()
+
+	a, err := requiredfields.Initializer().Init(config.LintersConfig{})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	analysistest.RunWithSuggestedFixes(t, testdata, a, "a")
+}
+
+func TestWhenRequiredPreferenceConfiguration(t *testing.T) {
+	testdata := analysistest.TestData()
+
+	a, err := requiredfields.Initializer().Init(config.LintersConfig{
+		OptionalFields: config.OptionalFieldsConfig{
+			Pointers: config.OptionalFieldsPointers{
+				Preference: config.OptionalFieldsPointerPreferenceWhenRequired,
+			},
+		},
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	analysistest.RunWithSuggestedFixes(t, testdata, a, "b")
+}

pkg/analysis/optionalfields/analyzer_test.go

@@ -0,0 +1,3 @@
+/*
+ */
+package optionalfields

pkg/analysis/optionalfields/doc.go

@@ -0,0 +1,30 @@
+package optionalfields
+
+import (
+	"golang.org/x/tools/go/analysis"
+	"sigs.k8s.io/kube-api-linter/pkg/config"
+)
+
+// Initializer returns the AnalyzerInitializer for this
+// Analyzer so that it can be added to the registry.
+func Initializer() initializer {
+	return initializer{}
+}
+
+// intializer implements the AnalyzerInitializer interface.
+type initializer struct{}
+
+// Name returns the name of the Analyzer.
+func (initializer) Name() string {
+	return name
+}
+
+// Init returns the intialized Analyzer.
+func (initializer) Init(cfg config.LintersConfig) (*analysis.Analyzer, error) {
+	return newAnalyzer(cfg.OptionalFields), nil
+}
+
+// Default determines whether this Analyzer is on by default, or not.
+func (initializer) Default() bool {
+	return true
+}

pkg/analysis/optionalfields/initializer.go

@@ -0,0 +1,57 @@
+package a
+
+type A struct {
+	// required field should not be picked up.
+	// +required
+	RequiredField string `json:"requiredField,omitempty"`
+
+	// pointerString is a pointer string field.
+	// +optional
+	PointerString *string `json:"pointerString,omitempty"`
+
+	// pointerInt is a pointer int field.
+	// +optional
+	PointerInt *int `json:"pointerInt,omitempty"`
+
+	// pointerStruct is a pointer struct field.
+	// +optional
+	PointerStruct *B `json:"pointerStruct,omitempty"`
+
+	// string is a string field.
+	// +optional
+	String string `json:"string,omitempty"` // want "field String is optional and should be a pointer"
+
+	// int is an int field.
+	// +optional
+	Int int `json:"int,omitempty"` // want "field Int is optional and should be a pointer"
+
+	// struct is a struct field.
+	// +optional
+	Struct B `json:"struct,omitempty"` // want "field Struct is optional and should be a pointer"
+
+	// slice is a slice field.
+	// +optional
+	Slice []string `json:"slice,omitempty"`
+
+	// map is a map field.
+	// +optional
+	Map map[string]string `json:"map,omitempty"`
+
+	// PointerSlice is a pointer slice field.
+	// +optional
+	PointerSlice *[]string `json:"pointerSlice,omitempty"` // want "field PointerSlice is a pointer type and should not be a pointer"
+
+	// PointerMap is a pointer map field.
+	// +optional
+	PointerMap *map[string]string `json:"pointerMap,omitempty"` // want "field PointerMap is a pointer type and should not be a pointer"
+
+	// PointerPointerString is a double pointer string field.
+	// +optional
+	DoublePointerString **string `json:"doublePointerString,omitempty"` // want "field DoublePointerString is a pointer type and should not be a pointer"
+}
+
+type B struct {
+	// pointerString is a pointer string field.
+	// +optional
+	PointerString *string `json:"pointerString,omitempty"`
+}

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

@@ -0,0 +1,57 @@
+package a
+
+type A struct {
+	// required field should not be picked up.
+	// +required
+	RequiredField string `json:"requiredField,omitempty"`
+
+	// pointerString is a pointer string field.
+	// +optional
+	PointerString *string `json:"pointerString,omitempty"`
+
+	// pointerInt is a pointer int field.
+	// +optional
+	PointerInt *int `json:"pointerInt,omitempty"`
+
+	// pointerStruct is a pointer struct field.
+	// +optional
+	PointerStruct *B `json:"pointerStruct,omitempty"`
+
+	// string is a string field.
+	// +optional
+	String *string `json:"string,omitempty"` // want "field String is optional and should be a pointer"
+
+	// int is an int field.
+	// +optional
+	Int *int `json:"int,omitempty"` // want "field Int is optional and should be a pointer"
+
+	// struct is a struct field.
+	// +optional
+	Struct *B `json:"struct,omitempty"` // want "field Struct is optional and should be a pointer"
+
+	// slice is a slice field.
+	// +optional
+	Slice []string `json:"slice,omitempty"`
+
+	// map is a map field.
+	// +optional
+	Map map[string]string `json:"map,omitempty"`
+
+	// PointerSlice is a pointer slice field.
+	// +optional
+	PointerSlice []string `json:"pointerSlice,omitempty"` // want "field PointerSlice is a pointer type and should not be a pointer"
+
+	// PointerMap is a pointer map field.
+	// +optional
+	PointerMap map[string]string `json:"pointerMap,omitempty"` // want "field PointerMap is a pointer type and should not be a pointer"
+
+	// PointerPointerString is a double pointer string field.
+	// +optional
+	DoublePointerString *string `json:"doublePointerString,omitempty"` // want "field DoublePointerString is a pointer type and should not be a pointer"
+}
+
+type B struct {
+	// pointerString is a pointer string field.
+	// +optional
+	PointerString *string `json:"pointerString,omitempty"`
+}