Support building/running copies of Sync Gateway (#385)

Author: torcolvin

environment/aws/topology_setup/test_server_platforms/exe_bridge.py

@@ -58,17 +58,25 @@ class ExeBridge(PlatformBridge):
     A class to manage executable applications on local or remote machines.
     """
 
-    def __init__(self, exe_path: str, extra_args: list[str] | None = None):
+    def __init__(
+        self,
+        exe_path: str,
+        extra_args: list[str] | None = None,
+        *,
+        log_filename: str = "server.log",
+    ):
         """
         Initialize the ExeBridge with the executable path and optional extra arguments.
 
         Args:
             exe_path (str): The path to the executable file.
             extra_args (Optional[List[str]]): A list of extra arguments to pass to the executable.
+            log_filename (str): The filename for the log output (default "server.log").
         """
         self.__exe_path = exe_path
         self.__extra_args = extra_args or []
         self.__exe_name = Path(self.__exe_path).name
+        self.__log_filename = log_filename
 
     def validate(self, location: str) -> None:
         """
@@ -104,7 +112,7 @@ def run(self, location: str) -> None:
 
         args = [self.__exe_path]
         args.extend(self.__extra_args)
-        log_file = Path(self.__exe_path).parent / "server.log"
+        log_file = Path(self.__exe_path).parent / self.__log_filename
         log_fd = open(log_file, "w")
         process = subprocess.Popen(
             args, start_new_session=True, stdout=log_fd, stderr=log_fd

environment/local/.gitignore

@@ -0,0 +1,7 @@
+# Build artifacts for windows
+*.exe
+
+# Sync Gateway local builds
+sync_gateway
+sync_gateway_clone/
+*.log

environment/local/README.md

@@ -0,0 +1,57 @@
+# Local Environment Setup
+
+This directory contains scripts to help set up and run a local testing environment.
+
+## Building Sync Gateway
+
+Use `build_sync_gateway.py` to compile Sync Gateway from source. This requires `go` to be installed on your system.
+
+```bash
+# Build from an existing local repository
+uv run environment/local/build_sync_gateway.py --repo-path /path/to/sync-gateway
+
+# Build from a specific git tag/branch (clones to environment/local/sync_gateway_clone)
+uv run environment/local/build_sync_gateway.py --git-tag release/3.3.0
+```
+
+## Running Sync Gateway
+
+Once built, you can manage the Sync Gateway process using `run_sync_gateway.py`. You must provide either `--start` (with a `--server` type) or `--stop`.
+
+```bash
+# Start Sync Gateway in the background using Rosmar
+uv run environment/local/run_sync_gateway.py --start --server rosmar
+
+# Start Sync Gateway in the background using CBS
+uv run environment/local/run_sync_gateway.py --start --server cbs
+
+# Stop the background Sync Gateway process
+uv run environment/local/run_sync_gateway.py --stop
+```
+
+- **Logs:** Written to `environment/local/sync_gateway.log`.
+- **Configuration:** 
+  - `--server rosmar`: uses `environment/local/sync_gateway_config/basic_sync_gateway_rosmar.json`
+  - `--server cbs`: uses `environment/local/sync_gateway_config/basic_sync_gateway_cbs.json`
+
+## Running the Test Server
+
+To start the local test server (CBL-C):
+
+```bash
+uv run environment/local/start_local.py
+```
+
+## Running Tests
+
+After starting the environment, you can run tests against it:
+
+```bash
+cd tests/dev_e2e
+
+# If using Couchbase Server (cbs)
+uv run pytest --config ../../environment/local/cbs_config.json
+
+# If using Rosmar
+uv run pytest --config ../../environment/local/rosmar_config.json
+```

environment/local/build_sync_gateway.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+import os
+import subprocess
+import sys
+
+import click
+
+
+@click.command()
+@click.option("--repo-path", help="Path to an existing sync_gateway repo")
+@click.option("--git-tag", help="Build tag (will clone/reset a local repo to this tag)")
+def main(repo_path, git_tag):
+    """Build Sync Gateway"""
+    if bool(repo_path) == bool(git_tag):
+        raise click.UsageError(
+            "Exactly one of --repo-path or --git-tag must be provided."
+        )
+
+    env_local_dir = os.path.dirname(os.path.abspath(__file__))
+    output_bin = os.path.join(env_local_dir, "sync_gateway")
+
+    if repo_path:
+        repo_dir = os.path.abspath(repo_path)
+        if not os.path.isdir(repo_dir):
+            click.secho(f"Error: Repository path {repo_dir} does not exist.", fg="red")
+            sys.exit(1)
+    else:
+        # We use a local clone
+        repo_dir = os.path.join(env_local_dir, "sync_gateway_clone")
+        repo_url = "https://github.com/couchbase/sync_gateway.git"
+
+        if not os.path.exists(repo_dir):
+            click.echo(f"Cloning {repo_url} into {repo_dir}...")
+            subprocess.check_call(["git", "clone", repo_url, repo_dir])
+
+        click.echo(f"Fetching updates and checking out {git_tag}...")
+        subprocess.check_call(["git", "fetch", "--all", "--tags"], cwd=repo_dir)
+        subprocess.check_call(["git", "reset", "--hard"], cwd=repo_dir)
+        subprocess.check_call(["git", "checkout", git_tag], cwd=repo_dir)
+
+    click.echo(f"Building sync_gateway in {repo_dir}...")
+    build_cmd = ["go", "build", "-tags", "cb_sg_enterprise", "-o", output_bin, "."]
+
+    try:
+        subprocess.check_call(build_cmd, cwd=repo_dir)
+        click.secho(f"Successfully built sync_gateway to {output_bin}", fg="green")
+    except subprocess.CalledProcessError as e:
+        click.secho(f"Error building sync_gateway: {e}", fg="red")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

environment/local/config.json environment/local/cbs_config.jsonenvironment/local/config.json renamed to environment/local/cbs_config.json

@@ -0,0 +1,56 @@
+#!/usr/bin/env python3
+import pathlib
+import sys
+
+import click
+
+SCRIPT_DIR = pathlib.Path(__file__).parent.resolve()
+if __name__ == "__main__":
+    sys.path.append(str(SCRIPT_DIR.parent.parent))
+
+from environment.aws.topology_setup.test_server_platforms.exe_bridge import ExeBridge
+
+
+@click.command()
+@click.option("--start", is_flag=True, help="Start the sync_gateway instance.")
+@click.option("--stop", is_flag=True, help="Stop the running sync_gateway instance.")
+@click.option(
+    "--server",
+    type=click.Choice(["rosmar", "cbs"]),
+    help="The server type to use (required for --start).",
+)
+def main(start, stop, server):
+    """Manage local Sync Gateway process."""
+    if start == stop:
+        raise click.UsageError("Exactly one of --start or --stop must be provided.")
+
+    if start and not server:
+        raise click.UsageError("--server is required when using --start.")
+
+    exe_path = str(SCRIPT_DIR / "sync_gateway")
+
+    # We only need config if starting
+    config_path = None
+    if start:
+        config_dir = SCRIPT_DIR / "sync_gateway_config"
+        config_file = (
+            "basic_sync_gateway_rosmar.json"
+            if server == "rosmar"
+            else "basic_sync_gateway_cbs.json"
+        )
+        config_path = str(config_dir / config_file)
+
+    bridge = ExeBridge(
+        exe_path=exe_path,
+        extra_args=[config_path] if config_path else [],
+        log_filename="sync_gateway.log",
+    )
+
+    if stop:
+        bridge.stop("localhost")
+    else:
+        bridge.run("localhost")
+
+
+if __name__ == "__main__":
+    main()

environment/local/run_sync_gateway.py

@@ -0,0 +1,16 @@
+{
+  "bootstrap": {
+    "server": "couchbase://localhost",
+    "server_tls_skip_verify": true,
+    "use_tls_server": false,
+    "username": "Administrator",
+    "password": "password"
+  },
+  "logging": {
+    "console": {
+      "enabled": true,
+      "log_level": "info",
+      "log_keys": ["*"]
+    }
+  }
+}