made tests more forgiving for score values

Author: daniel-sanche

packages/google-cloud-firestore/tests/system/pipeline_e2e/search.yaml

@@ -43,15 +43,6 @@ tests:
         offset: 1
         query_enhancement: disabled
         language_code: en
-  assert_results:
-  - name: El Sol Tacos
-    description: A vibrant street-side taco stand serving up quick, delicious, and
-      traditional Mexican street food.
-    location: GEOPOINT(39.6952, -105.0274)
-    menu: <h3>Tacos ($3.50 each)</h3><ul><li>Al Pastor</li><li>Carne Asada</li><li>Pollo
-      Asado</li><li>Nopales (Cactus)</li></ul><h3>Beverages</h3><ul><li>Horchata -
-      $4</li><li>Mexican Coke - $3</li></ul>
-    average_price_per_person: 12
   assert_proto:
     pipeline:
       stages:
@@ -75,6 +66,7 @@ tests:
               args:
               - stringValue: tacos
               name: document_matches
+  assert_count: 1
 - description: search_stage_with_sort_and_add_fields
   pipeline:
   - Collection: restaurants
@@ -89,38 +81,31 @@ tests:
         - AliasedExpression:
           - Score: []
           - search_score
+  - Select:
+    - name
+    - search_score
   assert_results_approximate:
-  - name: Eastside Cantina
-    description: Authentic street tacos and hand-shaken margaritas on the vibrant
-      east side of the city.
-    location: GEOPOINT(39.735, -104.885)
-    menu: <h3>Tacos</h3><ul><li>Carnitas Tacos - $4</li><li>Barbacoa Tacos - $4.50</li><li>Shrimp
-      Tacos - $5</li></ul><h3>Drinks</h3><ul><li>House Margarita - $9</li><li>Jarritos
-      - $3</li></ul>
-    average_price_per_person: 18
-    search_score: 0.5137
-  - name: El Sol Tacos
-    description: A vibrant street-side taco stand serving up quick, delicious, and
-      traditional Mexican street food.
-    location: GEOPOINT(39.6952, -105.0274)
-    menu: <h3>Tacos ($3.50 each)</h3><ul><li>Al Pastor</li><li>Carne Asada</li><li>Pollo
-      Asado</li><li>Nopales (Cactus)</li></ul><h3>Beverages</h3><ul><li>Horchata -
-      $4</li><li>Mexican Coke - $3</li></ul>
-    average_price_per_person: 12
-    search_score: 0.4731
+    config:
+      # be flexible in score values, but should be > 0
+      absolute_tolerance: 0.99
+    data:
+    - name: Eastside Cantina
+      search_score: 1.0
+    - name: El Sol Tacos
+      search_score: 1.0
   assert_proto:
     pipeline:
       stages:
-      - args:
+      - name: collection
+        args:
         - referenceValue: /restaurants
-        name: collection
       - name: search
         options:
           query:
             functionValue:
+              name: document_matches
               args:
               - stringValue: tacos
-              name: document_matches
           sort:
             arrayValue:
               values:
@@ -137,6 +122,14 @@ tests:
                 search_score:
                   functionValue:
                     name: score
+      - name: select
+        args:
+        - mapValue:
+            fields:
+              name:
+                fieldReferenceValue: name
+              search_score:
+                fieldReferenceValue: search_score
 - description: expression_between
   pipeline:
   - Collection: restaurants
@@ -255,28 +248,31 @@ tests:
         - AliasedExpression:
           - Score: []
           - search_score
-  assert_results_approximate:
-  - search_score: 0.5137
-  - search_score: 0.4732
   assert_proto:
     pipeline:
       stages:
-      - args:
+      - name: collection
+        args:
         - referenceValue: /restaurants
-        name: collection
       - name: search
         options:
           query:
             functionValue:
+              name: document_matches
               args:
               - stringValue: tacos
-              name: document_matches
           select:
             mapValue:
               fields:
                 search_score:
                   functionValue:
                     name: score
+  assert_results_approximate:
+    config:
+      absolute_tolerance: 0.99
+    data:
+    - search_score: 1.0
+    - search_score: 1.0
 - description: search_full_document
   pipeline:
   - Collection: restaurants
@@ -458,36 +454,39 @@ tests:
   - Select:
     - name
     - searchScore
-  assert_results_approximate:
-  - name: The Golden Waffle
-    searchScore: 0.5919
   assert_proto:
     pipeline:
       stages:
-      - args:
+      - name: collection
+        args:
         - referenceValue: /restaurants
-        name: collection
       - name: search
         options:
           query:
             functionValue:
+              name: document_matches
               args:
               - stringValue: waffles
-              name: document_matches
           add_fields:
             mapValue:
               fields:
                 searchScore:
                   functionValue:
                     name: score
-      - args:
+      - name: select
+        args:
         - mapValue:
             fields:
               name:
                 fieldReferenceValue: name
               searchScore:
                 fieldReferenceValue: searchScore
-        name: select
+  assert_results_approximate:
+    config:
+      absolute_tolerance: 0.99
+    data:
+    - name: The Golden Waffle
+      searchScore: 1.0
 - description: search_sort_by_score
   pipeline:
   - Collection: restaurants

packages/google-cloud-firestore/tests/system/test_pipeline_acceptance.py

@@ -133,6 +133,29 @@ def test_pipeline_expected_errors(test_dict, client):
     assert match, f"error '{found_error}' does not match '{error_regex}'"
 
 
+
+def _assert_pipeline_results(got_results, expected_results, expected_approximate_results, expected_count):
+    if expected_results:
+        assert got_results == expected_results
+    if expected_approximate_results is not None:
+        tolerance = 1e-4
+        if isinstance(expected_approximate_results, dict) and "data" in expected_approximate_results:
+            if "config" in expected_approximate_results and "absolute_tolerance" in expected_approximate_results["config"]:
+                tolerance = expected_approximate_results["config"]["absolute_tolerance"]
+            expected_approximate_results = expected_approximate_results["data"]
+            
+        assert len(got_results) == len(expected_approximate_results), (
+            "got unexpected result count"
+        )
+        for idx in range(len(got_results)):
+            expected = expected_approximate_results[idx]
+            assert got_results[idx] == pytest.approx(
+                expected, abs=tolerance
+            )
+    if expected_count is not None:
+        assert len(got_results) == expected_count
+
+
 @pytest.mark.parametrize(
     "test_dict",
     [
@@ -158,18 +181,7 @@ def test_pipeline_results(test_dict, client):
     pipeline = parse_pipeline(client, test_dict["pipeline"])
     # check if server responds as expected
     got_results = [snapshot.data() for snapshot in pipeline.stream()]
-    if expected_results:
-        assert got_results == expected_results
-    if expected_approximate_results:
-        assert len(got_results) == len(expected_approximate_results), (
-            "got unexpected result count"
-        )
-        for idx in range(len(got_results)):
-            assert got_results[idx] == pytest.approx(
-                expected_approximate_results[idx], abs=1e-4
-            )
-    if expected_count is not None:
-        assert len(got_results) == expected_count
+    _assert_pipeline_results(got_results, expected_results, expected_approximate_results, expected_count)
     if expected_end_state:
         for doc_path, expected_content in expected_end_state.items():
             doc_ref = client.document(doc_path)
@@ -231,18 +243,7 @@ async def test_pipeline_results_async(test_dict, async_client):
     pipeline = parse_pipeline(async_client, test_dict["pipeline"])
     # check if server responds as expected
     got_results = [snapshot.data() async for snapshot in pipeline.stream()]
-    if expected_results:
-        assert got_results == expected_results
-    if expected_approximate_results:
-        assert len(got_results) == len(expected_approximate_results), (
-            "got unexpected result count"
-        )
-        for idx in range(len(got_results)):
-            assert got_results[idx] == pytest.approx(
-                expected_approximate_results[idx], abs=1e-4
-            )
-    if expected_count is not None:
-        assert len(got_results) == expected_count
+    _assert_pipeline_results(got_results, expected_results, expected_approximate_results, expected_count)
     if expected_end_state:
         for doc_path, expected_content in expected_end_state.items():
             doc_ref = async_client.document(doc_path)