⚠️ Add omitempty to required string without zero value (#12548)

* Add omitempty to required string without zero value

* Add temporary exclude rule

* Add another temporary exclude rule

* Drop omit empty on layout (it is not a string)

Author: fabriziopandini

.golangci-kal.yml

@@ -204,6 +204,17 @@ linters:
       linters:
         - kubeapilinter
 
+    # TODO: Excludes that should be removed once we will get the new version of the requiredfields linter
+    - path: "api/.*"
+      text: "requiredfields: field .* is marked as required, but has the omitempty tag"
+      linters:
+        - kubeapilinter
+
+    # TODO: Excludes that should be removed once https://github.com/kubernetes-sigs/kube-api-linter/issues/132 will be fixed
+    - path: "api/ipam/v1beta2/ipaddressclaim_types.go"
+      text: "optionalfields: field AddressRef is optional and has a valid zero value \\({}\\), but the validation is not complete \\(e.g. min properties/adding required fields\\). The field should be a pointer to allow the zero value to be set. If the zero value is not a valid use case, complete the validation and remove the pointer."
+      linters:
+        - kubeapilinter
 issues:
   max-same-issues: 0
   max-issues-per-linter: 0

api/addons/v1beta2/clusterresourceset_types.go

@@ -88,12 +88,12 @@ type ResourceRef struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=253
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
 
 	// kind of the resource. Supported kinds are: Secrets and ConfigMaps.
 	// +kubebuilder:validation:Enum=Secret;ConfigMap
 	// +required
-	Kind string `json:"kind"`
+	Kind string `json:"kind,omitempty"`
 }
 
 // ClusterResourceSetStrategy is a string representation of a ClusterResourceSet Strategy.

api/addons/v1beta2/clusterresourcesetbinding_types.go

@@ -49,7 +49,7 @@ type ResourceSetBinding struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=253
-	ClusterResourceSetName string `json:"clusterResourceSetName"`
+	ClusterResourceSetName string `json:"clusterResourceSetName,omitempty"`
 
 	// resources is a list of resources that the ClusterResourceSet has.
 	// +optional
@@ -140,7 +140,7 @@ type ClusterResourceSetBindingSpec struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=63
-	ClusterName string `json:"clusterName"`
+	ClusterName string `json:"clusterName,omitempty"`
 }
 
 // +kubebuilder:object:root=true

api/bootstrap/kubeadm/v1beta2/kubeadm_types.go

@@ -545,21 +545,21 @@ type ExternalEtcd struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=512
-	CAFile string `json:"caFile"`
+	CAFile string `json:"caFile,omitempty"`
 
 	// certFile is an SSL certification file used to secure etcd communication.
 	// Required if using a TLS connection.
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=512
-	CertFile string `json:"certFile"`
+	CertFile string `json:"certFile,omitempty"`
 
 	// keyFile is an SSL key file used to secure etcd communication.
 	// Required if using a TLS connection.
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=512
-	KeyFile string `json:"keyFile"`
+	KeyFile string `json:"keyFile,omitempty"`
 }
 
 // JoinConfiguration contains elements describing a particular node.
@@ -685,7 +685,7 @@ type FileDiscovery struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=512
-	KubeConfigPath string `json:"kubeConfigPath"`
+	KubeConfigPath string `json:"kubeConfigPath,omitempty"`
 
 	// kubeConfig is used (optionally) to generate a KubeConfig based on the KubeadmConfig's information.
 	// The file is generated at the path specified in KubeConfigPath.
@@ -785,7 +785,7 @@ type KubeConfigAuthProvider struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=256
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
 
 	// config holds the parameters for the authentication plugin.
 	// +optional
@@ -802,7 +802,7 @@ type KubeConfigAuthExec struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=1024
-	Command string `json:"command"`
+	Command string `json:"command,omitempty"`
 
 	// args is the arguments to pass to the command when executing it.
 	// +optional
@@ -846,12 +846,13 @@ type KubeConfigAuthExecEnv struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=512
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
+
 	// value of the environment variable
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=512
-	Value string `json:"value"`
+	Value string `json:"value,omitempty"`
 }
 
 // HostPathMount contains elements describing volumes that are mounted from the
@@ -861,21 +862,25 @@ type HostPathMount struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=512
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
+
 	// hostPath is the path in the host that will be mounted inside
 	// the pod.
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=512
-	HostPath string `json:"hostPath"`
+	HostPath string `json:"hostPath,omitempty"`
+
 	// mountPath is the path inside the pod where hostPath will be mounted.
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=512
-	MountPath string `json:"mountPath"`
+	MountPath string `json:"mountPath,omitempty"`
+
 	// readOnly controls write access to the volume
 	// +optional
 	ReadOnly *bool `json:"readOnly,omitempty"`
+
 	// pathType is the type of the HostPath.
 	// +optional
 	PathType corev1.HostPathType `json:"pathType,omitempty"`
@@ -963,7 +968,7 @@ type Arg struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=256
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
 
 	// value is the Value of the extraArg.
 	// +required

api/bootstrap/kubeadm/v1beta2/kubeadmconfig_types.go

@@ -611,7 +611,7 @@ type File struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=512
-	Path string `json:"path"`
+	Path string `json:"path,omitempty"`
 
 	// owner specifies the ownership of the file, e.g. "root:root".
 	// +optional
@@ -662,13 +662,13 @@ type SecretFileSource struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=253
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
 
 	// key is the key in the secret's data map for this value.
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=256
-	Key string `json:"key"`
+	Key string `json:"key,omitempty"`
 }
 
 // PasswdSource is a union of all possible external source types for passwd data.
@@ -689,13 +689,13 @@ type SecretPasswdSource struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=253
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
 
 	// key is the key in the secret's data map for this value.
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=256
-	Key string `json:"key"`
+	Key string `json:"key,omitempty"`
 }
 
 // User defines the input for a generated user in cloud-init.
@@ -704,7 +704,7 @@ type User struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=256
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
 
 	// gecos specifies the gecos to use for the user
 	// +optional
@@ -807,16 +807,19 @@ type Partition struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=256
-	Device string `json:"device"`
+	Device string `json:"device,omitempty"`
+
 	// layout specifies the device layout.
 	// If it is true, a single partition will be created for the entire device.
 	// When layout is false, it means don't partition or ignore existing partitioning.
 	// +required
 	Layout bool `json:"layout"`
+
 	// overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device.
 	// Use with caution. Default is 'false'.
 	// +optional
 	Overwrite *bool `json:"overwrite,omitempty"`
+
 	// tableType specifies the tupe of partition table. The following are supported:
 	// 'mbr': default and setups a MS-DOS partition table
 	// 'gpt': setups a GPT partition table
@@ -831,13 +834,13 @@ type Filesystem struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=256
-	Device string `json:"device"`
+	Device string `json:"device,omitempty"`
 
 	// filesystem specifies the file system type.
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=128
-	Filesystem string `json:"filesystem"`
+	Filesystem string `json:"filesystem,omitempty"`
 
 	// label specifies the file system label to be used. If set to None, no label is used.
 	// +optional

api/controlplane/kubeadm/v1beta2/kubeadm_control_plane_types.go

@@ -432,7 +432,7 @@ type KubeadmControlPlaneSpec struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=256
-	Version string `json:"version"`
+	Version string `json:"version,omitempty"`
 
 	// machineTemplate contains information about how machines
 	// should be shaped when creating or updating a control plane.
@@ -805,7 +805,7 @@ type LastRemediationStatus struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=253
-	Machine string `json:"machine"`
+	Machine string `json:"machine,omitempty"`
 
 	// time is when last remediation happened. It is represented in RFC3339 form and is in UTC.
 	// +required

api/core/v1beta2/cluster_types.go

@@ -525,7 +525,7 @@ type ClusterAvailabilityGate struct {
 	// +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$`
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=316
-	ConditionType string `json:"conditionType"`
+	ConditionType string `json:"conditionType,omitempty"`
 
 	// polarity of the conditionType specified in this availabilityGate.
 	// Valid values are Positive, Negative and omitted.
@@ -546,7 +546,7 @@ type Topology struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=256
-	Version string `json:"version"`
+	Version string `json:"version,omitempty"`
 
 	// controlPlane describes the cluster control plane.
 	// +optional
@@ -578,7 +578,7 @@ type ClusterClassRef struct {
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=253
 	// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
 
 	// namespace is the namespace of the ClusterClass that should be used for the topology.
 	// If namespace is empty or not set, it is defaulted to the namespace of the Cluster object.
@@ -822,7 +822,7 @@ type MachineDeploymentTopology struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=256
-	Class string `json:"class"`
+	Class string `json:"class,omitempty"`
 
 	// name is the unique identifier for this MachineDeploymentTopology.
 	// The value is used with other unique identifiers to create a MachineDeployment's Name
@@ -831,7 +831,7 @@ type MachineDeploymentTopology struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=63
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
 
 	// failureDomain is the failure domain the machines will be created in.
 	// Must match a key in the FailureDomains map stored on the cluster object.
@@ -1132,7 +1132,7 @@ type MachinePoolTopology struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=256
-	Class string `json:"class"`
+	Class string `json:"class,omitempty"`
 
 	// name is the unique identifier for this MachinePoolTopology.
 	// The value is used with other unique identifiers to create a MachinePool's Name
@@ -1141,7 +1141,7 @@ type MachinePoolTopology struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=63
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
 
 	// failureDomains is the list of failure domains the machine pool will be created in.
 	// Must match a key in the FailureDomains map stored on the cluster object.
@@ -1208,7 +1208,7 @@ type ClusterVariable struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=256
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
 
 	// value of the variable.
 	// Note: the value will be validated against the schema of the corresponding ClusterClassVariable
@@ -1608,7 +1608,7 @@ type FailureDomain struct {
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=256
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
 
 	// controlPlane determines if this failure domain is suitable for use by control plane machines.
 	// +optional