[CLIENT-1837] CI/CD: Label version with git commit when building on a…

… non-tagged commit (#605)

* Also label version when building unoptimized, with macOS debug support, or with uncommitted changes to the repo (i.e add a "dirty" label)
* Rename config.conf to config.conf.template and add config.conf to .gitignore, so creating and modifying config.conf won't cause the repo to be in a dirty state

.github/actions/run-ee-server/action.yml

@@ -23,6 +23,11 @@ runs:
     working-directory: .github/workflows
     shell: bash
 
+  - name: Create config.conf
+    run: cp config.conf.template config.conf
+    working-directory: test
+    shell: bash
+
   - name: Use enterprise edition instead of community edition in config.conf
     run: |
       crudini --existing=param --set config.conf enterprise-edition hosts ''

.github/workflows/build-wheels.yml

@@ -97,6 +97,7 @@ jobs:
       with:
         submodules: recursive
         ref: ${{ inputs.ref }}
+        fetch-depth: 0
 
     - name: Install build dependencies (pip packages)
       run: python3 -m pip install -r requirements.txt
@@ -147,6 +148,7 @@ jobs:
       with:
         submodules: recursive
         ref: ${{ inputs.ref }}
+        fetch-depth: 0
 
     - name: Set up QEMU for cross compiling arm64
       if: ${{ matrix.platform == 'aarch64' }}
@@ -170,16 +172,6 @@ jobs:
       if: ${{ !inputs.run_tests }}
       run: echo "TEST_COMMAND=python -c 'import aerospike'" >> $GITHUB_ENV
 
-    - name: Get current version if building a debug wheel
-      if: ${{ inputs.apply-no-optimizations }}
-      run: echo DEBUG_VERSION="$(cat VERSION)+unoptimized" >> $GITHUB_ENV
-
-    - name: Label version for debugging
-      if: ${{ inputs.apply-no-optimizations }}
-      uses: ./.github/actions/update-version
-      with:
-        new_version: ${{ env.DEBUG_VERSION }}
-
     - name: Set unoptimize flag
       if: ${{ inputs.apply-no-optimizations }}
       run: echo "UNOPTIMIZED=1" >> $GITHUB_ENV
@@ -235,6 +227,7 @@ jobs:
       with:
         submodules: recursive
         ref: ${{ inputs.ref }}
+        fetch-depth: 0
 
     - name: Install Docker Engine
       if: ${{ inputs.run_tests }}
@@ -323,6 +316,7 @@ jobs:
       with:
         submodules: recursive
         ref: ${{ inputs.ref }}
+        fetch-depth: 0
 
     # Update dependencies if needed
     - name: Add brew to path
@@ -381,6 +375,10 @@ jobs:
       run: python${{ matrix.python-version[1] }} -m pip install --break-system-packages --force-reinstall delocate -c ./requirements.txt
       working-directory: .github/workflows
 
+    - name: Create config.conf
+      run: cp config.conf.template config.conf
+      working-directory: test
+
     - run: delocate-wheel --require-archs "arm64" -w wheelhouse/ -v dist/*.whl
     - run: python${{ matrix.python-version[1] }} -m pip install --break-system-packages --find-links=wheelhouse/ --no-index --force-reinstall aerospike
 
@@ -439,6 +437,7 @@ jobs:
         with:
           submodules: recursive
           ref: ${{ inputs.ref }}
+          fetch-depth: 0
 
       - name: Add msbuild to PATH
         uses: microsoft/[email protected]
@@ -498,6 +497,11 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: ${{ matrix.python[0] }}-win_amd64.build
+
+      - name: Create config.conf
+        run: cp config.conf.template config.conf
+        working-directory: test
+
       - name: Install wheel
         run: python${{ matrix.python[1] }} -m pip install aerospike --force-reinstall --no-index --find-links=./
       - name: Connect to Docker container on remote machine with Docker daemon

.github/workflows/test-server-rc.yml

@@ -167,6 +167,10 @@ jobs:
     - name: Run server RC
       run: docker run -d -p 3000:3000 --name aerospike ${{ vars.SERVER_RC_REPO_LINK }}
 
+    - name: Create config.conf
+      run: cp config.conf.template config.conf
+      working-directory: test
+
     - name: Wait for server to be ready
       run: sleep 5
 

.github/workflows/tests.yml

@@ -51,6 +51,7 @@ jobs:
     - uses: actions/checkout@v2
       with:
         submodules: recursive
+        fetch-depth: 0
 
     - uses: actions/setup-python@v2
       with:
@@ -102,6 +103,10 @@ jobs:
       # Should be ready after 3 seconds
       run: sleep 3
 
+    - name: Create config.conf
+      run: cp config.conf.template config.conf
+      working-directory: test
+
     - name: Get number of tests
       run: echo "NUM_TESTS=$(python3 -m pytest new_tests/ --collect-only -q | tail -n 1 | awk '{print $1;}')" >> $GITHUB_ENV
       working-directory: test
@@ -119,6 +124,7 @@ jobs:
     - uses: actions/checkout@v2
       with:
         submodules: recursive
+        fetch-depth: 0
 
     - uses: actions/setup-python@v2
       with:
@@ -275,6 +281,10 @@ jobs:
       # Should be ready after 3 seconds
       run: sleep 3
 
+    - name: Create config.conf
+      run: cp config.conf.template config.conf
+      working-directory: test
+
     - name: Run tests
       run: python -m pytest ./new_tests
       working-directory: test
@@ -331,6 +341,10 @@ jobs:
       # Should be ready after 3 seconds
       run: sleep 3
 
+    - name: Create config.conf
+      run: cp config.conf.template config.conf
+      working-directory: test
+
     - name: Run tests
       run: python -m pytest ./new_tests -vv
       working-directory: test
@@ -365,6 +379,10 @@ jobs:
       # Should be ready after 3 seconds
       run: sleep 3
 
+    - name: Create config.conf
+      run: cp config.conf.template config.conf
+      working-directory: test
+
     - name: Run tests
       run: python -m pytest ./new_tests
       working-directory: test

.github/workflows/valgrind.yml

@@ -20,6 +20,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         submodules: recursive
+        fetch-depth: 0
 
     - uses: actions/setup-python@v2
       with:

BUILD.md

@@ -120,6 +120,18 @@ python3 -m pip install -r requirements.txt
 python3 -m build
 ```
 
+### Local version identifier
+
+If you are building on a non-tagged commit, or there are uncommitted changes to the repository, a local version
+identifier will be added to the version. The formatting of the local version identifier can be found [here](https://github.com/jwodder/versioningit/tree/v3.1.0?tab=readme-ov-file#example-configurations) under the versioneer
+section. 
+
+The local version identifier will appear in:
+- The package version in the wheel name
+- `python3 -m pip show aerospike` if you installed the wheel
+
+The local version identifier will NOT show up in `aerospike.__version__`.
+
 ### Unoptimized builds (only Linux and macOS)
 
 By default, the Python client and the C client submodule are built with optimizations, which can make debugging
@@ -129,8 +141,7 @@ environment variable:
 UNOPTIMIZED=1 python3 -m build
 ```
 
-In Linux, the package version will be labelled with `+debug`. This label is not applied to macOS currently, but it
-will be supported in the future (soon).
+In Linux and macOS builds, the package version will be labelled with `+unoptimized`.
 
 ### Including debug symbols in macOS
 
@@ -144,6 +155,8 @@ This way, when you debug the Python client using lldb, the source files and line
 breakpoints will actually work, etc. macOS builds with this option enabled do not have a labelled version yet, but this
 will be added in the future.
 
+In macOS builds, the package version will be labelled with `+dsym`.
+
 ### Building with sanitizer enabled
 
 You can build the Python client with sanitizer to find memory errors and memory leaks. To do this, pass in an environment variable:

MANIFEST.in

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

custom-versionit-format.py

@@ -0,0 +1,62 @@
+from parver import Version
+import versioningit
+from typing import Any, Dict, Union
+import pathlib
+
+import versioningit.basics
+import versioningit.git
+import os
+
+# Take in <version> and <string> as input
+# If local version identifier doesn't exist, append +<string> to <version>
+# Example: 15.0.0rc1 and dsym as input -> 15.0.0rc1+dsym
+# If it does exist, append <version> with .<string>
+# Then output new version as str
+def append_to_local(version_str: str, value: str) -> str:
+    version = Version.parse(version_str, strict=True)
+    if version.local == None:
+        new_local = value
+    else:
+        new_local = f"{version.local}.{value}"
+
+    version = version.replace(local=new_local)
+    return version.__str__()
+
+def my_vcs(
+        project_dir: Union[str, pathlib.Path],
+        params: Dict[str, Any]
+) -> versioningit.VCSDescription:
+    vcs_description = versioningit.git.describe_git(
+        project_dir=project_dir,
+        params=params
+    )
+    if vcs_description.state == "exact":
+        # We don't want the format step to be skipped
+        # Workaround: https://github.com/jwodder/versioningit/issues/42#issuecomment-1235573432
+        vcs_description.state = "exact_"
+    return vcs_description
+
+def my_format(
+        description: versioningit.VCSDescription,
+        base_version: str,
+        next_version: str,
+        params: Dict[str, Any]
+) -> str:
+    # Even if the repository state matches a tag, we always need to label the version if it's unoptimized or includes
+    # dsym for macOS
+    if description.state != "exact_":
+        version_str = versioningit.basics.basic_format(
+            description=description,
+            base_version=base_version,
+            next_version=next_version,
+            params=params
+        )
+    else:
+        version_str = base_version
+
+    if os.getenv("UNOPTIMIZED"):
+        version_str = append_to_local(version_str, "unoptimized")
+    if os.getenv("INCLUDE_DSYM"):
+        version_str = append_to_local(version_str, "dsym")
+
+    return version_str

pyproject.toml

@@ -1,5 +1,10 @@
 [build-system]
-requires = ["setuptools"]
+requires = [
+    "setuptools",
+    "versioningit==3.1.0",
+    # Used by our versioningit script that modifies the version
+    "parver==0.5"
+]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -32,3 +37,20 @@ dynamic = ["version"]
 [tool.setuptools]
 zip-safe = false
 include-package-data = true
+
+[tool.versioningit]
+
+[tool.versioningit.vcs]
+method = {module = "custom-versionit-format", value="my_vcs"}
+
+# Use versioneer formatting
+[tool.versioningit.format]
+method = {module = "custom-versionit-format", value="my_format"}
+distance = "{base_version}+{distance}.{vcs}{rev}"
+# Example formatted version: 1.2.3+42.ge174a1f
+
+dirty = "{base_version}+{distance}.{vcs}{rev}.dirty"
+# Example formatted version: 1.2.3+42.ge174a1f.dirty
+
+distance-dirty = "{base_version}+{distance}.{vcs}{rev}.dirty"
+# Example formatted version: 1.2.3+42.ge174a1f.dirty

test/.gitignore

@@ -0,0 +1 @@
+config.conf

test/README.md

@@ -21,7 +21,11 @@ python3 -m pytest new_tests/
 
 [Pytest usage]:http://pytest.org/latest/usage.html
 
-To set the server details, modify `config.conf`.
+To set the server details:
+- Create a copy of `config.conf.template` and rename it to `config.conf`. `config.conf` will be the config file used
+for testing, and it will be ignored by git.
+- Modify `config.conf` to suit your needs.
+
 If a community edition server is to be used, specify the list of hosts in the
 `[community-edition]` section. You can remove the `[enterprise-edition]` section
 or leave its options empty.