Skip to content

refactor: rename JUnit extensions to be more explicit #1254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,15 @@
import io.fabric8.kubernetes.api.model.rbac.ClusterRoleBinding;
import io.javaoperatorsdk.operator.api.config.ConfigurationService;

public class ClusterOperatorExtension extends AbstractOperatorExtension {
public class ClusterDeployedOperatorExtension extends AbstractOperatorExtension {

private static final Logger LOGGER = LoggerFactory.getLogger(ClusterOperatorExtension.class);
private static final Logger LOGGER =
LoggerFactory.getLogger(ClusterDeployedOperatorExtension.class);

private final List<HasMetadata> operatorDeployment;
private final Duration operatorDeploymentTimeout;

private ClusterOperatorExtension(
private ClusterDeployedOperatorExtension(
ConfigurationService configurationService,
List<HasMetadata> operatorDeployment,
Duration operatorDeploymentTimeout,
Expand All @@ -44,7 +45,7 @@ private ClusterOperatorExtension(
}

/**
* Creates a {@link Builder} to set up an {@link ClusterOperatorExtension} instance.
* Creates a {@link Builder} to set up an {@link ClusterDeployedOperatorExtension} instance.
*
* @return the builder.
*/
Expand Down Expand Up @@ -110,6 +111,7 @@ protected Builder() {
this.deploymentTimeout = Duration.ofMinutes(1);
}

@SuppressWarnings("unused")
public Builder withDeploymentTimeout(Duration value) {
deploymentTimeout = value;
return this;
Expand All @@ -127,13 +129,14 @@ public Builder withOperatorDeployment(List<HasMetadata> hm) {
return this;
}

@SuppressWarnings("unused")
public Builder withOperatorDeployment(HasMetadata... hms) {
operatorDeployment.addAll(Arrays.asList(hms));
return this;
}

public ClusterOperatorExtension build() {
return new ClusterOperatorExtension(
public ClusterDeployedOperatorExtension build() {
return new ClusterDeployedOperatorExtension(
configurationService,
operatorDeployment,
deploymentTimeout,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@
import static io.javaoperatorsdk.operator.api.config.ControllerConfigurationOverrider.override;

@SuppressWarnings("rawtypes")
public class LocalOperatorExtension extends AbstractOperatorExtension {
public class LocallyRunOperatorExtension extends AbstractOperatorExtension {

private static final Logger LOGGER = LoggerFactory.getLogger(LocalOperatorExtension.class);
private static final Logger LOGGER = LoggerFactory.getLogger(LocallyRunOperatorExtension.class);

private final Operator operator;
private final List<ReconcilerSpec> reconcilers;
private final List<PortFowardSpec> portForwards;
private final List<LocalPortForward> localPortForwards;
private final Map<Reconciler, RegisteredController> registeredControllers;

private LocalOperatorExtension(
private LocallyRunOperatorExtension(
ConfigurationService configurationService,
List<ReconcilerSpec> reconcilers,
List<HasMetadata> infrastructure,
Expand All @@ -60,7 +60,7 @@ private LocalOperatorExtension(
}

/**
* Creates a {@link Builder} to set up an {@link LocalOperatorExtension} instance.
* Creates a {@link Builder} to set up an {@link LocallyRunOperatorExtension} instance.
*
* @return the builder.
*/
Expand Down Expand Up @@ -221,8 +221,8 @@ public Builder withPortForward(String namespace, String labelKey, String labelVa
return this;
}

public LocalOperatorExtension build() {
return new LocalOperatorExtension(
public LocallyRunOperatorExtension build() {
return new LocallyRunOperatorExtension(
configurationService,
reconcilers,
infrastructure,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
import io.fabric8.kubernetes.api.model.NamespaceBuilder;
import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
import io.fabric8.kubernetes.client.KubernetesClient;
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
import io.javaoperatorsdk.operator.sample.changenamespace.ChangeNamespaceTestCustomResource;
import io.javaoperatorsdk.operator.sample.changenamespace.ChangeNamespaceTestReconciler;

Expand All @@ -26,9 +26,11 @@ class ChangeNamespaceIT {
public static final String TEST_RESOURCE_NAME_3 = "test3";
public static final String ADDITIONAL_TEST_NAMESPACE = "additional-test-namespace";
@RegisterExtension
LocalOperatorExtension operator =
LocalOperatorExtension.builder().withReconciler(new ChangeNamespaceTestReconciler()).build();
LocallyRunOperatorExtension operator =
LocallyRunOperatorExtension.builder().withReconciler(new ChangeNamespaceTestReconciler())
.build();

@SuppressWarnings("rawtypes")
@Test
void addNewAndRemoveOldNamespaceTest() {
try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import org.junit.jupiter.api.extension.RegisterExtension;

import io.fabric8.kubernetes.api.model.ObjectMeta;
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
import io.javaoperatorsdk.operator.sample.cleanerforreconciler.CleanerForReconcilerCustomResource;
import io.javaoperatorsdk.operator.sample.cleanerforreconciler.CleanerForReconcilerTestReconciler;

Expand All @@ -16,8 +16,8 @@ class CleanerForReconcilerIT {
public static final String TEST_RESOURCE_NAME = "cleaner-for-reconciler-test1";

@RegisterExtension
LocalOperatorExtension operator =
LocalOperatorExtension.builder().withReconciler(new CleanerForReconcilerTestReconciler())
LocallyRunOperatorExtension operator =
LocallyRunOperatorExtension.builder().withReconciler(new CleanerForReconcilerTestReconciler())
.build();


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import org.junit.jupiter.api.extension.RegisterExtension;

import io.fabric8.kubernetes.api.model.ObjectMeta;
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
import io.javaoperatorsdk.operator.sample.cleanupconflict.CleanupConflictCustomResource;
import io.javaoperatorsdk.operator.sample.cleanupconflict.CleanupConflictReconciler;

Expand All @@ -20,8 +20,8 @@ class CleanupConflictIT {
public static final String TEST_RESOURCE_NAME = "test1";

@RegisterExtension
LocalOperatorExtension operator =
LocalOperatorExtension.builder().withReconciler(new CleanupConflictReconciler())
LocallyRunOperatorExtension operator =
LocallyRunOperatorExtension.builder().withReconciler(new CleanupConflictReconciler())
.build();

@Test
Expand All @@ -30,10 +30,9 @@ void cleanupRemovesFinalizerWithoutConflict() throws InterruptedException {
testResource.addFinalizer(ADDITIONAL_FINALIZER);
testResource = operator.create(CleanupConflictCustomResource.class, testResource);

await().untilAsserted(() -> {
assertThat(operator.getReconcilerOfType(CleanupConflictReconciler.class)
.getNumberReconcileExecutions()).isEqualTo(1);
});
await().untilAsserted(
() -> assertThat(operator.getReconcilerOfType(CleanupConflictReconciler.class)
.getNumberReconcileExecutions()).isEqualTo(1));

operator.delete(CleanupConflictCustomResource.class, testResource);
Thread.sleep(WAIT_TIME / 2);
Expand All @@ -42,10 +41,9 @@ void cleanupRemovesFinalizerWithoutConflict() throws InterruptedException {
testResource.getMetadata().setResourceVersion(null);
operator.replace(CleanupConflictCustomResource.class, testResource);

await().pollDelay(Duration.ofMillis(WAIT_TIME * 2)).untilAsserted(() -> {
assertThat(operator.getReconcilerOfType(CleanupConflictReconciler.class)
.getNumberOfCleanupExecutions()).isEqualTo(1);
});
await().pollDelay(Duration.ofMillis(WAIT_TIME * 2)).untilAsserted(
() -> assertThat(operator.getReconcilerOfType(CleanupConflictReconciler.class)
.getNumberOfCleanupExecutions()).isEqualTo(1));
}

private CleanupConflictCustomResource createTestResource() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import org.slf4j.LoggerFactory;

import io.fabric8.kubernetes.api.model.ConfigMap;
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
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;
Expand All @@ -26,8 +26,8 @@ class ConcurrencyIT {
private static final Logger log = LoggerFactory.getLogger(ConcurrencyIT.class);

@RegisterExtension
LocalOperatorExtension operator =
LocalOperatorExtension.builder().withReconciler(new TestReconciler(true)).build();
LocallyRunOperatorExtension operator =
LocallyRunOperatorExtension.builder().withReconciler(new TestReconciler(true)).build();

@Test
void manyResourcesGetCreatedUpdatedAndDeleted() throws InterruptedException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import org.junit.jupiter.api.extension.RegisterExtension;

import io.fabric8.kubernetes.api.model.ConfigMap;
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
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;
Expand All @@ -18,8 +18,8 @@
class ControllerExecutionIT {

@RegisterExtension
LocalOperatorExtension operator =
LocalOperatorExtension.builder().withReconciler(new TestReconciler(true)).build();
LocallyRunOperatorExtension operator =
LocallyRunOperatorExtension.builder().withReconciler(new TestReconciler(true)).build();

@Test
void configMapGetsCreatedForTestCustomResource() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import io.fabric8.kubernetes.api.model.ConfigMap;
import io.fabric8.kubernetes.api.model.ObjectMeta;
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
import io.javaoperatorsdk.operator.sample.createupdateeventfilter.CreateUpdateEventFilterTestCustomResource;
import io.javaoperatorsdk.operator.sample.createupdateeventfilter.CreateUpdateEventFilterTestCustomResourceSpec;
import io.javaoperatorsdk.operator.sample.createupdateeventfilter.CreateUpdateEventFilterTestReconciler;
Expand All @@ -19,8 +19,8 @@
class CreateUpdateInformerEventSourceEventFilterIT {

@RegisterExtension
LocalOperatorExtension operator =
LocalOperatorExtension.builder()
LocallyRunOperatorExtension operator =
LocallyRunOperatorExtension.builder()
.withReconciler(new CreateUpdateEventFilterTestReconciler())
.build();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import org.junit.jupiter.api.extension.RegisterExtension;

import io.fabric8.kubernetes.api.model.ObjectMeta;
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
import io.javaoperatorsdk.operator.sample.customfilter.CustomFilteringTestReconciler;
import io.javaoperatorsdk.operator.sample.customfilter.CustomFilteringTestResource;
import io.javaoperatorsdk.operator.sample.customfilter.CustomFilteringTestResourceSpec;
Expand All @@ -14,8 +14,9 @@
class CustomResourceFilterIT {

@RegisterExtension
LocalOperatorExtension operator =
LocalOperatorExtension.builder().withReconciler(new CustomFilteringTestReconciler()).build();
LocallyRunOperatorExtension operator =
LocallyRunOperatorExtension.builder().withReconciler(new CustomFilteringTestReconciler())
.build();

@Test
void doesCustomFiltering() throws InterruptedException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import org.junit.jupiter.api.extension.RegisterExtension;

import io.fabric8.kubernetes.api.model.ObjectMeta;
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
import io.javaoperatorsdk.operator.sample.cleanermanageddependent.CleanerForManagedDependentCustomResource;
import io.javaoperatorsdk.operator.sample.cleanermanageddependent.CleanerForManagedDependentTestReconciler;
import io.javaoperatorsdk.operator.sample.cleanermanageddependent.ConfigMapDependentResource;
Expand All @@ -17,8 +17,8 @@ class DeleterForManagedDependentResourcesOnlyIT {
public static final String TEST_RESOURCE_NAME = "cleaner-for-reconciler-test1";

@RegisterExtension
LocalOperatorExtension operator =
LocalOperatorExtension.builder()
LocallyRunOperatorExtension operator =
LocallyRunOperatorExtension.builder()
.withReconciler(new CleanerForManagedDependentTestReconciler())
.build();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import io.fabric8.kubernetes.api.model.ConfigMap;
import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
import io.javaoperatorsdk.operator.sample.dependentannotationsecondarymapper.DependentAnnotationSecondaryMapperReconciler;
import io.javaoperatorsdk.operator.sample.dependentannotationsecondarymapper.DependentAnnotationSecondaryMapperResource;

Expand All @@ -21,8 +21,8 @@ class DependentAnnotationSecondaryMapperIT {
public static final String TEST_RESOURCE_NAME = "test1";

@RegisterExtension
LocalOperatorExtension operator =
LocalOperatorExtension.builder()
LocallyRunOperatorExtension operator =
LocallyRunOperatorExtension.builder()
.withReconciler(DependentAnnotationSecondaryMapperReconciler.class)
.build();

Expand All @@ -33,9 +33,8 @@ void mapsSecondaryByAnnotation() {
var reconciler =
operator.getReconcilerOfType(DependentAnnotationSecondaryMapperReconciler.class);

await().pollDelay(Duration.ofMillis(150)).untilAsserted(() -> {
assertThat(reconciler.getNumberOfExecutions()).isEqualTo(1);
});
await().pollDelay(Duration.ofMillis(150))
.untilAsserted(() -> assertThat(reconciler.getNumberOfExecutions()).isEqualTo(1));
var configMap = operator.get(ConfigMap.class, TEST_RESOURCE_NAME);

var annotations = configMap.getMetadata().getAnnotations();
Expand All @@ -49,9 +48,8 @@ void mapsSecondaryByAnnotation() {
configMap.getData().put("additional_data", "data");
operator.replace(ConfigMap.class, configMap);

await().pollDelay(Duration.ofMillis(150)).untilAsserted(() -> {
assertThat(reconciler.getNumberOfExecutions()).isEqualTo(2);
});
await().pollDelay(Duration.ofMillis(150))
.untilAsserted(() -> assertThat(reconciler.getNumberOfExecutions()).isEqualTo(2));
}


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import io.fabric8.kubernetes.api.model.ConfigMap;
import io.fabric8.kubernetes.api.model.ObjectMeta;
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
import io.javaoperatorsdk.operator.sample.dependentoperationeventfiltering.ConfigMapDependentResource;
import io.javaoperatorsdk.operator.sample.dependentoperationeventfiltering.DependentOperationEventFilterCustomResource;
import io.javaoperatorsdk.operator.sample.dependentoperationeventfiltering.DependentOperationEventFilterCustomResourceSpec;
Expand All @@ -23,8 +23,8 @@ class DependentOperationEventFilterIT {
public static final String SPEC_VAL_2 = "val2";

@RegisterExtension
LocalOperatorExtension operator =
LocalOperatorExtension.builder()
LocallyRunOperatorExtension operator =
LocallyRunOperatorExtension.builder()
.withReconciler(new DependentOperationEventFilterCustomResourceTestReconciler())
.build();

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
package io.javaoperatorsdk.operator;

import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
import io.javaoperatorsdk.operator.sample.primaryindexer.DependentPrimaryIndexerTestReconciler;

public class DependentPrimaryIndexerIT extends PrimaryIndexerIT {

protected LocalOperatorExtension buildOperator() {
return LocalOperatorExtension.builder()
protected LocallyRunOperatorExtension buildOperator() {
return LocallyRunOperatorExtension.builder()
.withReconciler(new DependentPrimaryIndexerTestReconciler())
.build();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import io.fabric8.kubernetes.api.model.ConfigMap;
import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
import io.fabric8.kubernetes.api.model.Secret;
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
import io.javaoperatorsdk.operator.sample.dependentresourcecrossref.DependentResourceCrossRefReconciler;
import io.javaoperatorsdk.operator.sample.dependentresourcecrossref.DependentResourceCrossRefResource;

Expand All @@ -21,8 +21,8 @@ class DependentResourceCrossRefIT {
public static final int EXECUTION_NUMBER = 50;

@RegisterExtension
LocalOperatorExtension operator =
LocalOperatorExtension.builder()
LocallyRunOperatorExtension operator =
LocallyRunOperatorExtension.builder()
.withReconciler(new DependentResourceCrossRefReconciler())
.build();

Expand Down
Loading