jimfuqian/BB2-3887 Added search parameter _tag for EOB (#1332)

* added search param _tag

* added unittests coverage.

* address feedback, having issue with switch check (WIP)

* refactor the custom validator to address error during migration...

Author: JFU-NAVA-PBC

apps/core/management/commands/create_test_feature_switches.py

@@ -16,6 +16,7 @@
     ("splunk_monitor", False, "This is used in other environments to ensure splunk forwarder is running."),
     ("testclient_v2", True, "This enables the v2 auth links in the test client"),
     ("wellknown_applications", True, "This enables the /.well-known/applications end-point. Active in prod, but not in sbx/test."),
+    ("bfd_v3_connectathon", True, "This enables the bfd v3 features for connectathon demo"),
 )
 
 WAFFLE_FEATURE_FLAGS = (

apps/fhir/bluebutton/tests/test_fhir_resources_read_search_w_validation.py

@@ -4,6 +4,7 @@
 from django.urls import reverse
 from httmock import all_requests, HTTMock
 from oauth2_provider.models import get_access_token_model
+from waffle.testutils import override_switch
 
 from apps.test import BaseApiTest
 
@@ -154,6 +155,67 @@ def catchall(url, req):
             for r in response.json()['entry']:
                 self._assertHasC4BBIdentifier(r['resource'], C4BB_SYSTEM_TYPES['IDTYPE'], v2)
 
+    @override_switch('bfd_v3_connectathon', active=True)
+    def test_search_eob_by_parameter_tag(self):
+        self._search_eob_by_parameter_tag(False)
+
+    @override_switch('bfd_v3_connectathon', active=True)
+    def test_search_eob_by_parameter_tag_v2(self):
+        self._search_eob_by_parameter_tag(True)
+
+    @override_switch('bfd_v3_connectathon', active=True)
+    def _search_eob_by_parameter_tag(self, v2=False):
+        # create the user
+        first_access_token = self.create_token('John', 'Smith')
+        ac = AccessToken.objects.get(token=first_access_token)
+        ac.scope = 'patient/ExplanationOfBenefit.read'
+        ac.save()
+        ver = 'v1' if not v2 else 'v2'
+
+        @all_requests
+        def catchall_w_tag_qparam(url, req):
+            # this is called in case EOB search with good tag
+            self.assertIn("https://fhir.backend.bluebutton.hhsdevcloud.us/{}/fhir/ExplanationOfBenefit/".format(ver), req.url)
+            self.assertIn("_format=application%2Fjson%2Bfhir", req.url)
+            # parameters encoded in prepared request's body
+            self.assertTrue(("_tag=Adjudicated" in req.body) or ("_tag=PartiallyAdjudicated" in req.body))
+
+            return {
+                'status_code': 200,
+                'content': get_response_json("eob_search_pt_{}".format(ver)),
+            }
+
+        @all_requests
+        def catchall(url, req):
+            self.assertIn("https://fhir.backend.bluebutton.hhsdevcloud.us/{}/fhir/ExplanationOfBenefit/".format(ver), req.url)
+            self.assertIn("_format=application%2Fjson%2Bfhir", req.url)
+
+            return {
+                'status_code': 200,
+                'content': get_response_json("eob_search_pt_{}".format(ver)),
+            }
+        # Test _tag with valid parameter value e.g. Adjudicated, PartiallyAdjudicated
+        with HTTMock(catchall_w_tag_qparam):
+            response = self.client.get(
+                reverse('bb_oauth_fhir_eob_search' if not v2 else 'bb_oauth_fhir_eob_search_v2'),
+                {'_tag': 'Adjudicated'},
+                Authorization="Bearer %s" % (first_access_token))
+            # just check for 200 is sufficient
+            self.assertEqual(response.status_code, 200)
+
+        # Test _tag with invalid parameter value e.g.: Adjudiacted-Typo
+        with HTTMock(catchall):
+            response = self.client.get(
+                reverse('bb_oauth_fhir_eob_search' if not v2 else 'bb_oauth_fhir_eob_search_v2'),
+                {'_tag': 'Adjudiacted-Typo'},
+                Authorization="Bearer %s" % (first_access_token))
+
+            content = json.loads(response.content.decode("utf-8"))
+            self.assertTrue(content['detail'].startswith("Invalid _tag value ("))
+            self.assertTrue(content['detail'].endswith("'PartiallyAdjudicated' or 'Adjudicated' expected."))
+            self.assertTrue('Adjudiacted-Typo' in content['detail'])
+            self.assertEqual(response.status_code, 400)
+
     def test_search_eob_by_parameters_request(self):
         self._search_eob_by_parameters_request(False)
 

apps/fhir/bluebutton/views/search.py

@@ -1,10 +1,13 @@
+import waffle
+
 from voluptuous import (
     Required,
     All,
     Match,
     Range,
     Coerce,
     Schema,
+    Invalid,
     REMOVE_EXTRA,
 )
 from rest_framework import (permissions)
@@ -105,6 +108,16 @@ def build_parameters(self, request, *args, **kwargs):
 
 
 class SearchViewExplanationOfBenefit(SearchView):
+    # customized validator for better error reporting
+    def validate_tag(self):
+        def validator(value):
+            for v in value:
+                if not (v in ["Adjudicated", "PartiallyAdjudicated"]):
+                    msg = f"Invalid _tag value (='{v}'), 'PartiallyAdjudicated' or 'Adjudicated' expected."
+                    raise Invalid(msg)
+            return value
+        return validator
+
     # Class used for ExplanationOfBenefit resource search view
     required_scopes = ['patient/ExplanationOfBenefit.read', 'patient/ExplanationOfBenefit.rs', 'patient/ExplanationOfBenefit.s']
 
@@ -136,7 +149,7 @@ class SearchViewExplanationOfBenefit(SearchView):
     # Add type parameter to schema only for EOB
     QUERY_SCHEMA = {**SearchView.QUERY_SCHEMA,
                     'type': Match(REGEX_TYPE_VALUES_LIST, msg="the type parameter value is not valid"),
-                    'service-date': [Match(REGEX_SERVICE_DATE_VALUE, msg="the service-date operator is not valid")]
+                    'service-date': [Match(REGEX_SERVICE_DATE_VALUE, msg="the service-date operator is not valid")],
                     }
 
     def __init__(self, version=1):
@@ -158,7 +171,15 @@ def filter_parameters(self, request):
         if service_dates:
             params['service-date'] = service_dates
 
+        query_schema = getattr(self, "QUERY_SCHEMA", {})
+
+        if waffle.switch_is_active('bfd_v3_connectathon'):
+            query_schema['_tag'] = self.validate_tag()
+            # _tag if presents, is a string value
+            params['_tag'] = request.query_params.getlist('_tag')
+
         schema = Schema(
-            getattr(self, "QUERY_SCHEMA", {}),
+            query_schema,
             extra=REMOVE_EXTRA)
+
         return schema(params)