WIP

Author: Ajay Kannan

gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/testing/LocalGcdHelper.java renamed to gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/testing/LocalDatastoreHelper.java

@@ -18,7 +18,6 @@
 
 import static com.google.common.base.MoreObjects.firstNonNull;
 import static com.google.common.base.Preconditions.checkArgument;
-import static java.nio.charset.StandardCharsets.UTF_8;
 
 import com.google.common.base.Strings;
 import com.google.gcloud.AuthCredentials;
@@ -30,8 +29,6 @@
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
-import java.io.FileReader;
-import java.io.FileWriter;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
@@ -54,10 +51,8 @@
 import java.security.NoSuchAlgorithmException;
 import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
-import java.util.Map;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.regex.Pattern;
@@ -67,18 +62,9 @@
 /**
  * Utility to start and stop local Google Cloud Datastore process.
  */
-public class LocalGcdHelper {
-  private static final Logger log = Logger.getLogger(LocalGcdHelper.class.getName());
-
-  private final String projectId;
-  private Path gcdPath;
-  private Process startProcess;
-  private ProcessStreamReader processReader;
-  private ProcessErrorStreamReader processErrorReader;
-  private final int port;
-
-  public static final String DEFAULT_PROJECT_ID = "projectid1";
-  public static final int DEFAULT_PORT = 8080;
+public class LocalDatastoreHelper {
+  private static final Logger log = Logger.getLogger(LocalDatastoreHelper.class.getName());
+  private static final double DEFAULT_CONSISTENCY = 0.9;
   private static final String GCD_VERSION = "v1beta2";
   private static final String GCD_BUILD = "rev1-2.1.2b";
   private static final String GCD_BASENAME = "gcd-" + GCD_VERSION + "-" + GCD_BUILD;
@@ -88,7 +74,13 @@ public class LocalGcdHelper {
   private static final String GCLOUD = "gcloud";
   private static final Path INSTALLED_GCD_PATH;
   private static final String GCD_VERSION_PREFIX = "gcd-emulator ";
-  private static final double DEFAULT_CONSISTENCY = 0.9;
+
+  private final String projectId;
+  private Path gcdPath;
+  private Process startProcess;
+  private ProcessStreamReader processReader;
+  private ProcessErrorStreamReader processErrorReader;
+  private final int port;
 
   static {
     INSTALLED_GCD_PATH = installedGcdPath();
@@ -103,14 +95,6 @@ public class LocalGcdHelper {
     }
   }
 
-  public static int findAvailablePort(int defaultPort) {
-    try (ServerSocket tempSocket = new ServerSocket(0)) {
-      return tempSocket.getLocalPort();
-    } catch (IOException e) {
-      return defaultPort;
-    }
-  }
-
   private static Path installedGcdPath() {
     String gcloudExecutableName;
     if (isWindows()) {
@@ -390,56 +374,6 @@ public static CommandWrapper create() {
     }
   }
 
-  public LocalGcdHelper(String projectId, int port) {
-    this.projectId = projectId;
-    this.port = port;
-  }
-
-  /**
-   * Returns a {@link DatastoreOptions} instance that sets the host to use the Datastore emulator
-   * on localhost.
-   */
-  public DatastoreOptions options() {
-    return DatastoreOptions.builder()
-        .projectId(projectId)
-        .host("http://localhost:" + Integer.toString(port))
-        .authCredentials(AuthCredentials.noAuth())
-        .build();
-  }
-
-  /**
-   * Starts the local datastore for the specific project.
-   *
-   * This will unzip the gcd tool, create the project and start it.
-   * All content is written to a temporary directory that will be deleted when
-   * {@link #stop()} is called or when the program terminates) to make sure that no left-over
-   * data from prior runs is used.
-   *
-   * @param consistency the fraction of job application attempts that will succeed, with 0.0
-   *     resulting in no attempts succeeding, and 1.0 resulting in all attempts succeeding. Defaults
-   *     to 0.9. Note that setting this to 1.0 may mask incorrect assumptions about the consistency
-   *     of non-ancestor queries; non-ancestor queries are eventually consistent.
-   */
-  public void start(double consistency) throws IOException, InterruptedException {
-    // send a quick request in case we have a hanging process from a previous run
-    checkArgument(consistency >= 0.0 && consistency <= 1.0, "Consistency must be between 0 and 1");
-    sendQuitRequest(port);
-    // Each run is associated with its own folder that is deleted once test completes.
-    gcdPath = Files.createTempDirectory("gcd");
-    File gcdFolder = gcdPath.toFile();
-    gcdFolder.deleteOnExit();
-
-    Path gcdExecutablePath;
-    // If cloud is available we use it, otherwise we download and start gcd
-    if (INSTALLED_GCD_PATH == null) {
-      downloadGcd();
-      gcdExecutablePath = gcdPath.resolve(GCD_BASENAME);
-    } else {
-      gcdExecutablePath = INSTALLED_GCD_PATH;
-    }
-    startGcd(gcdExecutablePath, consistency);
-  }
-
   private void downloadGcd() throws IOException {
     // check if we already have a local copy of the gcd utility and download it if not.
     File gcdZipFile = new File(System.getProperty("java.io.tmpdir"), GCD_FILENAME);
@@ -603,83 +537,93 @@ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IO
     });
   }
 
-  public static LocalGcdHelper start(String projectId, int port, double consistency)
+  private LocalDatastoreHelper(String projectId) {
+    this.projectId = projectId;
+    this.port = findAvailablePort();
+  }
+
+  private static int findAvailablePort() {
+    try (ServerSocket tempSocket = new ServerSocket(0)) {
+      return tempSocket.getLocalPort();
+    } catch (IOException e) {
+      return -1;
+    }
+  }
+
+  /**
+   * Returns a {@link DatastoreOptions} instance that sets the host to use the Datastore emulator
+   * on localhost.
+   */
+  public DatastoreOptions options() {
+    return DatastoreOptions.builder()
+        .projectId(projectId)
+        .host("http://localhost:" + Integer.toString(port))
+        .authCredentials(AuthCredentials.noAuth())
+        .build();
+  }
+
+  /**
+   * Returns the project ID associated with this local Datastore emulator.
+   */
+  public String projectId() {
+    return projectId;
+  }
+
+  /**
+   * Returns the port on localhost to which the local Datastore listens for requests.
+   */
+  public int port() {
+    return port;
+  }
+
+  /**
+   * Starts the local Datastore for the specific project.
+   *
+   * This will unzip the gcd tool, create the project and start it. All content is written to a
+   * temporary directory that will be deleted when {@link #stop()} is called (or when the program
+   * terminates) to make sure that no left-over data from prior runs is used.
+   *
+   * @param consistency the fraction of Datastore writes that are immediately visible to global
+   *     queries, with 0.0 resulting in no attempts succeeding, and 1.0 resulting in all attempts succeeding. Note
+   *     that setting this to 1.0 may mask incorrect assumptions about the consistency of
+   *     non-ancestor queries; non-ancestor queries are eventually consistent.
+   */
+  public static LocalDatastoreHelper start(String projectId, double consistency)
       throws IOException, InterruptedException {
-    LocalGcdHelper helper = new LocalGcdHelper(projectId, port);
+    LocalDatastoreHelper helper = new LocalDatastoreHelper(projectId);
     helper.start(consistency);
     return helper;
   }
 
-  public static void main(String... args) throws IOException, InterruptedException {
-    Map<String, String> parsedArgs = parseArgs(args);
-    String action = parsedArgs.get("action");
-    int port =
-        (parsedArgs.get("port") == null) ? DEFAULT_PORT : Integer.parseInt(parsedArgs.get("port"));
-    switch (action) {
-      case "START":
-        if (!isActive(DEFAULT_PROJECT_ID, port)) {
-          double consistency = parsedArgs.get("consistency") == null
-              ? DEFAULT_CONSISTENCY : Double.parseDouble(parsedArgs.get("consistency"));
-          LocalGcdHelper helper = start(DEFAULT_PROJECT_ID, port, consistency);
-          try (FileWriter writer = new FileWriter(".local_gcd_helper")) {
-            writer.write(helper.gcdPath.toAbsolutePath().toString() + System.lineSeparator());
-            writer.write(Integer.toString(port));
-          }
-        }
-        return;
-      case "STOP":
-        File file = new File(".local_gcd_helper");
-        String path = null;
-        boolean fileExists = file.exists();
-        if (fileExists) {
-          try (BufferedReader reader = new BufferedReader(new FileReader(file))) {
-            path = reader.readLine();
-            port = Integer.parseInt(reader.readLine());
-          }
-        }
-        sendQuitRequest(port);
-        if (fileExists) {
-          deleteRecurse(Paths.get(path));
-          file.delete();
-        }
-        return;
-      default:
-        break;
-    }
+  /**
+   * Starts the local Datastore for the specific project using a default consistency setting of 0.9.
+   *
+   * This will unzip the gcd tool, create the project and start it. All content is written to a
+   * temporary directory that will be deleted when {@link #stop()} is called (or when the program
+   * terminates) to make sure that no left-over data from prior runs is used.
+   */
+  public static LocalDatastoreHelper start(String projectId)
+      throws IOException, InterruptedException {
+    return start(projectId, DEFAULT_CONSISTENCY);
   }
 
-  private static Map<String, String> parseArgs(String[] args) {
-    Map<String, String> parsedArgs = new HashMap<String, String>();
-    for (String arg : args) {
-      if (arg.startsWith("--port=")) {
-        parsedArgs.put("port", arg.substring("--port=".length()));
-      } else if (arg.startsWith("--consistency=")) {
-        parsedArgs.put("consistency", arg.substring("--consistency=".length()));
-      } else if (arg.equals("START") || arg.equals("STOP")) {
-        parsedArgs.put("action", arg);
-      } else {
-        throw new RuntimeException("Only accepts START, STOP, --port=<port #> and "
-            + "--consistency=<double in range [0,1]> as arguments.");
-      }
-    }
-    if (parsedArgs.get("action") == null) {
-      throw new RuntimeException("EXPECTING START | STOP");
-    }
-    return parsedArgs;
-  }
+  private void start(double consistency) throws IOException, InterruptedException {
+    // send a quick request in case we have a hanging process from a previous run
+    checkArgument(consistency >= 0.0 && consistency <= 1.0, "Consistency must be between 0 and 1");
+    sendQuitRequest(port);
+    // Each run is associated with its own folder that is deleted once test completes.
+    gcdPath = Files.createTempDirectory("gcd");
+    File gcdFolder = gcdPath.toFile();
+    gcdFolder.deleteOnExit();
 
-  public static boolean isActive(String projectId, int port) {
-    try {
-      StringBuilder urlBuilder = new StringBuilder("http://localhost:").append(port);
-      urlBuilder.append("/datastore/v1beta2/datasets/").append(projectId).append("/lookup");
-      URL url = new URL(urlBuilder.toString());
-      try (BufferedReader reader =
-          new BufferedReader(new InputStreamReader(url.openStream(), UTF_8))) {
-        return "Valid RPC".equals(reader.readLine());
-      }
-    } catch (IOException ignore) {
-      // assume not active
-      return false;
+    Path gcdExecutablePath;
+    // If cloud is available we use it, otherwise we download and start gcd
+    if (INSTALLED_GCD_PATH == null) {
+      downloadGcd();
+      gcdExecutablePath = gcdPath.resolve(GCD_BASENAME);
+    } else {
+      gcdExecutablePath = INSTALLED_GCD_PATH;
     }
+    startGcd(gcdExecutablePath, consistency);
   }
 }

gcloud-java-datastore/src/test/java/com/google/gcloud/datastore/DatastoreOptionsTest.java

@@ -24,7 +24,7 @@
 
 import com.google.gcloud.datastore.spi.DatastoreRpc;
 import com.google.gcloud.datastore.spi.DatastoreRpcFactory;
-import com.google.gcloud.datastore.testing.LocalGcdHelper;
+import com.google.gcloud.datastore.testing.LocalDatastoreHelper;
 
 import org.easymock.EasyMock;
 import org.junit.Before;
@@ -33,7 +33,7 @@
 public class DatastoreOptionsTest {
 
   private static final String PROJECT_ID = "project_id";
-  private static final int PORT = LocalGcdHelper.findAvailablePort(LocalGcdHelper.DEFAULT_PORT);
+  private static final int PORT = LocalDatastoreHelper.findAvailablePort(LocalDatastoreHelper.DEFAULT_PORT);
   private DatastoreRpcFactory datastoreRpcFactory;
   private DatastoreRpc datastoreRpc;
   private DatastoreOptions.Builder options;

gcloud-java-datastore/src/test/java/com/google/gcloud/datastore/DatastoreTest.java

@@ -39,7 +39,7 @@
 import com.google.gcloud.datastore.StructuredQuery.PropertyFilter;
 import com.google.gcloud.datastore.spi.DatastoreRpc;
 import com.google.gcloud.datastore.spi.DatastoreRpcFactory;
-import com.google.gcloud.datastore.testing.LocalGcdHelper;
+import com.google.gcloud.datastore.testing.LocalDatastoreHelper;
 import com.google.protobuf.ByteString;
 
 import org.easymock.EasyMock;
@@ -63,7 +63,7 @@
 @RunWith(JUnit4.class)
 public class DatastoreTest {
 
-  private static final String PROJECT_ID = LocalGcdHelper.DEFAULT_PROJECT_ID;
+  private static final String PROJECT_ID = "projectid1";
   private static final String KIND1 = "kind1";
   private static final String KIND2 = "kind2";
   private static final String KIND3 = "kind3";
@@ -110,17 +110,14 @@ public class DatastoreTest {
   private DatastoreOptions options;
   private Datastore datastore;
 
-  private static LocalGcdHelper gcdHelper;
-  private static final int PORT = LocalGcdHelper.findAvailablePort(LocalGcdHelper.DEFAULT_PORT);
+  private static LocalDatastoreHelper gcdHelper;
 
   @Rule
   public ExpectedException thrown = ExpectedException.none();
 
   @BeforeClass
   public static void beforeClass() throws IOException, InterruptedException {
-    if (!LocalGcdHelper.isActive(PROJECT_ID, PORT)) {
-      gcdHelper = LocalGcdHelper.start(PROJECT_ID, PORT, 1.0);
-    }
+    gcdHelper = LocalDatastoreHelper.start(PROJECT_ID, 1.0);
   }
 
   @Before