def test_has_default(self):
option = make_option('-e', '--example_opt', type='int',
help='Example int option without default value')
obs = OptionInfo(option)
self.assertFalse(obs.has_default())
option = make_option('-e', '--example_opt', type='int', default=23,
help='Example int option with default value')
obs = OptionInfo(option)
self.assertTrue(obs.has_default())
def test_is_short_command_line(self):
option = make_option('-e', '--example_opt', type='string',
help='Example string option')
obj = OptionInfo(option)
self.assertTrue(obj.is_short_command_line())
# Test of an option whithout short opt
option = make_option('--example_opt', type='string',
help='Example string option')
obj = OptionInfo(option)
self.assertFalse(obj.is_short_command_line())
# Test of an option whithout long opt
option = make_option('-e', type='string',
help='Example string option')
obj = OptionInfo(option)
self.assertTrue(obj.is_short_command_line())
def test_get_command_line_string(self):
option = make_option('-e', '--example_opt', type='string',
help='Example string option')
obj = OptionInfo(option)
obs = obj.get_command_line_string()
self.assertEqual(obs, '-e')
# Test of an option whithout short opt
option = make_option('--example_opt', type='string',
help='Example string option')
obj = OptionInfo(option)
obs = obj.get_command_line_string()
self.assertEqual(obs, '--example_opt')
# Test of an option whithout long opt
option = make_option('-e', type='string',
help='Example string option')
obj = OptionInfo(option)
obs = obj.get_command_line_string()
self.assertEqual(obs, '-e')
def test_init(self):
# Test of an option whithout short opt
option = make_option('--example_opt', type='string',
help='Example string option')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'text')
self.assertEqual(obs.short_opt, None)
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example string option')
self.assertEqual(obs.default, None)
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, None)
# Test of an option whithout long opt
option = make_option('-e', type='string',
help='Example string option')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'e')
self.assertEqual(obs.type, 'text')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, None)
self.assertEqual(obs.label, 'Example string option')
self.assertEqual(obs.default, None)
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, None)
# Tests of string option
option = make_option('-e', '--example_opt', type='string',
help='Example string option')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'text')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example string option')
self.assertEqual(obs.default, None)
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, None)
# Tests of int option
option = make_option('-e', '--example_opt', type='int',
help='Example int option without default value')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'integer')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example int option without default value')
self.assertEqual(obs.default, None)
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, None)
option = make_option('-e', '--example_opt', type='int', default=23,
help='Example int option with default value')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'integer')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example int option with default value')
self.assertEqual(obs.default, '23')
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, None)
# Test of long option
option = make_option('-e', '--example_opt', type='long', default=92233720368547758070,
help='Example long option with default value')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'float')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example long option with default value')
self.assertEqual(obs.default, '92233720368547758070')
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, None)
# Test of float option
option = make_option('-e', '--example_opt', type='float', default=23.45,
help='Example float option with default value')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'float')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example float option with default value')
self.assertEqual(obs.default, '23.45')
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, None)
# Test of complex option
option = make_option('-e', '--example_opt', type='complex',
help='Example complex option with default value')
self.assertRaises(ValueError, OptionInfo, option)
# Test of choice option
option = make_option('-e', '--example_opt', type='choice', choices=['choice1','choice2','choice3'],
help='Example choice option')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'select')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example choice option')
self.assertEqual(obs.default, None)
self.assertEqual(obs.choices, ['choice1','choice2','choice3'])
self.assertEqual(obs.format, None)
# Test of existing_path option
option = make_option('-e', '--example_opt', type='existing_path',
help='Example existing_path option')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'input_dir')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example existing_path option')
self.assertEqual(obs.default, None)
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, None)
# Test of new_path option
option = make_option('-e', '--example_opt', type='new_path',
help='Example new_path option')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'output_dir')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example new_path option')
self.assertEqual(obs.default, None)
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, 'tgz')
# Test of existing_filepath option
option = make_option('-e', '--example_opt', type='existing_filepath',
help='Example existing_filepath option')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'data')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example existing_filepath option')
self.assertEqual(obs.default, None)
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, None)
# Test of existing_filepaths option
option = make_option('-e', '--example_opt', type='existing_filepaths',
help='Example existing_filepaths option')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'repeat')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example existing_filepaths option')
self.assertEqual(obs.default, None)
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, None)
# Test of new_filepath option
option = make_option('-e', '--example_opt', type='new_filepath',
help='Example new_filepath option')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'output')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example new_filepath option')
self.assertEqual(obs.default, None)
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, 'txt')
# Test of existing_dirpath option
option = make_option('-e', '--example_opt', type='existing_dirpath',
help='Example existing_dirpath option')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'input_dir')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example existing_dirpath option')
self.assertEqual(obs.default, None)
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, None)
# Test of new_dirpath option
option = make_option('-e', '--example_opt', type='new_dirpath',
help='Example new_dirpath option')
obs = OptionInfo(option)
self.assertEqual(obs.name, 'example_opt')
self.assertEqual(obs.type, 'output_dir')
self.assertEqual(obs.short_opt, '-e')
self.assertEqual(obs.long_opt, '--example_opt')
self.assertEqual(obs.label, 'Example new_dirpath option')
self.assertEqual(obs.default, None)
self.assertEqual(obs.choices, None)
self.assertEqual(obs.format, 'tgz')
output_fp = path.join(self.output_dir, 'example_script.xml')
self._paths_to_clean_up = [output_fp, './example_script.py']
copyfile(self.script_fp, './example_script.py')
make_xml(self.script_fp, self.output_dir, None)
self.assertTrue(path.exists(output_fp), 'The xml file was not created in the appropiate location')
# A script info example
script_info_example = {}
script_info_example['brief_description'] = "An example of brief description"
script_info_example['script_description'] = "An example of script description"
script_info_example['script_usage'] = [("Example", "Field not used", "%prog ")]
script_info_example['output_description'] = "Field not used"
script_info_example['required_options'] = [
make_option('-i', '--input_fp', type="existing_path",
help='An example of existing_path option'),
make_option('-o', '--output_fp', type="new_path",
help='An example of new_path option')
]
script_info_example['optional_options'] = [
make_option('-c', '--choice_ex', type="choice", choices=['choice1','choice2','choice3'],
help='An example of choice option'),
make_option('-r', '--repeat_ex', type="existing_filepaths",
help='An example of existing_filepaths option')
]
script_info_example['version'] = "1.4.0-dev"
text_script_info = {}
text_script_info['brief_description'] = "Example of script info with string options"
text_script_info['script_description'] = "An example of script info with a required string option and an optional string option"
text_script_info['script_usage'] = [("Example", "Field not used", "%prog ")]
