Skip to content

Commit 51d4ec1

Browse files
metacosmmetacosm
authored
refactor!: clean namespaces constants (#1206)
* refactor!: move SAME_AS_CONTROLLER constant to Constants class, add set * refactor!: rename WATCH_CURRENT_NAMESPACE_SET to match other constants * refactor!: rename set constants with `_SET` prefix
1 parent 881b113 commit 51d4ec1

File tree

11 files changed

+32
-26
lines changed

11 files changed

+32
-26
lines changed

‎operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/AnnotationControllerConfiguration.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEventFilter;
2626
import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEventFilters;
2727

28-
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES;
28+
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES_SET;
2929

3030
@SuppressWarnings("rawtypes")
3131
public class AnnotationControllerConfiguration<R extends HasMetadata>
@@ -75,7 +75,7 @@ public boolean isGenerationAware() {
7575
@Override
7676
public Set<String> getNamespaces() {
7777
return Set.of(valueOrDefault(annotation, ControllerConfiguration::namespaces,
78-
DEFAULT_NAMESPACES.toArray(String[]::new)));
78+
DEFAULT_NAMESPACES_SET.toArray(String[]::new)));
7979
}
8080

8181
@Override

‎operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfigurationOverrider.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResourceConfig;
1515
import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEventFilter;
1616

17-
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES;
17+
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES_SET;
1818
import static io.javaoperatorsdk.operator.api.reconciler.Constants.WATCH_CURRENT_NAMESPACE_SET;
1919

2020
@SuppressWarnings({"rawtypes", "unused"})
@@ -68,7 +68,7 @@ public ControllerConfigurationOverrider<R> addingNamespaces(String... namespaces
6868
public ControllerConfigurationOverrider<R> removingNamespaces(String... namespaces) {
6969
List.of(namespaces).forEach(this.namespaces::remove);
7070
if (this.namespaces.isEmpty()) {
71-
this.namespaces = DEFAULT_NAMESPACES;
71+
this.namespaces = DEFAULT_NAMESPACES_SET;
7272
}
7373
return this;
7474
}
@@ -80,7 +80,7 @@ public ControllerConfigurationOverrider<R> settingNamespace(String namespace) {
8080
}
8181

8282
public ControllerConfigurationOverrider<R> watchingAllNamespaces() {
83-
this.namespaces = DEFAULT_NAMESPACES;
83+
this.namespaces = DEFAULT_NAMESPACES_SET;
8484
return this;
8585
}
8686

‎operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/DefaultResourceConfiguration.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
import io.fabric8.kubernetes.api.model.HasMetadata;
66

7-
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES;
7+
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES_SET;
88

99
public class DefaultResourceConfiguration<R extends HasMetadata>
1010
implements ResourceConfiguration<R> {
@@ -16,7 +16,7 @@ public class DefaultResourceConfiguration<R extends HasMetadata>
1616
public DefaultResourceConfiguration(String labelSelector, Class<R> resourceClass,
1717
String... namespaces) {
1818
this(labelSelector, resourceClass,
19-
namespaces == null || namespaces.length == 0 ? DEFAULT_NAMESPACES
19+
namespaces == null || namespaces.length == 0 ? DEFAULT_NAMESPACES_SET
2020
: Set.of(namespaces));
2121
}
2222

@@ -25,7 +25,7 @@ public DefaultResourceConfiguration(String labelSelector, Class<R> resourceClass
2525
this.labelSelector = labelSelector;
2626
this.resourceClass = resourceClass;
2727
this.namespaces =
28-
namespaces == null || namespaces.isEmpty() ? DEFAULT_NAMESPACES
28+
namespaces == null || namespaces.isEmpty() ? DEFAULT_NAMESPACES_SET
2929
: namespaces;
3030
}
3131

‎operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/NamespaceChangeable.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import java.util.Set;
44

5-
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES;
5+
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES_SET;
66

77
public interface NamespaceChangeable {
88

@@ -18,7 +18,7 @@ public interface NamespaceChangeable {
1818

1919
default void changeNamespaces(String... namespaces) {
2020
changeNamespaces(
21-
namespaces != null ? Set.of(namespaces) : DEFAULT_NAMESPACES);
21+
namespaces != null ? Set.of(namespaces) : DEFAULT_NAMESPACES_SET);
2222
}
2323

2424
default boolean allowsNamespaceChanges() {

‎operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ResourceConfiguration.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import io.javaoperatorsdk.operator.ReconcilerUtils;
99
import io.javaoperatorsdk.operator.api.reconciler.Constants;
1010

11-
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES;
11+
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES_SET;
1212
import static io.javaoperatorsdk.operator.api.reconciler.Constants.WATCH_CURRENT_NAMESPACE_SET;
1313

1414
public interface ResourceConfiguration<R extends HasMetadata> {
@@ -35,7 +35,7 @@ default Class<R> getResourceClass() {
3535
}
3636

3737
default Set<String> getNamespaces() {
38-
return DEFAULT_NAMESPACES;
38+
return DEFAULT_NAMESPACES_SET;
3939
}
4040

4141
default boolean watchAllNamespaces() {
@@ -44,7 +44,7 @@ default boolean watchAllNamespaces() {
4444

4545
static boolean allNamespacesWatched(Set<String> namespaces) {
4646
failIfNotValid(namespaces);
47-
return DEFAULT_NAMESPACES.equals(namespaces);
47+
return DEFAULT_NAMESPACES_SET.equals(namespaces);
4848
}
4949

5050
default boolean watchCurrentNamespace() {

‎operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/informer/InformerConfiguration.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
import io.javaoperatorsdk.operator.processing.event.source.SecondaryToPrimaryMapper;
1111
import io.javaoperatorsdk.operator.processing.event.source.informer.Mappers;
1212

13-
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES;
13+
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES_SET;
1414

1515
public interface InformerConfiguration<R extends HasMetadata>
1616
extends ResourceConfiguration<R> {
@@ -73,7 +73,7 @@ public InformerConfigurationBuilder<R> withSecondaryToPrimaryMapper(
7373

7474
public InformerConfigurationBuilder<R> withNamespaces(String... namespaces) {
7575
return withNamespaces(
76-
namespaces != null ? Set.of(namespaces) : DEFAULT_NAMESPACES);
76+
namespaces != null ? Set.of(namespaces) : DEFAULT_NAMESPACES_SET);
7777
}
7878

7979
public InformerConfigurationBuilder<R> withNamespaces(Set<String> namespaces) {
@@ -92,7 +92,7 @@ public InformerConfigurationBuilder<R> withNamespaces(Set<String> namespaces) {
9292
*/
9393
public InformerConfigurationBuilder<R> withNamespaces(Set<String> namespaces,
9494
boolean followChanges) {
95-
this.namespaces = namespaces != null ? namespaces : DEFAULT_NAMESPACES;
95+
this.namespaces = namespaces != null ? namespaces : DEFAULT_NAMESPACES_SET;
9696
this.inheritControllerNamespacesOnChange = true;
9797
return this;
9898
}

‎operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/Constants.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,19 @@
55

66
public final class Constants {
77

8-
public static final Set<String> DEFAULT_NAMESPACES =
8+
public static final Set<String> DEFAULT_NAMESPACES_SET =
99
Collections.singleton(Constants.WATCH_ALL_NAMESPACES);
1010
public static final Set<String> WATCH_CURRENT_NAMESPACE_SET =
1111
Collections.singleton(Constants.WATCH_CURRENT_NAMESPACE);
1212

13+
public static final Set<String> SAME_AS_CONTROLLER_NAMESPACES_SET =
14+
Collections.singleton(Constants.SAME_AS_CONTROLLER);
15+
1316
public static final String NO_VALUE_SET = "";
1417
public static final String WATCH_CURRENT_NAMESPACE = "JOSDK_WATCH_CURRENT";
1518
public static final String WATCH_ALL_NAMESPACES = "JOSDK_ALL_NAMESPACES";
1619
public static final long NO_RECONCILIATION_MAX_INTERVAL = -1L;
20+
public static final String SAME_AS_CONTROLLER = "JOSDK_SAME_AS_CONTROLLER";
1721

1822
private Constants() {}
1923
}

‎operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependent.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@
55
import java.lang.annotation.RetentionPolicy;
66
import java.lang.annotation.Target;
77

8+
import io.javaoperatorsdk.operator.api.reconciler.Constants;
9+
810
import static io.javaoperatorsdk.operator.api.reconciler.Constants.NO_VALUE_SET;
911

1012
@Retention(RetentionPolicy.RUNTIME)
1113
@Target({ElementType.TYPE})
1214
public @interface KubernetesDependent {
13-
String SAME_AS_CONTROLLER = "JOSDK_SAME_AS_CONTROLLER";
1415

15-
String[] DEFAULT_NAMESPACES = {SAME_AS_CONTROLLER};
16+
String[] DEFAULT_NAMESPACES = {Constants.SAME_AS_CONTROLLER};
1617

1718
/**
1819
* Specified which namespaces this Controller monitors for custom resources events. If no
@@ -21,7 +22,7 @@
2122
*
2223
* @return the list of namespaces this controller monitors
2324
*/
24-
String[] namespaces() default {SAME_AS_CONTROLLER};
25+
String[] namespaces() default {Constants.SAME_AS_CONTROLLER};
2526

2627
/**
2728
* Optional label selector used to identify the set of custom resources the controller will acc

‎operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResourceConfig.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
package io.javaoperatorsdk.operator.processing.dependent.kubernetes;
22

3-
import java.util.Collections;
43
import java.util.Set;
54

5+
import io.javaoperatorsdk.operator.api.reconciler.Constants;
6+
67
import static io.javaoperatorsdk.operator.api.reconciler.Constants.NO_VALUE_SET;
78

89
public class KubernetesDependentResourceConfig {
910

10-
private Set<String> namespaces = Collections.emptySet();
11+
private Set<String> namespaces = Constants.SAME_AS_CONTROLLER_NAMESPACES_SET;
1112
private String labelSelector = NO_VALUE_SET;
1213

1314
private boolean namespacesWereConfigured = false;

‎operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/MockControllerConfiguration.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import io.fabric8.kubernetes.api.model.HasMetadata;
44

5-
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES;
5+
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES_SET;
66
import static org.mockito.Mockito.mock;
77
import static org.mockito.Mockito.when;
88

@@ -12,7 +12,7 @@ public static <R extends HasMetadata> ControllerConfiguration<R> forResource(
1212
Class<R> resourceType) {
1313
final ControllerConfiguration configuration = mock(ControllerConfiguration.class);
1414
when(configuration.getResourceClass()).thenReturn(resourceType);
15-
when(configuration.getNamespaces()).thenReturn(DEFAULT_NAMESPACES);
15+
when(configuration.getNamespaces()).thenReturn(DEFAULT_NAMESPACES_SET);
1616
when(configuration.getEffectiveNamespaces()).thenCallRealMethod();
1717
return configuration;
1818
}

‎operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSourceTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
import io.javaoperatorsdk.operator.processing.event.source.SecondaryToPrimaryMapper;
2121
import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;
2222

23-
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES;
23+
import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES_SET;
2424
import static org.mockito.ArgumentMatchers.any;
2525
import static org.mockito.Mockito.*;
2626

@@ -55,7 +55,7 @@ void setup() {
5555
when(informer.getIndexer()).thenReturn(mock(Indexer.class));
5656

5757
when(informerConfiguration.getEffectiveNamespaces())
58-
.thenReturn(DEFAULT_NAMESPACES);
58+
.thenReturn(DEFAULT_NAMESPACES_SET);
5959
when(informerConfiguration.getSecondaryToPrimaryMapper())
6060
.thenReturn(mock(SecondaryToPrimaryMapper.class));
6161

0 commit comments

Comments
 (0)