Add some error reporting for usability (#369)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Jim Borden <jim.borden@couchbase.com>

Author: 3 people

client/src/cbltest/api/couchbaseserver.py

@@ -23,13 +23,14 @@
     BucketAlreadyExistsException,
     BucketDoesNotExistException,
     CollectionAlreadyExistsException,
+    CouchbaseException,
     DocumentNotFoundException,
     QueryIndexAlreadyExistsException,
     ScopeAlreadyExistsException,
 )
 from couchbase.management.buckets import CreateBucketSettings
 from couchbase.management.options import CreatePrimaryQueryIndexOptions
-from couchbase.options import ClusterOptions
+from couchbase.options import ClusterOptions, ClusterTimeoutOptions
 from couchbase.subdocument import upsert
 from opentelemetry.trace import get_tracer
 
@@ -113,10 +114,22 @@ def __init__(self, url: str, username: str, password: str):
             self._parse_connection_url(url)
 
             auth = PasswordAuthenticator(username, password)
-            opts = ClusterOptions(auth)
+            opts = ClusterOptions(
+                auth,
+                timeout_options=ClusterTimeoutOptions(
+                    # mac dns resolution can be very slow, default timeout is 250ms
+                    dns_srv_timeout=timedelta(seconds=10)
+                ),
+            )
             self.__username = username
             self.__password = password
-            self.__cluster = Cluster(url, opts)
+            try:
+                self.__cluster = Cluster(url, opts)
+            except CouchbaseException as e:
+                cbl_warning(
+                    f"Initial connection to Couchbase Server {url} with {username=} password=<redacted> failed with: {e}"
+                )
+                raise
             self.__cluster.wait_until_ready(timedelta(seconds=10))
 
             # Create a reusable HTTP session for REST API calls

client/src/cbltest/utils.py

@@ -1,3 +1,5 @@
+import json
+import subprocess
 import time
 from collections.abc import Callable
 from typing import Any, TypeVar, cast
@@ -37,3 +39,32 @@ def _try_n_times(
 def assert_not_null(input: T | None, msg: str) -> T:
     assert input is not None, msg
     return cast(T, input)
+
+
+def verify_lfs_checkout() -> None:
+    """
+    This function is used to verify that the LFS files are being properly checked out.
+    """
+    try:
+        process_output = subprocess.run(
+            ["git", "lfs", "ls-files", "--json"],
+            check=True,
+            capture_output=True,
+            text=True,
+        )
+    except subprocess.CalledProcessError as e:
+        raise RuntimeError(
+            f"Failed to run {e.cmd!r} (return code {e.returncode}). "
+            f"stdout: {e.stdout!r} stderr: {e.stderr!r}"
+        ) from e
+    try:
+        lfs = json.loads(process_output.stdout)
+    except json.JSONDecodeError as e:
+        raise RuntimeError(f"Failed to parse git lfs output: {e}.") from e
+    if not lfs["files"]:
+        return
+    for f in lfs["files"]:
+        if f["checkout"] is False:
+            raise RuntimeError(
+                "git lfs is not configured. Please run 'git lfs install' and then 'git lfs pull'."
+            )

tests/QE/conftest.py

@@ -6,12 +6,14 @@
 import pytest_asyncio
 from cbltest.api.couchbaseserver import CouchbaseServer
 from cbltest.api.syncgateway import SyncGateway
+from cbltest.utils import verify_lfs_checkout
 
 
 # This is used to inject the full path to the dataset folder
 # into tests that need it.
 @pytest.fixture(scope="session")
 def dataset_path() -> Path:
+    verify_lfs_checkout()
     script_path = os.path.abspath(os.path.dirname(__file__))
     return Path(script_path, "..", "..", "dataset", "sg")
 

tests/dev_e2e/conftest.py

@@ -2,11 +2,13 @@
 from pathlib import Path
 
 import pytest
+from cbltest.utils import verify_lfs_checkout
 
 
 # This is used to inject the full path to the dataset folder
 # into tests that need it.
 @pytest.fixture(scope="session")
 def dataset_path() -> Path:
+    verify_lfs_checkout()
     script_path = os.path.abspath(os.path.dirname(__file__))
     return Path(script_path, "..", "..", "dataset", "sg")