def test_case_list_form_parent_child_basic(self):
"""
* Register house (case type = house, basic)
* Register house form
* Register person (case type = person, parent select = 'Register house', basic)
* Register person form
* Manager person (case type = person, case list form = 'Register person form', basic)
* Manage person form
"""
factory = AppFactory(build_version='2.9')
register_house_module, register_house_form = factory.new_basic_module(
'register_house', 'house')
factory.form_opens_case(register_house_form)
register_person_module, register_person_form = factory.new_basic_module(
'register_person', 'house')
factory.form_requires_case(register_person_form)
factory.form_opens_case(register_person_form,
case_type='person',
is_subcase=True)
person_module, update_person_form = factory.new_basic_module(
'update_person', 'person', case_list_form=register_person_form)
factory.form_requires_case(update_person_form,
parent_case_type='house')
self.assertXmlEqual(
self.get_xml('case-list-form-suite-parent-child-basic'),
factory.app.create_suite())
def test_case_list_form_parent_child_basic(self):
# * Register house (case type = house, basic)
# * Register house form
# * Register person (case type = person, parent select = 'Register house', basic)
# * Register person form
# * Manager person (case type = person, case list form = 'Register person form', basic)
# * Manage person form
factory = AppFactory(build_version='2.9')
register_house_module, register_house_form = factory.new_basic_module('register_house', 'house')
factory.form_opens_case(register_house_form)
register_person_module, register_person_form = factory.new_basic_module('register_person', 'house')
factory.form_requires_case(register_person_form)
factory.form_opens_case(register_person_form, case_type='person', is_subcase=True)
person_module, update_person_form = factory.new_basic_module(
'update_person',
'person',
case_list_form=register_person_form
)
factory.form_requires_case(update_person_form, parent_case_type='house')
register_person_module.case_details.short.columns.append(
DetailColumn(
header={'en': 'a'},
model='case',
field='parent/case_name', # Include a parent case property in the case list
format='plain',
)
)
self.assertXmlEqual(self.get_xml('case-list-form-suite-parent-child-basic'), factory.app.create_suite())
class FormFilterErrorTests(SimpleTestCase, TestXmlMixin):
file_path = ('data', 'suite')
def setUp(self):
self.suite_xml_is_usercase_in_use_patch = patch(
'corehq.apps.app_manager.suite_xml.sections.menus.is_usercase_in_use'
)
self.suite_xml_is_usercase_in_use_mock = self.suite_xml_is_usercase_in_use_patch.start()
self.factory = AppFactory(build_version='2.9')
def tearDown(self):
self.suite_xml_is_usercase_in_use_patch.stop()
def test_error_when_no_case(self):
self.suite_xml_is_usercase_in_use_mock.return_value = True
__, reg_form = self.factory.new_basic_module('reg_module', 'mother')
self.factory.form_opens_case(reg_form)
reg_form.form_filter = './due_date <= today()'
with self.assertRaises(CaseXPathValidationError):
self.factory.app.create_suite()
def test_no_error_when_user_case(self):
self.suite_xml_is_usercase_in_use_mock.return_value = True
__, reg_form = self.factory.new_basic_module('reg_module', 'mother')
self.factory.form_opens_case(reg_form)
reg_form.form_filter = '#user/due_date <= today()'
expected = """
<partial>
<menu id="m0">
<text>
<locale id="modules.m0"/>
</text>
<command id="m0-f0" relevant="instance('casedb')/casedb/case[@case_type='commcare-user'][hq_user_id=instance('commcaresession')/session/context/userid]/due_date <= today()"/>
</menu>
</partial>
"""
self.assertXmlPartialEqual(expected, self.factory.app.create_suite(), './menu')
def test_no_error_when_case(self):
self.suite_xml_is_usercase_in_use_mock.return_value = False
__, update_form = self.factory.new_basic_module('update_mother', 'mother')
self.factory.form_requires_case(update_form)
update_form.form_filter = '#case/due_date <= today()'
expected = """
<partial>
<menu id="m0">
<text>
<locale id="modules.m0"/>
</text>
<command id="m0-f0" relevant="instance('casedb')/casedb/case[@case_id=instance('commcaresession')/session/data/case_id]/due_date <= today()"/>
</menu>
</partial>
"""
self.assertXmlPartialEqual(expected, self.factory.app.create_suite(), './menu')
def test_form_links_submodule(self):
"""
Test that when linking between two forms in a submodule we match up the session variables between the source
and target form correctly
:return:
"""
factory = AppFactory(build_version='2.9.0/latest')
m0, m0f0 = factory.new_basic_module('child visit', 'child')
factory.form_requires_case(m0f0)
factory.form_opens_case(m0f0, 'visit', is_subcase=True)
m1, m1f0 = factory.new_advanced_module('visit histroy', 'visit', parent_module=m0)
factory.form_requires_case(m1f0, 'child')
factory.form_requires_case(m1f0, 'visit', parent_case_type='child')
m1f1 = factory.new_form(m1)
factory.form_requires_case(m1f1, 'child')
factory.form_requires_case(m1f1, 'visit', parent_case_type='child')
m1f0.post_form_workflow = WORKFLOW_FORM
m1f0.form_links = [
FormLink(xpath="true()", form_id=m1f1.unique_id),
]
self.assertXmlPartialEqual(self.get_xml('form_link_submodule'), factory.app.create_suite(), "./entry")
def setUp(self):
factory = AppFactory(DOMAIN, "App with DR and child modules", build_version='2.53.0')
m0, f0 = factory.new_basic_module("case list", "case")
factory.form_requires_case(f0)
m1, f1 = factory.new_basic_module("child case list", "case", parent_module=m0)
m1.parent_select = ParentSelect(active=True, relationship="other", module_id=m0.get_or_create_unique_id())
f2 = factory.new_form(m1)
factory.form_requires_case(f1)
factory.form_requires_case(f2)
m1.search_config = CaseSearch(
properties=[CaseSearchProperty(name='name', label={'en': 'Name'})],
data_registry="myregistry",
data_registry_workflow=REGISTRY_WORKFLOW_LOAD_CASE,
)
# link from f1 to f2 (both in the child module)
f1.post_form_workflow = WORKFLOW_FORM
f1.form_links = [FormLink(form_id=f2.get_unique_id())]
factory.app._id = "123"
# wrap to have assign_references called
self.app = Application.wrap(factory.app.to_json())
def test_case_list_form_parent_child_basic(self):
"""
* Register house (case type = house, basic)
* Register house form
* Register person (case type = person, parent select = 'Register house', basic)
* Register person form
* Manager person (case type = person, case list form = 'Register person form', basic)
* Manage person form
"""
factory = AppFactory(build_version='2.9')
register_house_module, register_house_form = factory.new_basic_module('register_house', 'house')
factory.form_opens_case(register_house_form)
register_person_module, register_person_form = factory.new_basic_module('register_person', 'house')
factory.form_requires_case(register_person_form)
factory.form_opens_case(register_person_form, case_type='person', is_subcase=True)
person_module, update_person_form = factory.new_basic_module(
'update_person',
'person',
case_list_form=register_person_form
)
factory.form_requires_case(update_person_form, parent_case_type='house')
self.assertXmlEqual(self.get_xml('case-list-form-suite-parent-child-basic'), factory.app.create_suite())
def test_persistent_case_name_when_tiles_enabled(self):
"""
Confirm that the persistent case name context is not added when case tiles
are configured to persist in forms
"""
factory = AppFactory()
module, form = factory.new_advanced_module("my_module", "person")
factory.form_requires_case(form, "person")
module.case_details.short.custom_xml = '<detail id="m0_case_short"></detail>'
module.case_details.short.persist_tile_on_forms = True
module.case_details.short.persist_case_context = True
suite = factory.app.create_suite()
self.assertXmlDoesNotHaveXpath(suite, "detail[@id='m0_persistent_case_context']")
self.assertXmlPartialEqual(
"""
<partial>
<datum
detail-confirm="m0_case_long"
detail-persistent="m0_case_short"
detail-select="m0_case_short"
id="case_id_load_person_0"
nodeset="instance('casedb')/casedb/case[@case_type='person'][@status='open']"
value="./@case_id"
/>
</partial>
""",
suite,
"entry/session/datum"
)
def test_case_list_form_parent_child_advanced(self):
# * Register house (case type = house, basic)
# * Register house form
# * Register person (case type = person, parent select = 'Register house', advanced)
# * Register person form
# * Manager person (case type = person, case list form = 'Register person form', basic)
# * Manage person form
factory = AppFactory(build_version='2.9.0')
register_house_module, register_house_form = factory.new_basic_module('register_house', 'house')
factory.form_opens_case(register_house_form)
register_person_module, register_person_form = factory.new_advanced_module('register_person', 'person')
factory.form_requires_case(register_person_form, 'house')
factory.form_opens_case(register_person_form, 'person', is_subcase=True)
person_module, update_person_form = factory.new_basic_module(
'update_person',
'person',
case_list_form=register_person_form
)
person_module.parent_select.active = True
person_module.parent_select.module_id = register_house_module.unique_id
factory.form_requires_case(update_person_form)
self.assertXmlEqual(self.get_xml('case-list-form-suite-parent-child-advanced'), factory.app.create_suite())
def test_case_list_form_parent_child_basic(self):
# * Register house (case type = house, basic)
# * Register house form
# * Register person (case type = person, parent select = 'Register house', basic)
# * Register person form
# * Manager person (case type = person, case list form = 'Register person form', basic)
# * Manage person form
factory = AppFactory(build_version='2.9.0')
register_house_module, register_house_form = factory.new_basic_module('register_house', 'house')
factory.form_opens_case(register_house_form)
register_person_module, register_person_form = factory.new_basic_module('register_person', 'house')
factory.form_requires_case(register_person_form)
factory.form_opens_case(register_person_form, case_type='person', is_subcase=True)
person_module, update_person_form = factory.new_basic_module(
'update_person',
'person',
case_list_form=register_person_form
)
factory.form_requires_case(update_person_form, parent_case_type='house')
register_person_module.case_details.short.columns.append(
DetailColumn(
header={'en': 'a'},
model='case',
field='parent/case_name', # Include a parent case property in the case list
format='plain',
)
)
self.assertXmlEqual(self.get_xml('case-list-form-suite-parent-child-basic'), factory.app.create_suite())
def test_case_list_form_parent_child_advanced(self):
# * Register house (case type = house, basic)
# * Register house form
# * Register person (case type = person, parent select = 'Register house', advanced)
# * Register person form
# * Manager person (case type = person, case list form = 'Register person form', basic)
# * Manage person form
factory = AppFactory(build_version='2.9')
register_house_module, register_house_form = factory.new_basic_module(
'register_house', 'house')
factory.form_opens_case(register_house_form)
register_person_module, register_person_form = factory.new_advanced_module(
'register_person', 'person')
factory.form_requires_case(register_person_form, 'house')
factory.form_opens_case(register_person_form,
'person',
is_subcase=True)
person_module, update_person_form = factory.new_basic_module(
'update_person', 'person', case_list_form=register_person_form)
person_module.parent_select.active = True
person_module.parent_select.module_id = register_house_module.unique_id
factory.form_requires_case(update_person_form)
self.assertXmlEqual(
self.get_xml('case-list-form-suite-parent-child-advanced'),
factory.app.create_suite())
def setUpClass(cls):
super(TestCaseDelayedSchema, cls).setUpClass()
factory = AppFactory(domain=cls.domain)
module1, form1 = factory.new_basic_module('update_case', cls.case_type)
factory.form_requires_case(form1, cls.case_type, update={
'age': '/data/age',
'height': '/data/height',
})
cls.current_app = factory.app
cls.current_app._id = '1234'
factory = AppFactory(domain=cls.domain)
module1, form1 = factory.new_basic_module('update_case', cls.case_type)
factory.form_requires_case(form1, cls.case_type, update={
'age': '/data/age',
'height': '/data/height',
'weight': '/data/weight',
})
cls.build = factory.app
cls.build.copy_of = cls.current_app._id
cls.build.version = 5
cls.build.has_submissions = True
cls.apps = [
cls.current_app,
cls.build,
]
with drop_connected_signals(app_post_save):
for app in cls.apps:
app.save()
def test_persistent_case_tiles_in_advanced_module_case_lists(self):
"""
Test that the detail-persistent attributes is set correctly when persistent
case tiles are used on advanced module case lists
"""
factory = AppFactory()
module, form = factory.new_advanced_module("my_module", "person")
factory.form_requires_case(form, "person")
module.case_list.show = True
module.case_details.short.custom_xml = '<detail id="m0_case_short"></detail>'
module.case_details.short.persist_tile_on_forms = True
suite = factory.app.create_suite()
# The relevant check is really that detail-persistent="m0_case_short"
# but assertXmlPartialEqual xpath implementation doesn't currently
# support selecting attributes
self.assertXmlPartialEqual(
"""
<partial>
<datum
detail-confirm="m0_case_long"
detail-persistent="m0_case_short"
detail-select="m0_case_short"
id="case_id_case_person"
nodeset="instance('casedb')/casedb/case[@case_type='person'][@status='open']"
value="./@case_id"
/>
</partial>
""",
suite,
'entry/command[@id="m0-case-list"]/../session/datum',
)
def test_persistent_case_name_when_tiles_enabled(self):
"""
Confirm that the persistent case name context is not added when case tiles
are configured to persist in forms
"""
factory = AppFactory()
module, form = factory.new_advanced_module("my_module", "person")
factory.form_requires_case(form, "person")
module.case_details.short.custom_xml = '<detail id="m0_case_short"></detail>'
module.case_details.short.persist_tile_on_forms = True
module.case_details.short.persist_case_context = True
suite = factory.app.create_suite()
self.assertXmlDoesNotHaveXpath(
suite, "detail[@id='m0_persistent_case_context']")
self.assertXmlPartialEqual(
"""
<partial>
<datum
detail-confirm="m0_case_long"
detail-persistent="m0_case_short"
detail-select="m0_case_short"
id="case_id_load_person_0"
nodeset="instance('casedb')/casedb/case[@case_type='person'][@status='open']"
value="./@case_id"
/>
</partial>
""", suite, "entry/session/datum")
def test_persistent_case_tiles_in_advanced_module_case_lists(self):
"""
Test that the detail-persistent attributes is set correctly when persistent
case tiles are used on advanced module case lists
"""
factory = AppFactory()
module, form = factory.new_advanced_module("my_module", "person")
factory.form_requires_case(form, "person")
module.case_list.show = True
module.case_details.short.custom_xml = '<detail id="m0_case_short"></detail>'
module.case_details.short.persist_tile_on_forms = True
suite = factory.app.create_suite()
# The relevant check is really that detail-persistent="m0_case_short"
# but assertXmlPartialEqual xpath implementation doesn't currently
# support selecting attributes
self.assertXmlPartialEqual(
"""
<partial>
<datum
detail-confirm="m0_case_long"
detail-persistent="m0_case_short"
detail-select="m0_case_short"
id="case_id_case_person"
nodeset="instance('casedb')/casedb/case[@case_type='person'][@status='open']"
value="./@case_id"
/>
</partial>
""",
suite,
'entry/command[@id="m0-case-list"]/../session/datum',
)
def setUpClass(cls):
super(TestCaseDelayedSchema, cls).setUpClass()
factory = AppFactory(domain=cls.domain)
module1, form1 = factory.new_basic_module('update_case', cls.case_type)
factory.form_requires_case(form1,
cls.case_type,
update={
'age': '/data/age',
'height': '/data/height',
})
cls.current_app = factory.app
cls.current_app._id = '1234'
factory = AppFactory(domain=cls.domain)
module1, form1 = factory.new_basic_module('update_case', cls.case_type)
factory.form_requires_case(form1,
cls.case_type,
update={
'age': '/data/age',
'height': '/data/height',
'weight': '/data/weight',
})
cls.build = factory.app
cls.build.copy_of = cls.current_app._id
cls.build.version = 5
cls.build.has_submissions = True
cls.apps = [
cls.current_app,
cls.build,
]
with drop_connected_signals(app_post_save):
for app in cls.apps:
app.save()
def setUpClass(cls):
super(TestBuildingSchemaFromApplication, cls).setUpClass()
cls.current_app = Application.wrap(cls.get_json('basic_application'))
cls.first_build = Application.wrap(cls.get_json('basic_application'))
cls.first_build._id = '123'
cls.first_build.copy_of = cls.current_app.get_id
cls.first_build.version = 3
cls.first_build.has_submissions = True
factory = AppFactory(build_version='2.36.0')
m0, f0 = factory.new_advanced_module('mod0', 'advanced')
f0.source = cls.get_xml('repeat_group_form')
f0.xmlns = 'repeat-xmlns'
factory.form_requires_case(f0, 'case0')
f0.actions.open_cases = [
AdvancedOpenCaseAction(
case_type="advanced",
case_tag="open_case_0",
name_path="/data/question3/question4",
repeat_context="/data/question3",
case_indices=[CaseIndex(tag='load_case0_0')])
]
cls.advanced_app = factory.app
cls.advanced_app.save()
cls.apps = [
cls.current_app,
cls.first_build,
cls.advanced_app,
]
with drop_connected_signals(app_post_save):
for app in cls.apps:
app.save()
def test_scheduler_module(self):
factory = AppFactory()
m1, m1f1 = factory.new_basic_module('open_case', 'house')
factory.form_opens_case(m1f1)
m2, m2f1 = factory.new_advanced_module('scheduler_module', 'house')
m2f2 = factory.new_form(m2)
factory.form_requires_case(m2f1, case_type='house', update={
'foo': '/data/question1',
'bar': '/data/question2',
})
factory.form_requires_case(m2f2, case_type='house', update={
'bleep': '/data/question1',
'bloop': '/data/question2',
})
self._add_scheduler_to_module(m2)
self._add_scheduler_to_form(m2f1, m2, 'form1')
self._add_scheduler_to_form(m2f2, m2, 'form2')
self.assertCaseProperties(factory.app, 'house', [
'foo',
'bar',
'bleep',
'bloop',
# Scheduler properties:
'last_visit_date_form1',
'last_visit_number_form1',
'last_visit_date_form2',
'last_visit_number_form2',
'current_schedule_phase',
])
def setUpClass(cls):
super(UCRAggregationTest, cls).setUpClass()
# cleanup any previous data
cls._cleanup_data()
# setup app
factory = AppFactory(domain=cls.domain)
# parent case module, incl opening child cases of main type
m_parent, f_parent = factory.new_basic_module('Parent Module', cls.parent_case_type)
factory.form_opens_case(f_parent, case_type=cls.parent_case_type)
factory.form_opens_case(f_parent, case_type=cls.case_type, is_subcase=True)
# main module
m0, f0 = factory.new_basic_module('A Module', cls.case_type)
f1 = factory.new_form(m0)
f1.source = cls._get_xform()
factory.form_requires_case(f1, case_type=cls.case_type, update={
cp[0]: '/data/{}'.format(cp[0]) for cp in cls.case_properties
})
cls.followup_form = f1
cls.app = factory.app
cls.app.save()
# create form and case ucrs
cls.form_data_source = get_form_data_source(cls.app, cls.followup_form)
cls.case_data_source = get_case_data_source(cls.app, cls.case_type)
cls.parent_case_data_source = get_case_data_source(cls.app, cls.parent_case_type)
# create some data - first just create the case
cls.parent_case_id = cls._create_parent_case(cls.parent_name)
cls.case_id = cls._create_case(cls.parent_case_id)
for fu_date in cls.fu_visit_dates:
cls._submit_followup_form(cls.case_id, received_on=fu_date)
# the closed case causes there to be some data with an end_column
cls.closed_case_id = cls._create_closed_case()
# populate the UCRs with the data we just created
cls.form_adapter = get_indicator_adapter(cls.form_data_source)
cls.case_adapter = get_indicator_adapter(cls.case_data_source)
cls.parent_case_adapter = get_indicator_adapter(cls.parent_case_data_source)
cls.form_adapter.rebuild_table()
cls.case_adapter.rebuild_table()
cls.parent_case_adapter.rebuild_table()
_iteratively_build_table(cls.form_data_source)
_iteratively_build_table(cls.case_data_source)
_iteratively_build_table(cls.parent_case_data_source)
# setup AggregateTableDefinition
cls.monthly_aggregate_table_definition = cls._get_monthly_aggregate_table_definition()
cls.weekly_aggregate_table_definition = cls._get_weekly_aggregate_table_definition()
cls.basic_aggregate_table_definition = cls._get_basic_aggregate_table_definition()
# and adapter
cls.monthly_adapter = get_indicator_adapter(cls.monthly_aggregate_table_definition)
def setUpClass(cls):
super(UCRAggregationTest, cls).setUpClass()
# cleanup any previous data
cls._cleanup_data()
# setup app
factory = AppFactory(domain=cls.domain)
# parent case module, incl opening child cases of main type
m_parent, f_parent = factory.new_basic_module('Parent Module', cls.parent_case_type)
factory.form_opens_case(f_parent, case_type=cls.parent_case_type)
factory.form_opens_case(f_parent, case_type=cls.case_type, is_subcase=True)
# main module
m0, f0 = factory.new_basic_module('A Module', cls.case_type)
f1 = factory.new_form(m0)
f1.source = cls._get_xform()
factory.form_requires_case(f1, case_type=cls.case_type, update={
cp[0]: '/data/{}'.format(cp[0]) for cp in cls.case_properties
})
cls.followup_form = f1
cls.app = factory.app
cls.app.save()
# create form and case ucrs
cls.form_data_source = get_form_data_source(cls.app, cls.followup_form)
cls.case_data_source = get_case_data_source(cls.app, cls.case_type)
cls.parent_case_data_source = get_case_data_source(cls.app, cls.parent_case_type)
# create some data - first just create the case
cls.parent_case_id = cls._create_parent_case(cls.parent_name)
cls.case_id = cls._create_case(cls.parent_case_id)
for fu_date in cls.fu_visit_dates:
cls._submit_followup_form(cls.case_id, received_on=fu_date)
# the closed case causes there to be some data with an end_column
cls.closed_case_id = cls._create_closed_case()
# populate the UCRs with the data we just created
cls.form_adapter = get_indicator_adapter(cls.form_data_source)
cls.case_adapter = get_indicator_adapter(cls.case_data_source)
cls.parent_case_adapter = get_indicator_adapter(cls.parent_case_data_source)
cls.form_adapter.rebuild_table()
cls.case_adapter.rebuild_table()
cls.parent_case_adapter.rebuild_table()
_iteratively_build_table(cls.form_data_source)
_iteratively_build_table(cls.case_data_source)
_iteratively_build_table(cls.parent_case_data_source)
# setup AggregateTableDefinition
cls.monthly_aggregate_table_definition = cls._get_monthly_aggregate_table_definition()
cls.weekly_aggregate_table_definition = cls._get_weekly_aggregate_table_definition()
cls.basic_aggregate_table_definition = cls._get_basic_aggregate_table_definition()
# and adapter
cls.monthly_adapter = get_indicator_adapter(cls.monthly_aggregate_table_definition)
def test_circular_parent_case_ref(self):
factory = AppFactory()
m0, m0f0 = factory.new_basic_module('m0', 'case1')
m1, m1f0 = factory.new_basic_module('m1', 'case2')
factory.form_requires_case(m0f0, 'case1', parent_case_type='case2')
factory.form_requires_case(m1f0, 'case2', parent_case_type='case1')
with self.assertRaises(SuiteValidationError):
factory.app.create_suite()
def test_circular_parent_case_ref(self):
factory = AppFactory()
m0, m0f0 = factory.new_basic_module('m0', 'case1')
m1, m1f0 = factory.new_basic_module('m1', 'case2')
factory.form_requires_case(m0f0, 'case1', parent_case_type='case2')
factory.form_requires_case(m1f0, 'case2', parent_case_type='case1')
with self.assertRaises(SuiteValidationError):
factory.app.create_suite()
def test_persistent_case_name_in_forms(self):
"""
Test that the detail-persistent attributes are set correctly when the
module is configured to persist the case name at the top of the form.
Also confirm that the appropriate <detail> element is added to the suite.
"""
factory = AppFactory()
module, form = factory.new_basic_module("my_module", "person")
factory.form_requires_case(form, "person")
module.case_details.short.persist_case_context = True
suite = factory.app.create_suite()
self.assertXmlPartialEqual(
"""
<partial>
<detail id="m0_persistent_case_context">
<title>
<text/>
</title>
<field>
<style font-size="large" horz-align="center">
<grid grid-height="1" grid-width="12" grid-x="0" grid-y="0"/>
</style>
<header>
<text/>
</header>
<template>
<text>
<xpath function="case_name"/>
</text>
</template>
</field>
</detail>
</partial>
""",
suite,
"detail[@id='m0_persistent_case_context']"
)
# The attribute we care about here is detail-persistent="m0_persistent_case_context"
self.assertXmlPartialEqual(
"""
<partial>
<datum
detail-confirm="m0_case_long"
detail-persistent="m0_persistent_case_context"
detail-select="m0_case_short"
id="case_id"
nodeset="instance('casedb')/casedb/case[@case_type='person'][@status='open']"
value="./@case_id"
/>
</partial>
""",
suite,
"entry/session/datum"
)
def test_persistent_case_name_in_forms(self):
"""
Test that the detail-persistent attributes are set correctly when the
module is configured to persist the case name at the top of the form.
Also confirm that the appropriate <detail> element is added to the suite.
"""
factory = AppFactory()
module, form = factory.new_basic_module("my_module", "person")
factory.form_requires_case(form, "person")
module.case_details.short.persist_case_context = True
suite = factory.app.create_suite()
self.assertXmlPartialEqual(
"""
<partial>
<detail id="m0_persistent_case_context">
<title>
<text/>
</title>
<field>
<style font-size="large" horz-align="center">
<grid grid-height="1" grid-width="12" grid-x="0" grid-y="0"/>
</style>
<header>
<text/>
</header>
<template>
<text>
<xpath function="case_name"/>
</text>
</template>
</field>
</detail>
</partial>
""",
suite,
"detail[@id='m0_persistent_case_context']"
)
# The attribute we care about here is detail-persistent="m0_persistent_case_context"
self.assertXmlPartialEqual(
"""
<partial>
<datum
detail-confirm="m0_case_long"
detail-persistent="m0_persistent_case_context"
detail-select="m0_case_short"
id="case_id"
nodeset="instance('casedb')/casedb/case[@case_type='person'][@status='open']"
value="./@case_id"
/>
</partial>
""",
suite,
"entry/session/datum"
)
def test_owner_id_maps_to_attribute(self):
factory = AppFactory()
# Create form1 which uses case type 'house'
module1, form1 = factory.new_module(Module, 'open_case', 'house')
# Form1 updates house.owner_id
factory.form_requires_case(form1,
case_type='house',
update={'owner_id': 'new_owner'})
# Verify that the actual case property is '@owner_id', not 'owner_id'
self.assertCaseProperties(factory.app, 'house', ['@owner_id'])
def test_basic_apps(self):
for class_ in (Module, AdvancedModule):
factory = AppFactory()
m1, m1f1 = factory.new_module(class_, 'open_case', 'house')
factory.form_opens_case(m1f1)
m1f2 = factory.new_form(m1)
factory.form_requires_case(m1f2, case_type='house', update={
'foo': '/data/question1',
'bar': '/data/question2',
})
self.assertCaseProperties(factory.app, 'house', ['foo', 'bar'])
def test_workflow_registry_module_previous_screen_after_case_list_form(self):
factory = AppFactory(DOMAIN, "App with DR", build_version='2.53.0')
m0, f0 = factory.new_basic_module("new case", "case")
factory.form_opens_case(f0, "case")
m1, f1 = factory.new_basic_module("update case", "case")
factory.form_requires_case(f1, "case")
m1.case_details.long.columns.append(
DetailColumn.wrap(dict(
header={"en": "name"},
model="case",
format="plain",
field="whatever",
))
)
m1.search_config = CaseSearch(
properties=[
CaseSearchProperty(name='name', label={'en': 'Name'}),
],
data_registry="myregistry",
data_registry_workflow=REGISTRY_WORKFLOW_LOAD_CASE,
)
m1.case_list_form.form_id = f0.get_unique_id()
m1.case_list_form.label = {'en': 'New Case'}
f1.post_form_workflow = WORKFLOW_PREVIOUS
app = Application.wrap(factory.app.to_json())
app._id = "123"
suite = app.create_suite()
self.assertXmlPartialEqual(
"""
<partial>
<create>
<command value="'m1'"/>
<query id="results" value="http://localhost:8000/a/test_domain/phone/registry_case/123/">
<data key="case_type" ref="'case'"/>
<data key="x_commcare_data_registry" ref="'myregistry'"/>
<data key="case_id" ref="instance('commcaresession')/session/data/case_id"/>
</query>
<datum id="case_id" value="instance('commcaresession')/session/data/case_id"/>
<query id="registry" value="http://localhost:8000/a/test_domain/phone/registry_case/123/">
<data key="x_commcare_data_registry" ref="'myregistry'"/>
<data key="case_type" ref="'case'"/>
<data key="case_id" ref="instance('commcaresession')/session/data/case_id"/>
</query>
</create>
</partial>
""",
suite,
"./entry[2]/stack/create"
)
def test_inline_case_detail_from_another_module(self, *args):
factory = AppFactory()
module0, form0 = factory.new_advanced_module("m0", "person")
factory.form_requires_case(form0, "person")
module0.case_details.short.use_case_tiles = True
self._add_columns_for_case_details(module0)
module1, form1 = factory.new_advanced_module("m1", "person")
factory.form_requires_case(form1, "person")
# not configured to use other module's persistent case tile so
# has no detail-inline and detail-persistent attr
self.ensure_module_session_datum_xml(factory, '', '')
# configured to use other module's persistent case tile
module1.case_details.short.persistent_case_tile_from_module = module0.unique_id
self.ensure_module_session_datum_xml(
factory, '', 'detail-persistent="m0_case_short"')
# configured to use other module's persistent case tile that has custom xml
module0.case_details.short.use_case_tiles = False
module0.case_details.short.custom_xml = '<detail id="m0_case_short"></detail>'
self.ensure_module_session_datum_xml(
factory, '', 'detail-persistent="m0_case_short"')
module0.case_details.short.custom_xml = ''
module0.case_details.short.use_case_tiles = True
# configured to use pull down tile from the other module
module1.case_details.short.pull_down_tile = True
self.ensure_module_session_datum_xml(
factory, 'detail-inline="m0_case_long"',
'detail-persistent="m0_case_short"')
# set to use persistent case tile of its own as well but it would still
# persists case tiles and detail inline from another module
module1.case_details.short.use_case_tiles = True
module1.case_details.short.persist_tile_on_forms = True
self._add_columns_for_case_details(module1)
self.ensure_module_session_datum_xml(
factory, 'detail-inline="m0_case_long"',
'detail-persistent="m0_case_short"')
# set to use case tile from a module that does not support case tiles anymore
# and has own persistent case tile as well
# So now detail inline from its own details
module0.case_details.short.use_case_tiles = False
self.ensure_module_session_datum_xml(
factory, 'detail-inline="m1_case_long"',
'detail-persistent="m1_case_short"')
# set to use case tile from a module that does not support case tiles anymore
# and does not have its own persistent case tile as well
module1.case_details.short.use_case_tiles = False
self.ensure_module_session_datum_xml(factory, '', '')
def test_basic_apps(self):
for class_ in (Module, AdvancedModule):
factory = AppFactory()
m1, m1f1 = factory.new_module(class_, 'open_case', 'house')
factory.form_opens_case(m1f1)
m1f2 = factory.new_form(m1)
factory.form_requires_case(m1f2, case_type='house', update={
'foo': '/data/question1',
'bar': '/data/question2',
})
self.assertCaseProperties(factory.app, 'house', ['foo', 'bar'])
def test_followup_module(self, *args):
factory = AppFactory(build_version='2.9.0')
m0, m0f0 = factory.new_basic_module('m0', 'frog')
m0f0.post_form_workflow = WORKFLOW_FORM
m0f0.form_links = [
FormLink(xpath="(today() - dob) < 7",
module_unique_id=m0.unique_id)
]
factory.form_requires_case(m0f0)
self.assertXmlPartialEqual(self.get_xml('form_link_followup_module'),
factory.app.create_suite(), "./entry[1]")
def test_reference_to_missing_session_variable_in_stack(self):
# http://manage.dimagi.com/default.asp?236750
#
# Stack create blocks do not update the session after each datum
# so items put into the session in one step aren't available later steps
#
# <datum id="case_id_A" value="instance('commcaresession')/session/data/case_id_new_A"/>
# - <datum id="case_id_B" value="instance('casedb')/casedb/case[@case_id=instance('commcaresession')/session/data/case_id_A]/index/host"/>
# + <datum id="case_id_B" value="instance('casedb')/casedb/case[@case_id=instance('commcaresession')/session/data/case_id_new_A]/index/host"/>
#
# in the above example ``case_id_A`` is being added to the session and then
# later referenced. However since the session doesn't get updated
# the value isn't available in the session.
#
# To fix this we need to replace any references to previous variables with the full xpath which
# that session variable references.
#
# See corehq.apps.app_manager.suite_xml.post_process.workflow._replace_session_references_in_stack
factory = AppFactory(build_version='2.9.0/latest')
m0, m0f0 = factory.new_basic_module('person registration', 'person')
factory.form_opens_case(m0f0)
m1, m1f0 = factory.new_advanced_module('episode registration',
'episode')
factory.form_requires_case(m1f0, case_type='person')
factory.form_opens_case(m1f0,
case_type='episode',
is_subcase=True,
is_extension=True)
m2, m2f0 = factory.new_advanced_module('tests', 'episode')
factory.form_requires_case(m2f0, 'episode')
factory.advanced_form_autoloads(m2f0, AUTO_SELECT_CASE, 'host',
'load_episode_0')
m1f0.post_form_workflow = WORKFLOW_FORM
m1f0.form_links = [
FormLink(
xpath="true()",
form_id=m2f0.unique_id,
datums=[
FormDatum(
name='case_id_load_episode_0',
xpath=
"instance('commcaresession')/session/data/case_id_new_episode_0"
)
]),
]
self.assertXmlPartialEqual(self.get_xml('form_link_enikshay'),
factory.app.create_suite(), "./entry")
def test_fixture_to_case_selection(self):
factory = AppFactory(build_version='2.9')
module, form = factory.new_basic_module('my_module', 'cases')
module.fixture_select.active = True
module.fixture_select.fixture_type = 'days'
module.fixture_select.display_column = 'my_display_column'
module.fixture_select.variable_column = 'my_variable_column'
module.fixture_select.xpath = 'date(scheduled_date) <= date(today() + $fixture_value)'
factory.form_requires_case(form)
self.assertXmlEqual(self.get_xml('fixture-to-case-selection'), factory.app.create_suite())
def test_with_case_management_create_update(self):
factory = AppFactory(build_version='2.9.0/latest')
m0, m0f0 = factory.new_basic_module('m0', 'frog')
factory.form_opens_case(m0f0)
m1, m1f0 = factory.new_basic_module('m1', 'frog')
factory.form_requires_case(m1f0)
m0f0.post_form_workflow = WORKFLOW_FORM
m0f0.form_links = [FormLink(xpath='true()', form_id=m1f0.unique_id)]
self.assertXmlPartialEqual(
self.get_xml('form_link_create_update_case'),
factory.app.create_suite(), "./entry[1]")
def test_fixture_to_case_selection(self):
factory = AppFactory(build_version='2.9')
module, form = factory.new_basic_module('my_module', 'cases')
module.fixture_select.active = True
module.fixture_select.fixture_type = 'days'
module.fixture_select.display_column = 'my_display_column'
module.fixture_select.variable_column = 'my_variable_column'
module.fixture_select.xpath = 'date(scheduled_date) <= date(today() + $fixture_value)'
factory.form_requires_case(form)
self.assertXmlEqual(self.get_xml('fixture-to-case-selection'), factory.app.create_suite())
def test_with_case_management_create_update(self):
factory = AppFactory(build_version='2.9.0/latest')
m0, m0f0 = factory.new_basic_module('m0', 'frog')
factory.form_opens_case(m0f0)
m1, m1f0 = factory.new_basic_module('m1', 'frog')
factory.form_requires_case(m1f0)
m0f0.post_form_workflow = WORKFLOW_FORM
m0f0.form_links = [
FormLink(xpath='true()', form_id=m1f0.unique_id)
]
self.assertXmlPartialEqual(self.get_xml('form_link_create_update_case'), factory.app.create_suite(), "./entry[1]")
def test_link_between_child_modules(self, *args):
factory = AppFactory(build_version='2.9.0')
m0, m0f0 = factory.new_basic_module('Update City', 'city')
factory.form_requires_case(m0f0)
m1, m1f0 = factory.new_basic_module('Update Person',
'person',
parent_module=m0)
factory.form_requires_case(m1f0)
m2, m2f0 = factory.new_basic_module('Close City', 'city')
factory.form_requires_case(m2f0)
m3, m3f0 = factory.new_basic_module('Close Person',
'person',
parent_module=m2)
factory.form_requires_case(m3f0)
m1f0.post_form_workflow = WORKFLOW_FORM
m1f0.form_links = [
FormLink(xpath="true()", module_unique_id=m3.unique_id)
]
self.assertXmlPartialEqual(
"""
<partial>
<stack>
<create if="true()">
<command value="'m2'"/>
<datum id="case_id" value="instance('commcaresession')/session/data/case_id"/>
<command value="'m3'"/>
</create>
</stack>
</partial>
""", factory.app.create_suite(), "./entry[2]/stack")
def test_case_list_registration_form_advanced(self):
factory = AppFactory(build_version='2.9')
register_module, register_form = factory.new_advanced_module('register_dugong', 'dugong')
factory.form_opens_case(register_form)
case_module, update_form = factory.new_advanced_module('update_dugong', 'dugong')
factory.form_requires_case(update_form)
case_module.case_list_form.form_id = register_form.get_unique_id()
case_module.case_list_form.label = {
'en': 'Register another Dugong'
}
self.assertXmlEqual(self.get_xml('case-list-form-advanced'), factory.app.create_suite())
def setUpClass(cls):
super(AppManagerDataSourceConfigTest, cls).setUpClass()
factory = AppFactory(domain=cls.domain)
m0, f0 = factory.new_basic_module('A Module', cls.case_type)
f0.source = get_simple_xform()
cls.form = f0
factory.form_requires_case(f0,
case_type=cls.case_type,
update={
cp: '/data/{}'.format(cp)
for cp in cls.case_properties.keys()
})
cls.app = factory.app
cls.app.save()
def test_case_list_registration_form_advanced(self):
factory = AppFactory(build_version='2.9.0')
register_module, register_form = factory.new_advanced_module('register_dugong', 'dugong')
factory.form_opens_case(register_form)
case_module, update_form = factory.new_advanced_module('update_dugong', 'dugong')
factory.form_requires_case(update_form)
case_module.case_list_form.form_id = register_form.get_unique_id()
case_module.case_list_form.label = {
'en': 'Register another Dugong'
}
self.assertXmlEqual(self.get_xml('case-list-form-advanced'), factory.app.create_suite())
def setUp(self):
self.domain = "joto"
self.case_type = 'teddiursa'
app_factory = AppFactory(self.domain)
m, f = app_factory.new_basic_module('m', self.case_type)
app_factory.form_requires_case(f,
case_type=self.case_type,
update={
'prop1': '/data/prop1',
'move_type': '/data/move_type',
'mood': '/data/mood',
'level': '/data/level'
})
app_factory.app.save()
def test_form_links_other_child_module(self):
# This test demonstrates current behavior that I believe to be flawed
factory = AppFactory(build_version='2.9.0')
m0, m0f0 = factory.new_basic_module('parent', 'mother')
factory.form_opens_case(m0f0)
m1, m1f0 = factory.new_basic_module('child', 'baby', parent_module=m0)
factory.form_requires_case(m1f0)
m0f1 = factory.new_form(m0)
m0f1.post_form_workflow = WORKFLOW_FORM
m0f1.form_links = [FormLink(xpath='true()', form_id=m1f0.unique_id)]
m2, m2f0 = factory.new_basic_module('other_module', 'baby')
m2f0.post_form_workflow = WORKFLOW_FORM
m2f0.form_links = [FormLink(xpath='true()', form_id=m1f0.unique_id)]
suite_xml = factory.app.create_suite()
# m0f1 links to m1f0, a form in its child module. Here's the stack for that:
expected = """
<partial>
<stack>
<create if="true()">
<command value="'m0'"/>
<command value="'m1'"/>
<datum id="case_id_new_mother_0" value="uuid()"/>
<datum id="case_id" value="instance('commcaresession')/session/data/case_id"/>
<command value="'m1-f0'"/>
</create>
</stack>
</partial>
"""
self.assertXmlPartialEqual(expected, suite_xml, "./entry[2]/stack")
# m2f0 links to m1f0, a form in a separate child module, here's the stack there
expected = """
<partial>
<stack>
<create if="true()">
<command value="'m0'"/>
<command value="'m1'"/>
<datum id="case_id_new_mother_0" value="uuid()"/>
<datum id="case_id" value="instance('commcaresession')/session/data/case_id"/>
<command value="'m1-f0'"/>
</create>
</stack>
</partial>
"""
self.assertXmlPartialEqual(expected, suite_xml, "./entry[4]/stack")
def setUpClass(cls):
super(ReportBuilderDBTest, cls).setUpClass()
factory = AppFactory(domain=cls.domain)
module, form = factory.new_basic_module('Untitled Module',
cls.case_type)
form.source = get_simple_xform()
cls.form = form
factory.form_requires_case(form,
case_type=cls.case_type,
update={
'first_name': '/data/first_name',
'last_name': '/data/last_name',
})
cls.app = factory.app
cls.app.save()
def test_form_data_with_case_properties(self):
factory = AppFactory()
app = factory.app
module1, form1 = factory.new_basic_module('open_case', 'household')
form1_builder = XFormBuilder(form1.name)
# question 0
form1_builder.new_question('name', 'Name')
# question 1 (a group)
form1_builder.new_group('demographics', 'Demographics')
# question 2 (a question in a group)
form1_builder.new_question('age', 'Age', group='demographics')
# question 3 (a question that has a load property)
form1_builder.new_question('polar_bears_seen',
'Number of polar bears seen')
form1.source = form1_builder.tostring(
pretty_print=True).decode('utf-8')
factory.form_requires_case(form1,
case_type='household',
update={
'name': '/data/name',
'age': '/data/demographics/age',
},
preload={
'/data/polar_bears_seen':
'polar_bears_seen',
})
app.save()
modules, errors = get_app_summary_formdata(app.domain, app)
q1_saves = modules[0]['forms'][0]['questions'][0]['save_properties'][0]
self.assertEqual(q1_saves.case_type, 'household')
self.assertEqual(q1_saves.property, 'name')
group_saves = modules[0]['forms'][0]['questions'][2][
'save_properties'][0]
self.assertEqual(group_saves.case_type, 'household')
self.assertEqual(group_saves.property, 'age')
q3_loads = modules[0]['forms'][0]['questions'][3]['load_properties'][0]
self.assertEqual(q3_loads.case_type, 'household')
self.assertEqual(q3_loads.property, 'polar_bears_seen')
def test_case_list_form_reg_form_creates_child_case(self):
factory = AppFactory(build_version='2.9.0')
register_person_module, register_person_form = factory.new_basic_module(
'reg_person_and_stub', 'person')
factory.form_opens_case(register_person_form)
factory.form_opens_case(register_person_form,
case_type='stub',
is_subcase=True)
person_module, update_person_form = factory.new_basic_module(
'update_person', 'person', case_list_form=register_person_form)
factory.form_requires_case(update_person_form)
self.assertXmlPartialEqual(
self.get_xml('case_list_form_reg_form_creates_child_case'),
factory.app.create_suite(), './entry[1]')
def test_tiered_select_with_advanced_module_as_parent_with_filters(self):
factory = AppFactory(build_version="2.25")
parent_module, parent_form = factory.new_advanced_module("parent", "parent")
parent_module.case_details.short.filter = "parent_filter = 1"
child_module, child_form = factory.new_basic_module("child", "child")
child_form.xmlns = "http://id_m1-f0"
child_module.case_details.short.filter = "child_filter = 1"
factory.form_requires_case(child_form)
# make child module point to advanced module as parent
child_module.parent_select.active = True
child_module.parent_select.module_id = parent_module.unique_id
self.assertXmlPartialEqual(
self.get_xml("advanced_module_parent_filters"), factory.app.create_suite(), "./entry[2]"
)
def test_case_list_form_reg_form_creates_child_case(self):
factory = AppFactory(build_version='2.9.0')
register_person_module, register_person_form = factory.new_basic_module('reg_person_and_stub', 'person')
factory.form_opens_case(register_person_form)
factory.form_opens_case(register_person_form, case_type='stub', is_subcase=True)
person_module, update_person_form = factory.new_basic_module(
'update_person',
'person',
case_list_form=register_person_form
)
factory.form_requires_case(update_person_form)
self.assertXmlPartialEqual(
self.get_xml('case_list_form_reg_form_creates_child_case'), factory.app.create_suite(), './entry[1]'
)
def make_app(cls):
factory = AppFactory(domain=cls.domain.name,
name="API App",
build_version='2.11.0')
module1, form1 = factory.new_basic_module('open_case', 'house')
form1.source = XFormBuilder().new_question("name",
"name").form.tostring()
factory.form_opens_case(form1)
module2, form2 = factory.new_basic_module('update_case', 'person')
form2.source = XFormBuilder().new_question("name",
"name").form.tostring()
factory.form_requires_case(form2, case_type='house')
factory.form_opens_case(form2, case_type="person", is_subcase=True)
app = factory.app
app.save()
return app
def test_tiered_select_with_advanced_module_as_parent_with_filters(self):
factory = AppFactory(build_version='2.25')
parent_module, parent_form = factory.new_advanced_module(
'parent', 'parent')
parent_module.case_details.short.filter = 'parent_filter = 1'
child_module, child_form = factory.new_basic_module('child', 'child')
child_form.xmlns = 'http://id_m1-f0'
child_module.case_details.short.filter = 'child_filter = 1'
factory.form_requires_case(child_form)
# make child module point to advanced module as parent
child_module.parent_select.active = True
child_module.parent_select.module_id = parent_module.unique_id
self.assertXmlPartialEqual(
self.get_xml('advanced_module_parent_filters'),
factory.app.create_suite(), "./entry[2]")
def test_case_sharing(self):
factory1 = AppFactory()
factory2 = AppFactory()
factory1.app.case_sharing = True
factory2.app.case_sharing = True
with patch('corehq.apps.app_manager.app_schemas.case_properties.get_case_sharing_apps_in_domain')\
as mock_sharing:
mock_sharing.return_value = [factory1.app, factory2.app]
a1m1, a1m1f1 = factory1.new_basic_module('open_patient', 'patient')
factory1.form_requires_case(a1m1f1, update={
'app1': 'yes',
})
a2m1, a2m1f1 = factory2.new_basic_module('open_patient', 'patient')
factory1.form_requires_case(a2m1f1, update={
'app2': 'yes',
})
self.assertCaseProperties(factory1.app, 'patient', ['app1', 'app2'])
def test_with_case_management_multiple_links(self, *args):
factory = AppFactory(build_version='2.9.0')
m0, m0f0 = factory.new_basic_module('m0', 'frog')
factory.form_opens_case(m0f0)
m1, m1f0 = factory.new_basic_module('m1', 'frog')
factory.form_requires_case(m1f0)
m1f1 = factory.new_form(m1)
factory.form_opens_case(m1f1)
m0f0.post_form_workflow = WORKFLOW_FORM
m0f0.form_links = [
FormLink(xpath="a = 1", form_id=m1f0.unique_id),
FormLink(xpath="a = 2", form_id=m1f1.unique_id)
]
self.assertXmlPartialEqual(self.get_xml('form_link_multiple'),
factory.app.create_suite(), "./entry[1]")
def test_link_to_form_in_parent_module(self):
factory = AppFactory(build_version='2.9.0/latest')
m0, m0f0 = factory.new_basic_module('enroll child', 'child')
factory.form_opens_case(m0f0)
m1, m1f0 = factory.new_basic_module('child visit', 'child')
factory.form_requires_case(m1f0)
m2, m2f0 = factory.new_advanced_module('visit history', 'visit', parent_module=m1)
factory.form_requires_case(m2f0, 'child')
# link to child -> edit child
m2f0.post_form_workflow = WORKFLOW_FORM
m2f0.form_links = [
FormLink(xpath="true()", form_id=m1f0.unique_id),
]
self.assertXmlPartialEqual(self.get_xml('form_link_child_modules'), factory.app.create_suite(), "./entry[3]")
def test_tiered_select_with_advanced_module_as_parent_with_filters(self):
factory = AppFactory(build_version='2.25.0')
parent_module, parent_form = factory.new_advanced_module('parent', 'parent')
parent_module.case_details.short.filter = 'parent_filter = 1'
child_module, child_form = factory.new_basic_module('child', 'child')
child_form.xmlns = 'http://id_m1-f0'
child_module.case_details.short.filter = 'child_filter = 1'
factory.form_requires_case(child_form)
# make child module point to advanced module as parent
child_module.parent_select.active = True
child_module.parent_select.module_id = parent_module.unique_id
self.assertXmlPartialEqual(
self.get_xml('advanced_module_parent_filters'),
factory.app.create_suite(),
"./entry[2]"
)
def test_case_list_registration_form_advanced_autoload(self):
factory = AppFactory(build_version='2.9')
register_module, register_form = factory.new_advanced_module('register_dugong', 'dugong')
factory.form_opens_case(register_form)
register_form.actions.load_update_cases.append(LoadUpdateAction(
case_tag='usercase',
auto_select=AutoSelectCase(
mode=AUTO_SELECT_USERCASE,
)
))
case_module, update_form = factory.new_advanced_module('update_dugong', 'dugong')
factory.form_requires_case(update_form)
case_module.case_list_form.form_id = register_form.get_unique_id()
case_module.case_list_form.label = {
'en': 'Register another Dugong'
}
self.assertXmlEqual(self.get_xml('case-list-form-advanced-autoload'), factory.app.create_suite())
def setUpClass(cls):
super(AppManagerDataSourceConfigTest, cls).setUpClass()
factory = AppFactory(domain=cls.domain)
# create main form that defines case schema
m0, f0 = factory.new_basic_module('Main Module', cls.case_type)
f0.source = get_simple_xform()
f0.name = {'en': 'Main Form'}
factory.form_requires_case(f0, case_type=cls.case_type, update={
cp: '/data/{}'.format(cp) for cp in cls.case_properties.keys()
})
cls.main_form = f0
# create another module/form to generate a parent case relationship
# for the main case type
m1, f1 = factory.new_basic_module('Parent Module', cls.parent_type)
f1.source = get_simple_xform() # not used, just needs to be some valid XForm
f1.name = {'en': 'Parent Form'}
factory.form_opens_case(f1, case_type=cls.parent_type)
factory.form_opens_case(f1, case_type=cls.case_type, is_subcase=True)
cls.app = factory.app
cls.app.save()
def test_parent_preload(self):
"""
Test parent case is correctly set in preloads when first form of parent module updates a case
"""
factory = AppFactory(build_version='2.9.0')
upd_goldfish_mod, upd_goldfish_form = factory.new_basic_module('upd_goldfish', 'gold-fish')
factory.form_requires_case(upd_goldfish_form)
guppy_mod, guppy_form = factory.new_basic_module(
'upd_guppy',
'guppy',
parent_module=upd_goldfish_mod,
)
guppy_form.source = self.get_xml('original_form', override_path=('data',)).decode('utf-8')
factory.form_requires_case(
guppy_form,
'guppy',
parent_case_type='gold-fish',
preload={'/data/question1': 'parent/question1'})
self.assertXmlEqual(self.get_xml('child-module-preload-parent-ref'), guppy_form.render_xform())
def test_manual_form_link(self):
factory = AppFactory(build_version='2.9.0/latest')
m0, m0f0 = factory.new_basic_module('enroll child', 'child')
factory.form_opens_case(m0f0)
m1, m1f0 = factory.new_basic_module('child visit', 'child')
factory.form_requires_case(m1f0)
factory.form_opens_case(m1f0, case_type='visit', is_subcase=True)
m2, m2f0 = factory.new_advanced_module('visit history', 'visit', parent_module=m1)
factory.form_requires_case(m2f0, 'child')
factory.form_requires_case(m2f0, 'visit', parent_case_type='child')
m0f0.post_form_workflow = WORKFLOW_FORM
m0f0.form_links = [
FormLink(xpath="true()", form_id=m1f0.unique_id, datums=[
FormDatum(name='case_id', xpath="instance('commcaresession')/session/data/case_id_new_child_0")
]),
]
m1f0.post_form_workflow = WORKFLOW_FORM
m1f0.form_links = [
FormLink(xpath="true()", form_id=m2f0.unique_id, datums=[
FormDatum(name='case_id', xpath="instance('commcaresession')/session/data/case_id"),
FormDatum(name='case_id_load_visit_0', xpath="instance('commcaresession')/session/data/case_id_new_visit_0"),
]),
]
self.assertXmlPartialEqual(self.get_xml('form_link_tdh'), factory.app.create_suite(), "./entry")
def test_return_to_child_module(self):
factory = AppFactory(build_version='2.9.0/latest')
m0, m0f0 = factory.new_basic_module('enroll child', 'child')
factory.form_opens_case(m0f0)
m1, m1f0 = factory.new_basic_module('child visit', 'child')
factory.form_requires_case(m1f0)
factory.form_opens_case(m1f0, case_type='visit', is_subcase=True)
m2, m2f0 = factory.new_advanced_module('visit history', 'visit', parent_module=m1)
factory.form_requires_case(m2f0, 'child')
factory.form_requires_case(m2f0, 'visit', parent_case_type='child')
m2f0.post_form_workflow = WORKFLOW_MODULE
expected = """
<partial>
<stack>
<create>
<command value="'m1'"/>
<datum id="case_id" value="instance('commcaresession')/session/data/case_id"/>
<datum id="case_id_new_visit_0" value="uuid()"/>
<command value="'m2'"/>
</create>
</stack>
</partial>
"""
self.assertXmlPartialEqual(expected, factory.app.create_suite(), "./entry[3]/stack")
def test_form_display_condition(self):
"""
case_id should be renamed in a basic submodule form
"""
factory = AppFactory(domain=DOMAIN)
m0, m0f0 = factory.new_advanced_module('parent', 'gold-fish')
factory.form_requires_case(m0f0)
# changing this case tag should result in the session var in the submodule entry being updated to match it
m0f0.actions.load_update_cases[0].case_tag = 'load_goldfish_renamed'
m1, m1f0 = factory.new_advanced_module('child', 'guppy', parent_module=m0)
factory.form_requires_case(m1f0, 'gold-fish', update={'question1': '/data/question1'})
factory.form_requires_case(m1f0, 'guppy', parent_case_type='gold-fish')
# making this case tag the same as the one in the parent module should mean that it will also get changed
# to avoid conflicts
m1f0.actions.load_update_cases[1].case_tag = 'load_goldfish_renamed'
m1f0.form_filter = "#case/age > 33"
XML = """
<partial>
<menu id="m1" root="m0">
<text>
<locale id="modules.m1"/>
</text>
<command id="m1-f0" relevant="instance('casedb')/casedb/case[@case_id=instance('commcaresession')/session/data/case_id_load_goldfish_renamed_guppy]/age > 33"/>
</menu>
</partial>
"""
self.assertXmlPartialEqual(XML, factory.app.create_suite(), "./menu[@id='m1']")
def test_fixture_to_case_selection_parent_child(self):
factory = AppFactory(build_version='2.9')
m0, m0f0 = factory.new_basic_module('parent', 'parent')
m0.fixture_select.active = True
m0.fixture_select.fixture_type = 'province'
m0.fixture_select.display_column = 'display_name'
m0.fixture_select.variable_column = 'var_name'
m0.fixture_select.xpath = 'province = $fixture_value'
factory.form_requires_case(m0f0)
m1, m1f0 = factory.new_basic_module('child', 'child')
m1.fixture_select.active = True
m1.fixture_select.fixture_type = 'city'
m1.fixture_select.display_column = 'display_name'
m1.fixture_select.variable_column = 'var_name'
m1.fixture_select.xpath = 'city = $fixture_value'
factory.form_requires_case(m1f0, parent_case_type='parent')
self.assertXmlEqual(self.get_xml('fixture-to-case-selection-parent-child'), factory.app.create_suite())
def test_reference_to_missing_session_variable_in_stack(self):
# http://manage.dimagi.com/default.asp?236750
#
# Stack create blocks do not update the session after each datum
# so items put into the session in one step aren't available later steps
#
# <datum id="case_id_A" value="instance('commcaresession')/session/data/case_id_new_A"/>
# - <datum id="case_id_B" value="instance('casedb')/casedb/case[@case_id=instance('commcaresession')/session/data/case_id_A]/index/host"/>
# + <datum id="case_id_B" value="instance('casedb')/casedb/case[@case_id=instance('commcaresession')/session/data/case_id_new_A]/index/host"/>
#
# in the above example ``case_id_A`` is being added to the session and then
# later referenced. However since the session doesn't get updated
# the value isn't available in the session.
#
# To fix this we need to replace any references to previous variables with the full xpath which
# that session variable references.
#
# See corehq.apps.app_manager.suite_xml.post_process.workflow._replace_session_references_in_stack
factory = AppFactory(build_version='2.9.0/latest')
m0, m0f0 = factory.new_basic_module('person registration', 'person')
factory.form_opens_case(m0f0)
m1, m1f0 = factory.new_advanced_module('episode registration', 'episode')
factory.form_requires_case(m1f0, case_type='person')
factory.form_opens_case(m1f0, case_type='episode', is_subcase=True, is_extension=True)
m2, m2f0 = factory.new_advanced_module('tests', 'episode')
factory.form_requires_case(m2f0, 'episode')
factory.advanced_form_autoloads(m2f0, AUTO_SELECT_CASE, 'host', 'load_episode_0')
m1f0.post_form_workflow = WORKFLOW_FORM
m1f0.form_links = [
FormLink(xpath="true()", form_id=m2f0.unique_id, datums=[
FormDatum(name='case_id_load_episode_0', xpath="instance('commcaresession')/session/data/case_id_new_episode_0")
]),
]
self.assertXmlPartialEqual(self.get_xml('form_link_enikshay'), factory.app.create_suite(), "./entry")
def setUpClass(cls):
super(TestBuildingSchemaFromApplication, cls).setUpClass()
cls.current_app = Application.wrap(cls.get_json('basic_application'))
cls.first_build = Application.wrap(cls.get_json('basic_application'))
cls.first_build._id = '123'
cls.first_build.copy_of = cls.current_app.get_id
cls.first_build.version = 3
cls.first_build.has_submissions = True
factory = AppFactory(build_version='2.36.0')
m0, f0 = factory.new_advanced_module('mod0', 'advanced')
f0.source = cls.get_xml('repeat_group_form').decode('utf-8')
f0.xmlns = 'repeat-xmlns'
factory.form_requires_case(f0, 'case0')
f0.actions.open_cases = [
AdvancedOpenCaseAction(
case_type="advanced",
case_tag="open_case_0",
name_path="/data/question3/question4",
repeat_context="/data/question3",
case_indices=[CaseIndex(tag='load_case0_0')]
)
]
cls.advanced_app = factory.app
cls.advanced_app.save()
cls.apps = [
cls.current_app,
cls.first_build,
cls.advanced_app,
]
with drop_connected_signals(app_post_save):
for app in cls.apps:
app.save()
