Merge branch 'main' into numericbounds

Author: krishagarwal278

docs/linters.md

@@ -17,6 +17,7 @@
 - [NoDurations](#nodurations) - Prevents usage of duration types
 - [NoFloats](#nofloats) - Prevents usage of floating-point types
 - [Nomaps](#nomaps) - Restricts usage of map types
+- [NonPointerStructs](#nonpointerstructs) - Ensures non-pointer structs are marked correctly with required/optional markers
 - [NoNullable](#nonullable) - Prevents usage of the nullable marker
 - [Nophase](#nophase) - Prevents usage of 'Phase' fields
 - [Notimestamp](#notimestamp) - Prevents usage of 'TimeStamp' fields
@@ -533,6 +534,39 @@ lintersConfig:
     policy: Enforce | AllowStringToStringMaps | Ignore # Determines how the linter should handle maps of simple types. Defaults to AllowStringToStringMaps.
 ```
 
+## NonPointerStructs
+
+The `nonpointerstructs` linter checks that non-pointer structs that contain required fields are marked as required.
+Non-pointer structs that contain no required fields are marked as optional.
+
+This linter is important for types validated in Go as there is no way to validate the optionality of the fields at runtime,
+aside from checking the fields within them.
+
+This linter is NOT intended to be used to check for CRD types.
+The advice of this linter may be applied to CRD types, but it is not necessary for CRD types due to optionality being validated by openapi and no native Go code.
+For CRD types, the optionalfields and requiredfields linters should be used instead.
+
+If a struct is marked required, this can only be validated by having a required field within it.
+If there are no required fields, the struct is implicitly optional and must be marked as so.
+
+To have an optional struct field that includes required fields, the struct must be a pointer.
+To have a required struct field that includes no required fields, the struct must be a pointer.
+
+### Configuration
+
+```yaml
+lintersConfig:
+  nonpointerstructs:
+    preferredRequiredMarker: required | kubebuilder:validation:Required | k8s:required # The preferred required marker to use for required fields when providing fixes. Defaults to `required`.
+    preferredOptionalMarker: optional | kubebuilder:validation:Optional | k8s:optional # The preferred optional marker to use for optional fields when providing fixes. Defaults to `optional`.
+```
+
+### Fixes
+
+The `nonpointerstructs` linter can automatically fix non-pointer struct fields that are not marked as required or optional.
+
+It will suggest to mark the field as required or optional, depending on the fields within the non-pointer struct.
+
 ## NoNullable
 
 The `nonullable` linter ensures that types and fields do not have the `nullable` marker.

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

@@ -104,3 +104,16 @@ type IncorrectFieldTag struct {
 	// +optional
 	Conditions []metav1.Condition `json:"conditions"  patchMergeKey:"type" protobuf:"bytes,3,rep,name=conditions"` // want "Conditions field in IncorrectFieldTag has incorrect tags, should be: `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`"
 }
+
+// ConditionsWithOrphanedMarkers tests the fix for orphaned markers where markers
+// separated from the field doc comment by a blank line were not being detected.
+type ConditionsWithOrphanedMarkers struct {
+	// +optional
+	// +listType=map
+	// +listMapKey=type
+	// +patchStrategy=merge
+	// +patchMergeKey=type
+
+	// Conditions update as changes occur in the status.
+	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
+}

pkg/analysis/conditions/testdata/src/a/a.go.golden

@@ -114,3 +114,16 @@ type IncorrectFieldTag struct {
 	// +optional
 	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` // want "Conditions field in IncorrectFieldTag has incorrect tags, should be: `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`"
 }
+
+// ConditionsWithOrphanedMarkers tests the fix for orphaned markers where markers
+// separated from the field doc comment by a blank line were not being detected.
+type ConditionsWithOrphanedMarkers struct {
+	// +optional
+	// +listType=map
+	// +listMapKey=type
+	// +patchStrategy=merge
+	// +patchMergeKey=type
+
+	// Conditions update as changes occur in the status.
+	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
+}