Skip to content

fix: renaming mapper primary <-> secondary #1021

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 1 commit into from
Mar 11, 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 @@ -10,8 +10,8 @@
import io.javaoperatorsdk.operator.api.config.ResourceConfiguration;
import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
import io.javaoperatorsdk.operator.processing.event.ResourceID;
import io.javaoperatorsdk.operator.processing.event.source.AssociatedSecondaryResourceIdentifier;
import io.javaoperatorsdk.operator.processing.event.source.PrimaryResourcesRetriever;
import io.javaoperatorsdk.operator.processing.event.source.PrimaryToSecondaryMapper;
import io.javaoperatorsdk.operator.processing.event.source.SecondaryToPrimaryMapper;
import io.javaoperatorsdk.operator.processing.event.source.informer.Mappers;

public interface InformerConfiguration<R extends HasMetadata, P extends HasMetadata>
Expand All @@ -20,13 +20,13 @@ public interface InformerConfiguration<R extends HasMetadata, P extends HasMetad
class DefaultInformerConfiguration<R extends HasMetadata, P extends HasMetadata> extends
DefaultResourceConfiguration<R> implements InformerConfiguration<R, P> {

private final PrimaryResourcesRetriever<R> secondaryToPrimaryResourcesIdSet;
private final AssociatedSecondaryResourceIdentifier<P> associatedWith;
private final SecondaryToPrimaryMapper<R> secondaryToPrimaryResourcesIdSet;
private final PrimaryToSecondaryMapper<P> associatedWith;

protected DefaultInformerConfiguration(ConfigurationService service, String labelSelector,
Class<R> resourceClass,
PrimaryResourcesRetriever<R> secondaryToPrimaryResourcesIdSet,
AssociatedSecondaryResourceIdentifier<P> associatedWith,
SecondaryToPrimaryMapper<R> secondaryToPrimaryResourcesIdSet,
PrimaryToSecondaryMapper<P> associatedWith,
Set<String> namespaces) {
super(labelSelector, resourceClass, namespaces);
setConfigurationService(service);
Expand All @@ -38,24 +38,24 @@ protected DefaultInformerConfiguration(ConfigurationService service, String labe
}


public PrimaryResourcesRetriever<R> getPrimaryResourcesRetriever() {
public SecondaryToPrimaryMapper<R> getPrimaryResourcesRetriever() {
return secondaryToPrimaryResourcesIdSet;
}

public AssociatedSecondaryResourceIdentifier<P> getAssociatedResourceIdentifier() {
public PrimaryToSecondaryMapper<P> getAssociatedResourceIdentifier() {
return associatedWith;
}

}

PrimaryResourcesRetriever<R> getPrimaryResourcesRetriever();
SecondaryToPrimaryMapper<R> getPrimaryResourcesRetriever();

AssociatedSecondaryResourceIdentifier<P> getAssociatedResourceIdentifier();
PrimaryToSecondaryMapper<P> getAssociatedResourceIdentifier();

class InformerConfigurationBuilder<R extends HasMetadata, P extends HasMetadata> {

private PrimaryResourcesRetriever<R> secondaryToPrimaryResourcesIdSet;
private AssociatedSecondaryResourceIdentifier<P> associatedWith;
private SecondaryToPrimaryMapper<R> secondaryToPrimaryResourcesIdSet;
private PrimaryToSecondaryMapper<P> associatedWith;
private Set<String> namespaces;
private String labelSelector;
private final Class<R> resourceClass;
Expand All @@ -68,13 +68,13 @@ private InformerConfigurationBuilder(Class<R> resourceClass,
}

public InformerConfigurationBuilder<R, P> withPrimaryResourcesRetriever(
PrimaryResourcesRetriever<R> primaryResourcesRetriever) {
this.secondaryToPrimaryResourcesIdSet = primaryResourcesRetriever;
SecondaryToPrimaryMapper<R> secondaryToPrimaryMapper) {
this.secondaryToPrimaryResourcesIdSet = secondaryToPrimaryMapper;
return this;
}

public InformerConfigurationBuilder<R, P> withAssociatedSecondaryResourceIdentifier(
AssociatedSecondaryResourceIdentifier<P> associatedWith) {
PrimaryToSecondaryMapper<P> associatedWith) {
this.associatedWith = associatedWith;
return this;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@
import io.javaoperatorsdk.operator.api.reconciler.dependent.Matcher.Result;
import io.javaoperatorsdk.operator.api.reconciler.dependent.ResourceUpdatePreProcessor;
import io.javaoperatorsdk.operator.processing.event.ResourceID;
import io.javaoperatorsdk.operator.processing.event.source.AssociatedSecondaryResourceIdentifier;
import io.javaoperatorsdk.operator.processing.event.source.EventSource;
import io.javaoperatorsdk.operator.processing.event.source.PrimaryResourcesRetriever;
import io.javaoperatorsdk.operator.processing.event.source.PrimaryToSecondaryMapper;
import io.javaoperatorsdk.operator.processing.event.source.SecondaryToPrimaryMapper;
import io.javaoperatorsdk.operator.processing.event.source.informer.InformerEventSource;
import io.javaoperatorsdk.operator.processing.event.source.informer.Mappers;

Expand Down Expand Up @@ -63,11 +63,11 @@ public void configureWith(KubernetesDependentResourceConfig config) {
private void configureWith(ConfigurationService configService, String labelSelector,
Set<String> namespaces, boolean addOwnerReference) {
final var primaryResourcesRetriever =
(this instanceof PrimaryResourcesRetriever) ? (PrimaryResourcesRetriever<R>) this
(this instanceof SecondaryToPrimaryMapper) ? (SecondaryToPrimaryMapper<R>) this
: Mappers.fromOwnerReference();
final AssociatedSecondaryResourceIdentifier<P> secondaryResourceIdentifier =
(this instanceof AssociatedSecondaryResourceIdentifier)
? (AssociatedSecondaryResourceIdentifier<P>) this
final PrimaryToSecondaryMapper<P> secondaryResourceIdentifier =
(this instanceof PrimaryToSecondaryMapper)
? (PrimaryToSecondaryMapper<P>) this
: ResourceID::fromResource;
InformerConfiguration<R, P> ic =
InformerConfiguration.from(configService, resourceType())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
import io.javaoperatorsdk.operator.processing.event.ResourceID;

@FunctionalInterface
public interface AssociatedSecondaryResourceIdentifier<P extends HasMetadata> {
public interface PrimaryToSecondaryMapper<P extends HasMetadata> {
ResourceID associatedSecondaryID(P primary);
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
import io.javaoperatorsdk.operator.processing.event.ResourceID;

@FunctionalInterface
public interface PrimaryResourcesRetriever<T> {

public interface SecondaryToPrimaryMapper<T> {
Set<ResourceID> associatedPrimaryResources(T dependentResource);
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,38 +5,38 @@

import io.fabric8.kubernetes.api.model.HasMetadata;
import io.javaoperatorsdk.operator.processing.event.ResourceID;
import io.javaoperatorsdk.operator.processing.event.source.PrimaryResourcesRetriever;
import io.javaoperatorsdk.operator.processing.event.source.SecondaryToPrimaryMapper;

public class Mappers {

private Mappers() {}

public static <T extends HasMetadata> PrimaryResourcesRetriever<T> fromAnnotation(
public static <T extends HasMetadata> SecondaryToPrimaryMapper<T> fromAnnotation(
String nameKey) {
return fromMetadata(nameKey, null, false);
}

public static <T extends HasMetadata> PrimaryResourcesRetriever<T> fromAnnotation(
public static <T extends HasMetadata> SecondaryToPrimaryMapper<T> fromAnnotation(
String nameKey, String namespaceKey) {
return fromMetadata(nameKey, namespaceKey, false);
}

public static <T extends HasMetadata> PrimaryResourcesRetriever<T> fromLabel(
public static <T extends HasMetadata> SecondaryToPrimaryMapper<T> fromLabel(
String nameKey) {
return fromMetadata(nameKey, null, true);
}

public static <T extends HasMetadata> PrimaryResourcesRetriever<T> fromLabel(
public static <T extends HasMetadata> SecondaryToPrimaryMapper<T> fromLabel(
String nameKey, String namespaceKey) {
return fromMetadata(nameKey, namespaceKey, true);
}

public static <T extends HasMetadata> PrimaryResourcesRetriever<T> fromOwnerReference() {
public static <T extends HasMetadata> SecondaryToPrimaryMapper<T> fromOwnerReference() {
return resource -> ResourceID.fromFirstOwnerReference(resource).map(Set::of)
.orElse(Collections.emptySet());
}

private static <T extends HasMetadata> PrimaryResourcesRetriever<T> fromMetadata(
private static <T extends HasMetadata> SecondaryToPrimaryMapper<T> fromMetadata(
String nameKey, String namespaceKey, boolean isLabel) {
return resource -> {
final var metadata = resource.getMetadata();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import io.javaoperatorsdk.operator.api.config.informer.InformerConfiguration;
import io.javaoperatorsdk.operator.processing.event.EventHandler;
import io.javaoperatorsdk.operator.processing.event.ResourceID;
import io.javaoperatorsdk.operator.processing.event.source.PrimaryResourcesRetriever;
import io.javaoperatorsdk.operator.processing.event.source.SecondaryToPrimaryMapper;
import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;

import static org.mockito.ArgumentMatchers.any;
Expand Down Expand Up @@ -50,16 +50,16 @@ void setup() {
when(labeledResourceClientMock.runnableInformer(0)).thenReturn(informer);

when(informerConfiguration.getPrimaryResourcesRetriever())
.thenReturn(mock(PrimaryResourcesRetriever.class));
.thenReturn(mock(SecondaryToPrimaryMapper.class));

informerEventSource = new InformerEventSource<>(informerConfiguration, clientMock);
informerEventSource.setTemporalResourceCache(temporaryResourceCacheMock);
informerEventSource.setEventHandler(eventHandlerMock);

PrimaryResourcesRetriever primaryResourcesRetriever = mock(PrimaryResourcesRetriever.class);
SecondaryToPrimaryMapper secondaryToPrimaryMapper = mock(SecondaryToPrimaryMapper.class);
when(informerConfiguration.getPrimaryResourcesRetriever())
.thenReturn(primaryResourcesRetriever);
when(primaryResourcesRetriever.associatedPrimaryResources(any()))
.thenReturn(secondaryToPrimaryMapper);
when(secondaryToPrimaryMapper.associatedPrimaryResources(any()))
.thenReturn(Set.of(ResourceID.fromResource(testDeployment())));
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,11 @@
import io.javaoperatorsdk.operator.api.reconciler.dependent.Matcher.Result;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResource;
import io.javaoperatorsdk.operator.processing.event.ResourceID;
import io.javaoperatorsdk.operator.processing.event.source.AssociatedSecondaryResourceIdentifier;
import io.javaoperatorsdk.operator.processing.event.source.PrimaryToSecondaryMapper;
import io.javaoperatorsdk.operator.sample.MySQLSchema;

import static io.javaoperatorsdk.operator.sample.MySQLSchemaReconciler.*;

public class SecretDependentResource extends KubernetesDependentResource<Secret, MySQLSchema>
implements AssociatedSecondaryResourceIdentifier<MySQLSchema>, Creator<Secret, MySQLSchema> {
implements PrimaryToSecondaryMapper<MySQLSchema>, Creator<Secret, MySQLSchema> {

public static final String SECRET_FORMAT = "%s-secret";
public static final String USERNAME_FORMAT = "%s-user";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
import io.javaoperatorsdk.operator.processing.event.ResourceID;
import io.javaoperatorsdk.operator.processing.event.source.AssociatedSecondaryResourceIdentifier;
import io.javaoperatorsdk.operator.processing.event.source.EventSource;
import io.javaoperatorsdk.operator.processing.event.source.PrimaryResourcesRetriever;
import io.javaoperatorsdk.operator.processing.event.source.PrimaryToSecondaryMapper;
import io.javaoperatorsdk.operator.processing.event.source.SecondaryToPrimaryMapper;
import io.javaoperatorsdk.operator.processing.event.source.informer.InformerEventSource;

import static io.javaoperatorsdk.operator.api.reconciler.Constants.NO_FINALIZER;
Expand All @@ -52,7 +52,7 @@ public List<EventSource> prepareEventSources(EventSourceContext<Webapp> context)
* customResourceId of the WebApp resource we traverse the cache and identify it based on naming
* convention.
*/
final PrimaryResourcesRetriever<Tomcat> webappsMatchingTomcatName =
final SecondaryToPrimaryMapper<Tomcat> webappsMatchingTomcatName =
(Tomcat t) -> context.getPrimaryCache()
.list(webApp -> webApp.getSpec().getTomcat().equals(t.getMetadata().getName()))
.map(ResourceID::fromResource)
Expand All @@ -61,7 +61,7 @@ public List<EventSource> prepareEventSources(EventSourceContext<Webapp> context)
/*
* We retrieve the Tomcat instance associated with out Webapp from its spec
*/
final AssociatedSecondaryResourceIdentifier<Webapp> tomcatFromWebAppSpec =
final PrimaryToSecondaryMapper<Webapp> tomcatFromWebAppSpec =
(Webapp webapp) -> new ResourceID(
webapp.getSpec().getTomcat(),
webapp.getMetadata().getNamespace());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResource;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResourceConfig;
import io.javaoperatorsdk.operator.processing.event.ResourceID;
import io.javaoperatorsdk.operator.processing.event.source.AssociatedSecondaryResourceIdentifier;
import io.javaoperatorsdk.operator.processing.event.source.EventSource;
import io.javaoperatorsdk.operator.processing.event.source.PrimaryToSecondaryMapper;

import static io.javaoperatorsdk.operator.ReconcilerUtils.loadYaml;
import static io.javaoperatorsdk.operator.api.reconciler.Constants.NO_FINALIZER;
Expand Down Expand Up @@ -163,7 +163,7 @@ public static String serviceName(WebPage webPage) {
private class ConfigMapDependentResource
extends CrudKubernetesDependentResource<ConfigMap, WebPage>
implements
AssociatedSecondaryResourceIdentifier<WebPage> {
PrimaryToSecondaryMapper<WebPage> {

@Override
protected ConfigMap desired(WebPage webPage, Context context) {
Expand Down