Add ability to refresh hosting env (#176)

* fix path to category suggestions

* ability to refresh hosting envs

* add hosting event type

* add config option requests

Author: mcanoy

src/main/java/com/redhat/labs/lodestar/model/event/EventType.java

@@ -31,5 +31,6 @@ private EventType() {
     public static final String RELOAD_ARTIFACTS_EVENT_ADDRESS = "reload.artifacts.event";
     public static final String RELOAD_PARTICIPANTS_EVENT_ADDRESS = "reload.participants.event";
     public static final String RELOAD_ENGAGEMENT_STATUS_EVENT_ADDRESS = "reload.engagement.status.event";
+    public static final String RELOAD_HOSTING_EVENT_ADDRESS = "reload.hosting.event";
 
 }

src/main/java/com/redhat/labs/lodestar/resource/ConfigResource.java

@@ -1,5 +1,6 @@
 package com.redhat.labs.lodestar.resource;
 
+import java.util.Map;
 import java.util.Optional;
 
 import javax.enterprise.context.RequestScoped;
@@ -55,4 +56,22 @@ public Response invalidateRbacCache() {
         configService.invalidateCache();
         return Response.ok().build();
     }
+
+    @GET
+    @Path("artifact/options")
+    public Map<String, String> getArtifactOptions() {
+        return configService.getArtifactOptions();
+    }
+
+    @GET
+    @Path("engagement/options")
+    public Map<String, String> getEngagementOptions() {
+        return configService.getEngagementOptions();
+    }
+
+    @GET
+    @Path("region/options")
+    public Map<String, String> getRegionOptions() {
+        return configService.getRegionOptions();
+    }
 }

src/main/java/com/redhat/labs/lodestar/resource/HostingResource.java

@@ -24,6 +24,7 @@
 import com.redhat.labs.lodestar.model.filter.ListFilterOptions;
 import com.redhat.labs.lodestar.model.pagination.PagedHostingEnvironmentResults;
 import com.redhat.labs.lodestar.service.EngagementService;
+import org.eclipse.microprofile.openapi.annotations.tags.Tag;
 
 import java.util.*;
 
@@ -32,6 +33,7 @@
 @Produces(MediaType.APPLICATION_JSON)
 @Consumes(MediaType.APPLICATION_JSON)
 @SecurityScheme(securitySchemeName = "jwt", type = SecuritySchemeType.HTTP, scheme = "bearer", bearerFormat = "JWT")
+@Tag(name = "Hosting Environments", description = "Hosting Environment Info")
 public class HostingResource {
 
     @Inject

src/main/java/com/redhat/labs/lodestar/resource/RefreshResource.java

@@ -48,6 +48,7 @@ public Response refresh(
             @Parameter(description = "Refresh participants") @QueryParam("participants") boolean refreshParticipants,
             @Parameter(description = "Refresh activity") @QueryParam("activity") boolean refreshActivity,
             @Parameter(description = "Refresh engagement status") @QueryParam("status") boolean refreshStatus,
+            @Parameter(description = "Refresh hosting environments") @QueryParam("hosting") boolean refreshHosting,
             @Parameter(description = "Refresh engagements") @QueryParam("engagements") boolean refreshEngagements) {
 
         boolean didPickSomething = false;
@@ -58,6 +59,11 @@ public Response refresh(
             didPickSomething = true;
         }
 
+        if(refreshHosting) {
+            eventBus.publish(EventType.RELOAD_HOSTING_EVENT_ADDRESS, EventType.RELOAD_HOSTING_EVENT_ADDRESS);
+            didPickSomething = true;
+        }
+
         if (refreshActivity) {
             eventBus.publish(EventType.RELOAD_ACTIVITY_EVENT_ADDRESS, EventType.RELOAD_ACTIVITY_EVENT_ADDRESS);
             didPickSomething = true;

src/main/java/com/redhat/labs/lodestar/rest/client/ConfigApiClient.java

@@ -19,15 +19,26 @@
 @RegisterRestClient(configKey = "lodestar.config.api")
 @RegisterProvider(value = ServiceResponseMapper.class, priority = 50)
 @Path("/api/v1/configs/runtime")
+@Produces("application/json")
 public interface ConfigApiClient {
 
     @GET
-    @Produces("application/json")
     Response getRuntimeConfig(@QueryParam("type") String type);
 
     @GET
     @Path("/rbac")
-    @Produces("application/json")
     Map<String, List<String>> getPermission();
 
+    @GET
+    @Path("artifact/options")
+    Map<String, String> getArtifactOptions();
+
+    @GET
+    @Path("engagement/options")
+    Map<String, String> getEngagementOptions();
+
+    @GET
+    @Path("region/options")
+    Map<String, String> getRegionOptions();
+
 }

src/main/java/com/redhat/labs/lodestar/service/ConfigService.java

@@ -7,6 +7,8 @@
 
 import javax.enterprise.context.ApplicationScoped;
 import javax.inject.Inject;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
 import javax.ws.rs.core.Response;
 
 import org.eclipse.microprofile.rest.client.inject.RestClient;
@@ -40,12 +42,33 @@ public List<String> getPermission(String engagementType) {
 	}
 
 	@CacheInvalidateAll(cacheName = "rbac-cache")
+	@CacheInvalidateAll(cacheName = "artifact-options")
+	@CacheInvalidateAll(cacheName = "engagement-options")
+	@CacheInvalidateAll(cacheName = "region-options")
 	public void invalidateCache() {
-		LOGGER.debug("Invalidating rbac cache");
+		LOGGER.debug("Invalidating config cache");
 	}
 
 	public Response getRuntimeConfig(Optional<String> type) {
 
 		return configApiClient.getRuntimeConfig(type.isPresent() ? type.get() : null);
 	}
+
+	@CacheResult(cacheName = "artifact-options")
+	public Map<String, String> getArtifactOptions() {
+		LOGGER.debug("cache miss for artifact options");
+		return configApiClient.getArtifactOptions();
+	}
+
+	@CacheResult(cacheName = "engagement-options")
+	public Map<String, String> getEngagementOptions() {
+		LOGGER.debug("cache miss for engagement options");
+		return configApiClient.getEngagementOptions();
+	}
+
+	@CacheResult(cacheName = "region-options")
+	public Map<String, String> getRegionOptions() {
+		LOGGER.debug("cache miss for region options");
+		return configApiClient.getRegionOptions();
+	}
 }

src/main/java/com/redhat/labs/lodestar/service/HostingService.java

@@ -2,17 +2,23 @@
 
 import com.redhat.labs.lodestar.model.Author;
 import com.redhat.labs.lodestar.model.HostingEnvironment;
+import com.redhat.labs.lodestar.model.event.EventType;
 import com.redhat.labs.lodestar.rest.client.HostingEnvironmentApiClient;
+import io.quarkus.vertx.ConsumeEvent;
 import org.eclipse.microprofile.rest.client.inject.RestClient;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import javax.enterprise.context.ApplicationScoped;
 import javax.inject.Inject;
+import javax.ws.rs.WebApplicationException;
 import javax.ws.rs.core.*;
 import java.util.List;
 import java.util.Set;
 
 @ApplicationScoped
 public class HostingService {
+    private static final Logger LOGGER = LoggerFactory.getLogger(HostingService.class);
 
     @Inject
     @RestClient
@@ -33,4 +39,15 @@ public List<HostingEnvironment> updateAndReload(String engagementUuid, List<Host
     public Response isSubdomainValid(String engagementUuid, String subdomain) {
         return hostingEnvironmentApiClient.isSubdomainValid(engagementUuid, subdomain);
     }
+
+    @ConsumeEvent(value = EventType.RELOAD_HOSTING_EVENT_ADDRESS, blocking = true)
+    public void refresh(String message) {
+        try {
+            LOGGER.debug("refresh {}", message);
+            hostingEnvironmentApiClient.refresh();
+            LOGGER.debug("refresh {} completed", message);
+        } catch (WebApplicationException wae) { //without catching this it will fail silently
+            LOGGER.error("Failed to refresh hosting {}", wae.getResponse(), wae);
+        }
+    }
 }

src/test/java/com/redhat/labs/lodestar/resource/ConfigResourceTest.java

@@ -1,14 +1,19 @@
 package com.redhat.labs.lodestar.resource;
 
 import static io.restassured.RestAssured.given;
+import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.CoreMatchers.is;
 
 import javax.ws.rs.core.Response;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.redhat.labs.lodestar.rest.client.ConfigApiClient;
+import com.redhat.labs.lodestar.utils.ResourceLoader;
 import io.quarkus.test.common.http.TestHTTPEndpoint;
 import io.quarkus.test.junit.mockito.InjectMock;
 import org.eclipse.microprofile.rest.client.inject.RestClient;
+import org.hamcrest.Matchers;
+import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
@@ -17,15 +22,26 @@
 
 import io.quarkus.test.junit.QuarkusTest;
 
+import java.util.Map;
+
 @QuarkusTest
 @TestHTTPEndpoint(ConfigResource.class)
 @Tag("nested")
 class ConfigResourceTest {
 
+    static String VALID_TOKEN;
+
     @InjectMock
     @RestClient
     public ConfigApiClient configApiClient;
 
+    ObjectMapper om = new ObjectMapper();
+
+    @BeforeAll
+    static void generateToken() {
+        VALID_TOKEN = TokenUtils.generateTokenString("/JwtClaimsReader.json");
+    }
+
     @Test
     void testGetConfigTokenHasWrongRole()  {
 
@@ -91,4 +107,34 @@ void testVoidCache() {
         given().when().auth().oauth2(token).put("/rbac/cache").then().statusCode(200);
     }
 
+    @Test
+    void testRegionOptions() throws Exception {
+        String regions = ResourceLoader.load("config-region-options.json");
+        Map<String, String> regionMap = om.readValue(regions, Map.class);
+        Mockito.when(configApiClient.getRegionOptions()).thenReturn(regionMap);
+        given().when().auth().oauth2(VALID_TOKEN).get("/region/options").then().statusCode(200)
+                .body("$", Matchers.hasKey("region1"))
+                .body("$", Matchers.hasKey("region2"));
+    }
+
+    @Test
+    void testArtifactOptions() throws Exception {
+        String artifacts = ResourceLoader.load("config-artifact-options.json");
+        Map<String, String> artifactsMap = om.readValue(artifacts, Map.class);
+        Mockito.when(configApiClient.getArtifactOptions()).thenReturn(artifactsMap);
+        given().when().auth().oauth2(VALID_TOKEN).get("/artifact/options").then().statusCode(200)
+                .body("$", Matchers.hasKey("doc"))
+                .body("$", Matchers.hasKey("paper"));
+    }
+
+    @Test
+    void testEngagementOptions() throws Exception {
+        String engagements = ResourceLoader.load("config-engagement-options.json");
+        Map<String, String> engagementsMap = om.readValue(engagements, Map.class);
+        Mockito.when(configApiClient.getEngagementOptions()).thenReturn(engagementsMap);
+        given().when().auth().oauth2(VALID_TOKEN).get("/engagement/options").then().statusCode(200)
+                .body("$", Matchers.hasKey("res"))
+                .body("$", Matchers.hasKey("training"));
+    }
+
 }

src/test/resources/config-artifact-options.json

@@ -0,0 +1,4 @@
+{
+  "doc": "Document",
+  "paper": "White Paper"
+}

src/test/resources/config-engagement-options.json

@@ -0,0 +1,4 @@
+{
+  "res": "Resy",
+  "training": "Training"
+}