refactor: rename operator-framework module to operator-framework-core

Author: metacosm

operator-framework/pom.xml renamed to operator-framework-core/pom.xml

@@ -1,18 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
-
     <parent>
         <groupId>io.javaoperatorsdk</groupId>
         <artifactId>java-operator-sdk</artifactId>
         <version>1.5.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
-    <artifactId>operator-framework</artifactId>
-    <name>Operator SDK - Framework</name>
-    <description>Framework for implementing Kubernetes operators</description>
+    <artifactId>operator-framework-core</artifactId>
+    <name>Operator SDK - Framework - Core</name>
+    <description>Core framework for implementing Kubernetes operators</description>
     <packaging>jar</packaging>
 
     <properties>

operator-framework/src/main/java/io/javaoperatorsdk/operator/ControllerUtils.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/ControllerUtils.java

@@ -42,7 +42,7 @@ public <R extends CustomResource> void register(ResourceController<R> controller
       throws OperatorException {
     final var configuration = configurationService.getConfigurationFor(controller);
     final var retry = GenericRetry.fromConfiguration(configuration.getRetryConfiguration());
-    final var targetNamespaces = configuration.getNamespaces().toArray(new String[] {});
+    final var targetNamespaces = configuration.getNamespaces().toArray(new String[]{});
     registerController(controller, configuration.watchAllNamespaces(), retry, targetNamespaces);
   }
 
@@ -129,7 +129,7 @@ private CustomResourceEventSource createCustomResourceEventSource(
     CustomResourceEventSource customResourceEventSource =
         watchAllNamespaces
             ? CustomResourceEventSource.customResourceEventSourceForAllNamespaces(
-                customResourceCache, client, generationAware, finalizer)
+            customResourceCache, client, generationAware, finalizer)
             : CustomResourceEventSource.customResourceEventSourceForTargetNamespaces(
                 customResourceCache, client, targetNamespaces, generationAware, finalizer);
 
@@ -152,15 +152,15 @@ private CustomResourceDefinitionContext getCustomResourceDefinitionForController
   }
 
   public Map<Class<? extends CustomResource>, CustomResourceOperationsImpl>
-      getCustomResourceClients() {
+  getCustomResourceClients() {
     return customResourceClients;
   }
 
   public <
-          T extends CustomResource,
-          L extends CustomResourceList<T>,
-          D extends CustomResourceDoneable<T>>
-      CustomResourceOperationsImpl<T, L, D> getCustomResourceClients(Class<T> customResourceClass) {
+      T extends CustomResource,
+      L extends CustomResourceList<T>,
+      D extends CustomResourceDoneable<T>>
+  CustomResourceOperationsImpl<T, L, D> getCustomResourceClients(Class<T> customResourceClass) {
     return customResourceClients.get(customResourceClass);
   }
 }

operator-framework/src/main/java/io/javaoperatorsdk/operator/EventListUtils.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/EventListUtils.java

@@ -2,7 +2,8 @@
 
 public class OperatorException extends RuntimeException {
 
-  public OperatorException() {}
+  public OperatorException() {
+  }
 
   public OperatorException(String message) {
     super(message);

operator-framework/src/main/java/io/javaoperatorsdk/operator/Operator.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java

@@ -8,6 +8,7 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE})
 public @interface Controller {
+
   String NULL = "";
 
   String crdName();

operator-framework/src/main/java/io/javaoperatorsdk/operator/OperatorException.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/OperatorException.java

@@ -15,7 +15,7 @@ public interface ResourceController<R extends CustomResource> {
    *
    * @param resource
    * @return true - so the finalizer is automatically removed after the call. false if you don't
-   *     want to remove the finalizer. Note that this is ALMOST NEVER the case.
+   * want to remove the finalizer. Note that this is ALMOST NEVER the case.
    */
   DeleteControl deleteResource(R resource, Context<R> context);
 
@@ -25,10 +25,10 @@ public interface ResourceController<R extends CustomResource> {
    * parameter (not the custom resource that might be in the events)
    *
    * @return The resource is updated in api server if the return value is present within Optional.
-   *     This the common use cases. However in cases, for example the operator is restarted, and we
-   *     don't want to have an update call to k8s api to be made unnecessarily, by returning an
-   *     empty Optional this update can be skipped. <b>However we will always call an update if
-   *     there is no finalizer on object and its not marked for deletion.</b>
+   * This the common use cases. However in cases, for example the operator is restarted, and we
+   * don't want to have an update call to k8s api to be made unnecessarily, by returning an empty
+   * Optional this update can be skipped. <b>However we will always call an update if there is no
+   * finalizer on object and its not marked for deletion.</b>
    */
   UpdateControl<R> createOrUpdateResource(R resource, Context<R> context);
 
@@ -37,7 +37,8 @@ public interface ResourceController<R extends CustomResource> {
    *
    * @param eventSourceManager
    */
-  default void init(EventSourceManager eventSourceManager) {}
+  default void init(EventSourceManager eventSourceManager) {
+  }
 
   default String getName() {
     final var clazz = getClass();

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/Context.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/Context.java

@@ -5,6 +5,7 @@
 import io.javaoperatorsdk.operator.api.ResourceController;
 
 public interface ConfigurationService {
+
   <R extends CustomResource> ControllerConfiguration<R> getConfigurationFor(
       ResourceController<R> controller);
 

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/Controller.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/Controller.java

@@ -6,6 +6,7 @@
 import java.util.Set;
 
 public interface ControllerConfiguration<R extends CustomResource> {
+
   String WATCH_ALL_NAMESPACES_MARKER = "ALL_NAMESPACES";
 
   String getName();

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/DefaultContext.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/DefaultContext.java

@@ -1,3 +1,5 @@
 package io.javaoperatorsdk.operator.api.config;
 
-public class DefaultRetryConfiguration implements RetryConfiguration {}
+public class DefaultRetryConfiguration implements RetryConfiguration {
+
+}

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/DeleteControl.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/DeleteControl.java

@@ -1,6 +1,7 @@
 package io.javaoperatorsdk.operator.api.config;
 
 public interface RetryConfiguration {
+
   RetryConfiguration DEFAULT = new DefaultRetryConfiguration();
 
   int DEFAULT_MAX_ATTEMPTS = 5;

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/ResourceController.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/ResourceController.java

@@ -11,6 +11,7 @@
 import org.slf4j.LoggerFactory;
 
 public class CustomResourceCache {
+
   private static final Logger log = LoggerFactory.getLogger(CustomResourceCache.class);
 
   private final Map<String, CustomResource> resources = new ConcurrentHashMap<>();

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/RetryInfo.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/RetryInfo.java

@@ -194,7 +194,8 @@ private RetryExecution getOrInitRetryExecution(ExecutionScope executionScope) {
    * <p>Note that this is an improvement, not a bug fix. This situation can happen naturally, we
    * just make the execution more efficient, and avoid questions about conflicts.
    *
-   * <p>Note that without the conditional locking in the cache, there is a very minor chance that we
+   * <p>Note that without the conditional locking in the cache, there is a very minor chance that
+   * we
    * would override an additional change coming from a different client.
    */
   private void cacheUpdatedResourceIfChanged(

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/UpdateControl.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/UpdateControl.java

@@ -10,5 +10,6 @@ public void setEventHandler(EventHandler eventHandler) {
   }
 
   @Override
-  public void eventSourceDeRegisteredForResource(String customResourceUid) {}
+  public void eventSourceDeRegisteredForResource(String customResourceUid) {
+  }
 }

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java

@@ -42,7 +42,7 @@ public String toString() {
         + getCustomResource().getMetadata().getResourceVersion()
         + ", markedForDeletion: "
         + (getCustomResource().getMetadata().getDeletionTimestamp() != null
-            && !getCustomResource().getMetadata().getDeletionTimestamp().isEmpty())
+        && !getCustomResource().getMetadata().getDeletionTimestamp().isEmpty())
         + " ]}";
   }
 

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfiguration.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfiguration.java

@@ -19,7 +19,9 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/** This is a special case since is not bound to a single custom resource */
+/**
+ * This is a special case since is not bound to a single custom resource
+ */
 public class CustomResourceEventSource extends AbstractEventSource
     implements Watcher<CustomResource> {
 

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/config/DefaultRetryConfiguration.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/DefaultRetryConfiguration.java

@@ -60,6 +60,7 @@ public void cancelOnceSchedule(String customResourceUid) {
   }
 
   public class EventProducerTimeTask extends TimerTask {
+
     protected final String customResourceUid;
 
     public EventProducerTimeTask(String customResourceUid) {

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/config/RetryConfiguration.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/RetryConfiguration.java

@@ -120,7 +120,9 @@ void callsDeleteIfObjectHasFinalizerAndMarkedForDelete() {
     verify(controller, times(1)).deleteResource(eq(testCustomResource), any());
   }
 
-  /** Note that there could be more finalizers. Out of our control. */
+  /**
+   * Note that there could be more finalizers. Out of our control.
+   */
   @Test
   void callDeleteOnControllerIfMarkedForDeletionButThereIsNoDefaultFinalizer() {
     markForDeletion(testCustomResource);

operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/CustomResourceCache.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/CustomResourceCache.java

@@ -1,7 +1,11 @@
 package io.javaoperatorsdk.operator.sample.retry;
 
 import io.javaoperatorsdk.operator.TestExecutionInfoProvider;
-import io.javaoperatorsdk.operator.api.*;
+import io.javaoperatorsdk.operator.api.Context;
+import io.javaoperatorsdk.operator.api.Controller;
+import io.javaoperatorsdk.operator.api.DeleteControl;
+import io.javaoperatorsdk.operator.api.ResourceController;
+import io.javaoperatorsdk.operator.api.UpdateControl;
 import java.util.concurrent.atomic.AtomicInteger;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/DefaultEventHandler.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/DefaultEventHandler.java

@@ -6,7 +6,7 @@ spec:
   group: sample.javaoperatorsdk
   version: v1
   subresources:
-    status: {}
+    status: { }
   scope: Namespaced
   names:
     plural: eventsourcesamples

operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/EventBuffer.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/EventBuffer.java

@@ -6,7 +6,7 @@ spec:
   group: sample.javaoperatorsdk
   version: v1
   subresources:
-    status: {}
+    status: { }
   scope: Namespaced
   names:
     plural: retrysamples

operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/EventDispatcher.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/EventDispatcher.java

@@ -6,7 +6,7 @@ spec:
   group: sample.javaoperatorsdk
   version: v1
   subresources:
-    status: {}
+    status: { }
   scope: Namespaced
   names:
     plural: subresourcesample

operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/ExecutionConsumer.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/ExecutionConsumer.java

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Configuration status="WARN">
+  <Appenders>
+    <Console name="Console" target="SYSTEM_OUT">
+      <PatternLayout
+        pattern="%style{%d}{yellow} %style{%threadId}{green} %style{%-30c{1.}}{cyan} %highlight{[%-5level] %msg%n%throwable}{INFO=black}"/>
+    </Console>
+  </Appenders>
+  <Loggers>
+    <Root level="debug">
+      <AppenderRef ref="Console"/>
+    </Root>
+  </Loggers>
+</Configuration>

operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/ExecutionScope.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/ExecutionScope.java

@@ -41,7 +41,7 @@
     </properties>
 
     <modules>
-        <module>operator-framework</module>
+        <module>operator-framework-core</module>
         <module>spring-boot-starter</module>
         <module>samples</module>
         <module>quarkus-extension</module>

operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/KubernetesResourceUtils.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/KubernetesResourceUtils.java

@@ -20,7 +20,7 @@
   <dependencies>
     <dependency>
       <groupId>io.javaoperatorsdk</groupId>
-      <artifactId>operator-framework</artifactId>
+      <artifactId>operator-framework-core</artifactId>
       <version>${project.version}</version>
     </dependency>
     <dependency>
@@ -75,7 +75,7 @@
     </dependency>
     <dependency>
       <groupId>io.javaoperatorsdk</groupId>
-      <artifactId>operator-framework</artifactId>
+      <artifactId>operator-framework-core</artifactId>
       <version>${project.version}</version>
       <classifier>tests</classifier>
       <type>test-jar</type>