Move Push Taskqueue sample program to Github (#209)

* Move Push Taskqueue sample program to Github Some minor corrections to Requests testing and configuration. * Added licenses
GoogleCloudPlatform · Apr 28, 2016 · 60f17a2 · 60f17a2
1 parent f2212b5
commit 60f17a2
Show file tree

Hide file tree

Showing 11 changed files with 387 additions and 9 deletions.
diff --git a/appengine/requests/pom.xml b/appengine/requests/pom.xml
@@ -93,7 +93,6 @@ Copyright 2016 Google Inc. All Rights Reserved.
     <!-- 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>

diff --git a/appengine/requests/src/test/java/com/example/appengine/requests/LoggingServletTest.java b/appengine/requests/src/test/java/com/example/appengine/requests/LoggingServletTest.java
@@ -80,14 +80,6 @@ public void testListLogs() throws Exception {
     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");
   }
 
 }
diff --git a/appengine/taskqueue-push/README.md b/appengine/taskqueue-push/README.md
@@ -0,0 +1,39 @@
+# A Java Task Queue example for Google App Engine
+
+This sample demonstrates how to use the [TaskQueue API][taskqueue-api] on [Google App
+Engine][ae-docs].
+
+[taskqueue-api]: https://cloud.google.com/appengine/docs/java/javadoc/com/google/appengine/api/taskqueue/package-summary
+[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
+
+Go to the site `localhost:8080` to add elements to the queue.  They will appear in the log as the result of the Enqueue servlet transmitting the data to the Worker servlet.
+
+## Deploying
+In the following command, replace YOUR-PROJECT-ID with your
+[Google Cloud Project ID](https://support.google.com/cloud/answer/6158840).
+
+    $ 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.
diff --git a/appengine/taskqueue-push/pom.xml b/appengine/taskqueue-push/pom.xml
@@ -0,0 +1,98 @@
+<?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>taskqueue-push</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>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>
diff --git a/appengine/taskqueue-push/src/main/java/com/example/appengine/taskqueue/push/Enqueue.java b/appengine/taskqueue-push/src/main/java/com/example/appengine/taskqueue/push/Enqueue.java
@@ -0,0 +1,42 @@
+/* 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.taskqueue.push;
+
+import com.google.appengine.api.taskqueue.Queue;
+import com.google.appengine.api.taskqueue.QueueFactory;
+import com.google.appengine.api.taskqueue.TaskOptions;
+
+import java.io.IOException;
+
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+// [START enqueue]
+// The Enqueue servlet should be mapped to the "/enqueue" URL.
+public class Enqueue extends HttpServlet {
+  protected void doPost(HttpServletRequest request, HttpServletResponse response)
+          throws ServletException, IOException {
+    String key = request.getParameter("key");
+
+    // Add the task to the default queue.
+    Queue queue = QueueFactory.getDefaultQueue();
+    queue.add(TaskOptions.Builder.withUrl("/worker").param("key", key));
+
+    response.sendRedirect("/");
+  }
+}
+// [END enqueue]
diff --git a/appengine/taskqueue-push/src/main/java/com/example/appengine/taskqueue/push/Worker.java b/appengine/taskqueue-push/src/main/java/com/example/appengine/taskqueue/push/Worker.java
@@ -0,0 +1,40 @@
+/* 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.taskqueue.push;
+
+import java.io.IOException;
+import java.util.logging.Logger;
+
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+//  [START worker]
+// The Worker servlet should be mapped to the "/worker" URL.
+public class Worker extends HttpServlet {
+  private static final Logger log = Logger.getLogger(Worker.class.getName());
+
+  protected void doPost(HttpServletRequest request, HttpServletResponse response)
+          throws ServletException, IOException {
+    String key = request.getParameter("key");
+
+    // Do something with key.
+    // [START_EXCLUDE]
+    log.info("Worker is processing " + key);
+    // [END_EXCLUDE]
+  }
+}
+// [END worker]
diff --git a/appengine/taskqueue-push/src/main/webapp/WEB-INF/appengine-web.xml b/appengine/taskqueue-push/src/main/webapp/WEB-INF/appengine-web.xml
@@ -0,0 +1,21 @@
+<?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.
+-->
+<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>
diff --git a/appengine/taskqueue-push/src/main/webapp/WEB-INF/web.xml b/appengine/taskqueue-push/src/main/webapp/WEB-INF/web.xml
@@ -0,0 +1,39 @@
+<?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.
+-->
+<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee"
+         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
+         version="2.5">
+    <welcome-file-list>
+        <welcome-file>index.html</welcome-file>
+    </welcome-file-list>
+    <servlet>
+        <servlet-name>enqueue</servlet-name>
+        <servlet-class>com.example.appengine.taskqueue.push.Enqueue</servlet-class>
+    </servlet>
+    <servlet>
+        <servlet-name>worker</servlet-name>
+        <servlet-class>com.example.appengine.taskqueue.push.Worker</servlet-class>
+    </servlet>
+    <servlet-mapping>
+        <servlet-name>enqueue</servlet-name>
+        <url-pattern>/enqueue</url-pattern>
+    </servlet-mapping>
+    <servlet-mapping>
+        <servlet-name>worker</servlet-name>
+        <url-pattern>/worker</url-pattern>
+    </servlet-mapping>
+</web-app>
diff --git a/appengine/taskqueue-push/src/main/webapp/index.html b/appengine/taskqueue-push/src/main/webapp/index.html
@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<!--
+ 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.
+-->
+<!--[START index_file] -->
+<!-- A basic index.html file served from the "/" URL. -->
+<html>
+<body>
+<p>Enqueue a value, to be processed by a worker.</p>
+<form action="/enqueue" method="post">
+    <input type="text" name="key">
+    <input type="submit">
+</form>
+</body>
+</html>
+<!--[END index_file] -->