refactor: reduce dependency between internal and api

see https://gravitee.atlassian.net/browse/GKO-290

Author: a-cordier

api/model/api/base/status.go

@@ -0,0 +1,34 @@
+// Copyright (C) 2015 The Gravitee team (http://gravitee.io)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//         http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package base
+
+import "github.com/gravitee-io/gravitee-kubernetes-operator/pkg/types/k8s/custom"
+
+type Status struct {
+	// The organization ID, if a management context has been defined to sync with an APIM instance
+	OrgID string `json:"organizationId,omitempty"`
+	// The environment ID, if a management context has been defined to sync with an APIM instance
+	EnvID string `json:"environmentId,omitempty"`
+	// The ID of the API definition in the Gravitee API Management instance (if an API context has been configured).
+	ID string `json:"id,omitempty"`
+	// The Cross ID is used to identify an API that has been promoted from one environment to another.
+	CrossID string `json:"crossId,omitempty"`
+	// The processing status of the API definition.
+	ProcessingStatus custom.ProcessingStatus `json:"processingStatus,omitempty"`
+	// The state of the API. Can be either STARTED or STOPPED.
+	State ApiState `json:"state,omitempty"`
+	// This is the object generation observed during the latest reconcile.
+	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
+}

api/model/api/base/zz_generated.deepcopy.go

@@ -0,0 +1,25 @@
+// Copyright (C) 2015 The Gravitee team (http://gravitee.io)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//         http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package v4
+
+import "github.com/gravitee-io/gravitee-kubernetes-operator/api/model/api/base"
+
+type Status struct {
+	base.Status `json:",inline"`
+	// This field is used to store the list of plans that have been created
+	// for the API definition if a management context has been defined
+	// to sync the API with an APIM instance
+	Plans map[string]string `json:"plans,omitempty"`
+}

api/model/api/v4/status.go

@@ -0,0 +1,31 @@
+// Copyright (C) 2015 The Gravitee team (http://gravitee.io)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//         http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package application
+
+import "github.com/gravitee-io/gravitee-kubernetes-operator/pkg/types/k8s/custom"
+
+type Status struct {
+	// The organization ID, if a management context has been defined to sync with an APIM instance
+	OrgID string `json:"organizationId,omitempty"`
+	// The environment ID, if a management context has been defined to sync with an APIM instance
+	EnvID string `json:"environmentId,omitempty"`
+	// The ID of the Application, if a management context has been defined to sync with an APIM instance
+	ID string `json:"id,omitempty"`
+	// The processing status of the Application.
+	// The value is `Completed` if the sync with APIM succeeded, Failed otherwise.
+	ProcessingStatus custom.ProcessingStatus `json:"processingStatus,omitempty"`
+	// This is the object generation observed during the latest reconcile.
+	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
+}

api/model/api/v4/zz_generated.deepcopy.go

@@ -20,46 +20,31 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 )
 
-var _ custom.ResourceRef = &NamespacedName{}
+var _ custom.ResourceRef = NamespacedName{}
 
 type NamespacedName struct {
 	Name      string `json:"name"`
 	Namespace string `json:"namespace,omitempty"`
 }
 
-// SetNamespace implements custom.ResourceRef.
-func (n *NamespacedName) SetNamespace(ns string) {
-	n.Namespace = ns
-}
-
-// IsMissingNamespace implements custom.ResourceRef.
-func (n *NamespacedName) IsMissingNamespace() bool {
-	return !n.HasNameSpace()
-}
-
 // GetName implements custom.ResourceRef.
-func (n *NamespacedName) GetName() string {
+func (n NamespacedName) GetName() string {
 	return n.Name
 }
 
 // GetNamespace implements custom.ResourceRef.
-func (n *NamespacedName) GetNamespace() string {
+func (n NamespacedName) GetNamespace() string {
 	return n.Namespace
 }
 
-// HasNameSpace implements custom.ResourceRef.
-func (n *NamespacedName) HasNameSpace() bool {
-	return n.Namespace != ""
-}
-
 func NewNamespacedName(namespace, name string) NamespacedName {
 	return NamespacedName{Namespace: namespace, Name: name}
 }
 
-func (n *NamespacedName) NamespacedName() types.NamespacedName {
+func (n NamespacedName) NamespacedName() types.NamespacedName {
 	return types.NamespacedName{Namespace: n.Namespace, Name: n.Name}
 }
 
-func (n *NamespacedName) String() string {
+func (n NamespacedName) String() string {
 	return n.Namespace + "/" + n.Name
 }

api/model/application/status.go

@@ -58,24 +58,7 @@ type ApiDefinitionV2Spec struct {
 
 // ApiDefinitionStatus defines the observed state of API Definition.
 type ApiDefinitionStatus struct {
-	OrgID string `json:"organizationId,omitempty"`
-	EnvID string `json:"environmentId,omitempty"`
-	// The ID of the API definition in the Gravitee API Management instance (if an API context has been configured).
-	ID      string `json:"id,omitempty"`
-	CrossID string `json:"crossId,omitempty"`
-	// The processing status of the API definition.
-	Status custom.ProcessingStatus `json:"processingStatus,omitempty"`
-	// This field is kept for backward compatibility and shall be removed in future versions.
-	// Use processingStatus instead.
-	DeprecatedStatus custom.ProcessingStatus `json:"status,omitempty"`
-
-	// The state of the API. Can be either STARTED or STOPPED.
-	State base.ApiState `json:"state,omitempty"`
-
-	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
-	// This field is kept for backward compatibility and shall be removed in future versions.
-	// Use observedGeneration instead.
-	DeprecatedObservedGeneration int64 `json:"generation,omitempty"`
+	base.Status `json:",inline"`
 }
 
 var _ list.Item = &ApiDefinition{}
@@ -189,7 +172,7 @@ func (spec *ApiDefinitionV2Spec) Hash() string {
 }
 
 func (s *ApiDefinitionStatus) SetProcessingStatus(status custom.ProcessingStatus) {
-	s.Status = status
+	s.ProcessingStatus = status
 }
 
 func (s *ApiDefinitionStatus) SetObservedGeneration(g int64) {

api/model/application/zz_generated.deepcopy.go

@@ -40,27 +40,7 @@ type ApiV4DefinitionSpec struct {
 
 // ApiV4DefinitionStatus defines the observed state of API Definition.
 type ApiV4DefinitionStatus struct {
-	// The organisation ID, if a management context has been defined to sync the API with an APIM instance
-	OrgID string `json:"organizationId,omitempty"`
-	// The environment ID, if a management context has been defined to sync the API with an APIM instance
-	EnvID string `json:"environmentId,omitempty"`
-	// The ID of the API definition if a management context has been defined to sync the API with an APIM instance
-	ID string `json:"id,omitempty"`
-	// The Cross ID of the API definition if a management context has been defined to sync the API with an APIM instance
-	CrossID string `json:"crossId,omitempty"`
-
-	// The processing status of the API definition.
-	Status custom.ProcessingStatus `json:"processingStatus,omitempty"`
-
-	// The state of the API. Can be either STARTED or STOPPED.
-	State string `json:"state,omitempty"`
-
-	// This field is used to store the list of plans that have been created
-	// for the API definition if a management context has been defined
-	// to sync the API with an APIM instance
-	Plans map[string]string `json:"plans,omitempty"`
-	// Last generation of the CRD resource
-	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
+	v4.Status `json:",inline"`
 }
 
 var _ custom.ApiDefinition = &ApiV4Definition{}
@@ -231,7 +211,7 @@ func (spec *ApiV4DefinitionSpec) GetManagementContext() *refs.NamespacedName {
 }
 
 func (s *ApiV4DefinitionStatus) SetProcessingStatus(status custom.ProcessingStatus) {
-	s.Status = status
+	s.ProcessingStatus = status
 }
 
 func (s *ApiV4DefinitionStatus) SetObservedGeneration(g int64) {

api/model/refs/namespace.go

@@ -17,20 +17,11 @@ limitations under the License.
 package v1alpha1
 
 import (
-	"fmt"
-
 	"github.com/gravitee-io/gravitee-kubernetes-operator/api/model/application"
 	"github.com/gravitee-io/gravitee-kubernetes-operator/api/model/refs"
-	"github.com/gravitee-io/gravitee-kubernetes-operator/internal/hash"
-	"github.com/gravitee-io/gravitee-kubernetes-operator/pkg/types/k8s/custom"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
-var _ custom.ContextAwareResource = &Application{}
-var _ custom.Spec = &ApplicationSpec{}
-var _ custom.Status = &ApplicationStatus{}
-
 // Application is the main resource handled by the Kubernetes Operator
 // +kubebuilder:object:generate=true
 type ApplicationSpec struct {
@@ -41,14 +32,7 @@ type ApplicationSpec struct {
 
 // ApplicationStatus defines the observed state of Application.
 type ApplicationStatus struct {
-	OrgID string `json:"organizationId,omitempty"`
-	EnvID string `json:"environmentId,omitempty"`
-	// The ID of the Application in the Gravitee API Management instance (if an API context has been configured).
-	ID string `json:"id,omitempty"`
-	// The processing status of the Application.
-	Status custom.ProcessingStatus `json:"processingStatus,omitempty"`
-
-	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
+	application.Status `json:",inline"`
 }
 
 // +kubebuilder:object:root=true
@@ -65,16 +49,6 @@ type Application struct {
 	Status ApplicationStatus `json:"status,omitempty"`
 }
 
-// GetSpec implements custom.Resource.
-func (app *Application) GetSpec() custom.Spec {
-	return &app.Spec
-}
-
-// GetStatus implements custom.Resource.
-func (app *Application) GetStatus() custom.Status {
-	return &app.Status
-}
-
 // +kubebuilder:object:root=true
 type ApplicationList struct {
 	metav1.TypeMeta `json:",inline"`
@@ -89,53 +63,3 @@ func (app *Application) IsBeingDeleted() bool {
 func init() {
 	SchemeBuilder.Register(&Application{}, &ApplicationList{})
 }
-
-func (app *Application) ContextRef() custom.ResourceRef {
-	return app.Spec.Context
-}
-
-func (app *Application) HasContext() bool {
-	return app.Spec.Context != nil
-}
-
-func (app *Application) ID() string {
-	return app.Status.ID
-}
-
-func (app *Application) DeepCopyResource() custom.Resource {
-	return app.DeepCopy()
-}
-
-func (spec *ApplicationSpec) Hash() string {
-	return hash.Calculate(spec)
-}
-
-func (s *ApplicationStatus) DeepCopyFrom(obj client.Object) error {
-	switch t := obj.(type) {
-	case *Application:
-		t.Status.DeepCopyInto(s)
-	default:
-		return fmt.Errorf("unknown type %T", t)
-	}
-
-	return nil
-}
-
-func (s *ApplicationStatus) DeepCopyTo(api client.Object) error {
-	switch t := api.(type) {
-	case *Application:
-		s.DeepCopyInto(&t.Status)
-	default:
-		return fmt.Errorf("unknown type %T", t)
-	}
-
-	return nil
-}
-
-func (s *ApplicationStatus) SetObservedGeneration(g int64) {
-	s.ObservedGeneration = g
-}
-
-func (s *ApplicationStatus) SetProcessingStatus(status custom.ProcessingStatus) {
-	s.Status = status
-}