fixup

Author: sbueringer

exp/runtime/hooks/api/v1alpha1/common_types.go

@@ -30,9 +30,11 @@ type ResponseObject interface {
 	SetStatus(status ResponseStatus)
 }
 
-// Retryable defines the functionality for a hook response to be retryable.
+// RetryResponseObject is a ResponseObject which additionally defines the functionality
+// for a response to signal a retry.
 // +kubebuilder:object:generate=false
-type Retryable interface {
+type RetryResponseObject interface {
+	ResponseObject
 	GetRetryAfterSeconds() int32
 	SetRetryAfterSeconds(retryAfterSeconds int32)
 }
@@ -78,18 +80,20 @@ const (
 	ResponseStatusFailure ResponseStatus = "Failure"
 )
 
-// RetryableResponse is a CommonResponse that is Retryable.
-type RetryableResponse struct {
-	CommonResponse
-	RetryAfterSeconds int32
+// CommonRetryResponse is the data structure which contains all
+// common retry fields.
+type CommonRetryResponse struct {
+	// RetryAfterSeconds when set to a non-zero value signifies that the hook
+	// will be called again at a future time.
+	RetryAfterSeconds int32 `json:"retryAfterSeconds"`
 }
 
 // GetRetryAfterSeconds sets the RetryAfterSeconds value.
-func (r *RetryableResponse) GetRetryAfterSeconds() int32 {
+func (r *CommonRetryResponse) GetRetryAfterSeconds() int32 {
 	return r.RetryAfterSeconds
 }
 
 // SetRetryAfterSeconds returns the RetryAfterSeconds value.
-func (r *RetryableResponse) SetRetryAfterSeconds(retryAfterSeconds int32) {
+func (r *CommonRetryResponse) SetRetryAfterSeconds(retryAfterSeconds int32) {
 	r.RetryAfterSeconds = retryAfterSeconds
 }

exp/runtime/hooks/api/v1alpha1/lifecyclehooks_types.go

@@ -32,6 +32,8 @@ type BeforeClusterCreateRequest struct {
 	Cluster clusterv1.Cluster `json:"cluster"`
 }
 
+var _ RetryResponseObject = &BeforeClusterCreateResponse{}
+
 // BeforeClusterCreateResponse is the response of the BeforeClusterCreate hook.
 // +kubebuilder:object:root=true
 type BeforeClusterCreateResponse struct {
@@ -40,9 +42,8 @@ type BeforeClusterCreateResponse struct {
 	// CommonResponse contains Status and Message fields common to all response types.
 	CommonResponse `json:",inline"`
 
-	// RetryAfterSeconds when set to a non-zero value signifies that the hook
-	// will be called again at a future time.
-	RetryAfterSeconds int `json:"retryAfterSeconds"`
+	// CommonRetryResponse contains RetryAfterSeconds field common to all retry response types.
+	CommonRetryResponse `json:",inline"`
 }
 
 // BeforeClusterCreate is the runtime hook that will be called right before a Cluster is created.
@@ -57,6 +58,8 @@ type AfterControlPlaneInitializedRequest struct {
 	Cluster clusterv1.Cluster `json:"cluster"`
 }
 
+var _ ResponseObject = &AfterControlPlaneInitializedResponse{}
+
 // AfterControlPlaneInitializedResponse is the response of the AfterControlPlaneInitialized hook.
 // +kubebuilder:object:root=true
 type AfterControlPlaneInitializedResponse struct {
@@ -80,10 +83,13 @@ type BeforeClusterUpgradeRequest struct {
 
 	// The current Kubernetes version of the cluster.
 	FromKubernetesVersion string `json:"fromKubernetesVersion"`
+
 	// The target Kubernetes version of upgrade.
 	ToKubernetesVersion string `json:"toKubernetesVersion"`
 }
 
+var _ RetryResponseObject = &BeforeClusterUpgradeResponse{}
+
 // BeforeClusterUpgradeResponse is the response of the BeforeClusterUpgrade hook.
 // +kubebuilder:object:root=true
 type BeforeClusterUpgradeResponse struct {
@@ -92,9 +98,8 @@ type BeforeClusterUpgradeResponse struct {
 	// CommonResponse contains Status and Message fields common to all response types.
 	CommonResponse `json:",inline"`
 
-	// RetryAfterSeconds when set to a non-zero value signifies that the hook
-	// needs to be retried at a future time.
-	RetryAfterSeconds int `json:"retryAfterSeconds"`
+	// CommonRetryResponse contains RetryAfterSeconds field common to all retry response types.
+	CommonRetryResponse `json:",inline"`
 }
 
 // BeforeClusterUpgrade is the runtime hook that will be called after a cluster.spec.version is upgraded and
@@ -113,6 +118,8 @@ type AfterControlPlaneUpgradeRequest struct {
 	KubernetesVersion string `json:"kubernetesVersion"`
 }
 
+var _ RetryResponseObject = &AfterControlPlaneUpgradeResponse{}
+
 // AfterControlPlaneUpgradeResponse is the response of the AfterControlPlaneUpgrade hook.
 // +kubebuilder:object:root=true
 type AfterControlPlaneUpgradeResponse struct {
@@ -121,9 +128,8 @@ type AfterControlPlaneUpgradeResponse struct {
 	// CommonResponse contains Status and Message fields common to all response types.
 	CommonResponse `json:",inline"`
 
-	// RetryAfterSeconds when set to a non-zero value signifies that the hook
-	// needs to be retried at a future time.
-	RetryAfterSeconds int `json:"retryAfterSeconds"`
+	// CommonRetryResponse contains RetryAfterSeconds field common to all retry response types.
+	CommonRetryResponse `json:",inline"`
 }
 
 // AfterControlPlaneUpgrade is the runtime hook called after the control plane is successfully upgraded to the target
@@ -142,6 +148,8 @@ type AfterClusterUpgradeRequest struct {
 	KubernetesVersion string `json:"kubernetesVersion"`
 }
 
+var _ ResponseObject = &AfterClusterUpgradeResponse{}
+
 // AfterClusterUpgradeResponse is the response of the AfterClusterUpgrade hook.
 // +kubebuilder:object:root=true
 type AfterClusterUpgradeResponse struct {
@@ -164,6 +172,8 @@ type BeforeClusterDeleteRequest struct {
 	Cluster clusterv1.Cluster `json:"cluster"`
 }
 
+var _ RetryResponseObject = &BeforeClusterDeleteResponse{}
+
 // BeforeClusterDeleteResponse is the response of the BeforeClusterDelete hook.
 // +kubebuilder:object:root=true
 type BeforeClusterDeleteResponse struct {
@@ -172,9 +182,8 @@ type BeforeClusterDeleteResponse struct {
 	// CommonResponse contains Status and Message fields common to all response types.
 	CommonResponse `json:",inline"`
 
-	// RetryAfterSeconds when set to a non-zero value signifies that the hook
-	// needs to be retried at a future time.
-	RetryAfterSeconds int `json:"retryAfterSeconds"`
+	// CommonRetryResponse contains RetryAfterSeconds field common to all retry response types.
+	CommonRetryResponse `json:",inline"`
 }
 
 // BeforeClusterDelete is the runtime hook that is called after a delete is issued on a cluster

exp/runtime/hooks/api/v1alpha1/topologymutation_types.go

@@ -56,19 +56,17 @@ type GeneratePatchesRequestItem struct {
 	Variables []Variable `json:"variables"`
 }
 
+var _ ResponseObject = &GeneratePatchesResponse{}
+
 // GeneratePatchesResponse is the response of the GeneratePatches hook.
 // NOTE: The patches in GeneratePatchesResponse will be applied in the order in which they are defined to the
 // templates of the request. Thus applying changes consecutively when iterating through internal and external patches.
 // +kubebuilder:object:root=true
 type GeneratePatchesResponse struct {
 	metav1.TypeMeta `json:",inline"`
 
-	// Status of the call.
-	// One of: "Success" or "Failure".
-	Status ResponseStatus `json:"status"`
-
-	// A human-readable description of the status of the call.
-	Message string `json:"message,omitempty"`
+	// CommonResponse contains Status and Message fields common to all response types.
+	CommonResponse `json:",inline"`
 
 	// Items is the list of generated patches.
 	Items []GeneratePatchesResponseItem `json:"items"`
@@ -131,17 +129,15 @@ type ValidateTopologyRequestItem struct {
 	Variables []Variable `json:"variables"`
 }
 
+var _ ResponseObject = &ValidateTopologyResponse{}
+
 // ValidateTopologyResponse is the response of the ValidateTopology hook.
 // +kubebuilder:object:root=true
 type ValidateTopologyResponse struct {
 	metav1.TypeMeta `json:",inline"`
 
-	// Status of the call.
-	// One of: "Success" or "Failure".
-	Status ResponseStatus `json:"status"`
-
-	// A human-readable description of the status of the call.
-	Message string `json:"message"`
+	// CommonResponse contains Status and Message fields common to all response types.
+	CommonResponse `json:",inline"`
 }
 
 // Variable represents a variable value.

exp/runtime/hooks/api/v1alpha1/zz_generated.deepcopy.go

@@ -215,8 +215,8 @@ func aggregateSuccessfulResponses(aggregated runtimehooksv1.ResponseObject, resp
 	aggregated.SetMessage("")
 	aggregated.SetStatus(runtimehooksv1.ResponseStatusSuccess)
 	for _, resp := range responses {
-		if retryable, ok := resp.(runtimehooksv1.Retryable); ok {
-			if aggregatedRetryable, aggregatedOK := aggregated.(runtimehooksv1.Retryable); aggregatedOK {
+		if retryable, ok := resp.(runtimehooksv1.RetryResponseObject); ok {
+			if aggregatedRetryable, aggregatedOK := aggregated.(runtimehooksv1.RetryResponseObject); aggregatedOK {
 				aggregatedRetryable.SetRetryAfterSeconds(
 					lowestNonZeroRetryAfterSeconds(aggregatedRetryable.GetRetryAfterSeconds(), retryable.GetRetryAfterSeconds()),
 				)

internal/runtime/client/client.go

@@ -670,9 +670,9 @@ func Test_client_CallAllExtensions(t *testing.T) {
 	}{
 		{
 			name:     "success calling one extension for hook",
-			hook:     fakev1alpha1.FakeRetryableHook,
-			request:  &fakev1alpha1.FakeRetryableRequest{},
-			response: &fakev1alpha1.FakeRetryableResponse{},
+			hook:     fakev1alpha1.RetryableFakeHook,
+			request:  &fakev1alpha1.RetryableFakeRequest{},
+			response: &fakev1alpha1.RetryableFakeResponse{},
 			wantErr:  false,
 		},
 	}
@@ -746,7 +746,7 @@ func Test_aggregateResponses(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			response := &fakev1alpha1.FakeRetryableResponse{TypeMeta: metav1.TypeMeta{Kind: "FakeResponse", APIVersion: "v1alpha1"}}
+			response := &fakev1alpha1.RetryableFakeResponse{TypeMeta: metav1.TypeMeta{Kind: "FakeResponse", APIVersion: "v1alpha1"}}
 			aggregateSuccessfulResponses(response, tt.responses)
 			if !reflect.DeepEqual(response, tt.want) {
 				t.Errorf("aggregateSuccessfulResponses() got = %v, want %v", response, tt.want)
@@ -755,17 +755,17 @@ func Test_aggregateResponses(t *testing.T) {
 	}
 }
 
-func fakeResponse(retryAfterSeconds int32) *fakev1alpha1.FakeRetryableResponse {
-	return &fakev1alpha1.FakeRetryableResponse{
+func fakeResponse(retryAfterSeconds int32) *fakev1alpha1.RetryableFakeResponse {
+	return &fakev1alpha1.RetryableFakeResponse{
 		TypeMeta: metav1.TypeMeta{
 			Kind:       "FakeResponse",
 			APIVersion: "v1alpha1",
 		},
-		RetryableResponse: runtimehooksv1.RetryableResponse{
-			CommonResponse: runtimehooksv1.CommonResponse{
-				Message: "",
-				Status:  runtimehooksv1.ResponseStatusSuccess,
-			},
+		CommonResponse: runtimehooksv1.CommonResponse{
+			Message: "",
+			Status:  runtimehooksv1.ResponseStatusSuccess,
+		},
+		CommonRetryResponse: runtimehooksv1.CommonRetryResponse{
 			RetryAfterSeconds: retryAfterSeconds,
 		},
 	}

internal/runtime/client/client_test.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package v1alpha1 contains types for catalog tests
+// Package v1alpha1 contains types for tests.
 // Note: they have to be in a separate package because otherwise it wouldn't
 // be possible to register different versions of the same hook.
 // +k8s:conversion-gen=sigs.k8s.io/cluster-api/internal/runtime/test/v1alpha2