[CLIENT-4042] CI/CD: Cache C client build to save compute spend

.github/workflows/build-c-client.yml

@@ -0,0 +1,29 @@
+on:
+  workflow_call:
+
+jobs:
+  build-c-client:
+    runs-on: ubuntu-22.04
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+        sparse-checkout: |
+          aerospike-client-c
+
+    - run: echo C_CLIENT_REVISION=$(git rev-parse HEAD) >> $GITHUB_ENV
+      working-directory: aerospike-client-c
+
+    - uses: actions/cache@v5
+      id: download-c-client
+      with:
+        key: c-client-${{ env.C_CLIENT_REVISION }}
+        path: ./aerospike-client-c/target/Linux-x86_64/lib/libaerospike.a
+
+    - name: Install C client build dependencies
+      if: ${{ steps.download-c-client.outputs.cache-hit != 'true' }}
+      run: |
+        sudo apt update &&
+        sudo apt-get install -y libc6-dev libssl-dev autoconf automake libtool g++ zlib1g-dev ncurses-dev &&
+        make build
+      working-directory: aerospike-client-c

.github/workflows/build-python-client.yml

@@ -0,0 +1,49 @@
+on:
+  workflow_call:
+
+jobs:
+  build-python-client:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        py-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: recursive
+        fetch-depth: 0
+
+    - run: echo C_CLIENT_REVISION=$(git submodule status | awk '{print $1}') >> $GITHUB_ENV
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.py-version }}
+        architecture: 'x64'
+        allow-prereleases: true
+
+    - run: sudo apt update
+    - name: Install build dependencies (apt packages)
+      run: sudo apt install python3-dev libssl-dev -y
+    - name: Install build dependencies (pip packages)
+      run: python3 -m pip install -r requirements.txt
+
+    - uses: actions/cache/restore@v5
+      id: download-c-client
+      with:
+        key: c-client-${{ env.C_CLIENT_REVISION }}
+        path: libaerospike.a
+
+    - name: Build client
+      run: python3 -m build
+      env:
+        CFLAGS: '-Werror'
+        C_CLIENT_SHARED_PATH: ./libaerospike.a
+
+    - run: echo WHEEL_GH_ARTIFACT_NAME=wheel-${{ matrix.py-version }} >> $GITHUB_ENV
+
+    - name: Send wheel to test jobs
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ env.WHEEL_GH_ARTIFACT_NAME }}
+        path: ./dist/*.whl

.github/workflows/build.yml

@@ -0,0 +1,14 @@
+on:
+  pull_request:
+    paths:
+    - aerospike-client-c
+    - src/**
+  workflow_dispatch:
+
+jobs:
+  build-c-client-submodule:
+    uses: ./.github/workflows/build-c-client.yml
+
+  build-python-client:
+    needs: build-c-client-submodule
+    uses: ./.github/workflows/build-python-client.yml

.github/workflows/smoke-tests.yml

@@ -40,7 +40,34 @@ on:
         required: true
 
 jobs:
+  # TODO: check if C client was already built for current submodule revision
+  # TODO: define a var for the same OS used in the other build job
+  build-c-client:
+    runs-on: ubuntu-22.04
+    steps:
+    - run: sudo apt update
+    - name: Install C client build dependencies
+      run: sudo apt-get install -y libc6-dev libssl-dev autoconf automake libtool g++ zlib1g-dev ncurses-dev
+
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+        sparse-checkout: |
+          aerospike-client-c
+
+    - run: make build
+      working-directory: aerospike-client-c
+
+    - name: Send C client static library to job that builds Python client
+      uses: actions/upload-artifact@v4
+      with:
+        name: c-client
+        # TODO: not the precise folder
+        path: ./aerospike-client-c/target/Linux-x86_64/lib/libaerospike.a
+        if-no-files-found: error
+
   build:
+    needs: build-c-client
     runs-on: ubuntu-22.04
     strategy:
       matrix:
@@ -79,10 +106,18 @@ jobs:
     - if: ${{ matrix.sanitizer }}
       run: echo SANITIZER=1 >> $GITHUB_ENV
 
+    - uses: actions/download-artifact@v4
+      id: get-c-client
+      with:
+        name: c-client
+
+    - run: ls -R
+
     - name: Build client
       run: python3 -m build
       env:
         CFLAGS: '-Werror'
+        C_CLIENT_SHARED_PATH: 1
 
     - run: echo WHEEL_GH_ARTIFACT_NAME=wheel-${{ matrix.py-version }} >> $GITHUB_ENV
 

MANIFEST.in

@@ -8,3 +8,4 @@ include modules/aerospike-lua-core/src/*.lua
 global-include *.pyi
 global-include *.typed
 include custom-versionit-format.py
+include libaerospike.a

setup.py

@@ -64,6 +64,7 @@
 ################################################################################
 
 include_dirs = ['src/include'] + \
+    [f'{AEROSPIKE_C_HOME}/src/include'] + \
     [x for x in os.getenv('CPATH', '').split(':') if len(x) > 0] + \
     ['/usr/local/opt/openssl/include'] + \
     ['aerospike-client-c/modules/common/src/include']
@@ -177,11 +178,17 @@
     '/usr/local/opt/openssl/include',
 
 ]
+
+C_CLIENT_SHARED_PATH = os.getenv("C_CLIENT_SHARED_PATH")
+
 if not WINDOWS:
     include_dirs.append(AEROSPIKE_C_TARGET + '/include')
-    extra_objects = extra_objects + [
-        AEROSPIKE_C_TARGET + '/lib/libaerospike.a'
-    ]
+    if C_CLIENT_SHARED_PATH:
+        extra_objects.append(C_CLIENT_SHARED_PATH)
+    else:
+        extra_objects = extra_objects + [
+            AEROSPIKE_C_TARGET + '/lib/libaerospike.a'
+        ]
 else:
     include_dirs.append(AEROSPIKE_C_TARGET + '/src/include')
     library_dirs.append(f"{AEROSPIKE_C_TARGET}/vs/packages/aerospike-client-c-dependencies.{c_client_dependencies_version}/build/native/lib/x64/Release")
@@ -249,7 +256,8 @@ def compile():
             print(cmd, library_dirs, libraries)
             call(cmd, cwd=CCLIENT_PATH)
 
-        self.execute(compile, [], 'Compiling core aerospike-client-c')
+        if not C_CLIENT_SHARED_PATH:
+            self.execute(compile, [], 'Compiling core aerospike-client-c')
         # run original c-extension build code
         build.run(self)