Skip to content

feat: label selector on resources #90

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 5 commits into from
Apr 28, 2024
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
2 changes: 2 additions & 0 deletions src/main/java/io/csviri/operator/glue/ControllerConfig.java
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ public interface ControllerConfig {

Map<String, String> glueOperatorManagedGlueLabels();

Map<String, String> resourceLabelSelector();

}
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@
import io.javaoperatorsdk.operator.processing.dependent.workflow.KubernetesResourceDeletedCondition;
import io.javaoperatorsdk.operator.processing.dependent.workflow.WorkflowBuilder;

import jakarta.inject.Inject;

import static io.csviri.operator.glue.Utils.getResourceForSSAFrom;
import static io.csviri.operator.glue.reconciler.operator.GlueOperatorReconciler.PARENT_RELATED_RESOURCE_NAME;

Expand All @@ -42,14 +40,22 @@ public class GlueReconciler implements Reconciler<Glue>, Cleaner<Glue>, ErrorSta
public static final String PARENT_GLUE_FINALIZER_PREFIX = "io.csviri.operator.resourceflow.glue/";
public static final String GLUE_RECONCILER_NAME = "glue";

@Inject
ValidationAndErrorHandler validationAndErrorHandler;

private final ValidationAndErrorHandler validationAndErrorHandler;
private final InformerRegister informerRegister;

private final KubernetesResourceDeletedCondition deletePostCondition =
new KubernetesResourceDeletedCondition();
private final InformerRegister informerRegister = new InformerRegister();

private final GenericTemplateHandler genericTemplateHandler = new GenericTemplateHandler();


public GlueReconciler(ValidationAndErrorHandler validationAndErrorHandler,
InformerRegister informerRegister) {
this.validationAndErrorHandler = validationAndErrorHandler;
this.informerRegister = informerRegister;
}

/**
* Handling finalizers for GlueOperator: Glue ids a finalizer to parent, that is necessary since
* on clean up the resource name might be calculated based on the parents name, and it this way
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package io.csviri.operator.glue.reconciler.glue;


import io.csviri.operator.glue.customresource.glue.Glue;
import io.fabric8.kubernetes.api.model.GenericKubernetesResource;
import io.javaoperatorsdk.operator.api.config.informer.InformerConfiguration;
import io.javaoperatorsdk.operator.api.reconciler.Context;
import io.javaoperatorsdk.operator.processing.event.source.informer.InformerEventSource;

import jakarta.inject.Singleton;


/** For mocking purpose only. Too complex to mock InformerEventSource creation. */
@Singleton
public class InformerProducer {

public InformerEventSource<GenericKubernetesResource, Glue> createInformer(
InformerConfiguration<GenericKubernetesResource> configuration,
Context<Glue> context) {
return new InformerEventSource<>(configuration,
context.eventSourceRetriever().eventSourceContextForDynamicRegistration());
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import io.csviri.operator.glue.ControllerConfig;
import io.csviri.operator.glue.Utils;
import io.csviri.operator.glue.customresource.glue.Glue;
import io.csviri.operator.glue.customresource.glue.RelatedResourceSpec;
Expand All @@ -17,8 +18,11 @@
import io.javaoperatorsdk.operator.processing.event.ResourceID;
import io.javaoperatorsdk.operator.processing.event.source.informer.InformerEventSource;

import jakarta.inject.Singleton;

// todo unit test
class InformerRegister {
@Singleton
public class InformerRegister {

private static final Logger log = LoggerFactory.getLogger(InformerRegister.class);

Expand All @@ -27,6 +31,17 @@ class InformerRegister {
private final Map<GroupVersionKind, RelatedAndOwnedResourceSecondaryToPrimaryMapper> relatedResourceMappers =
new ConcurrentHashMap<>();


private final InformerProducer informerProducer;
private final ControllerConfig controllerConfig;


public InformerRegister(InformerProducer informerProducer, ControllerConfig controllerConfig) {
this.informerProducer = informerProducer;
this.controllerConfig = controllerConfig;
}


// todo test related resources deleting
public synchronized void deRegisterInformerOnResourceFlowChange(Context<Glue> context,
Glue primary) {
Expand Down Expand Up @@ -78,13 +93,19 @@ public InformerEventSource<GenericKubernetesResource, Glue> registerInformer(
mapper = relatedResourceMappers.get(gvk);
markEventSource(gvk, glue);
}
var newES = new InformerEventSource<>(InformerConfiguration.<GenericKubernetesResource>from(gvk)
.withSecondaryToPrimaryMapper(mapper)
.build(), context.eventSourceRetriever().eventSourceContextForDynamicRegistration());

var configBuilder = InformerConfiguration.<GenericKubernetesResource>from(gvk)
.withSecondaryToPrimaryMapper(mapper);
labelSelectorForGVK(gvk).ifPresent(ls -> {
log.debug("Registering label selector: {} for informer for gvk: {}", ls, gvk);
configBuilder.withLabelSelector(ls);
});

var newInformer = informerProducer.createInformer(configBuilder.build(), context);

return (InformerEventSource<GenericKubernetesResource, Glue>) context
.eventSourceRetriever()
.dynamicallyRegisterEventSource(gvk.toString(), newES);
.dynamicallyRegisterEventSource(gvk.toString(), newInformer);

}

Expand Down Expand Up @@ -147,4 +168,14 @@ private String workflowId(Glue glue) {
return glue.getMetadata().getName() + "#" + glue.getMetadata().getNamespace();
}

public Optional<String> labelSelectorForGVK(GroupVersionKind gvk) {
return Optional.ofNullable(controllerConfig.resourceLabelSelector().get(toSimpleString(gvk)));
}

public static String toSimpleString(GroupVersionKind gvk) {
String groupVersion =
gvk.getGroup() == null ? gvk.getVersion() : gvk.getGroup() + "/" + gvk.getVersion();
return groupVersion + "#" + gvk.getKind();
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package io.csviri.operator.glue;

import java.util.Map;

import org.junit.jupiter.api.Test;

import io.fabric8.kubernetes.api.model.ConfigMap;
import io.quarkus.test.junit.QuarkusTest;
import io.quarkus.test.junit.QuarkusTestProfile;
import io.quarkus.test.junit.TestProfile;

import static org.assertj.core.api.Assertions.assertThat;
import static org.awaitility.Awaitility.await;

@QuarkusTest
@TestProfile(GlueResourceLabelSelectorTest.GlueResourceLabelSelectorTestProfile.class)
public class GlueResourceLabelSelectorTest extends TestBase {

@Test
void showCreatingResourceWithLabelSelectorAndLabel() {
var glue = create(TestUtils.loadResoureFlow("/glue/SimpleGlueWithLabeledResource.yaml"));

// this serves more like a sample, hard to test here if the label selector is on informer
await().untilAsserted(() -> {
var cm = get(ConfigMap.class, "configmap");
assertThat(cm).isNotNull();
assertThat(cm.getMetadata().getLabels())
.containsEntry("test-glue", "true");
});

delete(glue);
await().untilAsserted(() -> {
var cm = get(ConfigMap.class, "configmap");
assertThat(cm).isNull();
});
}

public static class GlueResourceLabelSelectorTestProfile implements QuarkusTestProfile {
@Override
public Map<String, String> getConfigOverrides() {
return Map.of("glue.operator.resource-label-selector.v1#ConfigMap", "test-glue=true");
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
package io.csviri.operator.glue.reconciler.glue;

import java.util.Map;

import org.junit.jupiter.api.Test;

import io.csviri.operator.glue.ControllerConfig;
import io.csviri.operator.glue.customresource.glue.Glue;
import io.fabric8.kubernetes.api.model.ConfigMap;
import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
import io.javaoperatorsdk.operator.api.reconciler.Context;
import io.javaoperatorsdk.operator.processing.GroupVersionKind;
import io.javaoperatorsdk.operator.processing.event.EventSourceRetriever;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.*;

class InformerRegisterTest {


public static final String LABEL_SELECTOR = "myapp=true";

@Test
@SuppressWarnings("unchecked")
void registersInformerWithLabelSelectorIfConfigured() {
var gvk = GroupVersionKind.gvkFor(ConfigMap.class);
var labelSelectors = Map.of(InformerRegister.toSimpleString(gvk),
LABEL_SELECTOR);
var config = mock(ControllerConfig.class);
when(config.resourceLabelSelector()).thenReturn(labelSelectors);
var informerProducer = mock(InformerProducer.class);
var register = new InformerRegister(informerProducer, config);
var mockContext = mock(Context.class);
var mockEventSourceRetriever = mock(EventSourceRetriever.class);
when(mockContext.eventSourceRetriever()).thenReturn(mockEventSourceRetriever);

register.registerInformer(mockContext, gvk, testGlue());

verify(informerProducer).createInformer(argThat(c -> {
assertThat(c.getLabelSelector()).isEqualTo(LABEL_SELECTOR);
return true;
}), any());
}


@Test
void gvkToSimpleString() {
assertThat(InformerRegister.toSimpleString(new GroupVersionKind("apps", "v1", "Deployment")))
.isEqualTo("apps/v1#Deployment");
assertThat(InformerRegister.toSimpleString(new GroupVersionKind("v1", "ConfigMap")))
.isEqualTo("v1#ConfigMap");
}

Glue testGlue() {
Glue glue = new Glue();
glue.setMetadata(new ObjectMetaBuilder()
.withName("test1")
.build());
return glue;
}

}
17 changes: 17 additions & 0 deletions src/test/resources/glue/SimpleGlueWithLabeledResource.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Invalid GLUE, presents resources with non-unique name
apiVersion: io.csviri.operator.glue/v1beta1
kind: Glue
metadata:
name: glue
spec:
childResources:
- name: configMap
resource:
apiVersion: v1
kind: ConfigMap
metadata:
name: configmap
labels:
test-glue: true
data:
key: "value1"