Merge pull request #179 from GoogleCloudPlatform/requests

Requests

appengine/requests/README.md

@@ -0,0 +1,43 @@
+# Request Handling sample for Google App Engine
+
+This sample provides Java code samples in support of the "Handling Requests" description  [Requests][requests-doc] on [Google App
+Engine][ae-docs].
+
+[requests-doc]: https://cloud.google.com/appengine/docs/java/requests
+[ae-docs]: https://cloud.google.com/appengine/docs/java/
+
+## Running locally 
+This example uses the
+[Maven gcloud plugin](https://cloud.google.com/appengine/docs/java/managed-vms/maven).
+To run this sample locally:
+
+    $ mvn appengine:devserver
+
+To see the results of the RequestsServlet, open `localhost:8080` in a WWW browser.
+
+To see the results of the LoggingServlet, open `localhost:8080/logs` in a WWW browser
+and examine the logs to see the actual messages.
+
+## Deploying
+In the following command, replace YOUR-PROJECT-ID with your
+[Google Cloud Project ID](https://developers.google.com/console/help/new/#projectnumber) 
+and SOME-VERSION with a valid version number.
+
+    $ mvn appengine:update -Dappengine.appId=YOUR-PROJECT-ID -Dappengine.version=SOME-VERSION
+
+## Setup
+To save your project settings so that you don't need to enter the
+ parameters, you can:
+
+1. Update the `<application>` tag in src/main/webapp/WEB-INF/appengine-web.xml
+   with your project name.
+
+2. Update the `<version>` tag in src/main/webapp/WEB-INF/appengine-web.xml
+   with a valid version number.
+
+
+You will now be able to run
+
+    $ mvn appengine:update
+
+without the need for any additional parameters.

appengine/requests/pom.xml

@@ -0,0 +1,104 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Copyright 2016 Google Inc. All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<project>
+  <modelVersion>4.0.0</modelVersion>
+  <packaging>war</packaging>
+  <version>1.0-SNAPSHOT</version>
+  <groupId>com.example.appengine</groupId>
+  <artifactId>appengine-requests</artifactId>
+  <!-- Parent POM defines ${appengine.sdk.version} (updates frequently). -->
+  <parent>
+    <groupId>com.google.cloud</groupId>
+    <artifactId>doc-samples</artifactId>
+    <version>1.0.0</version>
+    <relativePath>../..</relativePath>
+  </parent>
+  <dependencies>
+   <dependency>
+    <groupId>com.google.appengine</groupId>
+    <artifactId>appengine-maven-plugin</artifactId>
+    <version>${appengine.sdk.version}</version>
+   </dependency>
+   <dependency>
+      <groupId>com.google.guava</groupId>
+      <artifactId>guava</artifactId>
+      <version>19.0</version>
+    </dependency>
+    <dependency>
+      <groupId>javax.servlet</groupId>
+      <artifactId>servlet-api</artifactId>
+      <version>2.5</version>
+      <type>jar</type>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.json</groupId>
+      <artifactId>json</artifactId>
+      <version>20151123</version>
+    </dependency>
+    <!-- Test Dependencies -->
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.10</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-all</artifactId>
+      <version>1.10.19</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.appengine</groupId>
+      <artifactId>appengine-testing</artifactId>
+      <version>${appengine.sdk.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.appengine</groupId>
+      <artifactId>appengine-api-stubs</artifactId>
+      <version>${appengine.sdk.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.appengine</groupId>
+      <artifactId>appengine-tools-sdk</artifactId>
+      <version>${appengine.sdk.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.truth</groupId>
+      <artifactId>truth</artifactId>
+      <version>0.28</version>
+      <scope>test</scope>
+    </dependency>
+
+  </dependencies>
+  <build>
+    <!-- for hot reload of the web application -->
+    <outputDirectory>${project.build.directory}/${project.build.finalName}/WEB-INF/classes</outputDirectory>
+    <plugins>
+
+      <plugin>
+        <groupId>com.google.appengine</groupId>
+        <artifactId>appengine-maven-plugin</artifactId>
+        <version>${appengine.sdk.version}</version>
+      </plugin>
+    </plugins>
+  </build>
+</project>

appengine/requests/src/main/java/com/example/appengine/requests/LoggingServlet.java

@@ -0,0 +1,41 @@
+/* Copyright 2016 Google Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.example.appengine.requests;
+
+import java.io.IOException;
+import java.util.logging.Logger;
+
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+// [START simple_logging_example]
+public class LoggingServlet extends HttpServlet {
+  private static final Logger log = Logger.getLogger(LoggingServlet.class.getName());
+
+  @Override
+  public void doGet(HttpServletRequest req, HttpServletResponse resp)
+        throws IOException {
+    log.info("An informational message.");
+    log.warning("A warning message.");
+    log.severe("An error message.");
+    // [START_EXCLUDE]
+    resp.setContentType("text/plain");
+    resp.getWriter().println("Check logs for results");
+    // [END_EXCLUDE]
+  }
+} 
+// [END simple_logging_example]
+

appengine/requests/src/main/java/com/example/appengine/requests/RequestsServlet.java

@@ -0,0 +1,33 @@
+/* Copyright 2016 Google Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.example.appengine.requests;
+
+import java.io.IOException;
+
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+// [START simple_request_example]
+public class RequestsServlet extends HttpServlet {
+  @Override
+  public void doGet(HttpServletRequest req, HttpServletResponse resp)
+          throws IOException {
+    resp.setContentType("text/plain");
+    resp.getWriter().println("Hello, world");
+  }
+}
+// [END simple_request_example]
+

appengine/requests/src/main/webapp/WEB-INF/appengine-web.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<appengine-web-app xmlns="http://appengine.google.com/ns/1.0">
+  <application>YOUR-PROJECT-ID</application>
+  <version>YOUR-VERSION-ID</version>
+  <threadsafe>true</threadsafe>
+</appengine-web-app>

appengine/requests/src/main/webapp/WEB-INF/web.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee"
+  xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
+  xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
+  version="2.5">
+  <servlet>
+    <servlet-name>requests</servlet-name>
+    <servlet-class>com.example.appengine.requests.RequestsServlet</servlet-class>
+  </servlet>
+  <servlet>
+    <servlet-name>logging</servlet-name>
+    <servlet-class>com.example.appengine.requests.LoggingServlet</servlet-class>
+  </servlet>
+  <servlet-mapping>
+    <servlet-name>requests</servlet-name>
+    <url-pattern>/</url-pattern>
+  </servlet-mapping>
+  <servlet-mapping>
+    <servlet-name>requests</servlet-name>
+    <url-pattern>/requests</url-pattern>
+  </servlet-mapping>
+  <servlet-mapping>
+    <servlet-name>logging</servlet-name>
+    <url-pattern>/logs</url-pattern>
+  </servlet-mapping>
+</web-app>

appengine/requests/src/test/java/com/example/appengine/requests/LoggingServletTest.java

@@ -0,0 +1,93 @@
+/*
+ * Copyright 2016 Google Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.appengine.requests;
+
+import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Mockito.when;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import java.io.PrintWriter;
+import java.io.StringWriter;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+/**
+ * Unit tests for {@link LoggingServlet}.
+ */
+@RunWith(JUnit4.class)
+public class LoggingServletTest {
+  // To capture and restore stderr
+  private final ByteArrayOutputStream stderr = new ByteArrayOutputStream();
+  private static final PrintStream REAL_ERR = System.err;
+
+  @Mock private HttpServletRequest mockRequest;
+  @Mock private HttpServletResponse mockResponse;
+  private StringWriter responseWriter;
+  private LoggingServlet servletUnderTest;
+
+  @Before
+  public void setUp() throws Exception {
+    //  Capture stderr to examine messages written to it
+    System.setErr(new PrintStream(stderr));
+
+    MockitoAnnotations.initMocks(this);
+
+    // Set up a fake HTTP response.
+    responseWriter = new StringWriter();
+    when(mockResponse.getWriter()).thenReturn(new PrintWriter(responseWriter));
+
+    servletUnderTest = new LoggingServlet();
+  }
+
+  @After 
+  public void tearDown() {
+    //  Restore stderr  
+    System.setErr(LoggingServletTest.REAL_ERR);
+  }
+
+  @Test
+  public void testListLogs() throws Exception {
+    servletUnderTest.doGet(mockRequest, mockResponse);
+
+    String out = stderr.toString();
+
+    // We expect three log messages to be created
+    // with the following messages.
+    assertThat(out).contains("An informational message.");
+    assertThat(out).contains("A warning message.");
+    assertThat(out).contains("An error message.");
+
+    // We expect three log messages to be created
+    // with the following severities.
+    // Since there's no guarantee of case, use lowercase
+    String lcOut = out.toLowerCase();
+    assertThat(lcOut).contains("info");
+    assertThat(lcOut).contains("warning");
+    assertThat(lcOut).contains("severe");
+  }
+
+}