class XLS2XFormTests(TestCase):
survey_package = {
'id_string': u'test_2011_08_29b',
'name_of_main_section': u'gps',
'sections': {
u'gps': {
u'children': [
{
u'name': u'location',
u'type': u'gps'
}
],
u'name': u'gps',
u'type': u'survey'
}
},
'title': u'test'
}
survey = pyxform.create_survey(**survey_package)
def test_create_parser_without_args(self):
"""Should exit when no args provided."""
with self.assertRaises(SystemExit):
_create_parser().parse_args([])
def test_create_parser_with_args(self):
"""Should parse the provided arguments."""
arg_xlsform = 'xlsform.xlsx'
arg_output = '.'
arg_json = '--json'
arg_skip_validate = '--skip_validate'
arg_list = [arg_json, arg_skip_validate, arg_xlsform, arg_output]
args = _create_parser().parse_args(arg_list)
self.assertEqual(arg_xlsform, args.path_to_XLSForm)
self.assertEqual(arg_output, args.output_path)
self.assertEqual(True, args.json)
self.assertEqual(False, args.skip_validate)
def test_create_parser_json_default_false(self):
"""Should have json=False if not specified."""
arg_xlsform = 'xlsform.xlsx'
arg_output = '.'
arg_list = [arg_xlsform, arg_output]
args = _create_parser().parse_args(arg_list)
self.assertEqual(False, args.json)
def test_create_parser_no_validate_default_true(self):
"""Should have no_validate=True if not specified."""
arg_xlsform = 'xlsform.xlsx'
arg_output = '.'
arg_list = [arg_xlsform, arg_output]
args = _create_parser().parse_args(arg_list)
self.assertEqual(True, args.skip_validate)
def setUp(self):
main_section = {
"type": "survey",
"name": "MyName",
"children": [{
u'type': u'text',
u'name': u'name'
}]
}
self.title = "TestAsurvey"
self.id_string = "Test_canSpecifyIDstring"
self.s = pyxform.create_survey(title=self.title, main_section=main_section, \
id_string=self.id_string)
class XLS2XFormTests(TestCase):
survey_package = {
'id_string': u'test_2011_08_29b',
'name_of_main_section': u'gps',
'sections': {
u'gps': {
u'children': [{
u'name': u'location',
u'type': u'gps'
}],
u'name': u'gps',
u'type': u'survey'
}
},
'title': u'test'
}
survey = pyxform.create_survey(**survey_package)
def export_survey(self, finalize=True, debug=False):
"""
the first way of exporting surveys didn't allow imports
(without writing temp files, which is hacky.)
so i think it's best to go a different route--
1. have this django app gather all the includes (from the portfolio)
-- this allows us to display what includes are missing and prompt
for them before creating the survey
2. this django app will then send a "packaged" dict to pyxform which
can be used to render the survey.
-- the packaged dict contains 4 things
* name (the survey name, no datestamp)
* id_string (for possible later reference)
* questions_list (with hierarchy of groups, etc.)
* question_types (for maximum customizability,
language compaitibility, etc.)
"""
survey_package = self._create_survey_package()
if debug:
return survey_package
return pyxform.create_survey(**survey_package)
class XLS2XFormTests(TestCase):
survey_package = {
"id_string": "test_2011_08_29b",
"name_of_main_section": "gps",
"sections": {
"gps": {
"children": [{
"name": "location",
"type": "gps"
}],
"name": "gps",
"type": "survey",
}
},
"title": "test",
}
survey = pyxform.create_survey(**survey_package)
def test_create_parser_without_args(self):
"""Should exit when no args provided."""
with self.assertRaises(SystemExit):
_create_parser().parse_args([])
def test_create_parser_optional_output_path(self):
"""
Should run fine for a single argument i.e. that is the
path to the xlsx file path, while the output path is left out
"""
try:
_create_parser().parse_args(["/some/path/tofile.xlsx"])
except SystemExit:
self.fail()
def test_create_parser_with_args(self):
"""Should parse the provided arguments."""
arg_xlsform = "xlsform.xlsx"
arg_output = "."
arg_list = [
"--json",
"--skip_validate",
"--pretty_print",
arg_xlsform,
arg_output,
]
args = _create_parser().parse_args(arg_list)
self.assertEqual(arg_xlsform, args.path_to_XLSForm)
self.assertEqual(arg_output, args.output_path)
self.assertEqual(True, args.json)
self.assertEqual(False, args.skip_validate)
self.assertEqual(True, args.pretty_print)
def test_create_parser_file_name_with_space(self):
"""Should interpret the path correctly."""
arg_xlsform = "some/path/my xlsform.xlsx"
arg_output = "."
arg_list = [arg_xlsform, arg_output]
args = _create_parser().parse_args(arg_list)
self.assertEqual(arg_xlsform, args.path_to_XLSForm)
def test_create_parser_json_default_false(self):
"""Should have json=False if not specified."""
arg_xlsform = "xlsform.xlsx"
arg_output = "."
arg_list = [arg_xlsform, arg_output]
args = _create_parser().parse_args(arg_list)
self.assertEqual(False, args.json)
def test_create_parser_skip_validate_default_true(self):
"""Should have skip_validate=True if not specified."""
arg_xlsform = "xlsform.xlsx"
arg_output = "."
arg_list = [arg_xlsform, arg_output]
args = _create_parser().parse_args(arg_list)
self.assertEqual(True, args.skip_validate)
def test_create_parser_no_enketo_default_false(self):
"""Should have enketo_validate=False if not specified."""
arg_xlsform = "xlsform.xlsx"
arg_output = "."
arg_list = [arg_xlsform, arg_output]
args = _create_parser().parse_args(arg_list)
self.assertEqual(False, args.enketo_validate)
def test_create_parser_pretty_print_default_False(self):
"""Should have pretty_print=False if not specified."""
args = _create_parser().parse_args(["xlsform.xlsx", "."])
self.assertFalse(args.pretty_print)
def test_validator_args_logic_skip_validate_alone(self):
"""Should deactivate both validators."""
raw_args = _create_parser().parse_args(
["xlsform.xlsx", ".", "--skip_validate"])
args = _validator_args_logic(args=raw_args)
self.assertEqual(False, args.odk_validate)
self.assertEqual(False, args.enketo_validate)
def test_validator_args_logic_odk_default(self):
"""Should activate ODK only."""
raw_args = _create_parser().parse_args(["xlsform.xlsx", "."])
args = _validator_args_logic(args=raw_args)
self.assertEqual(True, args.odk_validate)
self.assertEqual(False, args.enketo_validate)
def test_validator_args_logic_enketo_only(self):
"""Should activate Enketo only."""
raw_args = _create_parser().parse_args(
["xlsform.xlsx", ".", "--enketo_validate"])
args = _validator_args_logic(args=raw_args)
self.assertEqual(False, args.odk_validate)
self.assertEqual(True, args.enketo_validate)
def test_validator_args_logic_odk_only(self):
"""Should activate ODK only."""
raw_args = _create_parser().parse_args(
["xlsform.xlsx", ".", "--odk_validate"])
args = _validator_args_logic(args=raw_args)
self.assertEqual(True, args.odk_validate)
self.assertEqual(False, args.enketo_validate)
def test_validator_args_logic_odk_and_enketo(self):
"""Should activate ODK and Enketo."""
raw_args = _create_parser().parse_args(
["xlsform.xlsx", ".", "--odk_validate", "--enketo_validate"])
args = _validator_args_logic(args=raw_args)
self.assertEqual(True, args.odk_validate)
self.assertEqual(True, args.enketo_validate)
def test_validator_args_logic_skip_validate_override(self):
"""Should deactivate both validators"""
raw_args = _create_parser().parse_args([
"xlsform.xlsx",
".",
"--skip_validate",
"--odk_validate",
"--enketo_validate",
])
args = _validator_args_logic(args=raw_args)
self.assertEqual(False, args.odk_validate)
self.assertEqual(False, args.enketo_validate)
@mock.patch(
"argparse.ArgumentParser.parse_args",
return_value=argparse.Namespace(
path_to_XLSForm="xlsform.xlsx",
output_path=None,
json=False,
skip_validate=False,
odk_validate=False,
enketo_validate=False,
pretty_print=False,
),
)
@mock.patch("pyxform.xls2xform.xls2xform_convert")
def test_xls2form_convert_parameters(self, converter_mock,
parser_mock_args):
"""
Checks that xls2xform_convert is given the right arguments, when the
output-path is not given
"""
converter_mock.return_value = "{}"
main_cli()
converter_mock.assert_called_once_with(
xlsform_path="xlsform.xlsx",
xform_path="xlsform.xml",
validate=False,
pretty_print=False,
enketo=False,
)
@mock.patch(
"argparse.ArgumentParser.parse_args",
return_value=argparse.Namespace(
path_to_XLSForm="xlsform.xlsx",
output_path=None,
json=True,
skip_validate=False,
odk_validate=False,
enketo_validate=False,
pretty_print=False,
),
)
@mock.patch("pyxform.xls2xform.xls2xform_convert")
def test_xls2xform_convert_params_with_flags(self, converter_mock,
parser_mock_args):
"""
Should call xlsform_convert with the correct input for output
path where only the xlsform input path and json flag were provided, since
the xlsform-convert can be called if json flag was set or when not
"""
converter_mock.return_value = "{}"
main_cli()
converter_mock.assert_called_once_with(
xlsform_path="xlsform.xlsx",
xform_path="xlsform.xml",
validate=False,
pretty_print=False,
enketo=False,
)
@mock.patch(
"argparse.ArgumentParser.parse_args",
return_value=argparse.Namespace(
path_to_XLSForm=path_to_text_fixture("bad_calc.xlsx"),
output_path=None,
json=False,
skip_validate=True,
odk_validate=True,
enketo_validate=True,
pretty_print=True,
),
)
def test_xls2xform_convert_throwing_odk_error(self, parser_mock_args):
"""
Parse and validate bad_calc.xlsx
"""
logger = logging.getLogger("pyxform.xls2xform")
with mock.patch.object(logger, "error") as mock_debug:
main_cli()
self.assertEqual(mock_debug.call_count, 1)
def test_get_xml_path_function(self):
"""Should return an xml path in the same directory as the xlsx file"""
xlsx_path = "/home/user/Desktop/xlsform.xlsx"
expected = "/home/user/Desktop/xlsform.xml"
assert expected == get_xml_path(xlsx_path)
# check that it also handles spaced routes
xlsx_path = "/home/user/Desktop/my xlsform.xlsx"
expected = "/home/user/Desktop/my xlsform.xml"
assert expected == get_xml_path(xlsx_path)
class XLS2XFormTests(TestCase):
survey_package = {
'id_string': u'test_2011_08_29b',
'name_of_main_section': u'gps',
'sections': {
u'gps': {
u'children': [{
u'name': u'location',
u'type': u'gps'
}],
u'name': u'gps',
u'type': u'survey'
}
},
'title': u'test'
}
survey = pyxform.create_survey(**survey_package)
def test_create_parser_without_args(self):
"""Should exit when no args provided."""
with self.assertRaises(SystemExit):
_create_parser().parse_args([])
def test_create_parser_with_args(self):
"""Should parse the provided arguments."""
arg_xlsform = 'xlsform.xlsx'
arg_output = '.'
arg_list = [
'--json', '--skip_validate', '--no_pretty_print', arg_xlsform,
arg_output
]
args = _create_parser().parse_args(arg_list)
self.assertEqual(arg_xlsform, args.path_to_XLSForm)
self.assertEqual(arg_output, args.output_path)
self.assertEqual(True, args.json)
self.assertEqual(False, args.skip_validate)
self.assertEqual(False, args.no_pretty_print)
def test_create_parser_json_default_false(self):
"""Should have json=False if not specified."""
arg_xlsform = 'xlsform.xlsx'
arg_output = '.'
arg_list = [arg_xlsform, arg_output]
args = _create_parser().parse_args(arg_list)
self.assertEqual(False, args.json)
def test_create_parser_skip_validate_default_true(self):
"""Should have skip_validate=True if not specified."""
arg_xlsform = 'xlsform.xlsx'
arg_output = '.'
arg_list = [arg_xlsform, arg_output]
args = _create_parser().parse_args(arg_list)
self.assertEqual(True, args.skip_validate)
def test_create_parser_no_enketo_default_false(self):
"""Should have enketo_validate=False if not specified."""
arg_xlsform = 'xlsform.xlsx'
arg_output = '.'
arg_list = [arg_xlsform, arg_output]
args = _create_parser().parse_args(arg_list)
self.assertEqual(False, args.enketo_validate)
def test_create_parser_no_pretty_print_default_true(self):
"""Should have no_pretty_print=True if not specified."""
args = _create_parser().parse_args([
'xlsform.xlsx',
'.',
])
self.assertEqual(True, args.no_pretty_print)
def test_validator_args_logic_skip_validate_alone(self):
"""Should deactivate both validators."""
raw_args = _create_parser().parse_args(
['xlsform.xlsx', '.', '--skip_validate'])
args = _validator_args_logic(args=raw_args)
self.assertEqual(False, args.odk_validate)
self.assertEqual(False, args.enketo_validate)
def test_validator_args_logic_odk_default(self):
"""Should activate ODK only."""
raw_args = _create_parser().parse_args([
'xlsform.xlsx',
'.',
])
args = _validator_args_logic(args=raw_args)
self.assertEqual(True, args.odk_validate)
self.assertEqual(False, args.enketo_validate)
def test_validator_args_logic_enketo_only(self):
"""Should activate Enketo only."""
raw_args = _create_parser().parse_args(
['xlsform.xlsx', '.', '--enketo_validate'])
args = _validator_args_logic(args=raw_args)
self.assertEqual(False, args.odk_validate)
self.assertEqual(True, args.enketo_validate)
def test_validator_args_logic_odk_only(self):
"""Should activate ODK only."""
raw_args = _create_parser().parse_args(
['xlsform.xlsx', '.', '--odk_validate'])
args = _validator_args_logic(args=raw_args)
self.assertEqual(True, args.odk_validate)
self.assertEqual(False, args.enketo_validate)
def test_validator_args_logic_odk_and_enketo(self):
"""Should activate ODK and Enketo."""
raw_args = _create_parser().parse_args(
['xlsform.xlsx', '.', '--odk_validate', '--enketo_validate'])
args = _validator_args_logic(args=raw_args)
self.assertEqual(True, args.odk_validate)
self.assertEqual(True, args.enketo_validate)
def test_validator_args_logic_skip_validate_override(self):
"""Should deactivate both validators"""
raw_args = _create_parser().parse_args([
'xlsform.xlsx',
'.',
'--skip_validate',
'--odk_validate',
'--enketo_validate',
])
args = _validator_args_logic(args=raw_args)
self.assertEqual(False, args.odk_validate)
self.assertEqual(False, args.enketo_validate)