Merging in updated unit testing samples

unittests/pom.xml

@@ -5,25 +5,21 @@
     <packaging>war</packaging>
     <version>1.0-SNAPSHOT</version>
 
-    <groupId>com.google.appengine.samples.unittest</groupId>
-    <artifactId>unittests</artifactId>
+    <groupId>com.google.appengine.samples</groupId>
+    <artifactId>appengine-local-testing-samples</artifactId>
 
     <properties>
         <appengine.app.version>1</appengine.app.version>
-        <appengine.version>1.9.18</appengine.version>
+        <appengine.target.version>1.8.4</appengine.target.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
 
-    <prerequisites>
-        <maven>3.1.0</maven>
-    </prerequisites>
-
     <dependencies>
         <!-- Compile/runtime dependencies -->
         <dependency>
             <groupId>com.google.appengine</groupId>
             <artifactId>appengine-api-1.0-sdk</artifactId>
-            <version>${appengine.version}</version>
+            <version>${appengine.target.version}</version>
         </dependency>
         <dependency>
             <groupId>javax.servlet</groupId>
@@ -41,54 +37,45 @@
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
-            <version>4.12</version>
+            <version>4.10</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>com.google.appengine</groupId>
             <artifactId>appengine-testing</artifactId>
-            <version>${appengine.version}</version>
+            <version>${appengine.target.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>com.google.appengine</groupId>
             <artifactId>appengine-api-stubs</artifactId>
-            <version>${appengine.version}</version>
+            <version>${appengine.target.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.google.appengine</groupId>
+            <artifactId>appengine-tools-sdk</artifactId>
+            <version>${appengine.target.version}</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>org.codehaus.mojo</groupId>
-                <artifactId>versions-maven-plugin</artifactId>
-                <version>2.1</version>
-                <executions>
-                    <execution>
-                        <phase>compile</phase>
-                        <goals>
-                            <goal>display-dependency-updates</goal>
-                            <goal>display-plugin-updates</goal>
-                        </goals>
-                    </execution>
-                </executions>
-            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
-                <version>3.1</version>
+                <version>2.5.1</version>
                 <artifactId>maven-compiler-plugin</artifactId>
                 <configuration>
                     <source>1.7</source>
                     <target>1.7</target>
                 </configuration>
             </plugin>
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-war-plugin</artifactId>
-                <version>2.4</version>
+                <version>2.3</version>
                 <configuration>
                     <archiveClasses>true</archiveClasses>
                     <webResources>
@@ -105,36 +92,9 @@
             <plugin>
                 <groupId>com.google.appengine</groupId>
                 <artifactId>appengine-maven-plugin</artifactId>
-                <version>${appengine.version}</version>
-                <configuration>
-                    <enableJarClasses>false</enableJarClasses>
-                    <!-- Comment in the below snippet to bind to all IPs instead of just localhost -->
-                    <!-- address>0.0.0.0</address>
-                    <port>8080</port -->
-                    <!-- Comment in the below snippet to enable local debugging with a remove debugger
-                         like those included with Eclipse or IntelliJ -->
-                    <!-- jvmFlags>
-                      <jvmFlag>-agentlib:jdwp=transport=dt_socket,address=8000,server=y,suspend=n</jvmFlag>
-                    </jvmFlags -->
-                </configuration>
-            </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-checkstyle-plugin</artifactId>
-                <version>2.15</version>
-                <executions>
-                    <execution>
-                        <id>checkstyle</id>
-                        <phase>validate</phase>
-                        <goals>
-                            <goal>check</goal>
-                        </goals>
-                        <configuration>
-                            <failOnViolation>true</failOnViolation>
-                        </configuration>
-                    </execution>
-                </executions>
+                <version>${appengine.target.version}</version>
             </plugin>
         </plugins>
     </build>
+
 </project>

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

@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="utf-8"?>
 <appengine-web-app xmlns="http://appengine.google.com/ns/1.0">
-    <application>your-app-id</application>
+    <application>appengine-local-testing-samples</application>
     <version>${appengine.app.version}</version>
     <threadsafe>true</threadsafe>
-    
+
     <system-properties>
         <property name="java.util.logging.config.file" value="WEB-INF/logging.properties"/>
     </system-properties>

unittests/src/main/webapp/WEB-INF/queue.xml

@@ -0,0 +1,10 @@
+<queue-entries>
+    <queue>
+        <name>default</name>
+        <rate>1/s</rate>
+    </queue>
+    <queue>
+        <name>my-queue-name</name>
+        <rate>3/s</rate>
+    </queue>
+</queue-entries>

unittests/src/main/webapp/WEB-INF/web.xml

@@ -1,4 +1,7 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
-
+<?xml version="1.0" encoding="utf-8"?>
+<web-app
+        version="2.5"
+        xmlns="http://java.sun.com/xml/ns/javaee"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
 </web-app>

unittests/src/test/java/com/google/appengine/samples/unittest/AuthenticationTest.java → unittests/src/test/java/com/google/appengine/samples/AuthenticationTest.java

@@ -13,9 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.google.appengine.samples.unittest;
+package com.google.appengine.samples;
+
+// [START AuthenticationTest]
 
-// [START auth]
 import com.google.appengine.api.users.UserService;
 import com.google.appengine.api.users.UserServiceFactory;
 import com.google.appengine.tools.development.testing.LocalServiceTestHelper;
@@ -24,28 +25,28 @@
 import org.junit.Before;
 import org.junit.Test;
 
-import static org.junit.Assert.*;
+import static org.junit.Assert.assertTrue;
 
 public class AuthenticationTest {
 
-    private final LocalServiceTestHelper helper =
-            new LocalServiceTestHelper(new LocalUserServiceTestConfig())
-                    .setEnvIsAdmin(true).setEnvIsLoggedIn(true);
-
-    @Before
-    public void setUp() {
-        helper.setUp();
-    }
-
-    @After
-    public void tearDown() {
-        helper.tearDown();
-    }
-
-    @Test
-    public void testIsAdmin() {
-        UserService userService = UserServiceFactory.getUserService();
-        assertTrue(userService.isUserAdmin());
-    }
+  private final LocalServiceTestHelper helper =
+      new LocalServiceTestHelper(new LocalUserServiceTestConfig())
+          .setEnvIsAdmin(true).setEnvIsLoggedIn(true);
+
+  @Before
+  public void setUp() {
+    helper.setUp();
+  }
+
+  @After
+  public void tearDown() {
+    helper.tearDown();
+  }
+
+  @Test
+  public void testIsAdmin() {
+    UserService userService = UserServiceFactory.getUserService();
+    assertTrue(userService.isUserAdmin());
+  }
 }
-// [END auth]
+// [END AuthenticationTest]

unittests/src/test/java/com/google/appengine/samples/DeferredTaskTest.java

@@ -0,0 +1,74 @@
+/**
+ * Copyright 2015 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.google.appengine.samples;
+
+// [START DeferredTaskTest]
+
+import com.google.appengine.api.taskqueue.DeferredTask;
+import com.google.appengine.api.taskqueue.QueueFactory;
+import com.google.appengine.api.taskqueue.TaskOptions;
+import com.google.appengine.tools.development.testing.LocalServiceTestHelper;
+import com.google.appengine.tools.development.testing.LocalTaskQueueTestConfig;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.util.concurrent.TimeUnit;
+
+import static org.junit.Assert.assertTrue;
+
+public class DeferredTaskTest {
+
+  // Unlike CountDownLatch, TaskCountDownlatch lets us reset.
+  private final LocalTaskQueueTestConfig.TaskCountDownLatch latch =
+      new LocalTaskQueueTestConfig.TaskCountDownLatch(1);
+
+  private final LocalServiceTestHelper helper =
+      new LocalServiceTestHelper(new LocalTaskQueueTestConfig()
+          .setDisableAutoTaskExecution(false)
+          .setCallbackClass(LocalTaskQueueTestConfig.DeferredTaskCallback.class)
+          .setTaskExecutionLatch(latch));
+
+  private static class MyTask implements DeferredTask {
+    private static boolean taskRan = false;
+
+    @Override
+    public void run() {
+      taskRan = true;
+    }
+  }
+
+  @Before
+  public void setUp() {
+    helper.setUp();
+  }
+
+  @After
+  public void tearDown() {
+    MyTask.taskRan = false;
+    latch.reset();
+    helper.tearDown();
+  }
+
+  @Test
+  public void testTaskGetsRun() throws InterruptedException {
+    QueueFactory.getDefaultQueue().add(
+        TaskOptions.Builder.withPayload(new MyTask()));
+    assertTrue(latch.await(5, TimeUnit.SECONDS));
+    assertTrue(MyTask.taskRan);
+  }
+}
+// [END DeferredTaskTest]

unittests/src/test/java/com/google/appengine/samples/LocalCustomPolicyHighRepDatastoreTest.java

@@ -0,0 +1,75 @@
+/**
+ * Copyright 2015 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.google.appengine.samples;
+
+// [START LocalCustomPolicyHighRepDatastoreTest]
+
+import com.google.appengine.api.datastore.*;
+import com.google.appengine.api.datastore.dev.HighRepJobPolicy;
+import com.google.appengine.tools.development.testing.LocalDatastoreServiceTestConfig;
+import com.google.appengine.tools.development.testing.LocalServiceTestHelper;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+import static com.google.appengine.api.datastore.FetchOptions.Builder.withLimit;
+import static org.junit.Assert.assertEquals;
+
+public class LocalCustomPolicyHighRepDatastoreTest {
+  private static final class CustomHighRepJobPolicy implements HighRepJobPolicy {
+    static int newJobCounter = 0;
+    static int existingJobCounter = 0;
+
+    @Override
+    public boolean shouldApplyNewJob(Key entityGroup) {
+      // every other new job fails to apply
+      return newJobCounter++ % 2 == 0;
+    }
+
+    @Override
+    public boolean shouldRollForwardExistingJob(Key entityGroup) {
+      // every other existing job fails to apply
+      return existingJobCounter++ % 2 == 0;
+    }
+  }
+
+  private final LocalServiceTestHelper helper =
+      new LocalServiceTestHelper(new LocalDatastoreServiceTestConfig()
+          .setAlternateHighRepJobPolicyClass(CustomHighRepJobPolicy.class));
+
+  @Before
+  public void setUp() {
+    helper.setUp();
+  }
+
+  @After
+  public void tearDown() {
+    helper.tearDown();
+  }
+
+  @Test
+  public void testEventuallyConsistentGlobalQueryResult() {
+    DatastoreService ds = DatastoreServiceFactory.getDatastoreService();
+    ds.put(new Entity("yam")); // applies
+    ds.put(new Entity("yam")); // does not apply
+    // first global query only sees the first Entity
+    assertEquals(1, ds.prepare(new Query("yam")).countEntities(withLimit(10)));
+    // second global query sees both Entities because we "groom" (attempt to
+    // apply unapplied jobs) after every query
+    assertEquals(2, ds.prepare(new Query("yam")).countEntities(withLimit(10)));
+  }
+}
+// [END LocalCustomPolicyHighRepDatastoreTest]