redactor: Move CRD annotations to kubernetes-model-common (#2890)

* refactor!: move CRD annotations to kubernetes-model-common * feat: change retention policy so that generator could work at runtime * docs: add changelog entry * fix: imports * refactor!: move Scope to kubernetes-model-common and clean it up * refactor!: use Scope instead of String constants * fix: Export-package for common model classes Co-authored-by: manusa <[email protected]>
fabric8io · Mar 11, 2021 · f76c644 · f76c644
1 parent 1b4a456
commit f76c644
Show file tree

Hide file tree

Showing 20 changed files with 56 additions and 42 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,7 +8,8 @@
 * Fix #2853: Cannot change the type of the Service from ClusterIP to ExternalName with PATCH
 * Fix #2783: OpenIDConnectionUtils#persistKubeConfigWithUpdatedToken persists access token instead of refresh token
 * Fix #2871: Change longFileMode to LONGFILE\_POSIX for creating tar in PodUpload, improve exception handling in PodUpload.
-* Fix #2746: SharedInformerFactory should use key formed from OperationContext 
+* Fix #2746: SharedInformerFactory should use key formed from OperationContext
+* Fix #2736: Move CRD annotations to kubernetes-model-common module for greater coherence
 
 #### Improvements
 * Fix #2781: RawCustomResourceOperationsImpl#delete now returns a boolean value for deletion status

diff --git a/crd-generator/src/main/java/io/fabric8/crd/generator/apt/CustomResourceInfo.java b/crd-generator/src/main/java/io/fabric8/crd/generator/apt/CustomResourceInfo.java
@@ -17,6 +17,7 @@
 
 import io.fabric8.kubernetes.api.model.Namespaced;
 import io.fabric8.kubernetes.client.utils.Pluralize;
+import io.fabric8.kubernetes.model.Scope;
 import io.fabric8.kubernetes.model.annotation.Group;
 import io.fabric8.kubernetes.model.annotation.Kind;
 import io.fabric8.kubernetes.model.annotation.Plural;
@@ -66,7 +67,7 @@ public String key() {
   public Scope scope() {
     return customResource.getInterfaces().stream()
       .filter(t -> t.toString().equals(Namespaced.class.getTypeName()))
-      .map(t -> Scope.Namespaced).findFirst().orElse(Scope.Cluster);
+      .map(t -> Scope.NAMESPACED).findFirst().orElse(Scope.CLUSTER);
   }
 
   public String crdName() {

diff --git a/crd-generator/src/main/java/io/fabric8/crd/generator/v1/CustomResourceHandler.java b/crd-generator/src/main/java/io/fabric8/crd/generator/v1/CustomResourceHandler.java
@@ -56,7 +56,7 @@ protected void addDecorators(CustomResourceInfo config, TypeDef def,
     final String version = config.version();
     resources.decorate(
       new AddCustomResourceDefinitionResourceDecorator(name, config.group(), config.kind(),
-        config.scope().name(), config.shortNames(), config.plural(), config.singular()));
+        config.scope().value(), config.shortNames(), config.plural(), config.singular()));
 
     resources.decorate(new AddCustomResourceDefinitionVersionDecorator(name, version));
 

diff --git a/crd-generator/src/main/java/io/fabric8/crd/generator/v1beta1/CustomResourceHandler.java b/crd-generator/src/main/java/io/fabric8/crd/generator/v1beta1/CustomResourceHandler.java
@@ -57,7 +57,7 @@ protected void addDecorators(CustomResourceInfo config, TypeDef def,
     final String version = config.version();
     resources.decorate(
       new AddCustomResourceDefinitionResourceDecorator(name, config.group(), config.kind(),
-        config.scope().name(), config.shortNames(), config.plural(), config.singular()));
+        config.scope().value(), config.shortNames(), config.plural(), config.singular()));
 
     resources.decorate(new AddCustomResourceDefinitionVersionDecorator(name, version));
 

diff --git a/...rator/src/main/java/io/fabric8/crd/generator/visitor/AdditionalPrinterColumnDetector.java b/...rator/src/main/java/io/fabric8/crd/generator/visitor/AdditionalPrinterColumnDetector.java
@@ -15,7 +15,7 @@
  */
 package io.fabric8.crd.generator.visitor;
 
-import io.fabric8.crd.annotation.PrinterColumn;
+import io.fabric8.kubernetes.model.annotation.PrinterColumn;
 import java.util.ArrayList;
 
 public class AdditionalPrinterColumnDetector extends AnnotatedMultiPropertyPathDetector {

diff --git a/crd-generator/src/main/java/io/fabric8/crd/generator/visitor/LabelSelectorPathDetector.java b/crd-generator/src/main/java/io/fabric8/crd/generator/visitor/LabelSelectorPathDetector.java
@@ -15,7 +15,7 @@
  */
 package io.fabric8.crd.generator.visitor;
 
-import io.fabric8.crd.annotation.LabelSelector;
+import io.fabric8.kubernetes.model.annotation.LabelSelector;
 import java.util.ArrayList;
 
 public class LabelSelectorPathDetector extends AnnotatedPropertyPathDetector {

diff --git a/crd-generator/src/main/java/io/fabric8/crd/generator/visitor/SpecReplicasPathDetector.java b/crd-generator/src/main/java/io/fabric8/crd/generator/visitor/SpecReplicasPathDetector.java
@@ -15,7 +15,7 @@
  */
 package io.fabric8.crd.generator.visitor;
 
-import io.fabric8.crd.annotation.SpecReplicas;
+import io.fabric8.kubernetes.model.annotation.SpecReplicas;
 import java.util.ArrayList;
 
 public class SpecReplicasPathDetector extends AnnotatedPropertyPathDetector {

diff --git a/crd-generator/src/main/java/io/fabric8/crd/generator/visitor/StatusReplicasPathDetector.java b/crd-generator/src/main/java/io/fabric8/crd/generator/visitor/StatusReplicasPathDetector.java
@@ -15,7 +15,7 @@
  */
 package io.fabric8.crd.generator.visitor;
 
-import io.fabric8.crd.annotation.StatusReplicas;
+import io.fabric8.kubernetes.model.annotation.StatusReplicas;
 import java.util.ArrayList;
 
 public class StatusReplicasPathDetector extends AnnotatedPropertyPathDetector {

diff --git a/kubernetes-client/src/main/java/io/fabric8/kubernetes/client/CustomResource.java b/kubernetes-client/src/main/java/io/fabric8/kubernetes/client/CustomResource.java
@@ -26,6 +26,7 @@
 import io.fabric8.kubernetes.api.model.Namespaced;
 import io.fabric8.kubernetes.api.model.ObjectMeta;
 import io.fabric8.kubernetes.client.utils.Pluralize;
+import io.fabric8.kubernetes.model.Scope;
 import io.fabric8.kubernetes.model.annotation.Group;
 import io.fabric8.kubernetes.model.annotation.Plural;
 import io.fabric8.kubernetes.model.annotation.Singular;
@@ -68,8 +69,6 @@
 public abstract class CustomResource<S, T> implements HasMetadata {
   private static final Logger LOG = LoggerFactory.getLogger(CustomResource.class);
 
-  public static final String NAMESPACE_SCOPE = "Namespaced";
-  public static final String CLUSTER_SCOPE = "Cluster";
   private ObjectMeta metadata = new ObjectMeta();
 
   @JsonProperty("spec")
@@ -96,7 +95,7 @@ public CustomResource() {
     }
     this.apiVersion = version;
     this.kind = HasMetadata.super.getKind();
-    scope = this instanceof Namespaced ? NAMESPACE_SCOPE : CLUSTER_SCOPE;
+    scope = this instanceof Namespaced ? Scope.NAMESPACED.value() : Scope.CLUSTER.value();
     this.singular = getSingular(clazz);
     this.plural = getPlural(clazz);
     this.crdName = getCRDName(clazz);
@@ -228,7 +227,7 @@ public String getCRDName() {
   /**
    * Retrieves the scope that this CustomResource targets
    *
-   * @return the scope that this CustomResource targets. Possible values are {@link #CLUSTER_SCOPE} or {@link #NAMESPACE_SCOPE}.
+   * @return the scope that this CustomResource targets. Possible values are {@link Scope#CLUSTER} or {@link Scope#NAMESPACED}.
    */
   @JsonIgnore
   public String getScope() {

diff --git a/kubernetes-itests/src/test/java/io/fabric8/crd/zookeeper/ZookeeperCustomResourceIT.java b/kubernetes-itests/src/test/java/io/fabric8/crd/zookeeper/ZookeeperCustomResourceIT.java
@@ -15,21 +15,18 @@
  */
 package io.fabric8.crd.zookeeper;
 
-import java.util.List;
-import java.util.Optional;
-
-import org.junit.Test;
-import io.fabric8.kubernetes.client.utils.Serialization;
-import io.fabric8.kubernetes.api.model.HasMetadata;
-import io.fabric8.kubernetes.api.model.KubernetesList;
 import io.fabric8.kubernetes.api.model.apiextensions.v1beta1.CustomResourceDefinition;
 import io.fabric8.kubernetes.api.model.apiextensions.v1beta1.CustomResourceDefinitionVersion;
 import io.fabric8.kubernetes.api.model.apiextensions.v1beta1.JSONSchemaProps;
+import io.fabric8.kubernetes.client.utils.Serialization;
+import org.junit.Test;
+
+import java.util.List;
+import java.util.Optional;
 
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
 
 public class ZookeeperCustomResourceIT {
 

diff --git a/kubernetes-itests/src/test/java/io/fabric8/crd/zookeeper/v1/ZookeeperSpec.java b/kubernetes-itests/src/test/java/io/fabric8/crd/zookeeper/v1/ZookeeperSpec.java
@@ -15,10 +15,9 @@
  */
 package io.fabric8.crd.zookeeper.v1;
 
+import io.fabric8.kubernetes.model.annotation.SpecReplicas;
 import javax.validation.constraints.NotNull;
 
-import io.fabric8.crd.annotation.SpecReplicas;
-
 public class ZookeeperSpec {
 
     @SpecReplicas

diff --git a/kubernetes-itests/src/test/java/io/fabric8/crd/zookeeper/v1/ZookeeperStatus.java b/kubernetes-itests/src/test/java/io/fabric8/crd/zookeeper/v1/ZookeeperStatus.java
@@ -15,12 +15,11 @@
  */
 package io.fabric8.crd.zookeeper.v1;
 
+import io.fabric8.kubernetes.model.annotation.LabelSelector;
+import io.fabric8.kubernetes.model.annotation.PrinterColumn;
+import io.fabric8.kubernetes.model.annotation.StatusReplicas;
 import java.util.Map;
 
-import io.fabric8.crd.annotation.LabelSelector;
-import io.fabric8.crd.annotation.StatusReplicas;
-import io.fabric8.crd.annotation.PrinterColumn;
-
 public class ZookeeperStatus {
 
   @PrinterColumn

diff --git a/kubernetes-itests/src/test/java/io/fabric8/crd/zookeeper/v1alpha1/ZookeeperSpec.java b/kubernetes-itests/src/test/java/io/fabric8/crd/zookeeper/v1alpha1/ZookeeperSpec.java
@@ -15,7 +15,7 @@
  */
 package io.fabric8.crd.zookeeper.v1alpha1;
 
-import io.fabric8.crd.annotation.SpecReplicas;
+import io.fabric8.kubernetes.model.annotation.SpecReplicas;
 
 public class ZookeeperSpec {
 

diff --git a/kubernetes-itests/src/test/java/io/fabric8/crd/zookeeper/v1alpha1/ZookeeperStatus.java b/kubernetes-itests/src/test/java/io/fabric8/crd/zookeeper/v1alpha1/ZookeeperStatus.java
@@ -17,8 +17,8 @@
 
 import java.util.Map;
 
-import io.fabric8.crd.annotation.LabelSelector;
-import io.fabric8.crd.annotation.StatusReplicas;
+import io.fabric8.kubernetes.model.annotation.LabelSelector;
+import io.fabric8.kubernetes.model.annotation.StatusReplicas;
 
 public class ZookeeperStatus {
 

diff --git a/kubernetes-model-generator/kubernetes-model-common/pom.xml b/kubernetes-model-generator/kubernetes-model-common/pom.xml
@@ -51,8 +51,7 @@
             <Bundle-SymbolicName>${project.groupId}.${project.artifactId}</Bundle-SymbolicName>
             <Import-Package>*</Import-Package>
             <Export-Package>
-              io.fabric8.kubernetes.model.annotation,
-              io.fabric8.kubernetes.model.util
+              io.fabric8.kubernetes.model**
             </Export-Package>
           </instructions>
         </configuration>

diff --git a/...a/io/fabric8/crd/generator/apt/Scope.java → ...va/io/fabric8/kubernetes/model/Scope.java b/...a/io/fabric8/crd/generator/apt/Scope.java → ...va/io/fabric8/kubernetes/model/Scope.java
@@ -13,8 +13,27 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.fabric8.crd.generator.apt;
+package io.fabric8.kubernetes.model;
 
+/**
+ * Represents the scope of a resource in the cluster. Resources can either be cluster-scoped or only
+ * are visible within the confines of a given namespace.
+ */
 public enum Scope {
-  Namespaced, Cluster,
+  NAMESPACED("Namespaced"), CLUSTER("Cluster");
+
+  private final String value;
+
+  Scope(String value) {
+    this.value = value;
+  }
+
+  public String value() {
+    return value;
+  }
+
+  @Override
+  public String toString() {
+    return value;
+  }
 }
diff --git a/...fabric8/crd/annotation/LabelSelector.java → ...netes/model/annotation/LabelSelector.java b/...fabric8/crd/annotation/LabelSelector.java → ...netes/model/annotation/LabelSelector.java
@@ -13,15 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.fabric8.crd.annotation;
+package io.fabric8.kubernetes.model.annotation;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 @Target({ ElementType.FIELD })
-@Retention(RetentionPolicy.SOURCE)
+@Retention(RetentionPolicy.RUNTIME)
 public @interface LabelSelector {
 
 }
diff --git a/...fabric8/crd/annotation/PrinterColumn.java → ...netes/model/annotation/PrinterColumn.java b/...fabric8/crd/annotation/PrinterColumn.java → ...netes/model/annotation/PrinterColumn.java
@@ -13,15 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.fabric8.crd.annotation;
+package io.fabric8.kubernetes.model.annotation;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 @Target({ ElementType.FIELD })
-@Retention(RetentionPolicy.SOURCE)
+@Retention(RetentionPolicy.RUNTIME)
 public @interface PrinterColumn {
 
   /**

diff --git a/.../fabric8/crd/annotation/SpecReplicas.java → ...rnetes/model/annotation/SpecReplicas.java b/.../fabric8/crd/annotation/SpecReplicas.java → ...rnetes/model/annotation/SpecReplicas.java
@@ -13,15 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.fabric8.crd.annotation;
+package io.fabric8.kubernetes.model.annotation;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 @Target({ ElementType.FIELD })
-@Retention(RetentionPolicy.SOURCE)
+@Retention(RetentionPolicy.RUNTIME)
 public @interface SpecReplicas {
 
 }
diff --git a/...abric8/crd/annotation/StatusReplicas.java → ...etes/model/annotation/StatusReplicas.java b/...abric8/crd/annotation/StatusReplicas.java → ...etes/model/annotation/StatusReplicas.java
@@ -13,15 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.fabric8.crd.annotation;
+package io.fabric8.kubernetes.model.annotation;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 @Target({ ElementType.FIELD })
-@Retention(RetentionPolicy.SOURCE)
+@Retention(RetentionPolicy.RUNTIME)
 public @interface StatusReplicas {
 
 }