refactor: move integration tests to feature packages and sub packages…

… based on type (#2483) * refactor: integration tests moved to feature packages and sub packages pased on type Signed-off-by: Attila Mészáros <[email protected]> * fix resource paths Signed-off-by: Attila Mészáros <[email protected]> * fixes Signed-off-by: Attila Mészáros <[email protected]> * link and test fixes Signed-off-by: Attila Mészáros <[email protected]> * format Signed-off-by: Attila Mészáros <[email protected]> * wip Signed-off-by: Attila Mészáros <[email protected]> * old service Signed-off-by: Attila Mészáros <[email protected]> * test fix Signed-off-by: Attila Mészáros <[email protected]> * refactor: remove unneeded classes Signed-off-by: Chris Laprun <[email protected]> * fix: typo in package name Signed-off-by: Chris Laprun <[email protected]> --------- Signed-off-by: Attila Mészáros <[email protected]> Signed-off-by: Chris Laprun <[email protected]> Co-authored-by: Chris Laprun <[email protected]>
operator-framework · Aug 8, 2024 · 02b876b · 02b876b
1 parent dd104ab
commit 02b876b
Show file tree

Hide file tree

Showing 453 changed files with 785 additions and 998 deletions.
diff --git a/docs/content/en/docs/dependent-resources/_index.md b/docs/content/en/docs/dependent-resources/_index.md
@@ -291,7 +291,7 @@ customized by implementing
 by the dependent resource.
 
 See sample in one of the integration
-tests [here](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/primaryindexer/DependentPrimaryIndexerTestReconciler.java#L25-L25)
+tests [here](https://github.com/operator-framework/java-operator-sdk/tree/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/dependent/primaryindexer)
 .
 
 ## Multiple Dependent Resources of Same Type
@@ -310,7 +310,7 @@ There might be casees, though, where it might be problematic to call the `desire
 - Override the `selectManagedSecondaryResource` method, if your `DependentResource` extends `AbstractDependentResource`.
   This should be relatively simple to override this method to optimize the matching to your needs. You can see an
   example of such an implementation in
-  the [`ExternalWithStateDependentResource`](https://github.com/operator-framework/java-operator-sdk/blob/6cd0f884a7c9b60c81bd2d52da54adbd64d6e118/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/externalstate/ExternalWithStateDependentResource.java#L43-L49)
+  the [`ExternalWithStateDependentResource`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/dependent/externalstate/ExternalWithStateDependentResource.java)
   class.
 - Override the `managedSecondaryResourceID` method, if your `DependentResource` extends `KubernetesDependentResource`,
   where it's very often possible to easily determine the `ResourceID` of the secondary resource. This would probably be
@@ -333,9 +333,9 @@ would look as follows:
 ```
 
 A sample is provided as an integration test both:
-for [managed](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/MultipleManagedDependentNoDiscriminatorIT.java)
+for [managed](https://github.com/operator-framework/java-operator-sdk/tree/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/dependent/multipledrsametypenodiscriminator)
 
-For [standalone](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/MultipleDependentResourceIT.java)
+For [standalone](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/dependent/multipledependentresource)
 cases.
 
 ## Bulk Dependent Resources
@@ -352,11 +352,11 @@ implement the
 interface.
 
 Various examples are provided
-as [integration tests](https://github.com/java-operator-sdk/java-operator-sdk/tree/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/bulkdependent)
+as [integration tests](https://github.com/operator-framework/java-operator-sdk/tree/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/dependent/bulkdependent)
 .
 
 To see how bulk dependent resources interact with workflow conditions, please refer to this
-[integration test](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/bulkdependent/BulkDependentWithConditionIT.java).
+[integration test](https://github.com/operator-framework/java-operator-sdk/tree/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/dependent/bulkdependent/conidition).
 
 ## External State Tracking Dependent Resources
 
@@ -377,11 +377,11 @@ interface. Note that most of the JOSDK-provided dependent resource implementatio
 `PollingDependentResource` or `PerResourcePollingDependentResource` already extends
 `AbstractExternalDependentResource`, thus supporting external state tracking out of the box.
 
-See [integration test](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/ExternalStateDependentIT.java)
+See [integration test](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/dependent/externalstate/ExternalStateDependentIT.java)
 as a sample.
 
 For a better understanding it might be worth to study
-a [sample implementation](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/externalstate/ExternalStateReconciler.java)
+a [sample implementation](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/dependent/externalstate/ExternalStateReconciler.java)
 without dependent resources.
 
 Please also refer to the [docs](/docs/patterns-and-best-practices#managing-state) for managing state in
@@ -395,7 +395,7 @@ created. For example, if three bulk dependent resources associated with external
 three associated `ConfigMaps` (assuming `ConfigMaps` are used as a state-tracking resource) will
 also be created, one per dependent resource.
 
-See [integration test](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/ExternalStateBulkIT.java)
+See [integration test](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/dependent/externalstate/externalstatebulkdependent)
 as a sample.
 
 ## GenericKubernetesResource based Dependent Resources
@@ -435,13 +435,13 @@ samples [here](https://github.com/java-operator-sdk/java-operator-sdk/tree/main/
    practice in general) - so for example if there are two config map dependents, either
    there should be a shared event source between them, or a label selector on the event sources
    to select only the relevant events, see
-   in [related integration test](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/orderedmanageddependent/ConfigMapDependentResource1.java)
+   in [related integration test](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/workflow/orderedmanageddependent/ConfigMapDependentResource2.java)
    .
 
 ## "Read-only" Dependent Resources vs. Event Source
 
 See Integration test for a read-only
-dependent [here](https://github.com/java-operator-sdk/java-operator-sdk/blob/249b41f3c68c4d0e9c77c41eca647a69a24347b0/operator-framework/src/test/java/io/javaoperatorsdk/operator/PrimaryToSecondaryDependentIT.java).
+dependent [here](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/dependent/primarytosecondaydependent/ConfigMapDependent.java).
 
 Some secondary resources only exist as input for the reconciliation process and are never
 updated *by a controller* (they might, and actually usually do, get updated by users interacting

diff --git a/docs/content/en/docs/features/_index.md b/docs/content/en/docs/features/_index.md
@@ -97,15 +97,15 @@ using [Server Side Apply (SSA)](https://kubernetes.io/docs/reference/using-api/s
 It is important to understand how SSA works in Kubernetes. Mainly, resources applied using SSA
 should contain only the fields identifying the resource and those the user is interested in (a 'fully specified intent'
 in Kubernetes parlance), thus usually using a resource created from scratch, see
-[sample](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/patchresourcewithssa/PatchResourceWithSSAReconciler.java#L18-L22).
-To contrast, see the same sample, this time [without SSA](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/patchresourceandstatusnossa/PatchResourceAndStatusNoSSAReconciler.java#L16-L16).
+[sample](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/patchresourcewithssa).
+To contrast, see the same sample, this time [without SSA](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/patchresourceandstatusnossa/PatchResourceAndStatusNoSSAReconciler.java).
 
 Non-SSA based patch is still supported.  
 You can control whether or not to use SSA
 using [`ConfigurationServcice.useSSAToPatchPrimaryResource()`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java#L385-L385)
 and the related `ConfigurationServiceOverrider.withUseSSAToPatchPrimaryResource` method.
 Related integration test can be
-found [here](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/patchresourceandstatusnossa/PatchResourceAndStatusNoSSAReconciler.java).
+found [here](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/patchresourceandstatusnossa).
 
 Handling resources directly using the client, instead of delegating these updates operations to JOSDK by returning
 an `UpdateControl` at the end of your reconciliation, should work appropriately. However, we do recommend to
@@ -204,7 +204,7 @@ A Controller can be registered for a non-custom resource, so well known Kubernet
 `Ingress`, `Deployment`,...).
 
 See
-the [integration test](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/deployment/DeploymentReconciler.java)
+the [integration test](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/deployment)
 for reconciling deployments.
 
 ```java 
@@ -529,7 +529,7 @@ between a primary resource and its associated secondary resources using an imple
 `PrimaryToSecondaryMapper` interface. This is typically needed when there are many-to-one or
 many-to-many relationships between primary and secondary resources, e.g. when the primary resource
 is referencing secondary resources.
-See [PrimaryToSecondaryIT](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/PrimaryToSecondaryIT.java)
+See [PrimaryToSecondaryIT](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/primarytosecondary/PrimaryToSecondaryIT.java)
 integration test for a sample.
 
 ### Built-in EventSources
@@ -665,7 +665,7 @@ As seen in the above code snippet, the informer will have the initial namespaces
 controller, but also will adjust the target namespaces if it changes for the controller.
 
 See also
-the [integration test](https://github.com/java-operator-sdk/java-operator-sdk/blob/ec37025a15046d8f409c77616110024bf32c3416/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/changenamespace/ChangeNamespaceTestReconciler.java)
+the [integration test](https://github.com/operator-framework/java-operator-sdk/tree/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/changenamespace)
 for this feature.
 
 ## Leader Election

diff --git a/docs/content/en/docs/workflows/_index.md b/docs/content/en/docs/workflows/_index.md
@@ -46,7 +46,7 @@ reconciliation process.
   [CRDPresentActivationCondition](https://github.com/operator-framework/java-operator-sdk/blob/ba5e33527bf9e3ea0bd33025ccb35e677f9d44b4/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/CRDPresentActivationCondition.java)   
   that will prevent the associated dependent resource from being activated if the Custom Resource Definition associated
   with the dependent's resource type is not present on the cluster.
-  See related [integration test](https://github.com/operator-framework/java-operator-sdk/blob/ba5e33527bf9e3ea0bd33025ccb35e677f9d44b4/operator-framework/src/test/java/io/javaoperatorsdk/operator/CRDPresentActivationConditionIT.java).
+  See related [integration test](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/workflow/crdpresentactivation).
 
   To have multiple resources of same type with an activation condition is a bit tricky, since you
   don't want to have multiple `InformerEventSource` for the same type, you have to explicitly 
@@ -67,7 +67,7 @@ You can access the results for conditions from the `WorkflowResult` instance tha
 evaluated. You can access that result from the `ManagedWorkflowAndDependentResourceContext` accessible from the
 reconciliation `Context`. You can then access individual condition results using the `
 getDependentConditionResult` methods. You can see an example of this
-in [this integration test](https://github.com/operator-framework/java-operator-sdk/blob/fd0e92c0de55c47d5df50658cf4e147ee5e6102d/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/workflowallfeature/WorkflowAllFeatureReconciler.java#L44-L49).
+in [this integration test](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/workflow/workflowallfeature/WorkflowAllFeatureReconciler.java).
 
 ## Defining Workflows
 
@@ -350,7 +350,7 @@ checks that the resource is actually removed or that it, at least, doesn't have
 provides such a delete post-condition implementation in the form of
 [`KubernetesResourceDeletedCondition`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/KubernetesResourceDeletedCondition.java)
 
-Also, check usage in an [integration test](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/manageddependentdeletecondition/ManagedDependentDefaultDeleteConditionReconciler.java).
+Also, check usage in an [integration test](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/workflow/manageddependentdeletecondition/ManagedDependentDefaultDeleteConditionReconciler.java).
 
 In such cases the Kubernetes Dependent Resource should extend `CRUDNoGCKubernetesDependentResource`
 and NOT `CRUDKubernetesDependentResource` since otherwise the Kubernetes Garbage Collector would delete the resources.
@@ -373,13 +373,13 @@ ManagedWorkflowAndDependentResourceContext` retrieved from the reconciliation `C
 resource reconciler `reconcile` method arguments.
 
 See
-related [integration test](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/WorkflowExplicitInvocationIT.java)
+related [integration test](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/workflow/workflowexplicitinvocation)
 for more details.
 
 For `cleanup`, if the `Cleaner` interface is implemented, the `cleanupManageWorkflow()` needs to be called explicitly.
 However, if `Cleaner` interface is not implemented, it will be called implicitly.
 See
-related [integration test](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/WorkflowExplicitCleanupIT.java).
+related [integration test](https://github.com/operator-framework/java-operator-sdk/tree/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/workflow/workflowexplicitcleanup).
 
 While nothing prevents calling the workflow multiple times in a reconciler, it isn't typical or even recommended to do
 so. Conversely, if explicit invocation is requested but `reconcileManagedWorkflow` is not called in the primary resource

diff --git a/...vaoperatorsdk/operator/ConcurrencyIT.java → ...orsdk/operator/baseapi/ConcurrencyIT.java b/...vaoperatorsdk/operator/ConcurrencyIT.java → ...orsdk/operator/baseapi/ConcurrencyIT.java
@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator;
+package io.javaoperatorsdk.operator.baseapi;
 
 import java.util.List;
 import java.util.concurrent.TimeUnit;
@@ -10,9 +10,9 @@
 import org.slf4j.LoggerFactory;
 
 import io.fabric8.kubernetes.api.model.ConfigMap;
+import io.javaoperatorsdk.operator.baseapi.simple.TestCustomResource;
+import io.javaoperatorsdk.operator.baseapi.simple.TestReconciler;
 import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
-import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;
-import io.javaoperatorsdk.operator.sample.simple.TestReconciler;
 import io.javaoperatorsdk.operator.support.TestUtils;
 
 import static org.assertj.core.api.Assertions.assertThat;

diff --git a/...operator/InformerErrorHandlerStartIT.java → .../baseapi/InformerErrorHandlerStartIT.java b/...operator/InformerErrorHandlerStartIT.java → .../baseapi/InformerErrorHandlerStartIT.java
@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator;
+package io.javaoperatorsdk.operator.baseapi;
 
 import java.time.Duration;
 
@@ -9,6 +9,7 @@
 import io.fabric8.kubernetes.client.ConfigBuilder;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.javaoperatorsdk.operator.Operator;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;

diff --git a/.../operator/LeaderElectionPermissionIT.java → ...r/baseapi/LeaderElectionPermissionIT.java b/.../operator/LeaderElectionPermissionIT.java → ...r/baseapi/LeaderElectionPermissionIT.java
@@ -1,14 +1,16 @@
-package io.javaoperatorsdk.operator;
+package io.javaoperatorsdk.operator.baseapi;
 
 import org.junit.jupiter.api.Test;
 
 import io.fabric8.kubernetes.api.model.ConfigMap;
-import io.fabric8.kubernetes.api.model.authorization.v1.*;
 import io.fabric8.kubernetes.api.model.rbac.Role;
 import io.fabric8.kubernetes.api.model.rbac.RoleBinding;
 import io.fabric8.kubernetes.client.ConfigBuilder;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.javaoperatorsdk.operator.Operator;
+import io.javaoperatorsdk.operator.OperatorException;
+import io.javaoperatorsdk.operator.ReconcilerUtils;
 import io.javaoperatorsdk.operator.api.config.LeaderElectionConfiguration;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;

diff --git a/...dk/operator/BuiltInResourceCleanerIT.java → ...urcecleaner/BuiltInResourceCleanerIT.java b/...dk/operator/BuiltInResourceCleanerIT.java → ...urcecleaner/BuiltInResourceCleanerIT.java
@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator;
+package io.javaoperatorsdk.operator.baseapi.builtinresourcecleaner;
 
 import java.util.Map;
 
@@ -8,8 +8,9 @@
 import org.slf4j.LoggerFactory;
 
 import io.fabric8.kubernetes.api.model.Service;
+import io.javaoperatorsdk.operator.ReconcilerUtils;
+import io.javaoperatorsdk.operator.dependent.standalonedependent.StandaloneDependentResourceIT;
 import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
-import io.javaoperatorsdk.operator.sample.builtinresourcecleaner.ObservedGenerationTestReconciler;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.awaitility.Awaitility.await;
@@ -21,7 +22,7 @@ class BuiltInResourceCleanerIT {
   @RegisterExtension
   LocallyRunOperatorExtension operator =
       LocallyRunOperatorExtension.builder()
-          .withReconciler(new ObservedGenerationTestReconciler())
+          .withReconciler(new BuiltInResourceCleanerReconciler())
           .build();
 
   /**
@@ -33,7 +34,7 @@ void cleanerIsCalledOnBuiltInResource() {
     var service = operator.create(testService());
 
     await().untilAsserted(() -> {
-      assertThat(operator.getReconcilerOfType(ObservedGenerationTestReconciler.class)
+      assertThat(operator.getReconcilerOfType(BuiltInResourceCleanerReconciler.class)
           .getReconcileCount()).isPositive();
       var actualService = operator.get(Service.class, service.getMetadata().getName());
       assertThat(actualService.getMetadata().getFinalizers()).isNotEmpty();
@@ -42,14 +43,14 @@ void cleanerIsCalledOnBuiltInResource() {
     operator.delete(service);
 
     await().untilAsserted(() -> {
-      assertThat(operator.getReconcilerOfType(ObservedGenerationTestReconciler.class)
+      assertThat(operator.getReconcilerOfType(BuiltInResourceCleanerReconciler.class)
           .getCleanCount()).isPositive();
     });
   }
 
   Service testService() {
     Service service = ReconcilerUtils.loadYaml(Service.class, StandaloneDependentResourceIT.class,
-        "service-template.yaml");
+        "/io/javaoperatorsdk/operator/service-template.yaml");
     service.getMetadata().setLabels(Map.of("builtintest", "true"));
     return service;
   }