Extend Jenkins pipeline to run CBL on all supported platforms #343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

sanjivanipatrax wants to merge 80 commits into main from qe-jenkins

client/src/cbltest/plugins/greenboard_fixture.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     import pytest_asyncio
     from cbltest import CBLPyTest
     from cbltest.greenboarduploader import GreenboardUploader
-    from cbltest.logging import cbl_info
+    from cbltest.logging import cbl_info, cbl_warning
     # This plugin provides an automatic (i.e. not used directly by tests)
     # fixture that will upload test results to greenboard, if it is
@@ Expand Down Expand Up @@
         # is 'session' it basically means "before and after the run"
         yield
-        test_server_info = await cblpytest.test_servers[0].get_info()
-        sgw_version: str = "n/a"
-        if len(cblpytest.sync_gateways) > 0:
-            sgw_version_parts = await cblpytest.sync_gateways[0].get_version()
-            sgw_version = f"{sgw_version_parts.version}-{sgw_version_parts.build_number}"
-        os_name = (
-            test_server_info.device["systemName"]
-            if "systemName" in test_server_info.device
-            else ""
-        )
-        uploader.upload(
-            test_server_info.cbl, os_name, test_server_info.library_version, sgw_version
-        )
-        pytestconfig.pluginmanager.unregister(uploader)
+        try:
+            test_server_info = await cblpytest.test_servers[0].get_info()
+            sgw_version: str = "n/a"
+            if len(cblpytest.sync_gateways) > 0:
+                sgw_version_parts = await cblpytest.sync_gateways[0].get_version()
+                sgw_version = f"{sgw_version_parts.version}-{sgw_version_parts.build_number}"
+            os_name = (
+                test_server_info.device["systemName"] if "systemName" in test_server_info.device else ""
+            )
+            uploader.upload(
+                test_server_info.cbl, os_name, test_server_info.library_version, sgw_version
+            )
+        except Exception as e:
+            cbl_warning(f"Failed to upload results to Greenboard: {e}")
+        finally:
+            pytestconfig.pluginmanager.unregister(uploader)
     # This adds the --no-result-upload option to the pytest command line.
@@ Expand Down @@

environment/aws/topology_setup/test_server_platforms/c_register.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -59,6 +59,8 @@ @@
     LIB_DIR = C_TEST_SERVER_DIR / "lib"
     IOS_FRAMEWORKS_DIR = C_TEST_SERVER_DIR / "platforms" / "ios" / "Frameworks"
     IOS_VENDOR_DIR = C_TEST_SERVER_DIR / "platforms" / "ios" / "vendor"
+    ASSETS_DIR = C_TEST_SERVER_DIR / "assets"
+    DATASET_DIR = TEST_SERVER_DIR.parent / "dataset" / "server"
     class CTestServer(TestServer):
@@ Expand All / @@ -80,6 +82,23 @@ def cbl_filename(self, version: str) -> str: @@
         def product(self) -> str:
             return "couchbase-lite-c"
+        def _setup_assets(self):
+            """
+            Set up symlinks to the dataset assets required by iOS and Android builds.
+            """
+            header("Setting up dataset assets")
+            ASSETS_DIR.mkdir(0o755, exist_ok=True)
+            blobs_link = ASSETS_DIR / "blobs"
+            if blobs_link.is_symlink() or blobs_link.exists():
+                blobs_link.unlink()
+            blobs_link.symlink_to(DATASET_DIR / "blobs")
+            dbs_link = ASSETS_DIR / "dbs"
+            if dbs_link.is_symlink() or dbs_link.exists():
+                dbs_link.unlink()
+            dbs_link.symlink_to(DATASET_DIR / "dbs")
     class CTestServer_Desktop(CTestServer):
         def _download_cbl(self) -> None:
@@ Expand Down Expand Up / @@ -226,6 +245,7 @@ def _download_cbl(self): @@
         def build(self):
             self._download_cbl()
+            self._setup_assets()
             header("Building")
             env = os.environ.copy()
             env["LANG"] = "en_US.UTF-8"
@@ Expand Down Expand Up / @@ -383,6 +403,7 @@ def build(self) -> None: @@
             Build the C test server.
             """
             self._download_cbl()
+            self._setup_assets()
             gradle_path = C_TEST_SERVER_DIR / "platforms" / "android" / "gradlew"
             if platform.system() == "Windows":
                 gradle_path = gradle_path.with_suffix(".bat")
@@ Expand Down @@

environment/aws/topology_setup/test_server_platforms/dotnet_register.py

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -627,7 +627,7 @@ def create_bridge(self, **kwargs) -> PlatformBridge:
  
                / "bin"

                / "Release"

                / "net9.0-maccatalyst"

                / "maccatalyst-x64"

                / "maccatalyst-arm64"

            )

            return macOSBridge(str(prefix / "testserver.app"))

    @@ -645,7 +645,7 @@ def compress_package(self) -> str:
  
                / "bin"

                / "Release"

                / "net9.0-maccatalyst"

                / "maccatalyst-x64"

                / "maccatalyst-arm64"

                / "testserver.app"

            )

            zip_path = publish_dir.parents[5] / "testserver_macos.zip"

environment/aws/topology_setup/test_server_platforms/ios_bridge.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -414,10 +414,7 @@ def _get_ip(self, location: str) -> str | None: @@
                 location (str): The device location (e.g., device UUID).
             Returns:
-                str: The IP address of the device.
-            Raises:
-                RuntimeError: If the IP address cannot be determined.
+                str | None: The IP address of the device, or None if it cannot be determined.
             """
             # Apple provides no sane way to do this so the following dance is performed:
             #    1. Retrieve MAC address of device (this requires the default "Private Wifi Address" to be turned off on device)
@@ Expand All / @@ -427,10 +424,17 @@ def _get_ip(self, location: str) -> str | None: @@
             self.__verify_libimobiledevice()
             result = subprocess.run(
                 ["ideviceinfo", "-u", location, "-k", "WiFiAddress"],
-                check=True,
+                check=False,
                 capture_output=True,
                 text=True,
             )
+            if result.returncode != 0:
+                click.secho(
+                    f"Failed to retrieve WiFi address for device {location}: {result.stderr.strip()}",
+                    fg="yellow",
+                )
+                return None
             mac_address = result.stdout.strip()
             stripped_mac_parts = [
                 part.lstrip("0") or "0" for part in mac_address.split(":")
@@ Expand Down @@

environment/aws/topology_setup/test_server_platforms/java_register.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -134,7 +134,7 @@ def run(self, location: str) -> None: @@
             if platform.system() != "Windows":
                 args.insert(0, "nohup")
-            info_dir = JAK_TEST_SERVER_DIR / "desktop"
+            info_dir = Path(self.__jar_path).parent
             log_file = open(info_dir / "server.log", "w")
             process = subprocess.Popen(
                 args,
@@ Expand All / @@ -152,9 +152,19 @@ def stop(self, location): @@
             if location != "localhost":
                 raise ValueError("JarBridge only supports running on localhost")
-            with open(JAK_TEST_SERVER_DIR / "desktop" / "server.pid") as pid_file:
+            info_dir = Path(self.__jar_path).parent
+            pid_file_path = info_dir / "server.pid"
+            if not pid_file_path.exists():
+                click.secho("No PID file found, server may not be running", fg="yellow")
+                return
+            with open(pid_file_path) as pid_file:
                 pid = int(pid_file.read())
-                psutil.Process(pid).kill()
+                try:
+                    psutil.Process(pid).kill()
+                    click.secho(f"Stopped PID {pid}", fg="green")
+                except psutil.NoSuchProcess:
+                    click.secho(f"Process {pid} not found, may have already exited", fg="yellow")
     class JettyBridge(JavaBridge):
@@ Expand Down @@

jenkins/pipelines/QE/android/Jenkinsfile

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,16 +1,18 @@
  
    pipeline {

        agent none

        parameters {

            string(name: 'CBL_VERSION', defaultValue: '', description: 'Couchbase Lite Version')

            string(name: 'SGW_VERSION', defaultValue: '', description: "The version of Sync Gateway to download")

            string(name: 'CBL_VERSION', defaultValue: '3.3.0', description: 'Couchbase Lite Version (build number will be fetched if not provided)')

            string(name: 'SGW_VERSION', defaultValue: '3.3.0', description: "The version of Sync Gateway to download")

            string(name: 'TS_DATASET_VERSION', defaultValue: '4.0', description: 'The version of the dataset to use on the test servers')

        }

        stages {

            stage('Init') {

                steps {

                    script {

                        if (params.CBL_VERSION == '') { error "CBL_VERSION is required" }

                        if (params.SGW_VERSION == '') { error "SGW_VERSION is required" }

                        currentBuild.displayName = "android ${params.CBL_VERSION} (#${currentBuild.number})"

                        currentBuild.displayName = "Android CBL:${params.CBL_VERSION} (#${currentBuild.number})"

                        currentBuild.description = "SGW: ${params.SGW_VERSION}"

                    }

                }

            }

    @@ -26,38 +28,39 @@ pipeline {
  
                }

            }

            stage('Android') {

                agent { label 'mac-laptop1-new' }

                agent { label 'mac-mini-CBL-Android1' }

                options {

                    lock('mac-mini-CBL-Android1')

                }

                environment {

                    KEYCHAIN_PASSWORD = credentials('mobile-qe-keychain')

                    KEYCHAIN_PASSWORD = credentials('mobile-qe')

                    ANDROID_HOME = "/Users/couchbase/Library/Android/sdk"

                    PATH = "\$ANDROID_HOME/platform-tools:\$ANDROID_HOME/tools:\$ANDROID_HOME/tools/bin:/opt/homebrew/opt/[email protected]/bin:/opt/homebrew/bin:/usr/local/bin:${env.PATH}"

                    AWS_PROFILE = "mobile-for-now"

                    JAVA_HOME = "/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home"

                    PATH = "\$JAVA_HOME/bin:\$ANDROID_HOME/platform-tools:\$ANDROID_HOME/tools:\$ANDROID_HOME/tools/bin:/opt/homebrew/opt/[email protected]/bin:/opt/homebrew/bin:/usr/local/bin:${env.PATH}"

                    TS_ARTIFACTS_DIR = 'android'

                    TS_DATASET_VERSION = "${params.TS_DATASET_VERSION}"

                }

                steps {

                    // Unlock keychain:

                    sh 'security unlock-keychain -p ${KEYCHAIN_PASSWORD} ~/Library/Keychains/login.keychain-db'

                    echo "Run Android Tests"

                    echo "=== Run Android Tests"

                    timeout(time: 120, unit: 'MINUTES') {

                        sh """

                            jenkins/pipelines/QE/android/android_tests.sh "${params.CBL_VERSION}" "${params.SGW_VERSION}" ~/.ssh/jborden.pem

                            jenkins/pipelines/QE/android/android_tests.sh "${params.CBL_VERSION}" "${params.SGW_VERSION}"

                        """

                    }

                    echo "=== Android Tests Complete"

                }

                post {

                    always {

                        echo "Teardown Android Tests"

                        echo "=== Teardown Android Tests"

                        timeout(time: 5, unit: 'MINUTES') {

                            sh "jenkins/pipelines/QE/android/android_teardown.sh"

                        }

                        archiveArtifacts artifacts: 'tests/QE/android/**/*', fingerprint: true, allowEmptyArchive: true

                        echo "=== Android Test Teardown Complete"

                    }

                }

            }

        }

        post {

            failure {

                mail bcc: '', body: "Project: <a href='${env.BUILD_URL}'>${env.JOB_NAME}</a> has failed!", cc: '', charset: 'UTF-8', from: '[email protected]', mimeType: 'text/html', replyTo: '[email protected]', subject: "${env.JOB_NAME} failed", to: "[email protected]";

            }

        }

    }

jenkins/pipelines/QE/android/android_teardown.sh

-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,7 @@ @@
     set -euo pipefail
     SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+    export PATH="/opt/homebrew/opt/coreutils/libexec/gnubin:/opt/homebrew/bin:$PATH"
     source $SCRIPT_DIR/../../shared/config.sh
     export PYTHONPATH=$SCRIPT_DIR/../../../
@@ Expand Down @@

jenkins/pipelines/QE/android/android_tests.sh

-Original file line number
+Diff line change
@@ Expand Up / @@ -7,6 +7,7 @@ set -eu @@
     BUILD_TOOLS_VERSION='34.0.0'
     SDK_MGR="${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager"
     SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+    export PATH="/opt/homebrew/opt/coreutils/libexec/gnubin:/opt/homebrew/bin:$PATH"
     source $SCRIPT_DIR/../../shared/config.sh
     function usage() {
@@ Expand Down @@

jenkins/pipelines/QE/android/topology_single_device.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,8 @@ @@
             {
                 "platform": "jak_android",
                 "cbl_version": "{{version}}",
-                "location": "HT79F1A00593"
+                "location": "R5CT20FYA7R",
+                "download": true
             }
         ],
         "include": "../../../../environment/aws/topology_setup/default_topology.json"
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extend Jenkins pipeline to run CBL on all supported platforms #343

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Extend Jenkins pipeline to run CBL on all supported platforms #343

Are you sure you want to change the base?

Uh oh!

Extend Jenkins pipeline to run CBL on all supported platforms #343

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!