Skip to content

Commit 53cbd95

Browse files
metacosmcsviri
metacosm
authored and
csviri
committed
refactor: rename JUnit extensions to be more explicit (#1254)
Fixes #1215
1 parent ed8ca54 commit 53cbd95

File tree

38 files changed

+168
-147
lines changed

38 files changed

+168
-147
lines changed

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,15 @@
2020
import io.fabric8.kubernetes.api.model.rbac.ClusterRoleBinding;
2121
import io.javaoperatorsdk.operator.api.config.ConfigurationService;
2222

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

25-
private static final Logger LOGGER = LoggerFactory.getLogger(ClusterOperatorExtension.class);
25+
private static final Logger LOGGER =
26+
LoggerFactory.getLogger(ClusterDeployedOperatorExtension.class);
2627

2728
private final List<HasMetadata> operatorDeployment;
2829
private final Duration operatorDeploymentTimeout;
2930

30-
private ClusterOperatorExtension(
31+
private ClusterDeployedOperatorExtension(
3132
ConfigurationService configurationService,
3233
List<HasMetadata> operatorDeployment,
3334
Duration operatorDeploymentTimeout,
@@ -44,7 +45,7 @@ private ClusterOperatorExtension(
4445
}
4546

4647
/**
47-
* Creates a {@link Builder} to set up an {@link ClusterOperatorExtension} instance.
48+
* Creates a {@link Builder} to set up an {@link ClusterDeployedOperatorExtension} instance.
4849
*
4950
* @return the builder.
5051
*/
@@ -110,6 +111,7 @@ protected Builder() {
110111
this.deploymentTimeout = Duration.ofMinutes(1);
111112
}
112113

114+
@SuppressWarnings("unused")
113115
public Builder withDeploymentTimeout(Duration value) {
114116
deploymentTimeout = value;
115117
return this;
@@ -127,13 +129,14 @@ public Builder withOperatorDeployment(List<HasMetadata> hm) {
127129
return this;
128130
}
129131

132+
@SuppressWarnings("unused")
130133
public Builder withOperatorDeployment(HasMetadata... hms) {
131134
operatorDeployment.addAll(Arrays.asList(hms));
132135
return this;
133136
}
134137

135-
public ClusterOperatorExtension build() {
136-
return new ClusterOperatorExtension(
138+
public ClusterDeployedOperatorExtension build() {
139+
return new ClusterDeployedOperatorExtension(
137140
configurationService,
138141
operatorDeployment,
139142
deploymentTimeout,

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
import static io.javaoperatorsdk.operator.api.config.ControllerConfigurationOverrider.override;
2929

3030
@SuppressWarnings("rawtypes")
31-
public class LocalOperatorExtension extends AbstractOperatorExtension {
31+
public class LocallyRunOperatorExtension extends AbstractOperatorExtension {
3232

33-
private static final Logger LOGGER = LoggerFactory.getLogger(LocalOperatorExtension.class);
33+
private static final Logger LOGGER = LoggerFactory.getLogger(LocallyRunOperatorExtension.class);
3434

3535
private final Operator operator;
3636
private final List<ReconcilerSpec> reconcilers;
@@ -39,7 +39,7 @@ public class LocalOperatorExtension extends AbstractOperatorExtension {
3939
private final List<Class<? extends CustomResource>> additionalCustomResourceDefinitions;
4040
private final Map<Reconciler, RegisteredController> registeredControllers;
4141

42-
private LocalOperatorExtension(
42+
private LocallyRunOperatorExtension(
4343
ConfigurationService configurationService,
4444
List<ReconcilerSpec> reconcilers,
4545
List<HasMetadata> infrastructure,
@@ -65,7 +65,7 @@ private LocalOperatorExtension(
6565
}
6666

6767
/**
68-
* Creates a {@link Builder} to set up an {@link LocalOperatorExtension} instance.
68+
* Creates a {@link Builder} to set up an {@link LocallyRunOperatorExtension} instance.
6969
*
7070
* @return the builder.
7171
*/
@@ -236,14 +236,14 @@ public Builder withPortForward(String namespace, String labelKey, String labelVa
236236
}
237237

238238
public Builder withAdditionalCustomResourceDefinition(
239-
Class<? extends CustomResource> customResource) {
239+
Class<? extends CustomResource> customResource) {
240240
additionalCustomResourceDefinitions.add(customResource);
241241
return this;
242242
}
243243

244244

245-
public LocalOperatorExtension build() {
246-
return new LocalOperatorExtension(
245+
public LocallyRunOperatorExtension build() {
246+
return new LocallyRunOperatorExtension(
247247
configurationService,
248248
reconcilers,
249249
infrastructure,

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

Lines changed: 5 additions & 3 deletions
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.LocalOperatorExtension;
15+
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
1616
import io.javaoperatorsdk.operator.sample.changenamespace.ChangeNamespaceTestCustomResource;
1717
import io.javaoperatorsdk.operator.sample.changenamespace.ChangeNamespaceTestReconciler;
1818

@@ -26,9 +26,11 @@ 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-
LocalOperatorExtension operator =
30-
LocalOperatorExtension.builder().withReconciler(new ChangeNamespaceTestReconciler()).build();
29+
LocallyRunOperatorExtension operator =
30+
LocallyRunOperatorExtension.builder().withReconciler(new ChangeNamespaceTestReconciler())
31+
.build();
3132

33+
@SuppressWarnings("rawtypes")
3234
@Test
3335
void addNewAndRemoveOldNamespaceTest() {
3436
try {

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

Lines changed: 3 additions & 3 deletions
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.LocalOperatorExtension;
7+
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
88
import io.javaoperatorsdk.operator.sample.cleanerforreconciler.CleanerForReconcilerCustomResource;
99
import io.javaoperatorsdk.operator.sample.cleanerforreconciler.CleanerForReconcilerTestReconciler;
1010

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

1818
@RegisterExtension
19-
LocalOperatorExtension operator =
20-
LocalOperatorExtension.builder().withReconciler(new CleanerForReconcilerTestReconciler())
19+
LocallyRunOperatorExtension operator =
20+
LocallyRunOperatorExtension.builder().withReconciler(new CleanerForReconcilerTestReconciler())
2121
.build();
2222

2323

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

Lines changed: 9 additions & 11 deletions
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.LocalOperatorExtension;
9+
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
1010
import io.javaoperatorsdk.operator.sample.cleanupconflict.CleanupConflictCustomResource;
1111
import io.javaoperatorsdk.operator.sample.cleanupconflict.CleanupConflictReconciler;
1212

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

2222
@RegisterExtension
23-
LocalOperatorExtension operator =
24-
LocalOperatorExtension.builder().withReconciler(new CleanupConflictReconciler())
23+
LocallyRunOperatorExtension operator =
24+
LocallyRunOperatorExtension.builder().withReconciler(new CleanupConflictReconciler())
2525
.build();
2626

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

33-
await().untilAsserted(() -> {
34-
assertThat(operator.getReconcilerOfType(CleanupConflictReconciler.class)
35-
.getNumberReconcileExecutions()).isEqualTo(1);
36-
});
33+
await().untilAsserted(
34+
() -> assertThat(operator.getReconcilerOfType(CleanupConflictReconciler.class)
35+
.getNumberReconcileExecutions()).isEqualTo(1));
3736

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

45-
await().pollDelay(Duration.ofMillis(WAIT_TIME * 2)).untilAsserted(() -> {
46-
assertThat(operator.getReconcilerOfType(CleanupConflictReconciler.class)
47-
.getNumberOfCleanupExecutions()).isEqualTo(1);
48-
});
44+
await().pollDelay(Duration.ofMillis(WAIT_TIME * 2)).untilAsserted(
45+
() -> assertThat(operator.getReconcilerOfType(CleanupConflictReconciler.class)
46+
.getNumberOfCleanupExecutions()).isEqualTo(1));
4947
}
5048

5149
private CleanupConflictCustomResource createTestResource() {

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

Lines changed: 3 additions & 3 deletions
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.LocalOperatorExtension;
13+
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
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-
LocalOperatorExtension operator =
30-
LocalOperatorExtension.builder().withReconciler(new TestReconciler(true)).build();
29+
LocallyRunOperatorExtension operator =
30+
LocallyRunOperatorExtension.builder().withReconciler(new TestReconciler(true)).build();
3131

3232
@Test
3333
void manyResourcesGetCreatedUpdatedAndDeleted() throws InterruptedException {

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

Lines changed: 3 additions & 3 deletions
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.LocalOperatorExtension;
10+
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
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-
LocalOperatorExtension operator =
22-
LocalOperatorExtension.builder().withReconciler(new TestReconciler(true)).build();
21+
LocallyRunOperatorExtension operator =
22+
LocallyRunOperatorExtension.builder().withReconciler(new TestReconciler(true)).build();
2323

2424
@Test
2525
void configMapGetsCreatedForTestCustomResource() {

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

Lines changed: 3 additions & 3 deletions
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.LocalOperatorExtension;
10+
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
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-
LocalOperatorExtension operator =
23-
LocalOperatorExtension.builder()
22+
LocallyRunOperatorExtension operator =
23+
LocallyRunOperatorExtension.builder()
2424
.withReconciler(new CreateUpdateEventFilterTestReconciler())
2525
.build();
2626

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

Lines changed: 4 additions & 3 deletions
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.LocalOperatorExtension;
7+
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
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,9 @@
1414
class CustomResourceFilterIT {
1515

1616
@RegisterExtension
17-
LocalOperatorExtension operator =
18-
LocalOperatorExtension.builder().withReconciler(new CustomFilteringTestReconciler()).build();
17+
LocallyRunOperatorExtension operator =
18+
LocallyRunOperatorExtension.builder().withReconciler(new CustomFilteringTestReconciler())
19+
.build();
1920

2021
@Test
2122
void doesCustomFiltering() throws InterruptedException {

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

Lines changed: 3 additions & 3 deletions
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.LocalOperatorExtension;
7+
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
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,8 @@ class DeleterForManagedDependentResourcesOnlyIT {
1717
public static final String TEST_RESOURCE_NAME = "cleaner-for-reconciler-test1";
1818

1919
@RegisterExtension
20-
LocalOperatorExtension operator =
21-
LocalOperatorExtension.builder()
20+
LocallyRunOperatorExtension operator =
21+
LocallyRunOperatorExtension.builder()
2222
.withReconciler(new CleanerForManagedDependentTestReconciler())
2323
.build();
2424

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

Lines changed: 7 additions & 9 deletions
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.ObjectMetaBuilder;
10-
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
10+
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
1111
import io.javaoperatorsdk.operator.sample.dependentannotationsecondarymapper.DependentAnnotationSecondaryMapperReconciler;
1212
import io.javaoperatorsdk.operator.sample.dependentannotationsecondarymapper.DependentAnnotationSecondaryMapperResource;
1313

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

2323
@RegisterExtension
24-
LocalOperatorExtension operator =
25-
LocalOperatorExtension.builder()
24+
LocallyRunOperatorExtension operator =
25+
LocallyRunOperatorExtension.builder()
2626
.withReconciler(DependentAnnotationSecondaryMapperReconciler.class)
2727
.build();
2828

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

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

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

52-
await().pollDelay(Duration.ofMillis(150)).untilAsserted(() -> {
53-
assertThat(reconciler.getNumberOfExecutions()).isEqualTo(2);
54-
});
51+
await().pollDelay(Duration.ofMillis(150))
52+
.untilAsserted(() -> assertThat(reconciler.getNumberOfExecutions()).isEqualTo(2));
5553
}
5654

5755

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

Lines changed: 3 additions & 3 deletions
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.LocalOperatorExtension;
10+
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
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-
LocalOperatorExtension operator =
27-
LocalOperatorExtension.builder()
26+
LocallyRunOperatorExtension operator =
27+
LocallyRunOperatorExtension.builder()
2828
.withReconciler(new DependentOperationEventFilterCustomResourceTestReconciler())
2929
.build();
3030

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
package io.javaoperatorsdk.operator;
22

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

66
public class DependentPrimaryIndexerIT extends PrimaryIndexerIT {
77

8-
protected LocalOperatorExtension buildOperator() {
9-
return LocalOperatorExtension.builder()
8+
protected LocallyRunOperatorExtension buildOperator() {
9+
return LocallyRunOperatorExtension.builder()
1010
.withReconciler(new DependentPrimaryIndexerTestReconciler())
1111
.build();
1212
}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import io.fabric8.kubernetes.api.model.ConfigMap;
99
import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
1010
import io.fabric8.kubernetes.api.model.Secret;
11-
import io.javaoperatorsdk.operator.junit.LocalOperatorExtension;
11+
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
1212
import io.javaoperatorsdk.operator.sample.dependentresourcecrossref.DependentResourceCrossRefReconciler;
1313
import io.javaoperatorsdk.operator.sample.dependentresourcecrossref.DependentResourceCrossRefResource;
1414

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

2323
@RegisterExtension
24-
LocalOperatorExtension operator =
25-
LocalOperatorExtension.builder()
24+
LocallyRunOperatorExtension operator =
25+
LocallyRunOperatorExtension.builder()
2626
.withReconciler(new DependentResourceCrossRefReconciler())
2727
.build();
2828

0 commit comments

Comments
 (0)