fix: support value remap in fluent api test

Author: Bucknalla

test/fluent_api/conftest.py

@@ -11,7 +11,7 @@
 
 @pytest.fixture
 def run_fluent_api_notecard_api_mapping_test():
-    def _run_test(fluent_api, notecard_api_name, req_params, rename_map=None):
+    def _run_test(fluent_api, notecard_api_name, req_params, rename_key_map=None, rename_value_map=None):
         card = notecard.Notecard()
         card.Transaction = MagicMock()
 
@@ -21,21 +21,31 @@ def _run_test(fluent_api, notecard_api_name, req_params, rename_map=None):
         # There are certain fluent APIs that have keyword arguments that don't
         # map exactly onto the Notecard API. For example, note.changes takes a
         # 'maximum' parameter, but in the JSON request that gets sent to the
-        # Notecard, it's sent as 'max'. The rename_map allows a test to specify
+        # Notecard, it's sent as 'max'. The rename_key_map allows a test to specify
         # how a fluent API's keyword args map to Notecard API args, in cases
         # where they differ.
-        if rename_map is not None:
-            for old_key, new_key in rename_map.items():
+        if rename_key_map is not None:
+            for old_key, new_key in rename_key_map.items():
                 expected_notecard_api_req[new_key] = expected_notecard_api_req.pop(old_key)
 
+        # Additionally, some Notecard API args have values that are not directly
+        # mapped, but are instead derived from the value of another arg. For
+        # example, note.template takes a 'compact' parameter, but the value of
+        # that parameter is actually derived from the value of the 'format'
+        # parameter. The rename_value_map allows a test to specify how a fluent
+        # API's keyword args map to Notecard API args, in cases where the value
+        if rename_value_map is not None:
+            for old_key, new_value in rename_value_map.items():
+                expected_notecard_api_req[old_key] = new_value
+
         card.Transaction.assert_called_once_with(expected_notecard_api_req)
 
     return _run_test
 
 
 @pytest.fixture
 def run_fluent_api_invalid_notecard_test():
-    def _run_test(fluent_api, req_params):
+    def _run_test(fluent_api, req_params, rename_key_map=None, rename_value_map=None):
         with pytest.raises(Exception, match='Notecard object required'):
             # Call with None instead of a valid Notecard object.
             fluent_api(None, **req_params)

test/fluent_api/test_note.py

@@ -3,7 +3,7 @@
 
 
 @pytest.mark.parametrize(
-    'fluent_api,notecard_api,req_params,rename_map',
+    'fluent_api,notecard_api,req_params,rename_key_map,rename_value_map',
     [
         (
             note.add,
@@ -12,8 +12,10 @@
                 'file': 'data.qo',
                 'body': {'key_a:', 'val_a', 'key_b', 42},
                 'payload': 'ewogICJpbnRlcnZhbHMiOiI2MCwxMiwxNCIKfQ==',
+                'port': 50,
                 'sync': True
             },
+            None,
             None
         ),
         (
@@ -30,7 +32,8 @@
             },
             {
                 'maximum': 'max'
-            }
+            },
+            None
         ),
         (
             note.delete,
@@ -41,7 +44,8 @@
             },
             {
                 'note_id': 'note'
-            }
+            },
+            None
         ),
         (
             note.get,
@@ -54,17 +58,25 @@
             },
             {
                 'note_id': 'note'
-            }
+            },
+            None
         ),
         (
             note.template,
             'note.template',
             {
                 'file': 'my-settings.db',
                 'body': {'key_a:', 'val_a', 'key_b', 42},
-                'length': 42
+                'length': 42,
+                'port': 50,
+                'compact': True
             },
-            None
+            {
+                'compact': 'format'
+            },
+            {
+                'format' : 'compact'
+            }
         ),
         (
             note.update,
@@ -77,18 +89,21 @@
             },
             {
                 'note_id': 'note'
-            }
+            },
+            None
         )
     ]
 )
 class TestNote:
     def test_fluent_api_maps_notecard_api_correctly(
-            self, fluent_api, notecard_api, req_params, rename_map,
-            run_fluent_api_notecard_api_mapping_test):
+            self, fluent_api, notecard_api, req_params, rename_key_map,
+            rename_value_map, run_fluent_api_notecard_api_mapping_test):
         run_fluent_api_notecard_api_mapping_test(fluent_api, notecard_api,
-                                                 req_params, rename_map)
+                                                 req_params, rename_key_map,
+                                                 rename_value_map)
 
     def test_fluent_api_fails_with_invalid_notecard(
-            self, fluent_api, notecard_api, req_params, rename_map,
-            run_fluent_api_invalid_notecard_test):
-        run_fluent_api_invalid_notecard_test(fluent_api, req_params)
+            self, fluent_api, notecard_api, req_params, rename_key_map,
+            rename_value_map, run_fluent_api_invalid_notecard_test):
+        run_fluent_api_invalid_notecard_test(fluent_api, req_params,
+                                             rename_key_map, rename_value_map)