feat(templates): custom event templates in S3

src/main/java/io/cryostat/ConfigProperties.java

@@ -17,6 +17,7 @@
 
 public class ConfigProperties {
     public static final String AWS_BUCKET_NAME_ARCHIVES = "storage.buckets.archives.name";
+    public static final String AWS_EVENT_TEMPLATE_NAME = "storage.buckets.event-templates.name";
     public static final String AWS_OBJECT_EXPIRATION_LABELS =
             "storage.buckets.archives.expiration-label";
 

src/main/java/io/cryostat/events/EventTemplates.java

@@ -15,23 +15,63 @@
  */
 package io.cryostat.events;
 
+import java.io.IOException;
 import java.net.URI;
+import java.text.ParseException;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
+import java.util.concurrent.CompletableFuture;
+import java.util.Optional;
 
+import org.jsoup.nodes.Document;
+import org.openjdk.jmc.common.unit.IConstrainedMap;
+import org.openjdk.jmc.flightrecorder.configuration.events.EventOptionID;
+import org.openjdk.jmc.flightrecorder.controlpanel.ui.configuration.model.xml.JFCGrammar;
+import org.openjdk.jmc.flightrecorder.controlpanel.ui.configuration.model.xml.XMLAttributeInstance;
+import org.openjdk.jmc.flightrecorder.controlpanel.ui.configuration.model.xml.XMLModel;
+import org.openjdk.jmc.flightrecorder.controlpanel.ui.configuration.model.xml.XMLTagInstance;
+import org.openjdk.jmc.flightrecorder.controlpanel.ui.configuration.model.xml.XMLValidationResult;
+import org.openjdk.jmc.flightrecorder.controlpanel.ui.model.EventConfiguration;
+
+import io.cryostat.core.templates.MutableTemplateService.InvalidEventTemplateException;
+import io.cryostat.core.templates.MutableTemplateService.InvalidXmlException;
+import io.cryostat.ConfigProperties;
+import io.cryostat.core.FlightRecorderException;
 import io.cryostat.core.templates.Template;
+import io.cryostat.core.templates.TemplateService;
 import io.cryostat.core.templates.TemplateType;
 import io.cryostat.targets.Target;
 import io.cryostat.targets.TargetConnectionManager;
-
+import io.cryostat.util.HttpStatusCodeIdentifier;
+import io.quarkus.runtime.StartupEvent;
+import io.smallrye.common.annotation.Blocking;
+import io.smallrye.mutiny.Uni;
+import io.vertx.core.Vertx;
 import jakarta.annotation.security.RolesAllowed;
+import jakarta.enterprise.event.Observes;
 import jakarta.inject.Inject;
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.NotFoundException;
+import jakarta.ws.rs.POST;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.core.Response;
+import org.apache.http.entity.ContentType;
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+import org.jboss.logging.Logger;
+import org.jboss.resteasy.reactive.RestForm;
+import software.amazon.awssdk.services.s3.S3Client;
+import software.amazon.awssdk.services.s3.model.CreateBucketRequest;
+import software.amazon.awssdk.services.s3.model.HeadBucketRequest;
+import software.amazon.awssdk.services.s3.model.GetObjectRequest;
+import software.amazon.awssdk.services.s3.model.GetObjectTaggingRequest;
+import software.amazon.awssdk.services.s3.model.ListObjectsV2Request;
+
 import org.jboss.resteasy.reactive.RestPath;
 import org.jboss.resteasy.reactive.RestResponse;
+import org.jboss.resteasy.reactive.multipart.FileUpload;
+import software.amazon.awssdk.core.sync.RequestBody;
+import software.amazon.awssdk.services.s3.model.PutObjectRequest;
 
 @Path("")
 public class EventTemplates {
@@ -45,7 +85,37 @@ public class EventTemplates {
                     "Cryostat",
                     TemplateType.TARGET);
 
+    @Inject Vertx vertx;
     @Inject TargetConnectionManager connectionManager;
+    @Inject S3Client storage;
+    @Inject Logger logger;
+
+    @ConfigProperty(name = ConfigProperties.AWS_BUCKET_NAME_ARCHIVES)
+    static String eventTemplatesBucket;
+
+    void onStart(@Observes StartupEvent evt) {
+        boolean exists = false;
+        try {
+            exists =
+                    HttpStatusCodeIdentifier.isSuccessCode(
+                            storage.headBucket(
+                                            HeadBucketRequest.builder()
+                                                    .bucket(eventTemplatesBucket)
+                                                    .build())
+                                    .sdkHttpResponse()
+                                    .statusCode());
+        } catch (Exception e) {
+            logger.info(e);
+        }
+        if (!exists) {
+            try {
+                storage.createBucket(
+                        CreateBucketRequest.builder().bucket(eventTemplatesBucket).build());
+            } catch (Exception e) {
+                logger.error(e);
+            }
+        }
+    }
 
     @GET
     @Path("/api/v1/targets/{connectUrl}/templates")
@@ -58,6 +128,32 @@ public Response listTemplatesV1(@RestPath URI connectUrl) throws Exception {
                 .build();
     }
 
+    @POST
+    @Path("/api/v1/templates")
+    @RolesAllowed("write")
+    public Uni<Void> postTemplatesV1(@RestForm("template") FileUpload body) throws Exception {
+        CompletableFuture<Void> cf = new CompletableFuture<>();
+        var path = body.filePath();
+        vertx.fileSystem()
+                .readFile(path.toString())
+                .onComplete(
+                        ar -> {
+                            try {
+                                addTemplate(ar.result().toString());
+                                cf.complete(null);
+                            } catch (Exception e) {
+                                logger.error(e);
+                                cf.completeExceptionally(e);
+                            }
+                        })
+                .onFailure(
+                        ar -> {
+                            logger.error(ar.getCause());
+                            cf.completeExceptionally(ar.getCause());
+                        });
+        return Uni.createFrom().future(cf);
+    }
+
     @GET
     @Path("/api/v1/targets/{connectUrl}/templates/{templateName}/type/{templateType}")
     @RolesAllowed("read")
@@ -106,4 +202,94 @@ public String getTargetTemplate(
                                 .orElseThrow(NotFoundException::new)
                                 .toString());
     }
+
+    static class S3TemplateService implements TemplateService {
+        S3Client s3;
+
+        @Override
+        public Optional<IConstrainedMap<EventOptionID>> getEvents(String templateName, TemplateType templateType)
+                throws FlightRecorderException {
+            return Optional.empty();
+        }
+
+        @Override
+        public List<Template> getTemplates() throws FlightRecorderException {
+            var builder = ListObjectsV2Request.builder().bucket(eventTemplatesBucket);
+            var objects = s3.listObjectsV2(builder.build());
+            var templates = convertObjects(objects);
+            return templates;
+        }
+
+        @Override
+        public Optional<Document> getXml(String templateName, TemplateType templateType)
+                throws FlightRecorderException {
+            return Optional.empty();
+        }
+    }
+
+    @Blocking
+    public Template addTemplate(String templateText)
+            throws InvalidXmlException, InvalidEventTemplateException, IOException {
+        try {
+            XMLModel model = EventConfiguration.createModel(templateText);
+            model.checkErrors();
+
+            for (XMLValidationResult result : model.getResults()) {
+                if (result.isError()) {
+                    // throw new InvalidEventTemplateException(result.getText());
+                    throw new IllegalArgumentException(result.getText());
+                }
+            }
+
+            XMLTagInstance configuration = model.getRoot();
+            XMLAttributeInstance labelAttr = null;
+            for (XMLAttributeInstance attr : configuration.getAttributeInstances()) {
+                if (attr.getAttribute().getName().equals("label")) {
+                    labelAttr = attr;
+                    break;
+                }
+            }
+
+            if (labelAttr == null) {
+                // throw new InvalidEventTemplateException(
+                //         "Template has no configuration label attribute");
+                throw new IllegalArgumentException("Template has no configuration label attribute");
+            }
+
+            String templateName = labelAttr.getExplicitValue();
+            templateName = templateName.replaceAll("[\\W]+", "_");
+
+            XMLTagInstance root = model.getRoot();
+            root.setValue(JFCGrammar.ATTRIBUTE_LABEL_MANDATORY, templateName);
+
+            String key = templateName;
+            storage.putObject(
+                    PutObjectRequest.builder()
+                            .bucket(eventTemplatesBucket)
+                            .key(key)
+                            .contentType(ContentType.APPLICATION_XML.getMimeType())
+                            .build(),
+                    RequestBody.fromString(model.toString()));
+
+            return new Template(
+                    templateName,
+                    getAttributeValue(root, "description"),
+                    getAttributeValue(root, "provider"),
+                    TemplateType.CUSTOM);
+        } catch (IOException ioe) {
+            // throw new InvalidXmlException("Unable to parse XML stream", ioe);
+            throw new IllegalArgumentException("Unable to parse XML stream", ioe);
+        } catch (ParseException | IllegalArgumentException e) {
+            // throw new InvalidEventTemplateException("Invalid XML", e);
+            throw new IllegalArgumentException("Invalid XML", e);
+        }
+    }
+
+    protected String getAttributeValue(XMLTagInstance node, String valueKey) {
+        return node.getAttributeInstances().stream()
+                .filter(i -> Objects.equals(valueKey, i.getAttribute().getName()))
+                .map(i -> i.getValue())
+                .findFirst()
+                .get();
+    }
 }

src/main/resources/application.properties

@@ -54,6 +54,7 @@ quarkus.security.users.embedded.users.reader=reader
 quarkus.security.users.embedded.roles.reader=read
 
 storage.buckets.archives.name=archivedrecordings
+storage.buckets.event-templates.name=eventtemplates
 storage.buckets.archives.expiration-label=expiration
 
 quarkus.quinoa.build-dir=dist

src/test/java/io/cryostat/CustomEventTemplate.java

@@ -0,0 +1,44 @@
+package io.cryostat;
+
+import static io.cryostat.TestUtils.givenBasicAuth;
+
+import javax.swing.text.AbstractDocument.Content;
+
+import org.apache.http.entity.ContentType;
+import org.eclipse.microprofile.openapi.models.media.XML;
+import org.junit.Test;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+
+import io.cryostat.core.templates.Template;
+import io.cryostat.core.templates.TemplateType;
+import io.vertx.core.json.JsonObject;
+import jakarta.transaction.Transactional;
+
+public class CustomEventTemplate {
+
+    Template template;
+
+    static String TEMPLATE_NAME = "customEventTemplate";
+
+    @BeforeEach
+    public void setup() {
+        template = new Template(TEMPLATE_NAME, "desc", "prov", TemplateType.CUSTOM);
+    }
+
+    @AfterEach
+    @Transactional
+    public void afterEach() {
+        template.deleteAll();
+    }
+
+    @Test
+    public void testCustomEventTemplate() {
+        givenBasicAuth().get().then().statusCode(200);
+    }
+
+    @Test
+    public void testCustom() {
+        givenBasicAuth().body().contentType(ContentType.APPLICATION_XML).post().then().statusCode(200);
+    }
+}

src/test/java/io/cryostat/HealthTest.java

@@ -17,7 +17,6 @@
 
 import static io.restassured.RestAssured.when;
 import static org.hamcrest.CoreMatchers.is;
-import static org.hamcrest.Matchers.*;
 
 import java.util.Optional;
 

src/test/java/io/cryostat/expressions/MatchExpressionsTest.java

@@ -17,7 +17,6 @@
 
 import static io.cryostat.TestUtils.givenBasicAuth;
 import static io.restassured.RestAssured.given;
-import static org.hamcrest.Matchers.*;
 
 import java.util.HashMap;
 import java.util.List;

src/test/java/itest/TemplatePostDeleteIT.java

@@ -28,11 +28,10 @@
 import org.hamcrest.MatcherAssert;
 import org.hamcrest.Matchers;
 import org.junit.jupiter.api.Assertions;
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 @QuarkusIntegrationTest
-@Disabled("TODO")
+// @Disabled("TODO")
 public class TemplatePostDeleteIT extends StandardSelfTest {
     static final String INVALID_TEMPLATE_FILE_NAME = "invalidTemplate.xml";
     static final String SANITIZE_TEMPLATE_FILE_NAME = "TemplateToSanitize.jfc";
@@ -57,6 +56,7 @@ public void shouldThrowIfTemplateUploadNameInvalid() throws Exception {
 
         webClient
                 .post(REQ_URL)
+                .basicAuthentication("user", "pass")
                 .sendMultipartForm(
                         form,
                         ar -> {
@@ -86,6 +86,7 @@ public void shouldThrowWhenPostingInvalidTemplate() throws Exception {
 
         webClient
                 .post(REQ_URL)
+                .basicAuthentication("user", "pass")
                 .sendMultipartForm(
                         form,
                         ar -> {
@@ -105,6 +106,7 @@ public void testDeleteRecordingThrowsOnNonExistentTemplate() throws Exception {
 
         webClient
                 .delete(String.format("%s/%s", REQ_URL, INVALID_TEMPLATE_FILE_NAME))
+                .basicAuthentication("user", "pass")
                 .send(
                         ar -> {
                             assertRequestStatus(ar, response);
@@ -142,6 +144,7 @@ public void testPostedTemplateIsSanitizedAndCanBeDeleted() throws Exception {
             CompletableFuture<JsonArray> getResponse = new CompletableFuture<>();
             webClient
                     .get("/api/v1/targets/localhost:0/templates")
+                    .basicAuthentication("user", "pass")
                     .send(
                             ar -> {
                                 assertRequestStatus(ar, getResponse);
@@ -160,6 +163,7 @@ public void testPostedTemplateIsSanitizedAndCanBeDeleted() throws Exception {
             CompletableFuture<Integer> deleteResponse = new CompletableFuture<>();
             webClient
                     .delete(REQ_URL + "/Template_To_Sanitize")
+                    .basicAuthentication("user", "pass")
                     .send(
                             ar -> {
                                 assertRequestStatus(ar, deleteResponse);