refactor: rename runtime-configuration to operator-framework

This is the module that should now be imported by non-Quarkus apps

Author: metacosm

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/ResourceController.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);
 

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

@@ -194,8 +194,7 @@ 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(

runtime-configuration/pom.xml renamed to operator-framework/pom.xml

@@ -1,16 +1,16 @@
 <?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">
+  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">
   <parent>
     <artifactId>java-operator-sdk</artifactId>
     <groupId>io.javaoperatorsdk</groupId>
     <version>1.5.1-SNAPSHOT</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
 
-  <artifactId>runtime-configuration</artifactId>
-  <name>Operator SDK - Runtime configuration support</name>
+  <artifactId>operator-framework</artifactId>
+  <name>Operator SDK - Framework - Plain Java</name>
 
   <properties>
     <maven.compiler.source>11</maven.compiler.source>

runtime-configuration/src/main/java/io/javaoperatorsdk/operator/config/runtime/AccumulativeMappingWriter.java renamed to operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/AccumulativeMappingWriter.java

@@ -47,15 +47,16 @@ public AccumulativeMappingWriter loadExistingMappings() {
     return this;
   }
 
-  /** Add a new mapping */
+  /**
+   * Add a new mapping
+   */
   public AccumulativeMappingWriter add(String key, String value) {
     this.mappings.put(key, value);
     return this;
   }
 
   /**
-   * Generates or overrise the resource file with the given path
-   * ({@linkAccumulativeMappingWriter#resourcePath})
+   * Generates or overrise the resource file with the given path ({@linkAccumulativeMappingWriter#resourcePath})
    */
   public void flush() {
     PrintWriter printWriter = null;

runtime-configuration/src/main/java/io/javaoperatorsdk/operator/config/runtime/AnnotationConfiguration.java renamed to operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/AnnotationConfiguration.java

@@ -10,6 +10,7 @@
 
 public class AnnotationConfiguration<R extends CustomResource>
     implements ControllerConfiguration<R> {
+
   private final ResourceController<R> controller;
   private final Controller annotation;
 

runtime-configuration/src/main/java/io/javaoperatorsdk/operator/config/runtime/ClassMappingProvider.java renamed to operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/ClassMappingProvider.java

@@ -15,6 +15,7 @@
 import org.slf4j.LoggerFactory;
 
 class ClassMappingProvider {
+
   private static final Logger log = LoggerFactory.getLogger(ClassMappingProvider.class);
 
   static <T, V> Map<T, V> provide(final String resourcePath, T key, V value) {

runtime-configuration/src/main/java/io/javaoperatorsdk/operator/config/runtime/ControllerAnnotationProcessor.java renamed to operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/ControllerAnnotationProcessor.java

@@ -8,6 +8,7 @@
 import java.util.concurrent.ConcurrentHashMap;
 
 public class DefaultConfigurationService implements ConfigurationService {
+
   private static final ConfigurationService instance = new DefaultConfigurationService();
   private final Map<String, ControllerConfiguration> configurations = new ConcurrentHashMap<>();
 

runtime-configuration/src/main/java/io/javaoperatorsdk/operator/config/runtime/DefaultConfigurationService.java renamed to operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/DefaultConfigurationService.java

@@ -38,8 +38,8 @@ static <R extends CustomResource> Class<R> getCustomResourceClass(
   }
 
   public static <T extends CustomResource>
-      Class<? extends CustomResourceDoneable<T>> getCustomResourceDoneableClass(
-          ResourceController<T> controller) {
+  Class<? extends CustomResourceDoneable<T>> getCustomResourceDoneableClass(
+      ResourceController<T> controller) {
     final Class<T> customResourceClass = getCustomResourceClass(controller);
     final Class<? extends CustomResourceDoneable<T>> doneableClass =
         (Class<? extends CustomResourceDoneable<T>>)

runtime-configuration/src/main/java/io/javaoperatorsdk/operator/config/runtime/RuntimeControllerMetadata.java renamed to operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/RuntimeControllerMetadata.java

@@ -15,7 +15,9 @@
 import javax.lang.model.type.TypeVariable;
 import javax.lang.model.util.Types;
 
-/** This class can resolve a type parameter in the given index to the actual type defined. */
+/**
+ * This class can resolve a type parameter in the given index to the actual type defined.
+ */
 class TypeParameterResolver {
 
   private final DeclaredType interestedClass;
@@ -28,12 +30,12 @@ public TypeParameterResolver(DeclaredType interestedClass, int interestedTypeArg
   }
 
   /**
-   * @param typeUtils Type utilities, During the annotation processing processingEnv.getTypeUtils()
-   *     can be passed.
+   * @param typeUtils    Type utilities, During the annotation processing processingEnv.getTypeUtils()
+   *                     can be passed.
    * @param declaredType Class or Interface which extends or implements the interestedClass, and the
-   *     interest is getting the actual declared type is used.
+   *                     interest is getting the actual declared type is used.
    * @return the type of the parameter if it can be resolved from the the given declareType,
-   *     otherwise it returns null
+   * otherwise it returns null
    */
   public TypeMirror resolve(Types typeUtils, DeclaredType declaredType) {
     final var chain = findChain(typeUtils, declaredType);
@@ -137,18 +139,18 @@ private List<DeclaredType> findChainOfInterfaces(Types typeUtils, DeclaredType p
     var matchingInterfaces =
         ((TypeElement) parentInterface.asElement())
             .getInterfaces().stream()
-                .filter(i -> typeUtils.isAssignable(i, interestedClass))
-                .map(i -> (DeclaredType) i)
-                .collect(Collectors.toList());
+            .filter(i -> typeUtils.isAssignable(i, interestedClass))
+            .map(i -> (DeclaredType) i)
+            .collect(Collectors.toList());
     while (matchingInterfaces.size() > 0) {
       result.addAll(matchingInterfaces);
       final var lastFoundInterface = matchingInterfaces.get(matchingInterfaces.size() - 1);
       matchingInterfaces =
           ((TypeElement) lastFoundInterface.asElement())
               .getInterfaces().stream()
-                  .filter(i -> typeUtils.isAssignable(i, interestedClass))
-                  .map(i -> (DeclaredType) i)
-                  .collect(Collectors.toList());
+              .filter(i -> typeUtils.isAssignable(i, interestedClass))
+              .map(i -> (DeclaredType) i)
+              .collect(Collectors.toList());
     }
     return result;
   }

runtime-configuration/src/main/java/io/javaoperatorsdk/operator/config/runtime/TypeParameterResolver.java renamed to operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/TypeParameterResolver.java

@@ -15,6 +15,7 @@
 
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 public class EventSourceIT {
+
   private static final Logger log = LoggerFactory.getLogger(EventSourceIT.class);
 
   public static final int EXPECTED_TIMER_EVENT_COUNT = 3;

runtime-configuration/src/test/java/io/javaoperatorsdk/operator/ConcurrencyIT.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/ConcurrencyIT.java

@@ -32,10 +32,10 @@ public class IntegrationTestSupport {
   private static final Logger log = LoggerFactory.getLogger(IntegrationTestSupport.class);
   private KubernetesClient k8sClient;
   private MixedOperation<
-          CustomResource,
-          CustomResourceList,
-          CustomResourceDoneable,
-          Resource<CustomResource, CustomResourceDoneable>>
+      CustomResource,
+      CustomResourceList,
+      CustomResourceDoneable,
+      Resource<CustomResource, CustomResourceDoneable>>
       crOperations;
   private Operator operator;
   private ResourceController controller;
@@ -179,11 +179,11 @@ public KubernetesClient getK8sClient() {
   }
 
   public MixedOperation<
-          CustomResource,
-          CustomResourceList,
-          CustomResourceDoneable,
-          Resource<CustomResource, CustomResourceDoneable>>
-      getCrOperations() {
+      CustomResource,
+      CustomResourceList,
+      CustomResourceDoneable,
+      Resource<CustomResource, CustomResourceDoneable>>
+  getCrOperations() {
     return crOperations;
   }
 
@@ -196,6 +196,7 @@ public Operator getOperator() {
   }
 
   public interface TestRun {
+
     void run() throws Exception;
   }
 }

runtime-configuration/src/test/java/io/javaoperatorsdk/operator/ControllerExecutionIT.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/ControllerExecutionIT.java

@@ -62,7 +62,9 @@ public void updatesSubResourceStatusNoFinalizer() {
         });
   }
 
-  /** Note that we check on controller impl if there is finalizer on execution. */
+  /**
+   * Note that we check on controller impl if there is finalizer on execution.
+   */
   @Test
   public void ifNoFinalizerPresentFirstAddsTheFinalizerThenExecutesControllerAgain() {
     integrationTestSupport.teardownIfSuccess(

runtime-configuration/src/test/java/io/javaoperatorsdk/operator/EventSourceIT.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/EventSourceIT.java

@@ -16,6 +16,7 @@
 import org.junit.jupiter.api.Test;
 
 public class DefaultConfigurationServiceTest {
+
   public static final String CUSTOM_FINALIZER_NAME = "a.custom/finalizer";
 
   @Test
@@ -52,7 +53,10 @@ public void supportsInnerClassCustomResources() {
   @Controller(crdName = "test.crd", finalizerName = CUSTOM_FINALIZER_NAME)
   static class TestCustomFinalizerController
       implements ResourceController<TestCustomFinalizerController.InnerCustomResource> {
-    public class InnerCustomResource extends CustomResource {}
+
+    public class InnerCustomResource extends CustomResource {
+
+    }
 
     @Override
     public DeleteControl deleteResource(

runtime-configuration/src/test/java/io/javaoperatorsdk/operator/IntegrationTestSupport.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/IntegrationTestSupport.java

@@ -2,4 +2,6 @@
 
 import io.fabric8.kubernetes.client.CustomResource;
 
-class TestCustomResource extends CustomResource {}
+class TestCustomResource extends CustomResource {
+
+}

runtime-configuration/src/test/java/io/javaoperatorsdk/operator/RetryIT.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/RetryIT.java

@@ -42,10 +42,10 @@
 
     <modules>
         <module>operator-framework-core</module>
+        <module>operator-framework</module>
         <module>spring-boot-starter</module>
         <module>samples</module>
         <module>quarkus-extension</module>
-        <module>runtime-configuration</module>
     </modules>
 
 

runtime-configuration/src/test/java/io/javaoperatorsdk/operator/SubResourceUpdateIT.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/SubResourceUpdateIT.java

@@ -16,7 +16,7 @@
   <dependencies>
     <dependency>
       <groupId>io.javaoperatorsdk</groupId>
-      <artifactId>operator-framework</artifactId>
+      <artifactId>operator-framework-core</artifactId>
       <version>${project.version}</version>
       <scope>compile</scope>
     </dependency>

runtime-configuration/src/test/java/io/javaoperatorsdk/operator/config/runtime/ControllerAnnotationProcessorTest.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/config/runtime/ControllerAnnotationProcessorTest.java

@@ -26,12 +26,6 @@
             <artifactId>operator-framework</artifactId>
             <version>${project.version}</version>
         </dependency>
-        <dependency>
-            <groupId>io.javaoperatorsdk</groupId>
-            <artifactId>runtime-configuration</artifactId>
-            <version>${project.version}</version>
-            <scope>compile</scope>
-        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>

runtime-configuration/src/test/java/io/javaoperatorsdk/operator/config/runtime/DefaultConfigurationServiceTest.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/config/runtime/DefaultConfigurationServiceTest.java

@@ -26,11 +26,6 @@
             <artifactId>operator-framework</artifactId>
             <version>${project.version}</version>
         </dependency>
-        <dependency>
-            <groupId>io.javaoperatorsdk</groupId>
-            <artifactId>runtime-configuration</artifactId>
-            <version>${project.version}</version>
-        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>

runtime-configuration/src/test/java/io/javaoperatorsdk/operator/config/runtime/TestCustomResource.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/config/runtime/TestCustomResource.java

@@ -26,11 +26,6 @@
             <artifactId>operator-framework-samples-common</artifactId>
             <version>${project.version}</version>
         </dependency>
-        <dependency>
-            <groupId>io.javaoperatorsdk</groupId>
-            <artifactId>runtime-configuration</artifactId>
-            <version>${project.version}</version>
-        </dependency>
     </dependencies>
 
 </project>

runtime-configuration/src/test/resources/compile-fixtures/AbstractController.java renamed to operator-framework/src/test/resources/compile-fixtures/AbstractController.java

@@ -26,11 +26,6 @@
             <artifactId>operator-framework-samples-common</artifactId>
             <version>${project.version}</version>
         </dependency>
-        <dependency>
-            <groupId>io.javaoperatorsdk</groupId>
-            <artifactId>runtime-configuration</artifactId>
-            <version>${project.version}</version>
-        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-log4j2</artifactId>

runtime-configuration/src/test/resources/compile-fixtures/AdditionalControllerInterface.java renamed to operator-framework/src/test/resources/compile-fixtures/AdditionalControllerInterface.java

@@ -28,11 +28,6 @@
             <artifactId>operator-framework</artifactId>
             <version>${project.version}</version>
         </dependency>
-        <dependency>
-            <groupId>io.javaoperatorsdk</groupId>
-            <artifactId>runtime-configuration</artifactId>
-            <version>${project.version}</version>
-        </dependency>
         <dependency>
             <groupId>org.apache.logging.log4j</groupId>
             <artifactId>log4j-slf4j-impl</artifactId>

runtime-configuration/src/test/resources/compile-fixtures/ControllerImplemented2Interfaces.java renamed to operator-framework/src/test/resources/compile-fixtures/ControllerImplemented2Interfaces.java

@@ -26,11 +26,6 @@
             <artifactId>operator-framework</artifactId>
             <version>${project.version}</version>
         </dependency>
-        <dependency>
-            <groupId>io.javaoperatorsdk</groupId>
-            <artifactId>runtime-configuration</artifactId>
-            <version>${project.version}</version>
-        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>

runtime-configuration/src/test/resources/compile-fixtures/ControllerImplemented2InterfacesExpected.java renamed to operator-framework/src/test/resources/compile-fixtures/ControllerImplemented2InterfacesExpected.java

@@ -91,11 +91,6 @@
             <artifactId>operator-framework</artifactId>
             <version>${project.version}</version>
         </dependency>
-        <dependency>
-            <groupId>io.javaoperatorsdk</groupId>
-            <artifactId>runtime-configuration</artifactId>
-            <version>${project.version}</version>
-        </dependency>
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-core</artifactId>