API spec 1.1.1 and .NET implementation (#175)

This removes embedded blobs and dbs into the test server at build time and instead downloads them from GitHub

Author: borrrden

client/smoke_tests/test_new_session.py

@@ -31,5 +31,5 @@ async def test_logslurp(self, cblpytest: CBLPyTest) -> None:
     async def test_duplicate_new_session(self, cblpytest: CBLPyTest) -> None:
         with pytest.raises(CblTestServerBadResponseError, match="returned 400"):
             await cblpytest.test_servers[0].new_session(
-                str(cblpytest.request_factory.uuid), None, None
+                str(cblpytest.request_factory.uuid), "3.2", None, None
             )

client/src/cbltest/__init__.py

@@ -10,6 +10,7 @@
     CouchbaseServerInfo,
     ParsedConfig,
     SyncGatewayInfo,
+    TestServerInfo,
     _parse_config,
 )
 from .extrapropsparser import _parse_extra_props
@@ -80,6 +81,7 @@ async def create(
         for ts in ret_val.test_servers:
             await ts.new_session(
                 str(ret_val.request_factory.uuid),
+                ret_val.config.dataset_version_at(ts_index),
                 ret_val.config.logslurp_url,
                 f"test-server[{ts_index}]",
             )
@@ -105,8 +107,11 @@ def __init__(
         self.__request_factory = RequestFactory(self.__config)
         self.__test_servers: List[TestServer] = []
         index = 0
-        for url in self.__config.test_servers:
-            self.__test_servers.append(TestServer(self.__request_factory, index, url))
+        for ts in self.__config.test_servers:
+            ts_info = TestServerInfo(ts)
+            self.__test_servers.append(
+                TestServer(self.__request_factory, index, ts_info.url)
+            )
             index += 1
 
         self.__sync_gateways: List[SyncGateway] = []

client/src/cbltest/api/testserver.py

@@ -79,7 +79,9 @@ async def create_and_reset_db(
 
             return ret_val
 
-    async def new_session(self, id: str, url: Optional[str], tag: Optional[str]):
+    async def new_session(
+        self, id: str, dataset_version: str, url: Optional[str], tag: Optional[str]
+    ):
         """
         Instructs this test server to log to the given LogSlurp instance
 
@@ -88,7 +90,7 @@ async def new_session(self, id: str, url: Optional[str], tag: Optional[str]):
         :param tag: The tag to use for this test server
         """
         with self.__tracer.start_as_current_span("new_session"):
-            payload = PostNewSessionRequestBody(id, url, tag)
+            payload = PostNewSessionRequestBody(id, dataset_version, url, tag)
             request = self.__request_factory.create_request(
                 TestServerRequestType.NEW_SESSION, payload
             )

client/src/cbltest/configparser.py

@@ -12,6 +12,29 @@
 )
 
 
+class TestServerInfo:
+    """The parsed Test Server information from the config file"""
+
+    ___url_key: Final[str] = "url"
+    __dataset_version_key: Final[str] = "dataset_version"
+
+    @property
+    def url(self) -> str:
+        """Gets the URL of the test server instance"""
+        return self.__url
+
+    @property
+    def dataset_version(self) -> str:
+        """Gets the dataset version of the test server instance"""
+        return self.__dataset_version
+
+    def __init__(self, data: dict):
+        self.__url: str = _assert_string_entry(data, self.___url_key)
+        self.__dataset_version: str = _assert_string_entry(
+            data, self.__dataset_version_key
+        )
+
+
 class SyncGatewayInfo:
     """The parsed Sync Gateway information from the config file"""
 
@@ -105,9 +128,10 @@ class ParsedConfig:
     __greenboard_key: Final[str] = "greenboard"
     __api_version_key: Final[str] = "api-version"
     __logslurp_key: Final[str] = "logslurp"
+    __dataset_version_key: Final[str] = "dataset_version"
 
     @property
-    def test_servers(self) -> List[str]:
+    def test_servers(self) -> List[dict]:
         """The list of test servers that can be interacted with"""
         return self.__test_servers
 
@@ -160,9 +184,13 @@ def logslurp_url(self) -> Optional[str]:
         """The URL of the optional logslurp server to send and collect logs"""
         return self.__logslurp_url
 
+    def dataset_version_at(self, i: int) -> str:
+        """The dataset version of the test server instance"""
+        return self.__test_servers[i][self.__dataset_version_key]
+
     def __init__(self, json: dict):
         self.__test_servers = _get_typed_nonnull(
-            json, self.__test_server_key, List[str], []
+            json, self.__test_server_key, List[Dict], []
         )
         self.__sync_gateways = _get_typed_nonnull(json, self.__sgw_key, List[Dict], [])
         self.__couchbase_servers = _get_typed_nonnull(

client/src/cbltest/requests.py

@@ -5,7 +5,7 @@
 from importlib import import_module
 from pathlib import Path
 from shutil import rmtree
-from typing import Any, Optional, Type, cast
+from typing import Any, List, Optional, Type, cast
 from urllib.parse import urljoin
 from uuid import UUID, uuid4
 
@@ -238,7 +238,9 @@ def __init__(self, config: ParsedConfig):
         self.__uuid = uuid4()
         self.__session = ClientSession()
         self.__version = available_api_version(config.api_version)
-        self.__server_urls = config.test_servers
+        self.__server_urls = cast(
+            List[str], list(str(ts["url"]) for ts in config.test_servers)
+        )
         cbl_info(
             f"RequestFactory created with API version {self.__version} ({self.__uuid})"
         )

client/src/cbltest/v1/requests.py

@@ -568,14 +568,20 @@ def tag(self) -> Optional[str]:
         """Returns the tag to use to print in log statements from this particular remote"""
         return self.__tag
 
-    def __init__(self, id: str, url: Optional[str], tag: Optional[str]):
+    def __init__(
+        self, id: str, dataset_version: str, url: Optional[str], tag: Optional[str]
+    ):
         super().__init__(1)
         self.__url = url
+        self.__dataset_version = dataset_version
         self.__id = id
         self.__tag = tag
 
     def to_json(self) -> Any:
-        json: Dict[str, Any] = {"id": self.__id}
+        json: Dict[str, Any] = {
+            "id": self.__id,
+            "dataset_version": self.__dataset_version,
+        }
         if self.__url is not None and self.__tag is not None:
             json["logging"] = {"url": self.__url, "tag": self.__tag}
 

client/src/cbltest/version.py

@@ -1,7 +1,7 @@
 from typing import Final
 
 # For hatchling to easily detect the version
-__version__ = "1.1.0"
+__version__ = "1.1.1"
 
 # Typed version for outside use
 VERSION: Final[str] = __version__

environment/aws/start_backend.py

@@ -180,7 +180,12 @@ def write_config(
             test_servers = []
             for ts in topology.test_servers:
                 port = 5555 if ts.platform.startswith("dotnet") else 8080
-                test_servers.append(f"http://{ts.ip_address}:{port}")
+                test_servers.append(
+                    {
+                        "url": f"http://{ts.ip_address}:{port}",
+                        "dataset_version": ts.dataset_version,
+                    }
+                )
 
             config_json["test-servers"] = test_servers
 

environment/aws/topology_setup/setup_topology.py

@@ -372,13 +372,20 @@ def ip_address(self) -> str:
     def cbl_version(self) -> str:
         return self.__cbl_version
 
+    @property
+    def dataset_version(self) -> str:
+        return self.__dataset_version
+
     @property
     def platform(self) -> str:
         return self.__platform
 
-    def __init__(self, ip_address: str, cbl_version: str, platform: str):
+    def __init__(
+        self, ip_address: str, cbl_version: str, dataset_version: str, platform: str
+    ):
         self.__ip_address = ip_address
         self.__cbl_version = cbl_version
+        self.__dataset_version = dataset_version
         self.__platform = platform
 
 
@@ -648,6 +655,7 @@ def resolve_test_servers(self):
                 TestServerConfig(
                     bridge.get_ip(test_server_input.location),
                     test_server_input.cbl_version,
+                    test_server_input.dataset_version,
                     test_server_input.platform,
                 )
             )
@@ -807,6 +815,7 @@ def dump(self):
             click.echo(f"Test Server {i}:")
             click.echo(f"\tPlatform: {test_server.platform}")
             click.echo(f"\tCBL Version: {test_server.cbl_version}")
+            click.echo(f"\tDataset Version: {test_server.dataset_version}")
             click.echo(f"\tIP Address: {test_server.ip_address}")
             i += 1
 

environment/aws/topology_setup/test_server_platforms/dotnet_register.py

@@ -41,11 +41,7 @@
 
 from environment.aws.common.io import unzip_directory, zip_directory
 from environment.aws.common.output import header
-from environment.aws.topology_setup.test_server import (
-    TEST_SERVER_DIR,
-    TestServer,
-    copy_dataset,
-)
+from environment.aws.topology_setup.test_server import TEST_SERVER_DIR, TestServer
 
 from .android_bridge import AndroidBridge
 from .exe_bridge import ExeBridge
@@ -73,12 +69,6 @@ class DotnetTestServer(TestServer):
     def __init__(self, version: str, dataset_version: str):
         super().__init__(version, dataset_version)
 
-    def _copy_dataset(self) -> None:
-        copy_dataset(
-            DOTNET_TEST_SERVER_DIR / "testserver" / "Resources" / "Raw",
-            self.dataset_version,
-        )
-
     @property
     @abstractmethod
     def dotnet_framework(self) -> str:
@@ -115,7 +105,6 @@ def build(self) -> None:
         """
         Build the .NET test server.
         """
-        self._copy_dataset()
         version_parts = self.version.split("-")
         build = version_parts[1]
         cbl_version = f"{version_parts[0]}-b{build.zfill(4)}"
@@ -179,19 +168,10 @@ def rid(self) -> str:
         """
         pass
 
-    def _copy_dataset(self) -> None:
-        dest_dir = DOTNET_TEST_SERVER_DIR / "testserver.cli" / "Resources"
-        dest_dir.mkdir(0o755, exist_ok=True)
-        copy_dataset(
-            dest_dir,
-            self.dataset_version,
-        )
-
     def build(self) -> None:
         """
         Build the .NET CLI test server.
         """
-        self._copy_dataset()
         version_parts = self.version.split("-")
         build = version_parts[1]
         cbl_version = f"{version_parts[0]}-b{build.zfill(4)}"
@@ -293,7 +273,7 @@ def latestbuilds_path(self) -> str:
             str: The path for the latest builds.
         """
         version_parts = self.version.split("-")
-        return f"couchbase-lite-net/{version_parts[0]}/{version_parts[1]}/testserver_ios_{self.dataset_version}.zip"
+        return f"couchbase-lite-net/{version_parts[0]}/{version_parts[1]}/testserver_ios.zip"
 
     def create_bridge(self) -> PlatformBridge:
         """
@@ -400,7 +380,7 @@ def latestbuilds_path(self) -> str:
             str: The path for the latest builds.
         """
         version_parts = self.version.split("-")
-        return f"couchbase-lite-net/{version_parts[0]}/{version_parts[1]}/testserver_android_{self.dataset_version}.apk"
+        return f"couchbase-lite-net/{version_parts[0]}/{version_parts[1]}/testserver_android.apk"
 
     def create_bridge(self) -> PlatformBridge:
         """
@@ -414,7 +394,7 @@ def create_bridge(self) -> PlatformBridge:
             / "downloaded"
             / self.platform
             / self.version
-            / f"testserver_android_{self.dataset_version}.apk"
+            / "testserver_android.apk"
             if self._downloaded
             else DOTNET_TEST_SERVER_DIR
             / "testserver"
@@ -444,9 +424,7 @@ def compress_package(self) -> str:
             / "net8.0-android"
             / "com.couchbase.dotnet.testserver-Signed.apk"
         )
-        zip_path = (
-            apk_path.parents[5] / f"testserver_android_{self.dataset_version}.apk"
-        )
+        zip_path = apk_path.parents[5] / "testserver_android.apk"
         shutil.copy(apk_path, zip_path)
         return str(zip_path)
 
@@ -503,7 +481,7 @@ def latestbuilds_path(self) -> str:
             str: The path for the latest builds.
         """
         version_parts = self.version.split("-")
-        return f"couchbase-lite-net/{version_parts[0]}/{version_parts[1]}/testserver_windows_{self.dataset_version}.zip"
+        return f"couchbase-lite-net/{version_parts[0]}/{version_parts[1]}/testserver_windows.zip"
 
     def create_bridge(self) -> PlatformBridge:
         """
@@ -611,7 +589,7 @@ def latestbuilds_path(self) -> str:
             str: The path for the latest builds.
         """
         version_parts = self.version.split("-")
-        return f"couchbase-lite-net/{version_parts[0]}/{version_parts[1]}/testserver_macos_{self.dataset_version}.zip"
+        return f"couchbase-lite-net/{version_parts[0]}/{version_parts[1]}/testserver_macos.zip"
 
     def create_bridge(self) -> PlatformBridge:
         """