Extract HTTP API tests, which are not supported by Browserless

Author: joffrey-bion

src/jvmTest/kotlin/BrowserlessLocalIntegrationTests.kt

@@ -2,20 +2,20 @@ import org.testcontainers.containers.*
 import org.testcontainers.junit.jupiter.*
 import org.testcontainers.junit.jupiter.Container
 import org.testcontainers.utility.*
-import kotlin.test.*
 
 @Testcontainers
 class BrowserlessLocalIntegrationTests : IntegrationTestBase() {
 
     /**
-     * A container running the Browserless with Chromium support.
+     * A container running Browserless with Chromium support.
      * It is meant to be used mostly with the web socket API, which is accessible directly at `ws://localhost:{port}`
      * (no need for an intermediate HTTP call).
      *
-     * It provides a bridge to the JSON HTTP API of the DevTools protocol as well, but only for a subset of the
-     * endpoints. See [Browser REST APIs](https://docs.browserless.io/open-api#tag/Browser-REST-APIs) in the docs.
-     *
-     * Also, there is [a bug](https://github.com/browserless/browserless/issues/4566) with the `/json/new` endpoint.
+     * It provides a bridge to the HTTP endpoints `/json/protocol` and `/json/version` of the DevTools protocol as well,
+     * but not for endpoints related to tab manipulation.
+     * The `/json/list` and `/json/new` endpoints are just mocked to allow some clients to get the WS URL, but they
+     * don't actually reflect the reality or affect the browser's state.
+     * See [Browser REST APIs](https://docs.browserless.io/open-api#tag/Browser-REST-APIs) in the docs.
      */
     @Container
     var browserlessChromium: GenericContainer<*> = GenericContainer("ghcr.io/browserless/chromium:latest")
@@ -27,9 +27,4 @@ class BrowserlessLocalIntegrationTests : IntegrationTestBase() {
 
     override val wsConnectUrl: String
         get() = "ws://localhost:${browserlessChromium.firstMappedPort}"
-
-    @Ignore("The /json/new endpoint doesn't work with the HTTP API of Browserless: " +
-                "https://github.com/browserless/browserless/issues/4566")
-    override fun httpTabEndpoints() {
-    }
 }

src/jvmTest/kotlin/IntegrationTestBase.kt

@@ -65,22 +65,6 @@ abstract class IntegrationTestBase {
         }
     }
 
-    @Test
-    open fun httpTabEndpoints() {
-        runBlockingWithTimeout {
-            val chrome = chromeHttp()
-
-            @Suppress("DEPRECATION") // the point is to test this deprecated API
-            val googleTab = chrome.newTab(url = "https://www.google.com")
-            assertEquals("https://www.google.com", googleTab.url.trimEnd('/'))
-
-            val targets = chrome.targets()
-            assertTrue(targets.any { it.url.trimEnd('/') == "https://www.google.com" }, "the google.com page target should be listed, got: $targets")
-
-            chrome.closeTab(googleTab.id)
-        }
-    }
-
     @OptIn(ExperimentalChromeApi::class)
     @Test
     fun webSocket_basic() {

src/jvmTest/kotlin/ZenikaIntegrationTests.kt

@@ -1,8 +1,12 @@
+import org.hildan.chrome.devtools.protocol.ChromeDPTarget
+import org.junit.jupiter.api.Test
 import org.testcontainers.containers.*
 import org.testcontainers.junit.jupiter.*
 import org.testcontainers.junit.jupiter.Container
 import org.testcontainers.utility.*
 import kotlin.test.Ignore
+import kotlin.test.assertEquals
+import kotlin.test.assertTrue
 
 @Testcontainers
 class ZenikaIntegrationTests : LocalIntegrationTestBase() {
@@ -22,10 +26,65 @@ class ZenikaIntegrationTests : LocalIntegrationTestBase() {
     override val httpUrl: String
         get() = "http://localhost:${zenikaChrome.firstMappedPort}"
 
+    // the WS URL is not known in advance and needs to be queried first via the HTTP API, hence the HTTP URL here
     override val wsConnectUrl: String
         get() = "http://localhost:${zenikaChrome.firstMappedPort}"
 
     @Ignore("The Zenika container seems out of data and still treats cookiePartitionKey as a string instead of object")
     override fun missingExpiresInCookie() {
     }
+
+    @Suppress("DEPRECATION") // the point is to test this deprecated API
+    @Test
+    fun httpTabEndpoints_basic() {
+        runBlockingWithTimeout {
+            val chrome = chromeHttp()
+            val originalTabCount = chrome.targets().size
+
+            val newTab = chrome.newTab()
+            assertEquals("about:blank", newTab.url.trimEnd('/'))
+            assertTargetCount(originalTabCount + 1, chrome.targets())
+            chrome.closeTab(newTab.id)
+
+            assertTargetCount(originalTabCount, chrome.targets())
+            chrome.newTab()
+            chrome.newTab()
+            chrome.closeAllTargets()
+            assertTargetCount(0, chrome.targets())
+        }
+    }
+
+    @Suppress("DEPRECATION") // the point is to test this deprecated API
+    @Test
+    fun httpTabEndpoints_newTabWithCustomUrl() {
+        runBlockingWithTimeout {
+            val chrome = chromeHttp()
+
+            val googleTab = chrome.newTab(url = "https://www.google.com")
+            assertEquals("https://www.google.com", googleTab.url.trimEnd('/'))
+
+            val targets = chrome.targets()
+            assertTrue(
+                actual = targets.any { it.url.trimEnd('/') == "https://www.google.com" },
+                message = "the google.com page target should be listed, got:\n${targets.joinToString("\n")}",
+            )
+
+            chrome.closeTab(googleTab.id)
+
+            val targetsAfterClose = chrome.targets()
+            assertTrue(
+                actual = targetsAfterClose.none { it.url.trimEnd('/') == "https://www.google.com" },
+                message = "the google.com page target should be closed, got:\n${targetsAfterClose.joinToString("\n")}",
+            )
+        }
+    }
+
+    private fun assertTargetCount(expected: Int, currentTargets: List<ChromeDPTarget>) {
+        assertEquals(
+            expected = expected,
+            actual = currentTargets.size,
+            message = "Expected $expected tab(s) but got ${currentTargets.size} instead:\n" +
+                currentTargets.joinToString("\n"),
+        )
+    }
 }