[CLIENT-4237] Enable building debug wheels for Windows

.github/workflows/build-wheels.yml

@@ -248,8 +248,9 @@ jobs:
       shell: bash
 
     - name: Set unoptimize flag
-      if: ${{ inputs.unoptimized && (startsWith(inputs.platform-tag, 'manylinux') || startsWith(inputs.platform-tag, 'macosx')) }}
+      if: ${{ inputs.unoptimized }}
       run: echo "UNOPTIMIZED=1" >> $GITHUB_ENV
+      shell: bash
 
     - name: Set include dsym flag
       if: ${{ inputs.include-debug-info-for-macos && startsWith(inputs.platform-tag, 'macosx') }}
@@ -328,7 +329,11 @@ jobs:
           auditwheel repair -w {dest_dir} {wheel} &&
           auditwheel show {dest_dir}/* &&
           rm -rf $WHEEL_DIR
-        CIBW_REPAIR_WHEEL_COMMAND_WINDOWS: "delvewheel repair -vv --add-path ./aerospike-client-c/vs/x64/Release -w {dest_dir} {wheel}"
+        # --no-mangle-all to make sure .pdb files match the .dll files
+        # delvewheel mangles the .dll file names but not the .pdb file names
+        # --include-symbols to include the .pdb files in the wheel
+        # TODO: need to find way to add path properly here
+        CIBW_REPAIR_WHEEL_COMMAND_WINDOWS: "delvewheel repair -vv --add-path ./aerospike-client-c/vs/x64/Debug --no-mangle-all --include-symbols -w {dest_dir} {wheel}"
         # We also want to verify the same thing on macos
         CIBW_REPAIR_WHEEL_COMMAND_MACOS: >
           delocate-wheel --require-archs {delocate_archs} -w {dest_dir} -v {wheel} &&
@@ -437,10 +442,32 @@ jobs:
         working-directory: test
         shell: bash
 
-      - run: python3 -m pytest -vvs --full-trace new_tests/${{ inputs.test-file }}
+      - if: ${{ inputs.platform-tag == 'win_amd64' }}
+        id: run-tests
+        run: |
+          curl -O https://raw.githubusercontent.com/python/cpython/refs/heads/$PYTHON_VERSION/Misc/valgrind-python.supp
+          export _NT_SYMBOL_PATH=$(pip show aerospike | grep Location | cut -f 2- -d' ')
+          export PYTHONMALLOC=malloc
+          mkdir dumps
+          drmemory -light -suppress valgrind-python.supp -logdir dumps -- python3 -m pytest -vvs --full-trace new_tests/${{ inputs.test-file }}
+          # drmemory -callstack_max_frames 30 -lib_allowlist_frames 30 -lib_allowlist '**/*.pyd,**/aerospike.dll' -- python3 -m pytest -vvs --full-trace new_tests/${{ inputs.test-file }}
+        # run: |
+        #   mkdir dumps
+        #   procdump -accepteula -e -x ./dumps python3 -m pytest -vvs --full-trace new_tests/${{ inputs.test-file }}
         working-directory: test
         shell: bash
 
+      # - if: ${{ failure() && steps.run-tests.outcome == 'failure' }}
+      - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
+        with:
+          path: ./test/dumps/*
+          name: dump-${{ matrix.python-tag }}
+          if-no-files-found: error
+
+      # - run: python3 -m pytest -vvs --full-trace new_tests/${{ inputs.test-file }}
+      #   working-directory: test
+      #   shell: bash
+
       - name: Show job status for commit
         if: ${{ always() && github.event_name != 'push' && github.event_name != 'pull_request' }}
         uses: myrotvorets/set-commit-status-action@3730c0a348a2ace3c110851bed53331bc6406e9f # v2.0.1

.gitmodules

@@ -2,4 +2,4 @@
 	path = aerospike-client-c
 	# url = git@github.com:aerospike/aerospike-client-c.git
 	url = https://github.com/aerospike/aerospike-client-c.git
-	branch = stage
+	branch = CLIENT-4327

setup.py

@@ -119,8 +119,15 @@
     extra_compile_args.append('-ftest-coverage')
     extra_link_args.append('-lgcov')
 
+data_files = []
+
 if UNOPTIMIZED:
-    extra_compile_args.append('-O0')
+    if WINDOWS:
+        extra_compile_args.append('/Zi')
+        extra_link_args.append('/DEBUG')
+        # data_files.append("*.pdb")
+    else:
+        extra_compile_args.append('-O0')
 
 ################################################################################
 # STATIC SSL LINKING BUILD SETTINGS
@@ -140,6 +147,11 @@
 ################################################################################
 
 if WINDOWS:
+    if UNOPTIMIZED:
+        VS_PROJECT_CONFIGURATION = "Debug"
+    else:
+        VS_PROJECT_CONFIGURATION = "Release"
+
     AEROSPIKE_C_TARGET = AEROSPIKE_C_HOME
     tree = ET.parse(f"{AEROSPIKE_C_TARGET}/vs/aerospike/packages.config")
     packages = tree.getroot()
@@ -166,7 +178,10 @@
     libraries = libraries + ['rt']
     AEROSPIKE_C_TARGET = AEROSPIKE_C_HOME + '/target/Linux-' + machine
 elif WINDOWS:
-    libraries.append("pthreadVC2")
+    if UNOPTIMIZED:
+        libraries.append("pthreadVC2d")
+    else:
+        libraries.append("pthreadVC2")
     extra_compile_args.append("-DAS_SHARED_IMPORT")
     include_dirs.append(f"{AEROSPIKE_C_TARGET}/vs/packages/aerospike-client-c-dependencies.{c_client_dependencies_version}/build/native/include")
 else:
@@ -184,9 +199,9 @@
     ]
 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")
+    library_dirs.append(f"{AEROSPIKE_C_TARGET}/vs/packages/aerospike-client-c-dependencies.{c_client_dependencies_version}/build/native/lib/x64/{VS_PROJECT_CONFIGURATION}")
     # Needed for linking the Python client with the C client
-    extra_objects.append(AEROSPIKE_C_TARGET + "/vs/x64/Release/aerospike.lib")
+    extra_objects.append(AEROSPIKE_C_TARGET + f"/vs/x64/{VS_PROJECT_CONFIGURATION}/aerospike.lib")
 
 os.putenv('CPATH', ':'.join(include_dirs))
 os.environ['CPATH'] = ':'.join(include_dirs)
@@ -230,7 +245,7 @@ def clean():
             cmd = [
                 'msbuild',
                 'vs/aerospike.sln',
-                '/property:Configuration=Release'
+                f"/property:Configuration={VS_PROJECT_CONFIGURATION}"
             ]
         else:
             cmd = [
@@ -324,5 +339,6 @@ def clean():
     cmdclass={
         'build': CClientBuild,
         'clean': CClientClean
-    }
+    },
+    data_files=data_files
 )

test/new_tests/conftest.py

@@ -239,7 +239,7 @@ def invalid_key(request):
     yield request.param
 
 
-# aerospike.set_log_level(aerospike.LOG_LEVEL_DEBUG)
+aerospike.set_log_level(aerospike.LOG_LEVEL_DEBUG)
 # aerospike.set_log_handler(None)
 
 def verify_record_ttl(client: aerospike.Client, key, expected_ttl: int):

test/new_tests/test_admin_change_password.py

@@ -77,12 +77,10 @@ def test_change_password_with_invalid_timeout_policy_value(self):
         user = "testchangepassworduser"
         password = "newpassword"
 
-        try:
+        with pytest.raises(aerospike.exception.ParamError) as excinfo:
             self.client.admin_change_password(user, password, policy)
-
-        except aerospike.exception.ParamError as exception:
-            assert exception.code == -2
-            assert exception.msg == "timeout is invalid"
+        assert excinfo.value.code == -2
+        assert excinfo.value.msg == "timeout is invalid"
 
     # NOTE: This will fail if auth_mode is PKI_AUTH (3).
     @pytest.mark.xfail(reason="Might fail depending on auth_mode.")
@@ -116,36 +114,30 @@ def test_change_password_with_none_username(self):
         user = None
         password = "newpassword"
 
-        try:
+        with pytest.raises(aerospike.exception.ParamError) as excinfo:
             self.client.admin_change_password(user, password)
-
-        except aerospike.exception.ParamError as exception:
-            assert exception.code == -2
-            assert exception.msg == "Username should be a string"
+        assert excinfo.value.code == -2
+        assert excinfo.value.msg == "Username should be a string"
 
     def test_change_password_with_none_password(self):
 
         user = "testchangepassworduser"
         password = None
 
-        try:
+        with pytest.raises(aerospike.exception.ParamError) as excinfo:
             self.client.admin_change_password(user, password)
-
-        except aerospike.exception.ParamError as exception:
-            assert exception.code == -2
-            assert exception.msg == "Password should be a string"
+        assert excinfo.value.code == -2
+        assert excinfo.value.msg == "Password should be a string"
 
     def test_change_password_with_non_existent_user(self):
 
         user = "readwriteuser"
         password = "newpassword"
 
-        try:
+        with pytest.raises(aerospike.exception.InvalidUser) as excinfo:
             self.client.admin_change_password(user, password)
-
-        except aerospike.exception.InvalidUser as exception:
-            assert exception.code == 60
-            assert exception.msg == "AEROSPIKE_INVALID_USER"
+        assert excinfo.value.code == 60
+        assert excinfo.value.msg == "AEROSPIKE_INVALID_USER"
 
     def test_change_password_with_too_long_password(self):
 

test/new_tests/test_admin_create_role.py

@@ -250,11 +250,10 @@ def test_create_role_incorrect_role_type(self):
         """
         role name not string
         """
-        try:
+        with pytest.raises(e.ParamError) as excinfo:
             self.client.admin_create_role(1, [{"code": aerospike.PRIV_USER_ADMIN}])
-        except e.ParamError as exception:
-            assert exception.code == -2
-            assert "Role name should be a string" in exception.msg
+        assert excinfo.value.code == -2
+        assert "Role name should be a string" in excinfo.value.msg
 
     def test_create_role_unknown_privilege_type(self):
         """
@@ -268,21 +267,18 @@ def test_create_role_unknown_privilege_type(self):
         except e.InvalidRole:
             pass  # we are good, no such role exists
 
-        try:
+        with pytest.raises(e.InvalidPrivilege) as excinfo:
             self.client.admin_create_role("usr-sys-admin-test", [{"code": 64}])
-        except e.InvalidPrivilege as exception:
-            assert exception.code == 72
+        assert excinfo.value.code == 72
 
     def test_create_role_incorrect_privilege_type(self):
         """
         privilege type incorrect
         """
-        try:
+        with pytest.raises(e.ParamError) as excinfo:
             self.client.admin_create_role("usr-sys-admin-test", None)
-
-        except e.ParamError as exception:
-            assert exception.code == -2
-            assert exception.msg == "Privileges should be a list"
+        assert excinfo.value.code == -2
+        assert excinfo.value.msg == "Privileges should be a list"
 
     def test_create_role_existing_role(self):
         """
@@ -299,16 +295,14 @@ def test_create_role_existing_role(self):
         self.client.admin_create_role(
             "usr-sys-admin-test", [{"code": aerospike.PRIV_USER_ADMIN}, {"code": aerospike.PRIV_SYS_ADMIN}]
         )
-        try:
+        time.sleep(2)
+        with pytest.raises(e.RoleExistsError) as excinfo:
             self.client.admin_create_role(
                 "usr-sys-admin-test", [{"code": aerospike.PRIV_USER_ADMIN}, {"code": aerospike.PRIV_SYS_ADMIN}]
             )
+        assert excinfo.value.code == 71
+        assert excinfo.value.msg == "AEROSPIKE_ROLE_ALREADY_EXISTS"
 
-        except e.RoleExistsError as exception:
-            assert exception.code == 71
-            assert exception.msg == "AEROSPIKE_ROLE_ALREADY_EXISTS"
-
-        time.sleep(1)
         status = self.client.admin_drop_role("usr-sys-admin-test")
 
         assert status == 0
@@ -364,11 +358,9 @@ def test_create_role_positive_with_too_long_role_name(self):
         """
         role_name = "role$" * 1000
 
-        try:
+        with pytest.raises(e.InvalidRole) as excinfo:
             self.client.admin_create_role(
                 role_name, [{"code": aerospike.PRIV_READ, "ns": "test", "set": "demo"}]
             )
-
-        except e.InvalidRole as exception:
-            assert exception.code == 70
-            assert exception.msg == "AEROSPIKE_INVALID_ROLE"
+        assert excinfo.value.code == 70
+        assert excinfo.value.msg == "AEROSPIKE_INVALID_ROLE"

test/new_tests/test_admin_create_user.py

@@ -108,12 +108,10 @@ def test_create_user_with_invalid_timeout_policy_value(self):
         except Exception:
             pass
 
-        try:
+        with pytest.raises(e.ParamError) as excinfo:
             self.client.admin_create_user(user, password, roles, policy)
-
-        except e.ParamError as exception:
-            assert exception.code == -2
-            assert exception.msg == "timeout is invalid"
+            assert excinfo.value.code == -2
+            assert excinfo.value.msg == "timeout is invalid"
 
     def test_create_user_with_proper_timeout_policy_value(self):
 
@@ -146,25 +144,21 @@ def test_create_user_with_none_username(self):
         password = "user3-test"
         roles = ["sys-admin"]
 
-        try:
+        with pytest.raises(e.ParamError) as excinfo:
             self.client.admin_create_user(user, password, roles)
-
-        except e.ParamError as exception:
-            assert exception.code == -2
-            assert exception.msg == "Username should be a string"
+        assert excinfo.value.code == -2
+        assert excinfo.value.msg == "Username should be a string"
 
     def test_create_user_with_empty_username(self):
 
         user = ""
         password = "user3-test"
         roles = ["read-write"]
 
-        try:
+        with pytest.raises(e.InvalidUser) as excinfo:
             self.client.admin_create_user(user, password, roles)
-
-        except e.InvalidUser as exception:
-            assert exception.code == 60
-            assert exception.msg == "AEROSPIKE_INVALID_USER"
+        assert excinfo.value.code == 60
+        assert excinfo.value.msg == "AEROSPIKE_INVALID_USER"
 
     def test_create_user_with_special_characters_in_username(self):
 
@@ -190,12 +184,10 @@ def test_create_user_with_none_password(self):
         password = None
         roles = ["sys-admin"]
 
-        try:
+        with pytest.raises(e.ParamError) as excinfo:
             self.client.admin_create_user(user, password, roles)
-
-        except e.ParamError as exception:
-            assert exception.code == -2
-            assert exception.msg == "Password should be a string"
+        assert excinfo.value.code == -2
+        assert excinfo.value.msg == "Password should be a string"
 
     def test_create_user_with_empty_string_as_password(self):
 
@@ -245,15 +237,12 @@ def test_create_user_with_too_long_username(self):
         except Exception:
             pass
 
-        try:
+        with pytest.raises((e.InvalidUser, e.ClientError)) as excinfo:
             self.client.admin_create_user(user, password, roles)
 
-        except e.InvalidUser as exception:
-            assert exception.code == 60
-            assert exception.msg == "AEROSPIKE_INVALID_USER"
-
-        except e.ClientError:
-            pass
+        if excinfo.type == e.InvalidUser:
+            assert excinfo.value.code == 60
+            assert excinfo.value.msg == "AEROSPIKE_INVALID_USER"
 
     def test_create_user_with_too_long_password(self):
 
@@ -310,7 +299,7 @@ def test_create_user_with_non_user_admin_user(self):
 
         non_admin_client = None
 
-        try:
+        with pytest.raises(e.RoleViolation) as excinfo:
             # Close and reconnect with non_admin_test user
             non_admin_client = aerospike.client(config)
             non_admin_client.close()
@@ -319,9 +308,7 @@ def test_create_user_with_non_user_admin_user(self):
 
             if non_admin_client:
                 non_admin_client.close()
-
-        except e.RoleViolation as exception:
-            assert exception.code == 81
+        assert excinfo.value.code == 81
 
         self.delete_users.append("non_admin_test")