PYCBC-1930: Raise on an option value the getter cannot interpret

Changes
--------
* Raise InvalidArgumentException from the six request-option getters
  that handled None and str and then fell off the end, returning None
  from a signature declaring a non-optional enum: consistency, order and
  on_error on the view query, consistency and profile on the query, and
  consistency on the search builder
* Raise from ViewScanConsistency.from_str, which returned None for any
  string it did not recognise, matching QueryStatus.from_str
* Add tests to the view, query and search param suites driving an
  uninterpretable value in through set_option, which does no
  verification, and reading the property back

Change-Id: I1f8b6138b8d1e7dc6ee449d953381290ca1d58b1
Reviewed-on: https://review.couchbase.org/c/couchbase-python-client/+/252044
Reviewed-by: Sergey Avseyev <sergey.avseyev@gmail.com>
Tested-by: Build Bot <build@couchbase.com>

Author: thejcfactor

couchbase/logic/n1ql.py

@@ -444,6 +444,9 @@ def consistency(self) -> QueryScanConsistency:
             return QueryScanConsistency.NOT_BOUNDED
         if isinstance(value, str):
             return QueryScanConsistency.REQUEST_PLUS if value == 'request_plus' else QueryScanConsistency.NOT_BOUNDED
+        raise InvalidArgumentException(
+            message=(f"{value} is not a valid QueryScanConsistency option. "
+                     "Expected str representation of type QueryScanConsistency."))
 
     @consistency.setter
     def consistency(self, value  # type: Union[QueryScanConsistency, str]
@@ -559,6 +562,9 @@ def profile(self) -> QueryProfile:
                 return QueryProfile.PHASES
             else:
                 return QueryProfile.TIMINGS
+        raise InvalidArgumentException(
+            message=(f"{value} is not a valid QueryProfile option. "
+                     "Expected str representation of type QueryProfile."))
 
     @profile.setter
     def profile(self, value  # type: Union[QueryProfile, str]

couchbase/logic/search.py

@@ -1150,6 +1150,9 @@ def consistency(self) -> SearchScanConsistency:
             return SearchScanConsistency.NOT_BOUNDED
         if isinstance(value, str):
             return SearchScanConsistency.REQUEST_PLUS if value == 'request_plus' else SearchScanConsistency.NOT_BOUNDED
+        raise InvalidArgumentException(
+            message=(f"{value} is not a valid SearchScanConsistency option. "
+                     "Expected str representation of type SearchScanConsistency."))
 
     @consistency.setter
     def consistency(self, value  # type: Union[SearchScanConsistency, str]

couchbase/logic/views.py

@@ -60,6 +60,9 @@ def from_str(cls, value: str) -> ViewScanConsistency:
             return cls.NOT_BOUNDED
         elif value == 'update_after':
             return cls.UPDATE_AFTER
+        raise InvalidArgumentException(
+            message=(f"{value} is not a valid ViewScanConsistency option. "
+                     "Expected str representation of type ViewScanConsistency."))
 
 
 class ViewOrdering(Enum):
@@ -237,6 +240,9 @@ def consistency(self) -> ViewScanConsistency:
             return ViewScanConsistency.NOT_BOUNDED
         if isinstance(value, str):
             return ViewScanConsistency.from_str(value)
+        raise InvalidArgumentException(
+            message=(f"{value} is not a valid ViewScanConsistency option. "
+                     "Expected str representation of type ViewScanConsistency."))
 
     @consistency.setter
     def consistency(self, value  # type: Union[ViewScanConsistency, str]
@@ -352,6 +358,9 @@ def order(self) -> ViewOrdering:
             return ViewOrdering.DESCENDING
         if isinstance(value, str):
             return ViewOrdering.from_str(value)
+        raise InvalidArgumentException(
+            message=(f"{value} is not a valid ViewOrdering option. "
+                     "Expected str representation of type ViewOrdering."))
 
     @order.setter
     def order(self, value  # type: Union[ViewOrdering, str]
@@ -374,6 +383,9 @@ def on_error(self) -> ViewErrorMode:
             return ViewErrorMode.STOP
         if isinstance(value, str):
             return ViewErrorMode.from_str(value)
+        raise InvalidArgumentException(
+            message=(f"{value} is not a valid ViewErrorMode option. "
+                     "Expected str representation of type ViewErrorMode."))
 
     @on_error.setter
     def on_error(self, value  # type: Union[ViewErrorMode, str]

couchbase/tests/query_params_t.py

@@ -48,6 +48,7 @@ class QueryParamTestSuite:
         'test_params_scan_wait',
         'test_params_serializer',
         'test_params_timeout',
+        'test_params_uninterpretable_enum_option',
         'test_params_use_replica',
     ]
 
@@ -313,6 +314,14 @@ def test_params_serializer(self, base_opts):
         exp_opts['serializer'] = serializer
         assert query.params == exp_opts
 
+    def test_params_uninterpretable_enum_option(self):
+        # set_option does no verification, so the getter is where an unusable value surfaces
+        for option, prop in (('scan_consistency', 'consistency'), ('profile', 'profile')):
+            query = N1QLQuery.create_query_object('SELECT * FROM default', QueryOptions())
+            query.set_option(option, 5)
+            with pytest.raises(InvalidArgumentException):
+                getattr(query, prop)
+
     def test_params_timeout(self, base_opts):
         q_str = 'SELECT * FROM default'
         q_opts = QueryOptions(timeout=timedelta(seconds=20))

couchbase/tests/search_params_t.py

@@ -64,6 +64,7 @@ class SearchParamTestSuite:
         'test_params_limit',
         'test_params_logging',
         'test_params_scan_consistency',
+        'test_params_uninterpretable_enum_option',
         'test_params_scope_collections',
         'test_params_serializer',
         'test_params_show_request',
@@ -941,6 +942,16 @@ def test_params_scan_consistency(self, cb_env, base_query_opts):
         assert search_query.params == exp_opts
         assert search_query.consistency == search.SearchScanConsistency.REQUEST_PLUS
 
+    def test_params_uninterpretable_enum_option(self, cb_env, base_query_opts):
+        # set_option does no verification, so the getter is where an unusable value surfaces
+        q, _ = base_query_opts
+        search_query = search.SearchQueryBuilder.create_search_query_object(
+            cb_env.TEST_INDEX_NAME, q, SearchOptions()
+        )
+        search_query.set_option('scan_consistency', 5)
+        with pytest.raises(InvalidArgumentException):
+            search_query.consistency
+
     def test_params_scope_collections(self, cb_env, base_query_opts):
         q, base_opts = base_query_opts
         opts = SearchOptions(scope_name='test-scope', collections=['test-collection-1', 'test-collection-2'])

couchbase/tests/views_params_t.py

@@ -18,6 +18,7 @@
 
 import pytest
 
+from couchbase.exceptions import InvalidArgumentException
 from couchbase.management.views import DesignDocumentNamespace
 from couchbase.options import ViewOptions
 from couchbase.serializer import DefaultJsonSerializer
@@ -52,6 +53,7 @@ class ViewsParamSuite:
         'test_params_startkey',
         'test_params_startkey_docid',
         'test_params_timeout',
+        'test_params_uninterpretable_enum_option',
     ]
 
     @pytest.fixture(scope='class')
@@ -209,6 +211,17 @@ def test_params_scan_consistency(self, cb_env, base_opts):
         assert params == exp_opts
         assert query.consistency == ViewScanConsistency.REQUEST_PLUS
 
+    def test_params_uninterpretable_enum_option(self, cb_env, base_opts):
+        # set_option does no verification, so the getter is where an unusable value surfaces
+        for option, prop in (('scan_consistency', 'consistency'), ('order', 'order'), ('on_error', 'on_error')):
+            query = ViewQuery.create_view_query_object('default', cb_env.DOCNAME, cb_env.TEST_VIEW_NAME)
+            query.set_option(option, 5)
+            with pytest.raises(InvalidArgumentException):
+                getattr(query, prop)
+
+        with pytest.raises(InvalidArgumentException):
+            ViewScanConsistency.from_str('not_a_scan_consistency')
+
     def test_params_serializer(self, cb_env, base_opts):
         serializer = DefaultJsonSerializer()
         opts = ViewOptions(serializer=serializer)