def test_all_media_report_module(self):
"""
Report Modules support media
"""
from corehq.apps.userreports.tests.utils import get_sample_report_config
app = Application.new_app('domain', "Untitled Application")
report_module = app.add_module(ReportModule.new_module('Reports', None))
report_module.unique_id = 'report_module'
report = get_sample_report_config()
report._id = 'd3ff18cd83adf4550b35db8d391f6008'
report_app_config = ReportAppConfig(report_id=report._id,
header={'en': 'CommBugz'},
complete_graph_configs={
chart.chart_id: GraphConfiguration(
series=[GraphSeries() for c in chart.y_axis_columns],
)
for chart in report.charts
})
report_app_config._report = report
report_module.report_configs = [report_app_config]
report_module._loaded = True
image_path = 'jr://file/commcare/case_list_image.jpg'
audio_path = 'jr://file/commcare/case_list_audo.mp3'
app.get_module(0).media_image.update({'en': image_path})
app.get_module(0).media_audio.update({'en': audio_path})
self.assertTrue(app.get_module(0).uses_media())
self.assertEqual(len(app.all_media()), 2)
def setUpClass(cls):
super(ReportFiltersSuiteTest, cls).setUpClass()
delete_all_users()
cls.report_id = '7b97e8b53d00d43ca126b10093215a9d'
cls.report_config_uuid = 'a98c812873986df34fd1b4ceb45e6164ae9cc664'
cls.domain = 'report-filter-test-domain'
cls.user = create_restore_user(
domain=cls.domain,
username='******',
)
update_toggle_cache(MOBILE_UCR.slug, cls.domain, True, NAMESPACE_DOMAIN)
report_configuration = cls.make_report_config(cls.domain, cls.report_id)
cls.report_configs_by_id = {
cls.report_id: report_configuration
}
cls.app = Application.new_app(cls.domain, "Report Filter Test App")
module = cls.app.add_module(ReportModule.new_module("Report Module", 'en'))
module.report_configs.append(
ReportAppConfig(
report_id=cls.report_id,
header={},
description="",
complete_graph_configs={
'7451243209119342931': GraphConfiguration(
graph_type="bar",
series=[GraphSeries(
config={},
locale_specific_config={},
data_path="",
x_function="",
y_function="",
)],
)
},
filters={
'computed_owner_name_40cc88a0_1': MobileSelectFilter(),
'fav_fruit_abc123_1': MobileSelectFilter()
},
uuid=cls.report_config_uuid,
)
)
with mock_report_configurations(cls.report_configs_by_id):
cls.suite = cls.app.create_suite()
cls.data = [
{'color_94ec39e6': 'red', 'count': 2, 'computed_owner_name_40cc88a0': 'cory', 'fav_fruit_abc123': 'c'},
{'color_94ec39e6': 'black', 'count': 1, 'computed_owner_name_40cc88a0': 'ctsims', 'fav_fruit_abc123': 'b'},
{'color_94ec39e6': 'red', 'count': 3, 'computed_owner_name_40cc88a0': 'daniel', 'fav_fruit_abc123': 'b'},
]
with mock_report_data(cls.data):
with mock_report_configuration_get(cls.report_configs_by_id):
with mock.patch('corehq.apps.app_manager.fixtures.mobile_ucr.get_apps_in_domain',
lambda domain, include_remote: [cls.app]):
with mock_sql_backend():
with mock_datasource_config():
fixture, = call_fixture_generator(report_fixture_generator, cls.user)
cls.fixture = ElementTree.tostring(fixture)
def _get_graph_fields():
from corehq.apps.userreports.reports.specs import MultibarChartSpec
from corehq.apps.app_manager.models import GraphConfiguration, GraphSeries
def _locale_config(key):
return id_strings.mobile_ucr_configuration(module, config.uuid,
key)
def _locale_series_config(index, key):
return id_strings.mobile_ucr_series_configuration(
module, config.uuid, index, key)
def _locale_annotation(index):
return id_strings.mobile_ucr_annotation(module, config.uuid, index)
for chart_config in config.report(domain).charts:
if isinstance(chart_config, MultibarChartSpec):
graph_config = config.complete_graph_configs.get(
chart_config.chart_id,
GraphConfiguration(series=[
GraphSeries() for c in chart_config.y_axis_columns
], ))
# Reconcile graph_config.series with any additions/deletions in chart_config.y_axis_columns
while len(chart_config.y_axis_columns) > len(
graph_config.series):
graph_config.series.append(GraphSeries())
if len(chart_config.y_axis_columns) < len(graph_config.series):
graph_config.series = graph_config.series[:len(
chart_config.y_axis_columns)]
for index, column in enumerate(chart_config.y_axis_columns):
graph_config.series[index].data_path = (
graph_config.series[index].data_path or get_data_path(
config, domain, new_mobile_ucr_restore))
graph_config.series[index].x_function = (
graph_config.series[index].x_function
or _get_column_xpath_template(new_mobile_ucr_restore).
format(chart_config.x_axis_column))
graph_config.series[index].y_function = (
graph_config.series[index].y_function
or _get_column_xpath_template(
new_mobile_ucr_restore).format(column.column_id))
yield Field(header=Header(text=Text()),
template=GraphTemplate.build(
'graph',
graph_config,
locale_config=_locale_config,
locale_series_config=_locale_series_config,
locale_annotation=_locale_annotation))
def _get_graph_fields():
from corehq.apps.userreports.reports.specs import MultibarChartSpec
from corehq.apps.app_manager.models import GraphConfiguration, GraphSeries
def _locale_config(key):
return id_strings.mobile_ucr_configuration(module, config.uuid,
key)
def _locale_series_config(index, key):
return id_strings.mobile_ucr_series_configuration(
module, config.uuid, index, key)
def _locale_annotation(index):
return id_strings.mobile_ucr_annotation(module, config.uuid, index)
for chart_config in config.report(domain).charts:
if isinstance(chart_config, MultibarChartSpec):
graph_config = config.complete_graph_configs.get(
chart_config.chart_id,
GraphConfiguration(series=[
GraphSeries() for c in chart_config.y_axis_columns
], ))
for index, column in enumerate(chart_config.y_axis_columns):
graph_config.series[index].data_path = (
graph_config.series[index].data_path
or get_data_path(config, domain))
graph_config.series[index].x_function = (
graph_config.series[index].x_function
or COLUMN_XPATH_TEMPLATE.format(
chart_config.x_axis_column))
graph_config.series[index].y_function = (
graph_config.series[index].y_function
or COLUMN_XPATH_TEMPLATE.format(column.column_id))
yield Field(header=Header(text=Text()),
template=GraphTemplate.build(
'graph',
graph_config,
locale_config=_locale_config,
locale_series_config=_locale_series_config,
locale_annotation=_locale_annotation))
def setUpClass(cls):
super(ReportFiltersSuiteTest, cls).setUpClass()
delete_all_users()
cls.report_id = '7b97e8b53d00d43ca126b10093215a9d'
cls.report_config_mobile_id = 'a98c812873986df34fd1b4ceb45e6164ae9cc664'
cls.domain = 'report-filter-test-domain'
create_domain(cls.domain)
cls.user = create_restore_user(
domain=cls.domain,
username='******',
)
MOBILE_UCR.set(cls.domain, True, NAMESPACE_DOMAIN)
ADD_ROW_INDEX_TO_MOBILE_UCRS.set(cls.domain, True, NAMESPACE_DOMAIN)
report_configuration = cls.make_report_config(cls.domain, cls.report_id)
# also make a report with a hidden column
cls.hidden_column_report_id = 'bd2a43018ad9463682165c1bc16347ac'
cls.hidden_column_mobile_id = '45152061d8dc4d2a8d987a0568abe1ae'
report_configuration_with_hidden_column = MAKE_REPORT_CONFIG(
cls.domain,
cls.hidden_column_report_id,
columns=[
FieldColumn(
type='field',
aggregation="simple",
column_id="color_94ec39e6",
display="color",
field="color_94ec39e6"
).to_json(),
FieldColumn(
type='field',
aggregation="simple",
column_id="hidden_color_94ec39e6",
display="color",
field="color_94ec39e6",
visible=False,
).to_json(),
]
)
cls.report_configs_by_id = {
cls.report_id: report_configuration,
cls.hidden_column_report_id: report_configuration_with_hidden_column
}
cls.app = Application.new_app(cls.domain, "Report Filter Test App")
report_module = cls.app.add_module(ReportModule.new_module("Report Module", 'en'))
report_module.report_context_tile = True
report_module.report_configs.append(
ReportAppConfig(
report_id=cls.report_id,
header={},
description="",
complete_graph_configs={
'7451243209119342931': GraphConfiguration(
graph_type="bar",
series=[GraphSeries(
config={},
locale_specific_config={},
data_path="",
x_function="",
y_function="",
)],
)
},
filters=OrderedDict([
('fav_fruit_abc123_1', MobileSelectFilter()),
('computed_owner_name_40cc88a0_1', MobileSelectFilter()),
]),
uuid=cls.report_config_mobile_id,
)
)
report_module.report_configs.append(
ReportAppConfig(
report_id=cls.hidden_column_report_id,
header={},
description="",
complete_graph_configs={},
filters={},
uuid=cls.hidden_column_mobile_id,
)
)
case_module = cls.app.add_module(Module.new_module("Case Module", 'en'))
case_module.case_type = "fish"
case_module.report_context_tile = True
case_form = case_module.new_form("Update Fish", None)
case_form.requires = "case"
case_form.xmlns = "http://openrosa.org/formdesigner/2423EFB5-2E8C-4B8F-9DA0-23FFFD4391AF"
survey_module = cls.app.add_module(Module.new_module("Survey Module", 'en'))
survey_module.report_context_tile = True
survey_form = survey_module.new_form("Survey", None)
survey_form.xmlns = "http://openrosa.org/formdesigner/2423EFB5-2E8C-4B8F-9DA0-23FFFD4391AE"
with mock_report_configurations(cls.report_configs_by_id):
cls.suite = cls.app.create_suite()
cls.data = [
{'color_94ec39e6': 'red', 'count': 2, 'computed_owner_name_40cc88a0': 'cory', 'fav_fruit_abc123': 'c'},
{'color_94ec39e6': 'black', 'count': 1, 'computed_owner_name_40cc88a0': 'ctsims', 'fav_fruit_abc123': 'b'},
{'color_94ec39e6': 'red', 'count': 3, 'computed_owner_name_40cc88a0': 'daniel', 'fav_fruit_abc123': 'b'},
]
with mock_report_data(cls.data):
with mock_report_configuration_get(cls.report_configs_by_id):
with mock.patch('corehq.apps.app_manager.fixtures.mobile_ucr.get_apps_in_domain',
lambda domain, include_remote: [cls.app]):
with mock_datasource_config():
fixtures = call_fixture_generator(report_fixture_generator, cls.user)
fixture = [f for f in fixtures if f.attrib.get('id') == ReportFixturesProviderV1.id][0]
cls.fixture = ElementTree.tostring(fixture, encoding='utf-8')
def test_report_module(self, *args):
from corehq.apps.userreports.tests.utils import get_sample_report_config
app = Application.new_app('domain', "Untitled Application")
report = get_sample_report_config()
report._id = 'd3ff18cd83adf4550b35db8d391f6008'
report_app_config = ReportAppConfig(
report_id=report._id,
header={'en': 'CommBugz'},
uuid='ip1bjs8xtaejnhfrbzj2r6v1fi6hia4i',
xpath_description='"report description"',
use_xpath_description=True,
complete_graph_configs={
chart.chart_id: GraphConfiguration(
graph_type="bar",
series=[GraphSeries() for c in chart.y_axis_columns],
)
for chart in report.charts
},
)
report_app_config._report = report
report_module = app.add_module(ReportModule.new_module('Reports', None))
report_module.unique_id = 'report_module'
report_module.report_configs = [report_app_config]
report_module._loaded = True
self.assertXmlPartialEqual(
self.get_xml('reports_module_menu'),
app.create_suite(),
"./menu",
)
app.multimedia_map = {
"jr://file/commcare/image/module0_en.png": HQMediaMapItem(
multimedia_id='bb4472b4b3c702f81c0b208357eb22f8',
media_type='CommCareImage',
unique_id='fe06454697634053cdb75fd9705ac7e6',
),
}
report_module.media_image = {
'en': 'jr://file/commcare/image/module0_en.png',
}
report_module.get_details.reset_cache(report_module)
actual_suite = app.create_suite()
self.assertXmlPartialEqual(
self.get_xml('reports_module_menu_multimedia'),
actual_suite,
"./menu",
)
self.assertXmlPartialEqual(
self.get_xml('reports_module_select_detail'),
actual_suite,
"./detail[@id='reports.ip1bjs8xtaejnhfrbzj2r6v1fi6hia4i.select']",
)
self.assertXmlPartialEqual(
self.get_xml('reports_module_summary_detail_use_xpath_description'),
actual_suite,
"./detail[@id='reports.ip1bjs8xtaejnhfrbzj2r6v1fi6hia4i.summary']",
)
self.assertXmlPartialEqual(
self.get_xml('reports_module_data_detail'),
actual_suite,
"./detail/detail[@id='reports.ip1bjs8xtaejnhfrbzj2r6v1fi6hia4i.data']",
)
report_app_config.show_data_table = False
report_module.get_details.reset_cache(report_module)
self.assertXmlPartialEqual(
self.get_xml('reports_module_summary_detail_hide_data_table'),
app.create_suite(),
"./detail[@id='reports.ip1bjs8xtaejnhfrbzj2r6v1fi6hia4i.summary']",
)
report_app_config.show_data_table = True
report_module.get_details.reset_cache(report_module)
self.assertXmlPartialEqual(
self.get_xml('reports_module_data_entry'),
app.create_suite(),
"./entry",
)
self.assertIn(
'reports.ip1bjs8xtaejnhfrbzj2r6v1fi6hia4i=CommBugz',
app.create_app_strings('default'),
)
report_app_config.use_xpath_description = False
report_module.get_details.reset_cache(report_module)
self.assertXmlPartialEqual(
self.get_xml('reports_module_summary_detail_use_localized_description'),
app.create_suite(),
"./detail[@id='reports.ip1bjs8xtaejnhfrbzj2r6v1fi6hia4i.summary']",
)
# Tuple mapping translation formats to the expected output of each
translation_formats = [
({
'एक': {
'en': 'one',
'es': 'uno',
},
'2': {
'en': 'two',
'es': 'dos\'',
'hin': 'दो',
},
}, 'reports_module_data_detail-translated'),
({
'एक': 'one',
'2': 'two',
}, 'reports_module_data_detail-translated-simple'),
({
'एक': {
'en': 'one',
'es': 'uno',
},
'2': 'two',
}, 'reports_module_data_detail-translated-mixed'),
]
for translation_format, expected_output in translation_formats:
report_app_config._report.columns[0]['transform'] = {
'type': 'translation',
'translations': translation_format,
}
report_app_config._report = ReportConfiguration.wrap(report_app_config._report._doc)
report_module.get_details.reset_cache(report_module)
self.assertXmlPartialEqual(
self.get_xml(expected_output),
app.create_suite(),
"./detail/detail[@id='reports.ip1bjs8xtaejnhfrbzj2r6v1fi6hia4i.data']",
)
def setUpClass(cls):
super(ReportFiltersSuiteTest, cls).setUpClass()
delete_all_users()
cls.report_id = '7b97e8b53d00d43ca126b10093215a9d'
cls.report_config_mobile_id = 'a98c812873986df34fd1b4ceb45e6164ae9cc664'
cls.domain = 'report-filter-test-domain'
create_domain(cls.domain)
cls.user = create_restore_user(
domain=cls.domain,
username='******',
)
MOBILE_UCR.set(cls.domain, True, NAMESPACE_DOMAIN)
report_configuration = cls.make_report_config(cls.domain,
cls.report_id)
# also make a report with a hidden column
cls.hidden_column_report_id = 'bd2a43018ad9463682165c1bc16347ac'
cls.hidden_column_mobile_id = '45152061d8dc4d2a8d987a0568abe1ae'
report_configuration_with_hidden_column = MAKE_REPORT_CONFIG(
cls.domain,
cls.hidden_column_report_id,
columns=[
FieldColumn(type='field',
aggregation="simple",
column_id="color_94ec39e6",
display="color",
field="color_94ec39e6").to_json(),
FieldColumn(
type='field',
aggregation="simple",
column_id="hidden_color_94ec39e6",
display="color",
field="color_94ec39e6",
visible=False,
).to_json(),
])
cls.report_configs_by_id = {
cls.report_id: report_configuration,
cls.hidden_column_report_id:
report_configuration_with_hidden_column
}
cls.app = Application.new_app(cls.domain, "Report Filter Test App")
module = cls.app.add_module(
ReportModule.new_module("Report Module", 'en'))
module.report_configs.append(
ReportAppConfig(
report_id=cls.report_id,
header={},
description="",
complete_graph_configs={
'7451243209119342931':
GraphConfiguration(
graph_type="bar",
series=[
GraphSeries(
config={},
locale_specific_config={},
data_path="",
x_function="",
y_function="",
)
],
)
},
filters=OrderedDict([
('fav_fruit_abc123_1', MobileSelectFilter()),
('computed_owner_name_40cc88a0_1', MobileSelectFilter()),
]),
uuid=cls.report_config_mobile_id,
))
module.report_configs.append(
ReportAppConfig(
report_id=cls.hidden_column_report_id,
header={},
description="",
complete_graph_configs={},
filters={},
uuid=cls.hidden_column_mobile_id,
))
with mock_report_configurations(cls.report_configs_by_id):
cls.suite = cls.app.create_suite()
cls.data = [
{
'color_94ec39e6': 'red',
'count': 2,
'computed_owner_name_40cc88a0': 'cory',
'fav_fruit_abc123': 'c'
},
{
'color_94ec39e6': 'black',
'count': 1,
'computed_owner_name_40cc88a0': 'ctsims',
'fav_fruit_abc123': 'b'
},
{
'color_94ec39e6': 'red',
'count': 3,
'computed_owner_name_40cc88a0': 'daniel',
'fav_fruit_abc123': 'b'
},
]
with mock_report_data(cls.data):
with mock_report_configuration_get(cls.report_configs_by_id):
with mock.patch(
'corehq.apps.app_manager.fixtures.mobile_ucr.get_apps_in_domain',
lambda domain, include_remote: [cls.app]):
with mock_datasource_config():
fixture, = call_fixture_generator(
report_fixture_generator, cls.user)
cls.fixture = ElementTree.tostring(fixture)
