def main(argc, argv):
configs = Configs(argc, argv)
if configs == False:
return 2
definition = Definition()
definition.askUserForDefinition(configs.options)
fileManager = FileManager(configs, definition)
fileManager.writeFiles()
fileManager.close()
return 0
def test_banned_path(self):
"""
Test banned paths are detected
"""
bad_paths = [
"/etc/one", "/opt/two", "/usr/etc/three", "/usr/local/four",
"/usr/src/five", "/var/six"
]
for path in bad_paths:
self.assertTrue(FileManager.banned_path(path))
def setUp(self):
self.fm = FileManager()
class TestFiles(unittest.TestCase):
def setUp(self):
self.fm = FileManager()
def test_push_package_file(self):
"""
Test push_package_file with no package name specified (package name
should default to 'main'
"""
self.assertFalse(self.fm.newfiles_printed)
self.fm.push_package_file('test-fn')
self.assertEqual(self.fm.packages['main'], set(['test-fn']))
self.assertTrue(self.fm.newfiles_printed)
def test_push_package_file_dev(self):
"""
Test push_package_file with dev package specified
"""
self.fm.push_package_file('test-fn', 'dev')
self.assertEqual(self.fm.packages['dev'], set(['test-fn']))
self.assertTrue(self.fm.newfiles_printed)
def test_compat_exclude_keep_file(self):
"""
Test compat_exclude with a file that shouldn't be excluded.
"""
config.config_opts['compat'] = True
self.assertFalse(self.fm.compat_exclude('/usr/lib64/libfoo.so.1'))
def test_compat_exclude_exclude_file(self):
"""
Test compat_exclude with a file that should be excluded.
"""
config.config_opts['compat'] = True
self.assertTrue(self.fm.compat_exclude('/usr/lib64/libfoo.so'))
def test_compat_exclude_not_compat_mode(self):
"""
Test compat_exclude with a file that should be excluded but isn't
because the package isn't being run in compat mode.
"""
config.config_opts['compat'] = False
self.assertFalse(self.fm.compat_exclude('/usr/lib64/libfoo.so'))
def test_file_pat_match(self):
"""
Test file_pat_match with good match and no replacement or prefix
specified.
"""
self.fm.push_package_file = MagicMock()
self.assertTrue(self.fm.file_pat_match('test-fn', r'test-fn', 'main'))
self.fm.push_package_file.assert_called_with('test-fn', 'main')
def test_file_pat_match_exclude(self):
"""
Test file_pat_match with good match and filename in excludes list.
"""
self.fm.push_package_file = MagicMock()
self.fm.excludes.append('test-fn')
self.assertTrue(self.fm.file_pat_match('test-fn', r'test-fn', 'main'))
self.fm.push_package_file.assert_called_with('%exclude test-fn',
'main')
def test_file_pat_match_replacement(self):
"""
Test file_pat_match with replacement provided
"""
self.fm.push_package_file = MagicMock()
self.assertTrue(
self.fm.file_pat_match('test-fn', r'test-fn', 'main', 'testfn'))
self.fm.push_package_file.assert_called_with('testfn', 'main')
def test_file_pat_match_no_match(self):
"""
Test file_pat_match with no match
"""
self.fm.push_package_file = MagicMock()
self.assertFalse(self.fm.file_pat_match('test-fn', r'testfn', 'main'))
self.fm.push_package_file.assert_not_called()
def test_file_is_locale(self):
"""
Test file_is_locale with locale filename not present in locale list
"""
self.assertEqual(self.fm.locales, [])
self.assertTrue(self.fm.file_is_locale('/usr/share/locale/a/loc.mo'))
self.assertEqual(self.fm.locales, ['loc'])
def test_file_is_locale_non_locale(self):
"""
Test file_is_locale with non-locale filename
"""
self.assertFalse(self.fm.file_is_locale('test-fn'))
self.assertEqual(self.fm.locales, [])
def test_file_is_locale_present(self):
"""
Test file_is_locale with locale present in locale list
"""
self.fm.locales.append('loc')
self.assertEqual(self.fm.locales, ['loc'])
self.assertTrue(self.fm.file_is_locale('/usr/share/locale/a/loc.mo'))
self.assertEqual(self.fm.locales, ['loc'])
def test_push_file_autostart(self):
"""
Test push_file to autostart package, this excludes the file.
"""
self.fm.file_is_locale = MagicMock(return_value=False)
self.fm.push_package_file = MagicMock()
autostart = '/usr/lib/systemd/system/some.target.wants/some'
self.fm.push_file(autostart)
calls = [
call(autostart, 'autostart'),
call('%exclude ' + autostart, 'config')
]
self.fm.push_package_file.assert_has_calls(calls)
def test_push_file_extras(self):
"""
Test push_file to extras package, this excludes the file
"""
self.fm.file_is_locale = MagicMock(return_value=False)
self.fm.push_package_file = MagicMock()
self.fm.extras.append('test')
self.fm.push_file('test')
calls = [call('test', 'extras'), call('%exclude test')]
self.fm.push_package_file.assert_has_calls(calls)
def test_push_file_setuid(self):
"""
Test push_file with fname in setuid list
"""
self.fm.file_is_locale = MagicMock(return_value=False)
self.fm.push_package_file = MagicMock()
self.fm.setuid.append('test')
self.fm.push_file('test')
calls = [
call('%attr(4755, root, root) test', 'setuid'),
call('%exclude test')
]
self.fm.push_package_file.assert_has_calls(calls)
def test_push_file_match(self):
"""
Test push_file with match in pattern list
"""
self.fm.file_is_locale = MagicMock(return_value=False)
self.fm.push_package_file = MagicMock()
self.fm.push_file('/usr/bin/test')
self.fm.push_package_file.assert_called_once_with(
'/usr/bin/test', 'bin')
def test_push_file_match_tarball_name_dependency(self):
"""
Test push_file with match in the list on the single item that is
dependent on the tarball name.
"""
self.fm.file_is_locale = MagicMock(return_value=False)
self.fm.push_package_file = MagicMock()
files.tarball.name = 'testball'
self.fm.push_file('/usr/share/doc/testball/')
self.fm.push_package_file.assert_called_once_with(
'%doc /usr/share/doc/testball/*', 'doc')
def test_push_file_no_match(self):
"""
Test push_file with no pattern match on the file name. Should just push
the unmodified filename once.
"""
self.fm.file_is_locale = MagicMock(return_value=False)
self.fm.push_package_file = MagicMock()
self.fm.push_file('doesntmatcha thing')
self.fm.push_package_file.assert_called_once_with('doesntmatcha thing')
def test_remove_file(self):
"""
Test remove_file with filename in files list and main package
"""
self.fm.files.append('test')
self.fm.packages['main'] = ['test']
self.assertIn('test', self.fm.files)
self.assertNotIn('test', self.fm.files_blacklist)
self.assertIn('test', self.fm.packages['main'])
self.fm.remove_file('test')
self.assertNotIn('test', self.fm.files)
self.assertNotIn('test', self.fm.packages['main'])
self.assertIn('test', self.fm.files_blacklist)
def test_remove_file_not_present(self):
"""
Test remove_file with filename not in files list.
"""
self.assertNotIn('test', self.fm.files)
self.assertNotIn('test', self.fm.files_blacklist)
self.fm.remove_file('test')
self.assertNotIn('test', self.fm.files)
self.assertNotIn('test', self.fm.files_blacklist)
def test_clean_directories(self):
"""
Test clean_directories with a directory in the list
"""
with tempfile.TemporaryDirectory() as tmpd:
os.mkdir(os.path.join(tmpd, "directory"))
with open(os.path.join(tmpd, "file1"), "w") as f:
f.write(" ")
with open(os.path.join(tmpd, "file2"), "w") as f:
f.write(" ")
self.fm.packages["main"] = set()
self.fm.packages["main"].add("/directory")
self.fm.packages["main"].add("/file1")
self.fm.packages["main"].add("/file2")
self.fm.clean_directories(tmpd)
self.assertEqual(self.fm.packages["main"],
set(["/file1", "/file2"]))
def test_clean_directories_with_dir(self):
"""
Test clean_directories with a %dir directory in the list. This should
remain.
"""
with tempfile.TemporaryDirectory() as tmpd:
os.mkdir(os.path.join(tmpd, "directory"))
with open(os.path.join(tmpd, "file1"), "w") as f:
f.write(" ")
with open(os.path.join(tmpd, "file2"), "w") as f:
f.write(" ")
self.fm.packages["main"] = set()
self.fm.packages["main"].add("%dir /directory")
self.fm.packages["main"].add("/file1")
self.fm.packages["main"].add("/file2")
self.fm.clean_directories(tmpd)
self.assertEqual(self.fm.packages["main"],
set(["%dir /directory", "/file1", "/file2"]))
def test_clean_directories_with_symlink_to_dir(self):
"""
Test clean_directories with a symlink to a directory in the list. The
symlink should remain, but the directory should be cleaned.
"""
with tempfile.TemporaryDirectory() as tmpd:
dirname = os.path.join(tmpd, "directory")
linkname = os.path.join(tmpd, "symlink")
os.mkdir(dirname)
os.symlink(dirname, linkname)
self.fm.packages["main"] = set()
self.fm.packages["main"].add("/directory")
self.fm.packages["main"].add("/symlink")
self.fm.clean_directories(tmpd)
self.assertEqual(self.fm.packages["main"], set(["/symlink"]))
def test_clean_directories_with_symlink_to_explicit_dir(self):
"""
Test clean_directories with a symlink to a %dir directory in the list.
The symlink and directory should both remain.
"""
with tempfile.TemporaryDirectory() as tmpd:
dirname = os.path.join(tmpd, "directory")
linkname = os.path.join(tmpd, "symlink")
os.mkdir(dirname)
os.symlink(dirname, linkname)
self.fm.packages["main"] = set()
self.fm.packages["main"].add("%dir /directory")
self.fm.packages["main"].add("/symlink")
self.fm.clean_directories(tmpd)
self.assertEqual(self.fm.packages["main"],
set(["%dir /directory", "/symlink"]))
def test_clean_directories_with_doc(self):
"""
Test clean_directories with a %doc directive in the list. This should
remain.
"""
with tempfile.TemporaryDirectory() as tmpd:
os.mkdir(os.path.join(tmpd, "directory"))
with open(os.path.join(tmpd, "file1"), "w") as f:
f.write(" ")
with open(os.path.join(tmpd, "file2"), "w") as f:
f.write(" ")
self.fm.packages["main"] = set()
self.fm.packages["main"].add("%doc /directory")
self.fm.packages["main"].add("/file1")
self.fm.packages["main"].add("/file2")
self.fm.clean_directories(tmpd)
self.assertEqual(self.fm.packages["main"],
set(["%doc /directory", "/file1", "/file2"]))
def setUp(self):
conf = config.Config("")
pkg = build.Build()
self.fm = FileManager(conf, pkg)
def setUp(self):
conf = config.Config()
self.fm = FileManager(conf)
def main(args):
# Program parameters and their default values
use_cli = False
# Print banner
print(Storyboard.SEPARATOR3)
print(Storyboard.STARTUP_BANNER.format(Storyboard.IOTRAIN_SIM_VERSION))
print(Storyboard.SEPARATOR3)
# Parse command line arguments
try:
# Make sure to add ':' for short-form and '=' for long-form options that require an argument
opts, trailing_args = getopt.getopt(args, "hcg", ["help", "cli", "gui"])
except getopt.GetoptError as err:
print(Storyboard.ERROR_CMD_LINE_ARGS.format(str(err)))
usage()
sys.exit(1)
for opt, _ in opts:
if opt in ("-h", "--help"):
usage()
sys.exit(0)
elif opt in ("-c", "--cli"):
use_cli = True
elif opt in ("-g", "--gui"):
use_cli = False
else:
# Nothing to be done on else, since unrecognized options are caught by
# the getopt.GetoptError exception above
pass
if trailing_args:
print(Storyboard.ERROR_TRAILING_ARGS.format(trailing_args))
usage()
sys.exit(2)
# Make sure the database directory exists
if not os.path.isdir(Storyboard.IOTRAIN_DATABASE_PATH):
print(Storyboard.ERROR_DATABASE_NOT_FOUND.format(Storyboard.IOTRAIN_DATABASE_PATH))
sys.exit(3)
# Prepare the Contiki environment
print(Storyboard.INFO_COPY_BIN)
if not FileManager().copy_hierarchy(Storyboard.IOTRAIN_CONTIKI_PATH, Storyboard.CONTIKI_PATH):
print(Storyboard.ERROR_FAILED_COPY_BIN)
sys.exit(4)
# Display the appropriate interface
if use_cli:
# Display the top CLI training menu
print(Storyboard.INFO_START_CLI)
time.sleep(1) # Used for debugging purposes, to make sure messages are displayed
CLI().display_top_menu()
else:
# Display the top GUI training
print(Storyboard.INFO_START_GUI)
GUI().start()
# Cleanup the Contiki environment
print(Storyboard.INFO_REMOVE_BIN)
if not FileManager().delete_hierarchy(Storyboard.IOTRAIN_CONTIKI_PATH, Storyboard.CONTIKI_PATH):
sys.exit(5)
class TestFiles(unittest.TestCase):
def setUp(self):
self.fm = FileManager()
def test_push_package_file(self):
"""
Test push_package_file with no package name specified (package name
should default to 'main'
"""
self.assertFalse(self.fm.newfiles_printed)
self.fm.push_package_file('test-fn')
self.assertEqual(self.fm.packages['main'], set(['test-fn']))
self.assertTrue(self.fm.newfiles_printed)
def test_push_package_file_dev(self):
"""
Test push_package_file with dev package specified
"""
self.fm.push_package_file('test-fn', 'dev')
self.assertEqual(self.fm.packages['dev'], set(['test-fn']))
self.assertTrue(self.fm.newfiles_printed)
def test_file_pat_match(self):
"""
Test file_pat_match with good match and no replacement or prefix
specified.
"""
self.fm.push_package_file = MagicMock()
self.assertTrue(self.fm.file_pat_match('test-fn', r'test-fn', 'main'))
self.fm.push_package_file.assert_called_with('test-fn', 'main')
def test_file_pat_match_exclude(self):
"""
Test file_pat_match with good match and filename in excludes list.
"""
self.fm.push_package_file = MagicMock()
self.fm.excludes.append('test-fn')
self.assertTrue(self.fm.file_pat_match('test-fn', r'test-fn', 'main'))
self.fm.push_package_file.assert_called_with('%exclude test-fn', 'main')
def test_file_pat_match_replacement(self):
"""
Test file_pat_match with replacement provided
"""
self.fm.push_package_file = MagicMock()
self.assertTrue(self.fm.file_pat_match('test-fn', r'test-fn', 'main', 'testfn'))
self.fm.push_package_file.assert_called_with('testfn', 'main')
def test_file_pat_match_no_match(self):
"""
Test file_pat_match with no match
"""
self.fm.push_package_file = MagicMock()
self.assertFalse(self.fm.file_pat_match('test-fn', r'testfn', 'main'))
self.fm.push_package_file.assert_not_called()
def test_file_is_locale(self):
"""
Test file_is_locale with locale filename not present in locale list
"""
self.assertEqual(self.fm.locales, [])
self.assertTrue(self.fm.file_is_locale('/usr/share/locale/a/loc.mo'))
self.assertEqual(self.fm.locales, ['loc'])
def test_file_is_locale_non_locale(self):
"""
Test file_is_locale with non-locale filename
"""
self.assertFalse(self.fm.file_is_locale('test-fn'))
self.assertEqual(self.fm.locales, [])
def test_file_is_locale_present(self):
"""
Test file_is_locale with locale present in locale list
"""
self.fm.locales.append('loc')
self.assertEqual(self.fm.locales, ['loc'])
self.assertTrue(self.fm.file_is_locale('/usr/share/locale/a/loc.mo'))
self.assertEqual(self.fm.locales, ['loc'])
def test_push_file_autostart(self):
"""
Test push_file to autostart package, this excludes the file.
"""
self.fm.file_is_locale = MagicMock(return_value=False)
self.fm.push_package_file = MagicMock()
autostart = '/usr/lib/systemd/system/some.target.wants/some'
self.fm.push_file(autostart)
calls = [call(autostart, 'autostart'), call('%exclude ' + autostart, 'config')]
self.fm.push_package_file.assert_has_calls(calls)
def test_push_file_extras(self):
"""
Test push_file to extras package, this excludes the file
"""
self.fm.file_is_locale = MagicMock(return_value=False)
self.fm.push_package_file = MagicMock()
self.fm.extras.append('test')
self.fm.push_file('test')
calls = [call('test', 'extras'), call('%exclude test')]
self.fm.push_package_file.assert_has_calls(calls)
def test_push_file_setuid(self):
"""
Test push_file with fname in setuid list
"""
self.fm.file_is_locale = MagicMock(return_value=False)
self.fm.push_package_file = MagicMock()
self.fm.setuid.append('test')
self.fm.push_file('test')
calls = [call('%attr(4755, root, root) test', 'setuid'), call('%exclude test')]
self.fm.push_package_file.assert_has_calls(calls)
def test_push_file_match(self):
"""
Test push_file with match in pattern list
"""
self.fm.file_is_locale = MagicMock(return_value=False)
self.fm.push_package_file = MagicMock()
self.fm.push_file('/usr/bin/test')
self.fm.push_package_file.assert_called_once_with('/usr/bin/test', 'bin')
def test_push_file_match_tarball_name_dependency(self):
"""
Test push_file with match in the list on the single item that is
dependent on the tarball name.
"""
self.fm.file_is_locale = MagicMock(return_value=False)
self.fm.push_package_file = MagicMock()
files.tarball.name = 'testball'
self.fm.push_file('/usr/share/doc/testball/')
self.fm.push_package_file.assert_called_once_with('%doc /usr/share/doc/testball/*', 'doc')
def test_push_file_no_match(self):
"""
Test push_file with no pattern match on the file name. Should just push
the unmodified filename once.
"""
self.fm.file_is_locale = MagicMock(return_value=False)
self.fm.push_package_file = MagicMock()
self.fm.push_file('doesntmatcha thing')
self.fm.push_package_file.assert_called_once_with('doesntmatcha thing')
def test_remove_file(self):
"""
Test remove_file with filename in files list and main package
"""
self.fm.files.append('test')
self.fm.packages['main'] = ['test']
self.assertIn('test', self.fm.files)
self.assertNotIn('test', self.fm.files_blacklist)
self.assertIn('test', self.fm.packages['main'])
self.fm.remove_file('test')
self.assertNotIn('test', self.fm.files)
self.assertNotIn('test', self.fm.packages['main'])
self.assertIn('test', self.fm.files_blacklist)
def test_remove_file_not_present(self):
"""
Test remove_file with filename not in files list.
"""
self.assertNotIn('test', self.fm.files)
self.assertNotIn('test', self.fm.files_blacklist)
self.fm.remove_file('test')
self.assertNotIn('test', self.fm.files)
self.assertNotIn('test', self.fm.files_blacklist)
# Standard library imports import os import time # Local imports from menu import MenuDisplay from files import FileManager from storyboard import Storyboard # Print banner print(Storyboard.SEPARATOR3) print(Storyboard.STARTUP_BANNER.format(Storyboard.IOTRAIN_SIM_VERSION)) print(Storyboard.SEPARATOR3) # Prepare the Contiki environment print(Storyboard.STARTUP_COPY.format(Storyboard.CONTIKI_PATH)) FileManager().copy_dir_struct(Storyboard.IOTRAIN_CONTIKI_PATH, Storyboard.CONTIKI_PATH) # Show prompt before displaying the training menu #raw_input(Storyboard.READY_PROMPT) print(Storyboard.READY_MESSAGE) time.sleep(2) # Display the top training menu MenuDisplay().display_top_menu() # Cleanup the Contiki environment print(Storyboard.SHUTDOWN_CLEANUP) FileManager().delete_dir_struct(Storyboard.IOTRAIN_CONTIKI_PATH, Storyboard.CONTIKI_PATH)