Skip to content

Commit b4237f4

Browse files
metacosmmetacosm
authored
refactor!: rename JUnit extensions more appropriately (#1200)
* refactor: rename OperatorExtension -> LocalOperatorExtension * refactor: rename E2EOperatorExtension -> ClusterOperatorExtension
1 parent 2941884 commit b4237f4

31 files changed

+117
-109
lines changed

‎operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/E2EOperatorExtension.java renamed to ‎operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/ClusterOperatorExtension.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@
2020
import io.fabric8.kubernetes.api.model.rbac.ClusterRoleBinding;
2121
import io.javaoperatorsdk.operator.api.config.ConfigurationService;
2222

23-
public class E2EOperatorExtension extends AbstractOperatorExtension {
23+
public class ClusterOperatorExtension extends AbstractOperatorExtension {
2424

25-
private static final Logger LOGGER = LoggerFactory.getLogger(E2EOperatorExtension.class);
25+
private static final Logger LOGGER = LoggerFactory.getLogger(ClusterOperatorExtension.class);
2626

2727
private final List<HasMetadata> operatorDeployment;
2828
private final Duration operatorDeploymentTimeout;
2929

30-
private E2EOperatorExtension(
30+
private ClusterOperatorExtension(
3131
ConfigurationService configurationService,
3232
List<HasMetadata> operatorDeployment,
3333
Duration operatorDeploymentTimeout,
@@ -44,7 +44,7 @@ private E2EOperatorExtension(
4444
}
4545

4646
/**
47-
* Creates a {@link Builder} to set up an {@link E2EOperatorExtension} instance.
47+
* Creates a {@link Builder} to set up an {@link ClusterOperatorExtension} instance.
4848
*
4949
* @return the builder.
5050
*/
@@ -132,8 +132,8 @@ public Builder withOperatorDeployment(HasMetadata... hms) {
132132
return this;
133133
}
134134

135-
public E2EOperatorExtension build() {
136-
return new E2EOperatorExtension(
135+
public ClusterOperatorExtension build() {
136+
return new ClusterOperatorExtension(
137137
configurationService,
138138
operatorDeployment,
139139
deploymentTimeout,

‎operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/OperatorExtension.java renamed to ‎operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/LocalOperatorExtension.java

+9-9
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@
2626
import static io.javaoperatorsdk.operator.api.config.ControllerConfigurationOverrider.override;
2727

2828
@SuppressWarnings("rawtypes")
29-
public class OperatorExtension extends AbstractOperatorExtension {
29+
public class LocalOperatorExtension extends AbstractOperatorExtension {
3030

31-
private static final Logger LOGGER = LoggerFactory.getLogger(OperatorExtension.class);
31+
private static final Logger LOGGER = LoggerFactory.getLogger(LocalOperatorExtension.class);
3232

3333
private final Operator operator;
3434
private final List<ReconcilerSpec> reconcilers;
35-
private List<PortFowardSpec> portForwards;
36-
private List<LocalPortForward> localPortForwards;
37-
private Map<Reconciler, RegisteredController> registeredControllers;
35+
private final List<PortFowardSpec> portForwards;
36+
private final List<LocalPortForward> localPortForwards;
37+
private final Map<Reconciler, RegisteredController> registeredControllers;
3838

39-
private OperatorExtension(
39+
private LocalOperatorExtension(
4040
ConfigurationService configurationService,
4141
List<ReconcilerSpec> reconcilers,
4242
List<HasMetadata> infrastructure,
@@ -60,7 +60,7 @@ private OperatorExtension(
6060
}
6161

6262
/**
63-
* Creates a {@link Builder} to set up an {@link OperatorExtension} instance.
63+
* Creates a {@link Builder} to set up an {@link LocalOperatorExtension} instance.
6464
*
6565
* @return the builder.
6666
*/
@@ -221,8 +221,8 @@ public Builder withPortForward(String namespace, String labelKey, String labelVa
221221
return this;
222222
}
223223

224-
public OperatorExtension build() {
225-
return new OperatorExtension(
224+
public LocalOperatorExtension build() {
225+
return new LocalOperatorExtension(
226226
configurationService,
227227
reconcilers,
228228
infrastructure,

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/ChangeNamespaceIT.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
import io.fabric8.kubernetes.api.model.NamespaceBuilder;
1313
import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
1414
import io.fabric8.kubernetes.client.KubernetesClient;
15-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
15+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
1616
import io.javaoperatorsdk.operator.sample.changenamespace.ChangeNamespaceTestCustomResource;
1717
import io.javaoperatorsdk.operator.sample.changenamespace.ChangeNamespaceTestReconciler;
1818

@@ -26,8 +26,8 @@ class ChangeNamespaceIT {
2626
public static final String TEST_RESOURCE_NAME_3 = "test3";
2727
public static final String ADDITIONAL_TEST_NAMESPACE = "additional-test-namespace";
2828
@RegisterExtension
29-
OperatorExtension operator =
30-
OperatorExtension.builder().withReconciler(new ChangeNamespaceTestReconciler()).build();
29+
LocalOperatorExtension operator =
30+
LocalOperatorExtension.builder().withReconciler(new ChangeNamespaceTestReconciler()).build();
3131

3232
@Test
3333
void addNewAndRemoveOldNamespaceTest() {

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/CleanerForReconcilerIT.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import org.junit.jupiter.api.extension.RegisterExtension;
55

66
import io.fabric8.kubernetes.api.model.ObjectMeta;
7-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
7+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
88
import io.javaoperatorsdk.operator.sample.cleanerforreconciler.CleanerForReconcilerCustomResource;
99
import io.javaoperatorsdk.operator.sample.cleanerforreconciler.CleanerForReconcilerTestReconciler;
1010

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

1818
@RegisterExtension
19-
OperatorExtension operator =
20-
OperatorExtension.builder().withReconciler(new CleanerForReconcilerTestReconciler()).build();
19+
LocalOperatorExtension operator =
20+
LocalOperatorExtension.builder().withReconciler(new CleanerForReconcilerTestReconciler())
21+
.build();
2122

2223

2324
@Test

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/ConcurrencyIT.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
import org.slf4j.LoggerFactory;
1111

1212
import io.fabric8.kubernetes.api.model.ConfigMap;
13-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
13+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
1414
import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;
1515
import io.javaoperatorsdk.operator.sample.simple.TestReconciler;
1616
import io.javaoperatorsdk.operator.support.TestUtils;
@@ -26,8 +26,8 @@ class ConcurrencyIT {
2626
private static final Logger log = LoggerFactory.getLogger(ConcurrencyIT.class);
2727

2828
@RegisterExtension
29-
OperatorExtension operator =
30-
OperatorExtension.builder().withReconciler(new TestReconciler(true)).build();
29+
LocalOperatorExtension operator =
30+
LocalOperatorExtension.builder().withReconciler(new TestReconciler(true)).build();
3131

3232
@Test
3333
void manyResourcesGetCreatedUpdatedAndDeleted() throws InterruptedException {

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/ControllerExecutionIT.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import org.junit.jupiter.api.extension.RegisterExtension;
88

99
import io.fabric8.kubernetes.api.model.ConfigMap;
10-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
10+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
1111
import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;
1212
import io.javaoperatorsdk.operator.sample.simple.TestReconciler;
1313
import io.javaoperatorsdk.operator.support.TestUtils;
@@ -18,8 +18,8 @@
1818
class ControllerExecutionIT {
1919

2020
@RegisterExtension
21-
OperatorExtension operator =
22-
OperatorExtension.builder().withReconciler(new TestReconciler(true)).build();
21+
LocalOperatorExtension operator =
22+
LocalOperatorExtension.builder().withReconciler(new TestReconciler(true)).build();
2323

2424
@Test
2525
void configMapGetsCreatedForTestCustomResource() {

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/CreateUpdateInformerEventSourceEventFilterIT.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
import io.fabric8.kubernetes.api.model.ConfigMap;
99
import io.fabric8.kubernetes.api.model.ObjectMeta;
10-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
10+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
1111
import io.javaoperatorsdk.operator.sample.createupdateeventfilter.CreateUpdateEventFilterTestCustomResource;
1212
import io.javaoperatorsdk.operator.sample.createupdateeventfilter.CreateUpdateEventFilterTestCustomResourceSpec;
1313
import io.javaoperatorsdk.operator.sample.createupdateeventfilter.CreateUpdateEventFilterTestReconciler;
@@ -19,8 +19,8 @@
1919
class CreateUpdateInformerEventSourceEventFilterIT {
2020

2121
@RegisterExtension
22-
OperatorExtension operator =
23-
OperatorExtension.builder()
22+
LocalOperatorExtension operator =
23+
LocalOperatorExtension.builder()
2424
.withReconciler(new CreateUpdateEventFilterTestReconciler())
2525
.build();
2626

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/CustomResourceFilterIT.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import org.junit.jupiter.api.extension.RegisterExtension;
55

66
import io.fabric8.kubernetes.api.model.ObjectMeta;
7-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
7+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
88
import io.javaoperatorsdk.operator.sample.customfilter.CustomFilteringTestReconciler;
99
import io.javaoperatorsdk.operator.sample.customfilter.CustomFilteringTestResource;
1010
import io.javaoperatorsdk.operator.sample.customfilter.CustomFilteringTestResourceSpec;
@@ -14,8 +14,8 @@
1414
class CustomResourceFilterIT {
1515

1616
@RegisterExtension
17-
OperatorExtension operator =
18-
OperatorExtension.builder().withReconciler(new CustomFilteringTestReconciler()).build();
17+
LocalOperatorExtension operator =
18+
LocalOperatorExtension.builder().withReconciler(new CustomFilteringTestReconciler()).build();
1919

2020
@Test
2121
void doesCustomFiltering() throws InterruptedException {

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/DeleterForManagedDependentResourcesOnlyIT.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import org.junit.jupiter.api.extension.RegisterExtension;
55

66
import io.fabric8.kubernetes.api.model.ObjectMeta;
7-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
7+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
88
import io.javaoperatorsdk.operator.sample.cleanermanageddependent.CleanerForManagedDependentCustomResource;
99
import io.javaoperatorsdk.operator.sample.cleanermanageddependent.CleanerForManagedDependentTestReconciler;
1010
import io.javaoperatorsdk.operator.sample.cleanermanageddependent.ConfigMapDependentResource;
@@ -17,8 +17,9 @@ class DeleterForManagedDependentResourcesOnlyIT {
1717
public static final String TEST_RESOURCE_NAME = "cleaner-for-reconciler-test1";
1818

1919
@RegisterExtension
20-
OperatorExtension operator =
21-
OperatorExtension.builder().withReconciler(new CleanerForManagedDependentTestReconciler())
20+
LocalOperatorExtension operator =
21+
LocalOperatorExtension.builder()
22+
.withReconciler(new CleanerForManagedDependentTestReconciler())
2223
.build();
2324

2425

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/DependentOperationEventFilterIT.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
import io.fabric8.kubernetes.api.model.ConfigMap;
99
import io.fabric8.kubernetes.api.model.ObjectMeta;
10-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
10+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
1111
import io.javaoperatorsdk.operator.sample.dependentoperationeventfiltering.ConfigMapDependentResource;
1212
import io.javaoperatorsdk.operator.sample.dependentoperationeventfiltering.DependentOperationEventFilterCustomResource;
1313
import io.javaoperatorsdk.operator.sample.dependentoperationeventfiltering.DependentOperationEventFilterCustomResourceSpec;
@@ -23,8 +23,8 @@ class DependentOperationEventFilterIT {
2323
public static final String SPEC_VAL_2 = "val2";
2424

2525
@RegisterExtension
26-
OperatorExtension operator =
27-
OperatorExtension.builder()
26+
LocalOperatorExtension operator =
27+
LocalOperatorExtension.builder()
2828
.withReconciler(new DependentOperationEventFilterCustomResourceTestReconciler())
2929
.build();
3030

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/DependentPrimaryIndexerIT.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
package io.javaoperatorsdk.operator;
22

3-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
3+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
44
import io.javaoperatorsdk.operator.sample.primaryindexer.DependentPrimaryIndexerTestReconciler;
55

66
public class DependentPrimaryIndexerIT extends PrimaryIndexerIT {
77

8-
protected OperatorExtension buildOperator() {
9-
return OperatorExtension.builder().withReconciler(new DependentPrimaryIndexerTestReconciler())
8+
protected LocalOperatorExtension buildOperator() {
9+
return LocalOperatorExtension.builder()
10+
.withReconciler(new DependentPrimaryIndexerTestReconciler())
1011
.build();
1112
}
1213
}

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/ErrorStatusHandlerIT.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import org.junit.jupiter.api.extension.RegisterExtension;
77

88
import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
9-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
9+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
1010
import io.javaoperatorsdk.operator.processing.retry.GenericRetry;
1111
import io.javaoperatorsdk.operator.sample.errorstatushandler.ErrorStatusHandlerTestCustomResource;
1212
import io.javaoperatorsdk.operator.sample.errorstatushandler.ErrorStatusHandlerTestReconciler;
@@ -20,8 +20,8 @@ class ErrorStatusHandlerIT {
2020
ErrorStatusHandlerTestReconciler reconciler = new ErrorStatusHandlerTestReconciler();
2121

2222
@RegisterExtension
23-
OperatorExtension operator =
24-
OperatorExtension.builder()
23+
LocalOperatorExtension operator =
24+
LocalOperatorExtension.builder()
2525
.withReconciler(reconciler,
2626
new GenericRetry().setMaxAttempts(MAX_RETRY_ATTEMPTS).withLinearRetry())
2727
.build();

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/EventSourceIT.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import org.junit.jupiter.api.extension.RegisterExtension;
77

88
import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
9-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
9+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
1010
import io.javaoperatorsdk.operator.sample.event.EventSourceTestCustomReconciler;
1111
import io.javaoperatorsdk.operator.sample.event.EventSourceTestCustomResource;
1212
import io.javaoperatorsdk.operator.sample.event.EventSourceTestCustomResourceSpec;
@@ -17,8 +17,9 @@
1717

1818
class EventSourceIT {
1919
@RegisterExtension
20-
OperatorExtension operator =
21-
OperatorExtension.builder().withReconciler(EventSourceTestCustomReconciler.class).build();
20+
LocalOperatorExtension operator =
21+
LocalOperatorExtension.builder().withReconciler(EventSourceTestCustomReconciler.class)
22+
.build();
2223

2324
@Test
2425
void receivingPeriodicEvents() {

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/InformerEventSourceIT.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
import io.fabric8.kubernetes.api.model.ConfigMap;
1010
import io.fabric8.kubernetes.api.model.ObjectMeta;
11-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
11+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
1212
import io.javaoperatorsdk.operator.sample.informereventsource.InformerEventSourceTestCustomReconciler;
1313
import io.javaoperatorsdk.operator.sample.informereventsource.InformerEventSourceTestCustomResource;
1414

@@ -24,8 +24,8 @@ class InformerEventSourceIT {
2424
public static final String UPDATE_STATUS_MESSAGE = "Updated Status";
2525

2626
@RegisterExtension
27-
OperatorExtension operator =
28-
OperatorExtension.builder()
27+
LocalOperatorExtension operator =
28+
LocalOperatorExtension.builder()
2929
.withReconciler(new InformerEventSourceTestCustomReconciler())
3030
.build();
3131

@@ -38,7 +38,7 @@ void testUsingInformerToWatchChangesOfConfigMap() {
3838
waitForCRStatusValue(INITIAL_STATUS_MESSAGE);
3939

4040
configMap.getData().put(TARGET_CONFIG_MAP_KEY, UPDATE_STATUS_MESSAGE);
41-
configMap = operator.replace(ConfigMap.class, configMap);
41+
operator.replace(ConfigMap.class, configMap);
4242

4343
waitForCRStatusValue(UPDATE_STATUS_MESSAGE);
4444
}

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/KubernetesResourceStatusUpdateIT.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
import io.fabric8.kubernetes.api.model.*;
1212
import io.fabric8.kubernetes.api.model.apps.Deployment;
1313
import io.fabric8.kubernetes.api.model.apps.DeploymentSpec;
14-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
14+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
1515
import io.javaoperatorsdk.operator.sample.deployment.DeploymentReconciler;
1616

1717
import static io.javaoperatorsdk.operator.sample.deployment.DeploymentReconciler.STATUS_MESSAGE;
@@ -21,8 +21,8 @@
2121
class KubernetesResourceStatusUpdateIT {
2222

2323
@RegisterExtension
24-
OperatorExtension operator =
25-
OperatorExtension.builder().withReconciler(new DeploymentReconciler()).build();
24+
LocalOperatorExtension operator =
25+
LocalOperatorExtension.builder().withReconciler(new DeploymentReconciler()).build();
2626

2727
@Test
2828
void testReconciliationOfNonCustomResourceAndStatusUpdate() {

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/MaxIntervalIT.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import org.junit.jupiter.api.extension.RegisterExtension;
77

88
import io.fabric8.kubernetes.api.model.ObjectMeta;
9-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
9+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
1010
import io.javaoperatorsdk.operator.sample.maxinterval.MaxIntervalTestCustomResource;
1111
import io.javaoperatorsdk.operator.sample.maxinterval.MaxIntervalTestReconciler;
1212

@@ -15,8 +15,8 @@
1515
class MaxIntervalIT {
1616

1717
@RegisterExtension
18-
OperatorExtension operator =
19-
OperatorExtension.builder().withReconciler(new MaxIntervalTestReconciler()).build();
18+
LocalOperatorExtension operator =
19+
LocalOperatorExtension.builder().withReconciler(new MaxIntervalTestReconciler()).build();
2020

2121
@Test
2222
void reconciliationTriggeredBasedOnMaxInterval() {

‎operator-framework/src/test/java/io/javaoperatorsdk/operator/MultiVersionCRDIT.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import org.junit.jupiter.api.extension.RegisterExtension;
88

99
import io.fabric8.kubernetes.api.model.ObjectMeta;
10-
import io.javaoperatorsdk.operator.junit.OperatorExtension;
10+
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
1111
import io.javaoperatorsdk.operator.sample.multiversioncrd.*;
1212

1313
import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
@@ -19,8 +19,8 @@ class MultiVersionCRDIT {
1919
public static final String CR_V2_NAME = "crv2";
2020

2121
@RegisterExtension
22-
OperatorExtension operator =
23-
OperatorExtension.builder()
22+
LocalOperatorExtension operator =
23+
LocalOperatorExtension.builder()
2424
.withReconciler(MultiVersionCRDTestReconciler1.class)
2525
.withReconciler(MultiVersionCRDTestReconciler2.class)
2626
.build();

0 commit comments

Comments
 (0)