Merge pull request openshift#2321 from JoelSpeed/golangci-lint-v2

Update KAL and GolangCI-Lint to v2

Author: openshift-merge-bot[bot]

.golangci.yaml

@@ -1,26 +1,69 @@
-linters-settings:
-  custom:
-    kubeapilinter:
-      type: "module"
-      description: kubeapilinter is the Kube-API-Linter and lints Kube like APIs based on API conventions and best practices.
-      settings:
-        linters:
-          enable:
-          - "maxlength"
-          - "nobools"
-          - "nomaps"
-          - "statussubresource"
-        lintersConfig:
-          conditions:
-            isFirstField: Warn
-            useProtobuf: Ignore
-            usePatchStrategy: Ignore
+version: "2"
 linters:
-  disable-all: true
+  default: none
   enable:
     - kubeapilinter
+  settings:
+    custom:
+      kubeapilinter:
+        path: tools/_output/bin/kube-api-linter.so
+        description: kubeapilinter is the Kube-API-Linter and lints Kube like APIs based on API conventions and best practices.
+        settings:
+          linters:
+            enable:
+              - maxlength
+              - nobools
+              - nomaps
+              - statussubresource
+          lintersConfig:
+            conditions:
+              isFirstField: Warn
+              usePatchStrategy: Ignore
+              useProtobuf: Ignore
+            optionalfields:
+              pointers:
+                preference: WhenRequired
+                policy: SuggestFix
+              omitEmpty:
+                # Ignore missing omitempty so that we can omit the omitempty for discoverability.
+                # Discoverability is for configuration APIs, generally singletons.
+                # Refer to the API conventions for when to use discoverability (not our default stance).
+                policy: Ignore 
+            uniqueMarkers:
+              customMarkers:
+              - identifier: "openshift:validation:FeatureGateAwareEnum"
+                attributes:
+                - featureGate
+                - requiredFeatureGate
+              - identifier: "openshift:validation:FeatureGateMaxItems"
+                attributes:
+                - featureGate
+                - requiredFeatureGate
+              - identifier: "openshift:validation:FeatureGateAwareXValidation"
+                attributes:
+                - featureGate
+                - requiredFeatureGate
+                - rule
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
 issues:
   # We have a lot of existing issues.
   # Want to make sure that those adding new fields have an
   # opportunity to fix them when running the linter locally.
   max-issues-per-linter: 1000
+formatters:
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

apps/v1/generated.proto

@@ -304,26 +304,35 @@ type DeploymentTriggerImageChangeParams struct {
 type DeploymentConfigStatus struct {
 	// latestVersion is used to determine whether the current deployment associated with a deployment
 	// config is out of sync.
+	// +optional
 	LatestVersion int64 `json:"latestVersion" protobuf:"varint,1,opt,name=latestVersion"`
 	// observedGeneration is the most recent generation observed by the deployment config controller.
+	// +optional
 	ObservedGeneration int64 `json:"observedGeneration" protobuf:"varint,2,opt,name=observedGeneration"`
 	// replicas is the total number of pods targeted by this deployment config.
+	// +optional
 	Replicas int32 `json:"replicas" protobuf:"varint,3,opt,name=replicas"`
 	// updatedReplicas is the total number of non-terminated pods targeted by this deployment config
 	// that have the desired template spec.
+	// +optional
 	UpdatedReplicas int32 `json:"updatedReplicas" protobuf:"varint,4,opt,name=updatedReplicas"`
 	// availableReplicas is the total number of available pods targeted by this deployment config.
+	// +optional
 	AvailableReplicas int32 `json:"availableReplicas" protobuf:"varint,5,opt,name=availableReplicas"`
 	// unavailableReplicas is the total number of unavailable pods targeted by this deployment config.
+	// +optional
 	UnavailableReplicas int32 `json:"unavailableReplicas" protobuf:"varint,6,opt,name=unavailableReplicas"`
 	// details are the reasons for the update to this deployment config.
 	// This could be based on a change made by the user or caused by an automatic trigger
+	// +optional
 	Details *DeploymentDetails `json:"details,omitempty" protobuf:"bytes,7,opt,name=details"`
 	// conditions represents the latest available observations of a deployment config's current state.
 	// +patchMergeKey=type
 	// +patchStrategy=merge
+	// +optional
 	Conditions []DeploymentCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,8,rep,name=conditions"`
 	// Total number of ready pods targeted by this deployment.
+	// +optional
 	ReadyReplicas int32 `json:"readyReplicas,omitempty" protobuf:"varint,9,opt,name=readyReplicas"`
 }
 

apps/v1/types.go

@@ -208,9 +208,11 @@ type SubjectRulesReviewSpec struct {
 // SubjectRulesReviewStatus is contains the result of a rules check
 type SubjectRulesReviewStatus struct {
 	// rules is the list of rules (no particular sort) that are allowed for the subject
+	// +optional
 	Rules []PolicyRule `json:"rules" protobuf:"bytes,1,rep,name=rules"`
 	// evaluationError can appear in combination with Rules.  It means some error happened during evaluation
 	// that may have prevented additional rules from being populated.
+	// +optional
 	EvaluationError string `json:"evaluationError,omitempty" protobuf:"bytes,2,opt,name=evaluationError"`
 }
 

authorization/v1/generated.proto

@@ -192,54 +192,67 @@ type ImageChangeCause struct {
 type BuildStatus struct {
 	// phase is the point in the build lifecycle. Possible values are
 	// "New", "Pending", "Running", "Complete", "Failed", "Error", and "Cancelled".
+	// +optional
 	Phase BuildPhase `json:"phase" protobuf:"bytes,1,opt,name=phase,casttype=BuildPhase"`
 
 	// cancelled describes if a cancel event was triggered for the build.
+	// +optional
 	Cancelled bool `json:"cancelled,omitempty" protobuf:"varint,2,opt,name=cancelled"`
 
 	// reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.
+	// +optional
 	Reason StatusReason `json:"reason,omitempty" protobuf:"bytes,3,opt,name=reason,casttype=StatusReason"`
 
 	// message is a human-readable message indicating details about why the build has this status.
+	// +optional
 	Message string `json:"message,omitempty" protobuf:"bytes,4,opt,name=message"`
 
 	// startTimestamp is a timestamp representing the server time when this Build started
 	// running in a Pod.
 	// It is represented in RFC3339 form and is in UTC.
+	// +optional
 	StartTimestamp *metav1.Time `json:"startTimestamp,omitempty" protobuf:"bytes,5,opt,name=startTimestamp"`
 
 	// completionTimestamp is a timestamp representing the server time when this Build was
 	// finished, whether that build failed or succeeded.  It reflects the time at which
 	// the Pod running the Build terminated.
 	// It is represented in RFC3339 form and is in UTC.
+	// +optional
 	CompletionTimestamp *metav1.Time `json:"completionTimestamp,omitempty" protobuf:"bytes,6,opt,name=completionTimestamp"`
 
 	// duration contains time.Duration object describing build time.
+	// +optional
 	Duration time.Duration `json:"duration,omitempty" protobuf:"varint,7,opt,name=duration,casttype=time.Duration"`
 
 	// outputDockerImageReference contains a reference to the container image that
 	// will be built by this build. Its value is computed from
 	// Build.Spec.Output.To, and should include the registry address, so that
 	// it can be used to push and pull the image.
+	// +optional
 	OutputDockerImageReference string `json:"outputDockerImageReference,omitempty" protobuf:"bytes,8,opt,name=outputDockerImageReference"`
 
 	// config is an ObjectReference to the BuildConfig this Build is based on.
+	// +optional
 	Config *corev1.ObjectReference `json:"config,omitempty" protobuf:"bytes,9,opt,name=config"`
 
 	// output describes the container image the build has produced.
+	// +optional
 	Output BuildStatusOutput `json:"output,omitempty" protobuf:"bytes,10,opt,name=output"`
 
 	// stages contains details about each stage that occurs during the build
 	// including start time, duration (in milliseconds), and the steps that
 	// occured within each stage.
+	// +optional
 	Stages []StageInfo `json:"stages,omitempty" protobuf:"bytes,11,opt,name=stages"`
 
 	// logSnippet is the last few lines of the build log.  This value is only set for builds that failed.
+	// +optional
 	LogSnippet string `json:"logSnippet,omitempty" protobuf:"bytes,12,opt,name=logSnippet"`
 
 	// conditions represents the latest available observations of a build's current state.
 	// +patchMergeKey=type
 	// +patchStrategy=merge
+	// +optional
 	Conditions []BuildCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,13,rep,name=conditions"`
 }
 
@@ -1005,11 +1018,13 @@ const (
 // BuildConfigStatus contains current state of the build config object.
 type BuildConfigStatus struct {
 	// lastVersion is used to inform about number of last triggered build.
+	// +optional
 	LastVersion int64 `json:"lastVersion" protobuf:"varint,1,opt,name=lastVersion"`
 
 	// imageChangeTriggers captures the runtime state of any ImageChangeTrigger specified in the BuildConfigSpec,
 	// including the value reconciled by the OpenShift APIServer for the lastTriggeredImageID. There is a single entry
 	// in this array for each image change trigger in spec. Each trigger status references the ImageStreamTag that acts as the source of the trigger.
+	// +optional
 	ImageChangeTriggers []ImageChangeTriggerStatus `json:"imageChangeTriggers,omitempty" protobuf:"bytes,2,rep,name=imageChangeTriggers"`
 }
 

authorization/v1/types.go

@@ -146,7 +146,7 @@ type AuditCustomRule struct {
 	// If unset, the 'Default' profile is used as the default.
 	//
 	// +required
-	Profile AuditProfileType `json:"profile,omitempty"`
+	Profile AuditProfileType `json:"profile"`
 }
 
 type APIServerServingCerts struct {

build/v1/generated.proto

@@ -108,6 +108,7 @@ type AuthenticationStatus struct {
 	// If the config map or expected key is not found, no metadata is served.
 	// If the specified metadata is not valid, no metadata is served.
 	// The namespace for this config map is openshift-config-managed.
+	// +optional
 	IntegratedOAuthMetadata ConfigMapNameReference `json:"integratedOAuthMetadata"`
 
 	// oidcClients is where participating operators place the current OIDC client status
@@ -119,6 +120,7 @@ type AuthenticationStatus struct {
 	// +kubebuilder:validation:MaxItems=20
 	// +openshift:enable:FeatureGate=ExternalOIDC
 	// +openshift:enable:FeatureGate=ExternalOIDCWithUIDAndExtraClaimMappings
+	// +optional
 	OIDCClients []OIDCClientStatus `json:"oidcClients"`
 }
 
@@ -207,7 +209,7 @@ type OIDCProvider struct {
 	Name string `json:"name"`
 
 	// issuer is a required field that configures how the platform interacts
-	// with the identity provider and how tokens issued from the identity provider 
+	// with the identity provider and how tokens issued from the identity provider
 	// are evaluated by the Kubernetes API server.
 	//
 	// +required
@@ -737,7 +739,7 @@ type TokenClaimValidationRule struct {
 	// JWT is valid for this identity provider.
 	//
 	// +optional
-	RequiredClaim *TokenRequiredClaim `json:"requiredClaim"`
+	RequiredClaim *TokenRequiredClaim `json:"requiredClaim,omitempty"`
 }
 
 type TokenRequiredClaim struct {