[CLIENT-5049] Convert existing code examples in examples/ folder to inherit from a base class for boilerplate setup

.github/workflows/smoke-tests.yml

@@ -229,7 +229,8 @@ jobs:
         test: [
           stubtest,
           doctest,
-          code-examples
+          ce-code-examples,
+          ee-code-examples
         ]
       fail-fast: false
     needs: [
@@ -261,22 +262,33 @@ jobs:
     - name: Install client
       run: pip install ./*.whl
 
-    - if: ${{ matrix.test == 'doctest' || matrix.test == 'code-examples' }}
+    - if: ${{ matrix.test == 'doctest' || endsWith(matrix.test, 'code-examples') }}
       uses: aerospike/shared-workflows/.github/actions/setup-aerospike-server@bd168dedaa4fc0b17a560541779d815540eded2d # v3.7.0
       with:
         num-nodes: 1
         oidc-provider: ${{ vars.OIDC_PROVIDER_NAME }}
         oidc-audience: ${{ vars.OIDC_AUDIENCE }}
         server-tag: ${{ matrix.test == 'code-examples' && '8.1.3.0-35-20260629033923' || needs.get-env-vars.outputs.server-tag }}
-        server-container-repo: database-docker-virtual/aerospike-server
-        config-file: ./.github/workflows/aerospike-ce.conf
-
-    - if: ${{ matrix.test == 'code-examples' }}
-      # We cannot run this module with the cwd being string_ops
-      # Otherwise we will get relative import errors
-      # https://stackoverflow.com/a/47030746
-      run: python3 -m string_ops.run_all_examples
-      working-directory: examples
+        server-container-repo: database-docker-virtual/aerospike-server${{ matrix.test == 'ee-code-examples' && '-enterprise' || '' }}
+        config-file: ${{ (matrix.test == 'doctest' || matrix.test == 'ce-code-examples') && './.github/workflows/aerospike-ce.conf' || '' }}
+        enable-security: ${{ matrix.test == 'ee-code-examples' }}
+
+    - name: Run canonical code examples
+      if: ${{ endsWith(matrix.test, 'code-examples') }}
+      run: |
+        # This is required for the TTL code example
+        run_tools=(
+          docker run --rm --network host aerospike/aerospike-tools asinfo -v
+        )
+
+        if [[ ${{ matrix.test == 'ce-code-examples' }} == true ]]; then
+          "${run_tools[@]}" "set-config:context=namespace;id=test;nsup-period=1"
+          "${run_tools[@]}" "set-config:context=namespace;namespace=test;default-ttl=10S"
+        fi
+
+        python3 -m examples.run_all_examples "$SERVER_EDITION"
+      env:
+        SERVER_EDITION: ${{ matrix.test == 'ce-code-examples' && 'CE' || 'EE' }}
 
     - name: Install test dependencies
       if: ${{ matrix.test == 'doctest' }}

README.rst

@@ -94,12 +94,15 @@ Examples
 
 Example applications are provided in the `examples directory of the GitHub repository <https://github.com/aerospike/aerospike-client-python/tree/master/examples/client>`__
 
-For examples, to run the ``kvs.py``:
+For examples, to run all code examples:
 
 ::
 
-    python examples/client/kvs.py
+    python3 -m examples.run_all_examples
 
+To run a specific code example from ``examples/client/kvs.py``:
+
+    python3 -m examples.run_all_examples KVS
 
 Benchmarks
 ----------

examples/__init__.py

@@ -0,0 +1,65 @@
+import aerospike
+import os
+
+
+class Example:
+    def __init__(
+        self,
+        host: str = "127.0.0.1",
+        port: int = 3000,
+        user: str = None,
+        password: str = None,
+        namespace: str = "test",
+        set_name: str = "demo",
+        extra_config: dict = {}
+    ):
+        self.config = {
+            "hosts": [(host, port)],
+            "user": user,
+            "password": password
+        }
+        self.config |= extra_config
+        client = aerospike.client(self.config)
+
+        self.client = client
+        self.namespace = namespace
+        self.set_name = set_name
+        self.user_key = "docreadkey"
+        self.key = (self.namespace, self.set_name, self.user_key)
+        self.non_existent_key = (self.namespace, self.set_name, "nonexistent")
+        self.BIN_NAME = "a"
+
+    def cleanup(self):
+        self.client.close()
+
+class UDFExample(Example):
+    def __init__(self):
+        extra_config = {
+            'lua': {
+                'user_path': os.path.dirname(__file__) + "/client/"
+            }
+        }
+        super().__init__(extra_config=extra_config)
+
+class ExampleWithIndex(Example):
+    INDEX_NAME = "index_name"
+    def __init__(self):
+        super().__init__()
+
+        self.client.index_single_value_create(self.namespace, self.set_name, self.BIN_NAME, aerospike.INDEX_INTEGER, self.INDEX_NAME)
+
+    def cleanup(self):
+        self.client.index_remove(self.namespace, self.INDEX_NAME)
+
+        super().cleanup()
+
+class ExampleWithRecord(Example):
+    def __init__(self):
+        super().__init__()
+
+        self.client.put(self.key, bins={self.BIN_NAME: 1})
+
+    def cleanup(self):
+        self.client.remove(self.key)
+
+        super().cleanup()