Merge pull request #13 from mattcorey/simplified-profile-support

Simplified profile support and closing issue #12

Author: sapessi

README.md

@@ -36,7 +36,7 @@ public class LambdaHandler implements RequestHandler<AwsProxyRequest, AwsProxyRe
 ```
 
 ### Spring support
-The library supports Spring applications that are configured using annotations (in code) rather than in an XML file. The simplest possible configuration uses the `@ComponentScan` annotation to load all controller classes from a package. For example, our unit test application has the following configuuration class.
+The library supports Spring applications that are configured using annotations (in code) rather than in an XML file. The simplest possible configuration uses the `@ComponentScan` annotation to load all controller classes from a package. For example, our unit test application has the following configuration class.
 
 ```java
 @Configuration
@@ -57,6 +57,9 @@ public class LambdaHandler implements RequestHandler<AwsProxyRequest, AwsProxyRe
 }
 ```
 
+#### Spring Profiles
+You can enable Spring Profiles (as defined with the `@Profile` annotation) by using the `SpringLambdaContainerHandler.activateSpringProfiles(String...)` method - common drivers of this might be the AWS Lambda stage that you're deployed under, or stage variables.  See [@Profile documentation](http://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/context/annotation/Profile.html) for details.
+
 ### Spark support
 The library also supports applications written with the [Spark framework](http://sparkjava.com/). When using the library with Spark, it's important to initialize the `SparkLambdaContainerHandler` before defining routes.
 

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/servlet/AwsProxyServletContext.java

@@ -410,6 +410,9 @@ public String getVirtualServerName() {
         return null;
     }
 
+    public String getStage() {
+        return awsProxyRequest.getRequestContext().getStage();
+    }
 
     public static ServletContext getInstance(AwsProxyRequest request, Context lambdaContext) {
         if (instance == null) {
@@ -418,4 +421,8 @@ public static ServletContext getInstance(AwsProxyRequest request, Context lambda
 
         return instance;
     }
+
+    public static void clearServletContextCache() {
+        instance = null;
+    }
 }

aws-serverless-java-container-spring/src/main/java/com/amazonaws/serverless/proxy/spring/LambdaSpringApplicationInitializer.java

@@ -47,6 +47,7 @@ public class LambdaSpringApplicationInitializer implements WebApplicationInitial
     private ConfigurableWebApplicationContext applicationContext;
     private boolean refreshContext = true;
     private List<ServletContextListener> contextListeners;
+    private List<String> springProfiles;
 
     // Dynamically instantiated properties
     private ServletConfig dispatcherConfig;
@@ -84,8 +85,19 @@ public void dispatch(HttpServletRequest request, HttpServletResponse response)
         dispatcherServlet.service(request, response);
     }
 
+    public List<String> getSpringProfiles() {
+        return Collections.unmodifiableList(springProfiles);
+    }
+
+    public void setSpringProfiles(List<String> springProfiles) {
+        this.springProfiles = new ArrayList<>(springProfiles);
+    }
+
     @Override
     public void onStartup(ServletContext servletContext) throws ServletException {
+        if (springProfiles != null) {
+            applicationContext.getEnvironment().setActiveProfiles(springProfiles.toArray(new String[0]));
+        }
         applicationContext.setServletContext(servletContext);
 
         dispatcherConfig = new DefaultDispatcherConfig(servletContext);

aws-serverless-java-container-spring/src/main/java/com/amazonaws/serverless/proxy/spring/SpringLambdaContainerHandler.java

@@ -25,6 +25,7 @@
 import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
 
 import javax.servlet.ServletContext;
+import java.util.Arrays;
 import java.util.concurrent.CountDownLatch;
 
 /**
@@ -104,6 +105,14 @@ protected AwsHttpServletResponse getContainerResponse(CountDownLatch latch) {
         return new AwsHttpServletResponse(latch);
     }
 
+    public void activateSpringProfiles(String... profiles) throws ContainerInitializationException {
+        if (initializer == null) {
+            throw new ContainerInitializationException(LambdaSpringApplicationInitializer.ERROR_NO_CONTEXT, null);
+        }
+
+        initializer.setSpringProfiles(Arrays.asList(profiles));
+    }
+
     @Override
     protected void handleRequest(AwsProxyHttpServletRequest containerRequest, AwsHttpServletResponse containerResponse, Context lambdaContext) throws Exception {
         if (initializer == null) {

aws-serverless-java-container-spring/src/test/java/com/amazonaws/serverless/proxy/spring/echoapp/EchoSpringAppConfig.java

@@ -2,18 +2,18 @@
 
 import com.amazonaws.serverless.exceptions.ContainerInitializationException;
 import com.amazonaws.serverless.proxy.internal.testutils.MockLambdaContext;
-import com.amazonaws.serverless.proxy.spring.LambdaSpringApplicationInitializer;
 import com.amazonaws.serverless.proxy.spring.SpringLambdaContainerHandler;
-import com.amazonaws.services.lambda.runtime.Context;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.PropertySource;
 import org.springframework.web.context.ConfigurableWebApplicationContext;
 
 @Configuration
 @ComponentScan("com.amazonaws.serverless.proxy.spring.echoapp")
+@PropertySource("classpath:application.properties")
 public class EchoSpringAppConfig {
 
     @Autowired

aws-serverless-java-container-spring/src/test/java/com/amazonaws/serverless/proxy/spring/echoapp/ProfileOverrideConfig.java

@@ -0,0 +1,11 @@
+package com.amazonaws.serverless.proxy.spring.echoapp;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Profile;
+import org.springframework.context.annotation.PropertySource;
+
+@Configuration
+@Profile("override")
+@PropertySource("classpath:/application-override.properties")
+public class ProfileOverrideConfig {
+}

aws-serverless-java-container-spring/src/test/java/com/amazonaws/serverless/proxy/spring/echoapp/profile/DefaultProfileConfiguration.java

@@ -0,0 +1,12 @@
+package com.amazonaws.serverless.proxy.spring.echoapp.profile;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class DefaultProfileConfiguration {
+    @Bean
+    public String beanInjectedValue() {
+        return "default-profile-from-bean";
+    }
+}

aws-serverless-java-container-spring/src/test/java/com/amazonaws/serverless/proxy/spring/echoapp/profile/DefaultProfileResource.java

@@ -0,0 +1,31 @@
+package com.amazonaws.serverless.proxy.spring.echoapp.profile;
+
+import com.amazonaws.serverless.proxy.spring.echoapp.model.MapResponseModel;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/profile")
+public class DefaultProfileResource {
+    @Value("${spring-proxy.profile-test}")
+    private String profileTest;
+
+    @Value("${spring-proxy.not-overridden-test}")
+    private String noOverride;
+
+    @Autowired
+    private String beanInjectedValue;
+
+    @RequestMapping(path = "/spring-properties", method = RequestMethod.GET)
+    public MapResponseModel loadProperties() {
+        MapResponseModel model = new MapResponseModel();
+
+        model.addValue("profileTest", profileTest);
+        model.addValue("noOverride", noOverride);
+        model.addValue("beanInjectedValue", beanInjectedValue);
+        return model;
+    }
+}

aws-serverless-java-container-spring/src/test/java/com/amazonaws/serverless/proxy/spring/echoapp/profile/OverrideProfileConfiguration.java

@@ -0,0 +1,14 @@
+package com.amazonaws.serverless.proxy.spring.echoapp.profile;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Profile;
+
+@Configuration
+@Profile("override")
+public class OverrideProfileConfiguration {
+    @Bean
+    public String beanInjectedValue() {
+        return "override-profile-from-bean";
+    }
+}

aws-serverless-java-container-spring/src/test/java/com/amazonaws/serverless/proxy/spring/profile/SpringProfileTest.java

@@ -0,0 +1,72 @@
+package com.amazonaws.serverless.proxy.spring.profile;
+
+import com.amazonaws.serverless.proxy.internal.model.AwsProxyRequest;
+import com.amazonaws.serverless.proxy.internal.model.AwsProxyResponse;
+import com.amazonaws.serverless.proxy.internal.servlet.AwsProxyServletContext;
+import com.amazonaws.serverless.proxy.internal.testutils.AwsProxyRequestBuilder;
+import com.amazonaws.serverless.proxy.internal.testutils.MockLambdaContext;
+import com.amazonaws.serverless.proxy.spring.SpringLambdaContainerHandler;
+import com.amazonaws.serverless.proxy.spring.echoapp.EchoSpringAppConfig;
+import com.amazonaws.serverless.proxy.spring.echoapp.model.MapResponseModel;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.TestExecutionListeners;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.support.DependencyInjectionTestExecutionListener;
+import org.springframework.test.context.web.WebAppConfiguration;
+
+import static org.junit.Assert.assertEquals;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(classes = EchoSpringAppConfig.class)
+@WebAppConfiguration
+@TestExecutionListeners(inheritListeners = false, listeners = {DependencyInjectionTestExecutionListener.class})
+public class SpringProfileTest {
+    @Autowired
+    private ObjectMapper objectMapper;
+
+    @Autowired
+    private MockLambdaContext lambdaContext;
+
+    @Before
+    public void clearServletContextCache() {
+        AwsProxyServletContext.clearServletContextCache();
+    }
+
+    @Test
+    public void profile_defaultProfile() throws Exception {
+        AwsProxyRequest request = new AwsProxyRequestBuilder("/profile/spring-properties", "GET")
+                .build();
+
+        SpringLambdaContainerHandler<AwsProxyRequest, AwsProxyResponse> handler = SpringLambdaContainerHandler.getAwsProxyHandler(EchoSpringAppConfig.class);
+        AwsProxyResponse output = handler.proxy(request, lambdaContext);
+        assertEquals(200, output.getStatusCode());
+
+        MapResponseModel response = objectMapper.readValue(output.getBody(), MapResponseModel.class);
+        assertEquals(3, response.getValues().size());
+        assertEquals("default-profile", response.getValues().get("profileTest"));
+        assertEquals("not-overridden", response.getValues().get("noOverride"));
+        assertEquals("default-profile-from-bean", response.getValues().get("beanInjectedValue"));
+    }
+
+    @Test
+    public void profile_overrideProfile() throws Exception {
+        AwsProxyRequest request = new AwsProxyRequestBuilder("/profile/spring-properties", "GET")
+                .build();
+
+        SpringLambdaContainerHandler<AwsProxyRequest, AwsProxyResponse> handler = SpringLambdaContainerHandler.getAwsProxyHandler(EchoSpringAppConfig.class);
+        handler.activateSpringProfiles("override");
+        AwsProxyResponse output = handler.proxy(request, lambdaContext);
+        assertEquals(200, output.getStatusCode());
+
+        MapResponseModel response = objectMapper.readValue(output.getBody(), MapResponseModel.class);
+        assertEquals(3, response.getValues().size());
+        assertEquals("override-profile", response.getValues().get("profileTest"));
+        assertEquals("not-overridden", response.getValues().get("noOverride"));
+        assertEquals("override-profile-from-bean", response.getValues().get("beanInjectedValue"));
+    }
+}