def main():
""" Starting point of the furtive command line tool """
args = parse_args(sys.argv[1:])
log_format = '%(asctime)s [%(levelname)s]: %(message)s'
date_format = '%c %Z'
numeric_level = getattr(logging, args.log_level.upper(), None)
logging.basicConfig(level=numeric_level,
format=log_format,
datefmt=date_format)
furtive = Furtive(args.basedir, args.manifest_path, args.exclude)
if args.action == 'create':
furtive.create()
elif args.action in ['compare', 'check']:
changes = furtive.compare()
if not args.quiet:
args.report_output.write(yaml.safe_dump(changes,
default_flow_style=False))
if args.action == 'check' and (changes['changed'] or
changes['removed'] or
changes['added']):
sys.exit(1)
def test_compare_added(self):
""" Ensure comparison reports added files correctly """
with open('tests/fixtures/test-data/test-file', 'w') as text_file:
text_file.write('This is a test file.')
furtive = Furtive('tests/fixtures/test-data', '.test_manifest.yaml')
changes = furtive.compare()
self.assertEqual(changes['added'], ['test-file'])
self.assertEqual(changes['removed'], [])
self.assertEqual(changes['changed'], [])
def test_raise_error_on_empty_manifest(self):
""" Ensure an error is raised when acting upon an empty manifest """
self.furtive = Furtive('tests/fixtures/test-data', 'non-existing-manifest')
with self.assertRaises(RuntimeError):
changes = self.furtive.compare()
self.assertTrue(changes is None)
def test_furtive_create_with_exclusion(self):
""" Ensure a manifest can be created but excluding some files"""
self.furtive = Furtive('tests/fixtures/test-data', '.test_manifest.yaml', ['*exclude*.txt'])
self.furtive.create()
self.assertEqual(self.furtive.manifest['documents/Important Document 1.odt'], 'd460a36805fb460c038d96723f206b20')
self.assertEqual(self.furtive.manifest['documents/Important Presentation.odp'], '1911ec839cedcbf00739a7d3447ec3a3')
self.assertEqual(self.furtive.manifest['pictures/Picture #1.jpg'], '6eec850e32622c0e33bdae08ced29e24')
self.assertFalse('documents/exclude_me.txt' in self.furtive.manifest.manifest)
self.assertEqual(len(self.furtive.manifest.manifest), 3)
class TestFurtive(unittest.TestCase):
""" Test case intended to test the furtive module """
def setUp(self):
""" Common setup tasks for all tests in this test case """
self.furtive = Furtive('tests/fixtures/test-data', '.test_manifest.yaml')
self.furtive.create()
def test_furtive_create(self):
""" Ensure a manifest can be created """
self.assertEqual(self.furtive.manifest['documents/Important Document 1.odt'], 'd460a36805fb460c038d96723f206b20')
self.assertEqual(self.furtive.manifest['pictures/Picture #1.jpg'], '6eec850e32622c0e33bdae08ced29e24')
self.assertEqual(self.furtive.manifest['documents/exclude_me.txt'], '2e7d8cb32bb82e838506aff5600182d1')
self.assertEqual(self.furtive.manifest['documents/Important Presentation.odp'], '1911ec839cedcbf00739a7d3447ec3a3')
self.assertEqual(len(self.furtive.manifest.manifest), 4)
def test_furtive_create_with_exclusion(self):
""" Ensure a manifest can be created but excluding some files"""
self.furtive = Furtive('tests/fixtures/test-data', '.test_manifest.yaml', ['*exclude*.txt'])
self.furtive.create()
self.assertEqual(self.furtive.manifest['documents/Important Document 1.odt'], 'd460a36805fb460c038d96723f206b20')
self.assertEqual(self.furtive.manifest['documents/Important Presentation.odp'], '1911ec839cedcbf00739a7d3447ec3a3')
self.assertEqual(self.furtive.manifest['pictures/Picture #1.jpg'], '6eec850e32622c0e33bdae08ced29e24')
self.assertFalse('documents/exclude_me.txt' in self.furtive.manifest.manifest)
self.assertEqual(len(self.furtive.manifest.manifest), 3)
def test_compare_added(self):
""" Ensure comparison reports added files correctly """
with open('tests/fixtures/test-data/test-file', 'w') as text_file:
text_file.write('This is a test file.')
furtive = Furtive('tests/fixtures/test-data', '.test_manifest.yaml')
changes = furtive.compare()
self.assertEqual(changes['added'], ['test-file'])
self.assertEqual(changes['removed'], [])
self.assertEqual(changes['changed'], [])
def test_compare_removed(self):
""" Ensure comparison reports removed files correctly """
with open('tests/fixtures/test-data/test-file', 'w') as text_file:
text_file.write('This is a test file.')
self.furtive.create()
os.unlink('tests/fixtures/test-data/test-file')
changes = self.furtive.compare()
self.assertEqual(changes['added'], [])
self.assertEqual(changes['removed'], ['test-file'])
self.assertEqual(changes['changed'], [])
def test_compare_changed(self):
""" Ensure comparison reports changed files correctly """
with open('tests/fixtures/test-data/test-file', 'w') as text_file:
text_file.write('This is a test file.')
self.furtive.create()
with open('tests/fixtures/test-data/test-file', 'w') as text_file:
text_file.write('This file has been changed')
changes = self.furtive.compare()
self.assertEqual(changes['added'], [])
self.assertEqual(changes['removed'], [])
self.assertEqual(changes['changed'], ['test-file'])
def test_raise_error_on_empty_manifest(self):
""" Ensure an error is raised when acting upon an empty manifest """
self.furtive = Furtive('tests/fixtures/test-data', 'non-existing-manifest')
with self.assertRaises(RuntimeError):
changes = self.furtive.compare()
self.assertTrue(changes is None)
def tearDown(self):
""" Common tearDown tasks for all tests in this test case """
if os.path.exists('.test_manifest.yaml'):
os.unlink('.test_manifest.yaml')
if os.path.exists('tests/fixtures/test-data/test-file'):
os.unlink('tests/fixtures/test-data/test-file')
def setUp(self):
""" Common setup tasks for all tests in this test case """
self.furtive = Furtive('tests/fixtures/test-data', '.test_manifest.yaml')
self.furtive.create()
