Skip to content

feat: encode and decode base64 in qute template #181

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
Apr 26, 2025
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
@@ -1,5 +1,7 @@
package io.javaoperatorsdk.operator.glue.templating;

import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.HashMap;
import java.util.Map;

Expand All @@ -10,6 +12,7 @@
import io.javaoperatorsdk.operator.glue.customresource.glue.Glue;
import io.quarkus.qute.Engine;
import io.quarkus.qute.Template;
import io.quarkus.qute.ValueResolver;

import com.fasterxml.jackson.databind.ObjectMapper;

Expand All @@ -21,7 +24,10 @@ public class GenericTemplateHandler {
public static final String WORKFLOW_METADATA_KEY = "glueMetadata";

private static final ObjectMapper objectMapper = new ObjectMapper();
private static final Engine engine = Engine.builder().addDefaults().build();
private static final Engine engine = Engine.builder().addDefaults()
.addValueResolver(base64EncodeResolver())
.addValueResolver(base64DecodeResolver())
.build();

public String processTemplate(Map<String, Map<?, ?>> data, String template,
boolean objectTemplate) {
Expand Down Expand Up @@ -77,4 +83,32 @@ public String processTemplate(String template, Glue primary, boolean objectTempl
return Serialization.unmarshal(template, Map.class);
}

static ValueResolver base64DecodeResolver() {
return ValueResolver.builder()
.appliesTo(c -> c.getName().equals("decodeBase64")
&& (c.getBase() instanceof String || c.getBase() instanceof byte[]))
.resolveSync(context -> {
if (context.getBase() instanceof byte[] bytes) {
return new String(Base64.getDecoder().decode(bytes), StandardCharsets.UTF_8);
} else {
return new String(Base64.getDecoder().decode(context.getBase().toString()),
StandardCharsets.UTF_8);
}
}).build();
}

static ValueResolver base64EncodeResolver() {
return ValueResolver.builder()
.appliesTo(c -> c.getName().equals("encodeBase64")
&& (c.getBase() instanceof String || c.getBase() instanceof byte[]))
.applyToBaseClass(String.class)
.resolveSync(context -> {
if (context.getBase() instanceof byte[] bytes) {
return Base64.getEncoder().encodeToString(bytes);
} else {
return Base64.getEncoder().encodeToString(context.getBase().toString().getBytes());
}
}).build();
}

}
45 changes: 42 additions & 3 deletions src/test/java/io/javaoperatorsdk/operator/glue/GlueTest.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package io.javaoperatorsdk.operator.glue;

import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Base64;
import java.util.List;
import java.util.Map;
import java.util.stream.IntStream;
Expand All @@ -23,6 +25,7 @@
import io.quarkus.test.junit.QuarkusTest;

import static io.javaoperatorsdk.operator.glue.TestUtils.INITIAL_RECONCILE_WAIT_TIMEOUT;
import static io.javaoperatorsdk.operator.glue.TestUtils.loadGlue;
import static org.assertj.core.api.Assertions.assertThat;
import static org.awaitility.Awaitility.await;

Expand Down Expand Up @@ -412,6 +415,45 @@ void invalidGlueMessageHandling() {
});
}

@Test
void secretToConfigMapCopy() {
String nsa = "namespace-a";
String nsb = "namespace-b";

createNamespace(nsa);
createNamespace(nsb);
createSecretToCopy(nsb);

var glue = client.resource(loadGlue("/glue/CopySecretToConfigMap.yaml"))
.createOr(NonDeletingOperation::update);

await().untilAsserted(() -> {
var cm = client.configMaps().inNamespace(nsa).withName("my-secret-copy").get();
assertThat(cm).isNotNull();
assertThat(cm.getData())
.containsExactlyInAnyOrderEntriesOf(Map.of("key1", "value1", "key2", "value2"));
});

deleteInOwnNamespace(glue);
await().pollDelay(INITIAL_RECONCILE_WAIT_TIMEOUT).untilAsserted(() -> {
var g = get(Glue.class, "secret-to-configmap", nsa);
assertThat(g).isNull();
});
}

private Secret createSecretToCopy(String nsb) {
var secret = new Secret();
secret.setMetadata(new ObjectMetaBuilder()
.withName("secret-to-copy")
.withNamespace(nsb)
.build());
secret.setData(Map.of("key1",
Base64.getEncoder().encodeToString("value1".getBytes(StandardCharsets.UTF_8)),
"key2",
Base64.getEncoder().encodeToString("value2".getBytes(StandardCharsets.UTF_8))));

return client.resource(secret).createOr(NonDeletingOperation::update);
}

private List<Glue> testWorkflowList(int num) {
List<Glue> res = new ArrayList<>();
Expand All @@ -423,7 +465,4 @@ private List<Glue> testWorkflowList(int num) {
});
return res;
}



}
16 changes: 13 additions & 3 deletions src/test/java/io/javaoperatorsdk/operator/glue/TestBase.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public void prepareNamespace(TestInfo testInfo) {
testInfo.getTestMethod()
.ifPresent(method -> testNamespace = KubernetesResourceUtil.sanitizeName(method.getName()));

client.namespaces().resource(testNamespace(testNamespace)).create();
createNamespace(testNamespace);
}

@AfterEach
Expand All @@ -49,7 +49,11 @@ void cleanupNamespace() {
});
}

protected Namespace testNamespace(String name) {
protected Namespace createNamespace(String name) {
return client.namespaces().resource(namespace(name)).createOr(NonDeletingOperation::update);
}

protected Namespace namespace(String name) {
return new NamespaceBuilder().withMetadata(new ObjectMetaBuilder()
.withName(name)
.build()).build();
Expand All @@ -72,6 +76,10 @@ protected <T extends HasMetadata> T get(Class<T> clazz, String name) {
return client.resources(clazz).inNamespace(testNamespace).withName(name).get();
}

protected <T extends HasMetadata> T get(Class<T> clazz, String name, String namespace) {
return client.resources(clazz).inNamespace(namespace).withName(name).get();
}

protected <T extends HasMetadata> List<T> list(Class<T> clazz) {
return client.resources(clazz).inNamespace(testNamespace).list().getItems();
}
Expand All @@ -93,6 +101,8 @@ protected void delete(HasMetadata resource) {
client.resource(resource).inNamespace(testNamespace).delete();
}


protected void deleteInOwnNamespace(HasMetadata resource) {
client.resource(resource).delete();
}

}
24 changes: 24 additions & 0 deletions src/test/resources/glue/CopySecretToConfigMap.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
apiVersion: io.javaoperatorsdk.operator.glue/v1beta1
kind: Glue
metadata:
name: "secret-to-configmap"
namespace: namespace-a
spec:
childResources:
- name: configmap
resourceTemplate: |
apiVersion: v1
kind: ConfigMap
metadata:
name: my-secret-copy
namespace: namespace-a
data:
{#for entry in secret-to-copy.data}
{entry.key}: {entry.value.decodeBase64}
{/for}
relatedResources:
- name: secret-to-copy
apiVersion: v1
kind: Secret
resourceNames: ["secret-to-copy"]
namespace: namespace-b
Loading