[CLIENT-3161] Add client config option to validate keys passed into client config and policy dictionaries

.flake8

@@ -4,4 +4,4 @@ max-line-length = 120
 extend-ignore = E203
 filename =
     ./aerospike_helpers/**/*.py,
-    ./test/**/*.py
+    ./test/new_tests/**/*.py

.github/workflows/tests.yml

@@ -107,7 +107,7 @@ jobs:
       # They will also contain .gcno files there
       # and .gcda files will be generated there after running the tests
       # The build frontend doesn't generate these .o files (may be wrong?)
-      run: COVERAGE=1 python3 setup.py build
+      run: COVERAGE=1 UNOPTIMIZED=1 python3 setup.py build
 
     - name: Install client
       # Install in user directory to prevent permission errors

doc/aerospike.rst

@@ -343,6 +343,61 @@ Only the `hosts` key is required; the rest of the keys are optional.
     .. hlist::
         :columns: 1
 
+        * **validate_keys** (:class:`bool`)
+            (Optional) Validate keys passed into this config dictionary as well as any policy dictionaries.
+
+            If a key that is undefined in this documentation gets passed to a config or policy dictionary:
+
+            * If this option is set to :py:obj:`True`, :py:class:`~aerospike.exception.ParamError` will be raised.
+            * If this option is set to :py:obj:`False`, the key will be ignored and the client does not raise an
+              exception in response to the invalid key.
+
+            Default: :py:obj:`False`
+
+            Invalid client config example:
+
+            .. code-block:: python
+
+                import aerospike
+
+                config = {
+                    "validate_keys": True,
+                    "hosts": [
+                        ("127.0.0.1", 3000)
+                    ],
+                    # The correct key is "user", but "username" may be used by accident
+                    "username": "user",
+                    "password": "password"
+                }
+                # This call will raise a ParamError from aerospike.exception
+                # Exception message should be:
+                # "username" is an invalid client config dictionary key
+                client = aerospike.client(config)
+
+            Invalid policy example:
+
+            .. code-block:: python
+
+                import aerospike
+
+                config = {
+                    "validate_keys": True,
+                    "hosts": [
+                        ("127.0.0.1", 3000)
+                    ],
+                }
+                client = aerospike.client(config)
+
+                key = ("test", "demo", 1)
+                # "key_policy" is used instead of the correct key named "key"
+                policy = {
+                    "key_policy": aerospike.POLICY_KEY_SEND
+                }
+                # This call will raise a ParamError from aerospike.exception
+                # Exception message should be:
+                # "key_policy" is an invalid policy dictionary key
+                client.get(key, policy=policy)
+
         * **hosts** (:class:`list`)
             A list of tuples identifying a node (or multiple nodes) in the cluster.
 

src/include/policy.h

@@ -196,8 +196,8 @@ as_status pyobject_to_policy_apply(AerospikeClient *self, as_error *err,
                                    as_policy_apply *config_apply_policy,
                                    as_exp *exp_list, as_exp **exp_list_p);
 
-as_status pyobject_to_policy_info(as_error *err, PyObject *py_policy,
-                                  as_policy_info *policy,
+as_status pyobject_to_policy_info(AerospikeClient *self, as_error *err,
+                                  PyObject *py_policy, as_policy_info *policy,
                                   as_policy_info **policy_p,
                                   as_policy_info *config_info_policy);
 

src/include/policy_config.h

@@ -37,22 +37,36 @@ as_status set_optional_gen(as_policy_gen *target_ptr, PyObject *py_policy,
 as_status set_optional_exists(as_policy_exists *target_ptr, PyObject *py_policy,
                               const char *name);
 
-as_status set_subpolicies(as_config *config, PyObject *py_policies);
-as_status set_read_policy(as_policy_read *read_policy, PyObject *py_policy);
-as_status set_write_policy(as_policy_write *write_policy, PyObject *py_policy);
-as_status set_apply_policy(as_policy_apply *apply_policy, PyObject *py_policy);
-as_status set_remove_policy(as_policy_remove *remove_policy,
-                            PyObject *py_policy);
-as_status set_query_policy(as_policy_query *query_policy, PyObject *py_policy);
-as_status set_scan_policy(as_policy_scan *scan_policy, PyObject *py_policy);
-as_status set_operate_policy(as_policy_operate *operate_policy,
-                             PyObject *py_policy);
-as_status set_batch_policy(as_policy_batch *batch_policy, PyObject *py_policy);
-as_status set_info_policy(as_policy_info *info_policy, PyObject *py_policy);
-as_status set_admin_policy(as_policy_admin *admin_policy, PyObject *py_policy);
-as_status set_batch_apply_policy(as_policy_batch_apply *batch_apply_policy,
-                                 PyObject *py_policy);
-as_status set_batch_write_policy(as_policy_batch_write *batch_write_policy,
-                                 PyObject *py_policy);
-as_status set_batch_remove_policy(as_policy_batch_remove *batch_remove_policy,
-                                  PyObject *py_policy);
+// This only sets the err object if an invalid dictionary key is passed
+// On error, return an error code
+as_status set_subpolicies(as_error *err, as_config *config,
+                          PyObject *py_policies, int validate_keys);
+as_status set_read_policy(as_error *err, as_policy_read *read_policy,
+                          PyObject *py_policy, int validate_keys);
+as_status set_write_policy(as_error *err, as_policy_write *write_policy,
+                           PyObject *py_policy, int validate_keys);
+as_status set_apply_policy(as_error *err, as_policy_apply *apply_policy,
+                           PyObject *py_policy, int validate_keys);
+as_status set_remove_policy(as_error *err, as_policy_remove *remove_policy,
+                            PyObject *py_policy, int validate_keys);
+as_status set_query_policy(as_error *err, as_policy_query *query_policy,
+                           PyObject *py_policy, int validate_keys);
+as_status set_scan_policy(as_error *err, as_policy_scan *scan_policy,
+                          PyObject *py_policy, int validate_keys);
+as_status set_operate_policy(as_error *err, as_policy_operate *operate_policy,
+                             PyObject *py_policy, int validate_keys);
+as_status set_batch_policy(as_error *err, as_policy_batch *batch_policy,
+                           PyObject *py_policy, int validate_keys);
+as_status set_info_policy(as_error *err, as_policy_info *info_policy,
+                          PyObject *py_policy, int validate_keys);
+as_status set_admin_policy(as_error *err, as_policy_admin *admin_policy,
+                           PyObject *py_policy, int validate_keys);
+as_status set_batch_apply_policy(as_error *err,
+                                 as_policy_batch_apply *batch_apply_policy,
+                                 PyObject *py_policy, int validate_keys);
+as_status set_batch_write_policy(as_error *err,
+                                 as_policy_batch_write *batch_write_policy,
+                                 PyObject *py_policy, int validate_keys);
+as_status set_batch_remove_policy(as_error *err,
+                                  as_policy_batch_remove *batch_remove_policy,
+                                  PyObject *py_policy, int validate_keys);

src/include/types.h

@@ -78,6 +78,7 @@ typedef struct {
     bool has_connected;
     bool use_shared_connection;
     uint8_t send_bool_as;
+    bool validate_keys;
 } AerospikeClient;
 
 typedef struct {
@@ -117,3 +118,37 @@ typedef struct {
 } AerospikeConfigProvider;
 
 extern PyTypeObject AerospikeConfigProvider_Type;
+
+// These are defined in aerospike.c
+extern PyObject *py_client_config_valid_keys;
+extern PyObject *py_client_config_shm_valid_keys;
+extern PyObject *py_client_config_lua_valid_keys;
+extern PyObject *py_client_config_policies_valid_keys;
+extern PyObject *py_client_config_tls_valid_keys;
+extern PyObject *py_apply_policy_valid_keys;
+extern PyObject *py_admin_policy_valid_keys;
+extern PyObject *py_info_policy_valid_keys;
+extern PyObject *py_query_policy_valid_keys;
+extern PyObject *py_read_policy_valid_keys;
+extern PyObject *py_remove_policy_valid_keys;
+extern PyObject *py_scan_policy_valid_keys;
+extern PyObject *py_write_policy_valid_keys;
+extern PyObject *py_operate_policy_valid_keys;
+extern PyObject *py_batch_policy_valid_keys;
+extern PyObject *py_batch_write_policy_valid_keys;
+extern PyObject *py_batch_read_policy_valid_keys;
+extern PyObject *py_batch_apply_policy_valid_keys;
+extern PyObject *py_batch_remove_policy_valid_keys;
+extern PyObject *py_bit_policy_valid_keys;
+extern PyObject *py_map_policy_valid_keys;
+extern PyObject *py_list_policy_valid_keys;
+extern PyObject *py_hll_policy_valid_keys;
+
+// py_set contains the valid keys
+// Return -1 if we failed to validate dictionary
+// Return 0 if dictionary has invalid keys
+// Return 1 if dictionary's keys are all valid
+// If validating_policy is false, we are validating a client config dictionary
+extern int does_py_dict_contain_valid_keys(as_error *err, PyObject *py_dict,
+                                           PyObject *py_set,
+                                           bool validating_policy);