Check if XForm is a MergedXForm and merge field choices if it is(a MergedXForm)

onadata/apps/api/tests/viewsets/test_charts_viewset.py

@@ -3,21 +3,48 @@
 import mock
 
 from django.utils import timezone
+from django.core.cache import cache
 from rest_framework.test import APIClient
 from rest_framework.test import APIRequestFactory
 from rest_framework.test import force_authenticate
 from onadata.apps.api.viewsets.charts_viewset import ChartsViewSet
+from onadata.apps.api.viewsets.merged_xform_viewset import MergedXFormViewSet
 from onadata.apps.main.tests.test_base import TestBase
 from onadata.apps.logger.models.instance import Instance
 from django.db.utils import DataError
 from onadata.libs.utils.timing import calculate_duration
+from onadata.libs.utils.user_auth import get_user_default_project
 from onadata.libs.renderers.renderers import DecimalJSONRenderer
 
 
 def raise_data_error(a):
     raise DataError
 
 
+MD = """
+| survey  |
+|         | type              | name  | label   |
+|         | select one fruits | fruits | Fruit   |
+
+| choices |
+|         | list name         | name   | label  |
+|         | fruits            | orange | Orange |
+|         | fruits            | mango  | Mango  |
+"""
+
+
+MD2 = """
+| survey  |
+|         | type              | name  | label   |
+|         | select one fruits | fruits | Fruit   |
+
+| choices |
+|         | list name         | name   | label  |
+|         | fruits            | apple  | Apple  |
+|         | fruits            | cherries  | Cherries  |
+"""
+
+
 class TestChartsViewSet(TestBase):
 
     def setUp(self):
@@ -47,6 +74,59 @@ def setUp(self):
                 os.path.dirname(__file__), '..', 'fixtures', 'forms',
                 'tutorial', 'instances', '3.xml'))
 
+    def test_correct_merged_dataset_data_for_charts(self):
+        """Return correct data from the charts endpoint"""
+        view = MergedXFormViewSet.as_view({
+            'post': 'create',
+        })
+        # pylint: disable=attribute-defined-outside-init
+        self.project = get_user_default_project(self.user)
+        xform_a = self._publish_markdown(MD, self.user, id_string='a')
+        xform_b = self._publish_markdown(MD2, self.user, id_string='b')
+
+        data = {
+            'xforms': [
+                "http://testserver/api/v1/forms/%s" % xform_a.pk,
+                "http://testserver/api/v1/forms/%s" % xform_b.pk,
+            ],
+            'name':
+            'Merged Dataset',
+            'project':
+            "http://testserver/api/v1/projects/%s" % self.project.pk,
+        }
+        # anonymous user
+        request = self.factory.post('/', data=data)
+        response = view(request)
+        self.assertEqual(response.status_code, 401)
+
+        request = self.factory.post('/', data=data)
+        force_authenticate(request, user=self.user)
+        response = view(request)
+        self.assertEqual(response.status_code, 201)
+
+        # make submission to form a
+        xml = '<data id="b"><fruits>orange mango</fruits></data>'
+        Instance(xform=xform_a, xml=xml).save()
+
+        # make submission to form b
+        xml = '<data id="b"><fruits>apple cherries</fruits></data>'
+        Instance(xform=xform_b, xml=xml).save()
+
+        data = {'field_xpath': 'fruits'}
+        request = self.factory.get('/charts', data=data)
+        force_authenticate(request, user=self.user)
+        response = self.view(
+            request,
+            pk=response.data['id']
+        )
+        self.assertEqual(response.status_code, 200)
+        # check that the data is correct
+        expected_data = [{'fruits': ['Apple', 'Cherries'], 'count': 1},
+                         {'fruits': ['Orange', 'Mango'], 'count': 1}]
+        self.assertEqual(response.data['data'],
+                         expected_data)
+        cache.clear()
+
     def test_duration_field_on_metadata(self):
         # the instance below has valid start and end times
         instance = Instance.objects.all()[0]

onadata/libs/utils/chart_tools.py

@@ -12,6 +12,7 @@
 from rest_framework.exceptions import ParseError
 
 from onadata.apps.logger.models.data_view import DataView
+from onadata.apps.logger.models.merged_xform import MergedXForm
 from onadata.apps.logger.models.xform import XForm
 from onadata.libs.data.query import \
     get_form_submissions_aggregated_by_select_one
@@ -435,6 +436,16 @@ def get_field_label(field, language_index=0):
     return field_label
 
 
+def _get_form_field_from_name_or_xpath(xform, name=None, xpath=None):
+    """
+    Given a name or xpath, get xform field
+    """
+    if name:
+        return get_field_from_field_name(name, xform)
+    elif xpath:
+        return get_field_from_field_xpath(xpath, xform)
+
+
 def get_chart_data_for_field(field_name,
                              xform,
                              accepted_format,
@@ -446,9 +457,6 @@ def get_chart_data_for_field(field_name,
     """
     data = {}
 
-    if field_name:
-        field = get_field_from_field_name(field_name, xform)
-
     if group_by:
         if len(group_by.split(',')) > 1:
             group_by = [
@@ -458,10 +466,22 @@ def get_chart_data_for_field(field_name,
         else:
             group_by = get_field_from_field_xpath(group_by, xform)
 
-    if field_xpath:
-        field = get_field_from_field_xpath(field_xpath, xform)
+    field = _get_form_field_from_name_or_xpath(xform,
+                                               name=field_name,
+                                               xpath=field_xpath)
 
     choices = get_field_choices(field, xform)
+    # check if xform is a MergedXForm and if it is, merge the field's choices
+    if xform.is_merged_dataset:
+        merged_xform = MergedXForm.objects.get(pk=xform.pk)
+        children = []
+        for xform in merged_xform.xforms.all():
+            form_field = _get_form_field_from_name_or_xpath(xform,
+                                                            name=field_name,
+                                                            xpath=field_xpath)
+            children += form_field.children
+        field.children = children
+        xform = merged_xform
 
     try:
         data = build_chart_data_for_field(