[CLIENT-2239] CI/CD: Run memory profiler test (#513)

* Allow pytest-memray to save dumps for tests with long names
* Ignore ZeroDivisionError thrown by pytest-memray

.github/workflows/tests.yml

@@ -69,6 +69,45 @@ jobs:
         name: wheel-${{ matrix.py-version }}
         path: ./dist/*.whl
 
+  test-memray:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: actions/setup-python@v2
+      with:
+        python-version: "3.8"
+        architecture: 'x64'
+
+    - uses: actions/download-artifact@v3
+      with:
+        name: wheel-3.8
+
+    - name: Install client
+      run: pip install *.whl
+
+    - name: Install test dependencies
+      run: pip install -r test/requirements.txt
+
+    - name: Run Aerospike server
+      run: docker run -d --name aerospike -p 3000-3002:3000-3002 aerospike/aerospike-server
+
+    - name: Wait for database to be ready
+      # Should be ready after 3 seconds
+      run: sleep 3
+
+    - 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
+
+    - name: Run tests
+      # Get number of tests since setting to 0 doesn't work properly
+      # pytest-memray currently throws a ZeroDivision error due to having a bug
+      # We ignore this for now
+      run: python -m pytest ./new_tests --memray --memray-bin-path=./ --most-allocations=${{ env.NUM_TESTS }} || true
+      working-directory: test
+
   test-coverage:
     runs-on: ubuntu-latest
     steps:

test/new_tests/test_key_digest.py

@@ -67,6 +67,7 @@ def test_validate_digest_ints(pk, expected):
         ("-" * 10000, "b42e64afbfccb05912a609179228d9249ea1c1a0"),
         ("+" * 100000, "0a3e888c20bb8958537ddd4ba835e4070bd51740"),
     ),
+    ids=["empty", "s", "10 a's", "100 m's", "1000 t's", "10000 -'s", "100000 +'s"]
 )
 def test_validate_digest_str(pk, expected):
     digest = aerospike.calc_digest(NAMESPACE, SET, pk)
@@ -90,6 +91,7 @@ def test_validate_digest_str(pk, expected):
         ("-" * 10000, "ed65c63f7a1f8c6697eb3894b6409a95461fd982"),
         ("+" * 100000, "fe19770c371774ba1a1532438d4851b8a773a9e6"),
     ),
+    ids=["s", "10 a's", "100 m's", "1000 t's", "10000 -'s", "100000 +'s"]
 )
 def test_validate_digest_bytes(pk, expected):
     # encode the primary key as bytes

test/requirements.txt

@@ -1,5 +1,7 @@
 pytest==7.4.0
 # To generate coverage reports in the Github Actions pipeline
 pytest-cov==4.1.0
+# Memory profiling
+pytest-memray==1.5.0
 # TODO: these should be removed since we are not using them
 psutil