Support specifying port for EmbeddedTestServer

Adds the ability for the native and Java versions of EmbeddedTestServer
to be started using a specified port instead of always using an auto
selected one.

The use case that prompted this is pixel tests in VR, which need to use
the test server (instead of file URLs) in order to grant permissions to
pages, but need the URL to remain constant so that captured images
don't differ between test runs.

Bug: 883940
Change-Id: I7c0fa1a86cdf15d0e3271de6722d315a0191327a
Reviewed-on: https://chromium-review.googlesource.com/1225304Reviewed-by: Zhongyi Shi <zhongyi@chromium.org>
Reviewed-by: Bo <boliu@chromium.org>
Reviewed-by: Daniel Cheng <dcheng@chromium.org>
Commit-Queue: Brian Sheedy <bsheedy@chromium.org>
Cr-Commit-Position: refs/heads/master@{#591389}

android_webview/test/embedded_test_server/java/src/org/chromium/android_webview/test/AwEmbeddedTestServer.java

@@ -44,6 +44,6 @@ public class AwEmbeddedTestServer extends EmbeddedTestServer {
      */
     public static AwEmbeddedTestServer createAndStartServer(Context context)
             throws InterruptedException {
-        return initializeAndStartServer(new AwEmbeddedTestServer(), context);
+        return initializeAndStartServer(new AwEmbeddedTestServer(), context, 0 /* port */);
     }
 }

net/test/android/javatests/src/org/chromium/net/test/EmbeddedTestServer.java

@@ -277,7 +277,7 @@ public class EmbeddedTestServer {
         }
     }
 
-    /** Starts the server.
+    /** Starts the server with an automatically selected port.
      *
      *  Note that this should be called after handlers are set up, including any relevant calls
      *  serveFilesFromDirectory.
@@ -285,10 +285,23 @@ public class EmbeddedTestServer {
      *  @return Whether the server was successfully initialized.
      */
     public boolean start() {
+        return start(0);
+    }
+
+    /** Starts the server with the specified port.
+     *
+     *  Note that this should be called after handlers are set up, including any relevant calls
+     *  serveFilesFromDirectory.
+     *
+     *  @param port The port to use for the server, 0 to auto-select an unused port.
+     *
+     *  @return Whether the server was successfully initialized.
+     */
+    public boolean start(int port) {
         try {
             synchronized (mImplMonitor) {
                 checkServiceLocked();
-                return mImpl.start();
+                return mImpl.start(port);
             }
         } catch (RemoteException e) {
             throw new EmbeddedTestServerFailure("Failed to start server.", e);
@@ -338,11 +351,25 @@ public class EmbeddedTestServer {
      */
     public static EmbeddedTestServer createAndStartServer(Context context)
             throws InterruptedException {
+        return createAndStartServerWithPort(context, 0);
+    }
+
+    /** Create and initialize a server with the default handlers and specified port.
+     *
+     *  This handles native object initialization, server configuration, and server initialization.
+     *  On returning, the server is ready for use.
+     *
+     *  @param context The context in which the server will run.
+     *  @param port The port to use for the server, 0 to auto-select an unused port.
+     *  @return The created server.
+     */
+    public static EmbeddedTestServer createAndStartServerWithPort(Context context, int port)
+            throws InterruptedException {
         Assert.assertNotEquals("EmbeddedTestServer should not be created on UiThread, "
                 + "the instantiation will hang forever waiting for tasks to post to UI thread",
                 Looper.getMainLooper(), Looper.myLooper());
         EmbeddedTestServer server = new EmbeddedTestServer();
-        return initializeAndStartServer(server, context);
+        return initializeAndStartServer(server, context, port);
     }
 
     /** Create and initialize an HTTPS server with the default handlers.
@@ -356,12 +383,27 @@ public class EmbeddedTestServer {
      */
     public static EmbeddedTestServer createAndStartHTTPSServer(
             Context context, int serverCertificate) throws InterruptedException {
+        return createAndStartHTTPSServerWithPort(context, serverCertificate, 0 /* port */);
+    }
+
+    /** Create and initialize an HTTPS server with the default handlers and specified port.
+     *
+     *  This handles native object initialization, server configuration, and server initialization.
+     *  On returning, the server is ready for use.
+     *
+     *  @param context The context in which the server will run.
+     *  @param serverCertificate The certificate option that the server will use.
+     *  @param port The port to use for the server, 0 to auto-select an unused port.
+     *  @return The created server.
+     */
+    public static EmbeddedTestServer createAndStartHTTPSServerWithPort(
+            Context context, int serverCertificate, int port) throws InterruptedException {
         Assert.assertNotEquals("EmbeddedTestServer should not be created on UiThread, "
                         + "the instantiation will hang forever waiting for tasks"
                         + " to post to UI thread",
                 Looper.getMainLooper(), Looper.myLooper());
         EmbeddedTestServer server = new EmbeddedTestServer();
-        return initializeAndStartHTTPSServer(server, context, serverCertificate);
+        return initializeAndStartHTTPSServer(server, context, serverCertificate, port);
     }
 
     /** Initialize a server with the default handlers.
@@ -371,13 +413,14 @@ public class EmbeddedTestServer {
      *
      *  @param server The server instance that will be initialized.
      *  @param context The context in which the server will run.
+     *  @param port The port to use for the server, 0 to auto-select an unused port.
      *  @return The created server.
      */
     public static <T extends EmbeddedTestServer> T initializeAndStartServer(
-            T server, Context context) throws InterruptedException {
+            T server, Context context, int port) throws InterruptedException {
         server.initializeNative(context, ServerHTTPSSetting.USE_HTTP);
         server.addDefaultHandlers("");
-        if (!server.start()) {
+        if (!server.start(port)) {
             throw new EmbeddedTestServerFailure("Failed to start serving using default handlers.");
         }
         return server;
@@ -392,14 +435,15 @@ public class EmbeddedTestServer {
      *  @param server The server instance that will be initialized.
      *  @param context The context in which the server will run.
      *  @param serverCertificate The certificate option that the server will use.
+     *  @param port The port to use for the server.
      *  @return The created server.
      */
-    public static <T extends EmbeddedTestServer> T initializeAndStartHTTPSServer(
-            T server, Context context, int serverCertificate) throws InterruptedException {
+    public static <T extends EmbeddedTestServer> T initializeAndStartHTTPSServer(T server,
+            Context context, int serverCertificate, int port) throws InterruptedException {
         server.initializeNative(context, ServerHTTPSSetting.USE_HTTPS);
         server.addDefaultHandlers("");
         server.setSSLConfig(serverCertificate);
-        if (!server.start()) {
+        if (!server.start(port)) {
             throw new EmbeddedTestServerFailure("Failed to start serving using default handlers.");
         }
         return server;

net/test/android/javatests/src/org/chromium/net/test/EmbeddedTestServerImpl.java

@@ -98,14 +98,16 @@ public class EmbeddedTestServerImpl extends IEmbeddedTestServerImpl.Stub {
      *  Note that this should be called after handlers are set up, including any relevant calls
      *  serveFilesFromDirectory.
      *
+     *  @param port The port to use for the server, 0 to auto-select an unused port.
+     *
      *  @return Whether the server was successfully started.
      */
     @Override
-    public boolean start() {
+    public boolean start(int port) {
         return runOnHandlerThread(new Callable<Boolean>() {
             @Override
             public Boolean call() {
-                return nativeStart(mNativeEmbeddedTestServer);
+                return nativeStart(mNativeEmbeddedTestServer, port);
             }
         });
     }
@@ -314,7 +316,7 @@ public class EmbeddedTestServerImpl extends IEmbeddedTestServerImpl.Stub {
 
     private native void nativeInit(String testDataDir, boolean https);
     private native void nativeDestroy(long nativeEmbeddedTestServerAndroid);
-    private native boolean nativeStart(long nativeEmbeddedTestServerAndroid);
+    private native boolean nativeStart(long nativeEmbeddedTestServerAndroid, int port);
     private native String nativeGetRootCertPemPath(long nativeEmbeddedTestServerAndroid);
     private native boolean nativeShutdownAndWaitUntilComplete(long nativeEmbeddedTestServerAndroid);
     private native void nativeAddDefaultHandlers(

net/test/android/javatests/src/org/chromium/net/test/EmbeddedTestServerRule.java

@@ -14,13 +14,12 @@ import org.junit.runner.Description;
  * finishes.
  */
 public class EmbeddedTestServerRule extends TestWatcher {
-    EmbeddedTestServer mServer = new EmbeddedTestServer();
+    EmbeddedTestServer mServer;
 
     @Override
     protected void starting(Description description) {
         try {
-            EmbeddedTestServer.initializeAndStartServer(
-                    mServer, InstrumentationRegistry.getContext());
+            mServer = EmbeddedTestServer.createAndStartServer(InstrumentationRegistry.getContext());
         } catch (InterruptedException e) {
             throw new EmbeddedTestServer.EmbeddedTestServerFailure("Test server didn't start");
         }

net/test/android/javatests/src/org/chromium/net/test/IEmbeddedTestServerImpl.aidl

@@ -13,9 +13,10 @@ interface IEmbeddedTestServerImpl {
 
     /** Start the server.
      *
+     *  @param port The port to use for the server, 0 to auto-select an unused port.
      *  @return Whether the server was successfully started.
      */
-    boolean start();
+    boolean start(int port);
 
     /** Get the path of the server's root certificate.
      *

net/test/embedded_test_server/android/embedded_test_server_android.cc

@@ -56,8 +56,9 @@ EmbeddedTestServerAndroid::~EmbeddedTestServerAndroid() {
 }
 
 jboolean EmbeddedTestServerAndroid::Start(JNIEnv* env,
-                                          const JavaParamRef<jobject>& jobj) {
-  return test_server_.Start();
+                                          const JavaParamRef<jobject>& jobj,
+                                          jint port) {
+  return test_server_.Start(static_cast<int>(port));
 }
 
 ScopedJavaLocalRef<jstring> EmbeddedTestServerAndroid::GetRootCertPemPath(

net/test/embedded_test_server/android/embedded_test_server_android.h

@@ -28,7 +28,9 @@ class EmbeddedTestServerAndroid {
 
   void Destroy(JNIEnv* env, const base::android::JavaParamRef<jobject>& obj);
 
-  jboolean Start(JNIEnv* env, const base::android::JavaParamRef<jobject>& jobj);
+  jboolean Start(JNIEnv* env,
+                 const base::android::JavaParamRef<jobject>& jobj,
+                 jint port);
 
   base::android::ScopedJavaLocalRef<jstring> GetRootCertPemPath(
       JNIEnv* jenv,

net/test/embedded_test_server/embedded_test_server.cc

@@ -89,15 +89,15 @@ void EmbeddedTestServer::SetConnectionListener(
   connection_listener_ = listener;
 }
 
-bool EmbeddedTestServer::Start() {
-  bool success = InitializeAndListen();
+bool EmbeddedTestServer::Start(int port) {
+  bool success = InitializeAndListen(port);
   if (!success)
     return false;
   StartAcceptingConnections();
   return true;
 }
 
-bool EmbeddedTestServer::InitializeAndListen() {
+bool EmbeddedTestServer::InitializeAndListen(int port) {
   DCHECK(!Started());
 
   const int max_tries = 5;
@@ -114,7 +114,8 @@ bool EmbeddedTestServer::InitializeAndListen() {
 
     listen_socket_.reset(new TCPServerSocket(nullptr, NetLogSource()));
 
-    int result = listen_socket_->ListenWithAddressAndPort("127.0.0.1", 0, 10);
+    int result =
+        listen_socket_->ListenWithAddressAndPort("127.0.0.1", port, 10);
     if (result) {
       LOG(ERROR) << "Listen failed: " << ErrorToString(result);
       listen_socket_.reset();

net/test/embedded_test_server/embedded_test_server.h

@@ -145,11 +145,11 @@ class EmbeddedTestServer {
   // This is the equivalent of calling InitializeAndListen() followed by
   // StartAcceptingConnections().
   // Returns whether a listening socket has been successfully created.
-  bool Start() WARN_UNUSED_RESULT;
+  bool Start(int port = 0) WARN_UNUSED_RESULT;
 
   // Starts listening for incoming connections but will not yet accept them.
   // Returns whether a listening socket has been succesfully created.
-  bool InitializeAndListen() WARN_UNUSED_RESULT;
+  bool InitializeAndListen(int port = 0) WARN_UNUSED_RESULT;
 
   // Starts the Accept IO Thread and begins accepting connections.
   void StartAcceptingConnections();