def test_refresh_removes_non_existing_file_entries(self):
# Given
p = Project(name='test', path=self.root)
p.scan()
# When
relpath = 'hello.py'
m = p.get(relpath)
os.remove(m.path)
p.refresh()
# Then
#self.assertEqual(p.number_of_files, 4)
self.assertFalse(p.has_media(relpath))
self.assertFalse(relpath in p._media)
self.assertFalse(relpath in p._relpath2index)
for key in p._data:
self.assertEqual(len(p._data[key]), 4)
for key in p._tag_data:
self.assertEqual(len(p._tag_data[key]), 4)
files = [x.name for x in p.root.files]
self.assertTrue(relpath not in files)
# Check if the database is consistent.
for rp in p._relpath2index.keys():
m = p.get(rp)
self.assertEqual(m.relpath, rp)
def test_update_tags_handles_type_changes_for_existing_tag(self):
# Given
tags = [
TagInfo(name='completed', type='bool'),
TagInfo(name='foo', type='string')
]
p = Project(name='test', path=self.root, tags=tags)
p.scan()
key = 'root.txt'
m = p.get(key)
m.tags['completed'] = True
m.tags['foo'] = 'hello world'
# When
new_tags = [
TagInfo(name='foo', type='int'),
TagInfo(name='completed', type='bool')
]
p.update_tags(new_tags)
# Then
self.assertEqual(p.tags, new_tags)
self.assertEqual(m.tags['completed'], True)
self.assertEqual(m.tags['foo'], 0)
for key in p.keys():
m = p.get(key)
self.assertEqual(type(m.tags['completed']), bool)
self.assertEqual(m.tags['foo'], 0)
def test_load_should_restore_saved_state(self):
# Given
p = Project(name='test', description='Test', path=self.root)
p.scan()
out_fname = tempfile.mktemp(dir=self.root)
out = open(out_fname, 'wb')
# When
p.save_as(out)
p1 = Project()
p1.load(out_fname)
# Then
self.assertEqual(p.name, 'test')
self.assertEqual(p.description, 'Test')
self.assertEqual(p.root.name, 'test')
self.assertEqual(len(p.root.directories), 2)
self.assertEqual(len(p.root.files), 2)
self.assertEqual(len(p.tags), 1)
self.assertEqual(p.tags[0].name, 'completed')
self.assertEqual(p.tags[0].type, 'bool')
self.assertEqual(p.number_of_files, 5)
m = p.get('root.txt')
self.assertEqual(len(m.tags), 1)
self.assertIn('completed', m.tags)
m = p.get(join('sub', 'sub.txt'))
self.assertEqual(m.file_name, 'sub.txt')
self.assertEqual(len(m.tags), 1)
self.assertIn('completed', m.tags)
# Ensure that the ctime and mtimes are saved.
self.assertEqual(p.get('root.txt')._ctime, p1.get('root.txt')._ctime)
self.assertEqual(p.get('root.txt')._mtime, p1.get('root.txt')._mtime)
def test_version_1_loads_correctly(self):
# Given
p = Project(name='test', path=self.root)
p.scan()
fname = join(self.root, 'test.vxn')
p._save_as_v1(fname)
# When
p = Project()
p.load(fname)
# Then
self.assertEqual(p.number_of_files, 5)
m = p.get('root.txt')
self.assertEqual(m.relpath, 'root.txt')
self.assertEqual(m.type, 'text')
self.assertEqual(len(m.tags), 1)
self.assertIn('completed', m.tags)
relpath = join('sub', 'sub.txt')
m = p.get(relpath)
self.assertEqual(m.file_name, 'sub.txt')
self.assertEqual(m.relpath, relpath)
self.assertEqual(len(m.tags), 1)
self.assertIn('completed', m.tags)
d = p.root.directories[0]
self.assertEqual(d.relpath, d.name)
def test_project_scan_works(self):
# Given
p = Project(name='test', path=self.root)
# When
p.scan()
# Then
self.assertEqual(p.number_of_files, 5)
m = p.get('root.txt')
self.assertEqual(m.relpath, 'root.txt')
self.assertEqual(m.type, 'text')
self.assertEqual(len(m.tags), 1)
self.assertIn('completed', m.tags)
m = p.get(join('sub', 'sub.txt'))
self.assertEqual(m.file_name, 'sub.txt')
self.assertEqual(len(m.tags), 1)
self.assertIn('completed', m.tags)
def test_import_csv_works(self):
# Given
p = Project(name='test', path=self.root)
p.add_tags([TagInfo(name='fox', type='int')])
p.scan()
data = dedent(u"""\
path,fox,junk
%s,2,hello
%s,1,bye
""" % (join(self.root, 'root.txt'), join(self.root, 'hello.py')))
csv = self._write_csv(data)
# Get one of the paths to see if cached media are handled correctly.
self.assertEqual(p.get('root.txt').tags['fox'], 0)
# When
success, err = p.import_csv(csv)
# Then
self.assertTrue(success)
self.assertEqual(p.get('root.txt').tags['fox'], 2)
self.assertEqual(p.get('hello.py').tags['fox'], 1)
def test_update_tags_updates_existing_media(self):
# Given
p = Project(name='test', path=self.root)
p.scan()
# When
new_tags = [TagInfo(name='foo', type='string')]
p.update_tags(new_tags)
# Then
self.assertEqual(p.tags, new_tags)
for key in p.keys():
m = p.get(key)
self.assertEqual(m.tags['foo'], '')
self.assertTrue('completed' not in m.tags)
def test_refresh_updates_new_media(self):
# Given
p = Project(name='test', path=self.root)
p.scan()
self.assertEqual(p.number_of_files, 5)
m = p.get('root.txt')
orig_size = m.size
# Change this.
m.tags['completed'] = True
create_dummy_file(join(self.root, 'sub', 'sub1.txt'))
with open(m.path, 'w') as fp:
fp.write('hello world\n')
# When
p.refresh()
# Then
m = p.get('root.txt')
self.assertEqual(m.tags['completed'], True)
self.assertEqual(p.number_of_files, 6)
self.assertTrue(m.size > orig_size)
m = p.get(join('sub', 'sub1.txt'))
self.assertEqual(m.tags['completed'], False)
def test_tagger_factory_tags_known_tags(self):
# Given.
code = 'import sys; print("args:"+sys.argv[1]'\
'+"\nlength:10\ncompleted:yes\n")'
command = "python -c %r" % code
factory = TaggerFactory(command=command)
p = Project(name='test', path=self.root)
p.add_tags([
TagInfo(name='args', type='string'),
TagInfo(name='length', type='int')
])
p.scan()
# When
jobs = factory.make_jobs(p.keys(), p)
for job in jobs:
job.run()
job.thread.join()
# Then.
self.assertEqual(len(jobs), 5)
for job in jobs:
self.assertEqual(job.status, 'success')
for key in p.keys():
media = p.get(key)
self.assertEqual(media.tags['completed'], True)
expect = "%s" % (media.path)
self.assertEqual(media.tags['args'], expect)
self.assertEqual(media.tags['length'], 10)
# When
jobs = factory.make_jobs(p.keys(), p)
# Then
self.assertEqual(len(jobs), 0)
# When.
data = dump(factory)
f1 = load(data)
# Then.
# The _tag_types should not be dumped.
self.assertEqual(f1._tag_types, None)
self.assertNotIn('_tag_types', data[1])
f = factory
for attr in ['command', '_done']:
self.assertEqual(getattr(f1, attr), getattr(f, attr))
def test_phrases_are_searchable(self):
# Given
tags = [
TagInfo(name='comment', type='string'),
]
p = Project(name='test', path=self.root, tags=tags)
p.scan()
p.get('root.txt').tags['comment'] = 'Hola how are you?'
# When
result = list(p.search('comment:"hola how"'))
# Then
self.assertEqual(len(result), 1)
self.assertEqual(result[0][0], 'root.txt')
def test_tags_in_search_work_correctly(self):
# Given
p = Project(name='test', path=self.root)
p.scan()
# When
result = list(p.search("path:hello.py"))
# Then
self.assertEqual(len(result), 1)
self.assertEqual(result[0][0], "hello.py")
# When
result = list(p.search("file_name:test"))
# Then
self.assertEqual(len(result), 0)
# When
result = list(p.search("path:test"))
# Then
# Should get everything since everything is inside the
# test directory!
self.assertEqual(len(result), 5)
# When
p.get('root.txt').tags['completed'] = True
result = list(p.search("completed:1"))
# Then
self.assertEqual(len(result), 1)
self.assertEqual(result[0][0], "root.txt")
# When
result = list(p.search("completed:yes"))
# Then
self.assertEqual(len(result), 1)
self.assertEqual(result[0][0], "root.txt")
# When
result = list(p.search("completed:0"))
# Then
self.assertEqual(len(result), 4)
self.assertNotIn('root.txt', [x[0] for x in result])
def test_python_function_factory(self):
# Given.
from textwrap import dedent
code = dedent("""
def process(relpath, media, dest):
media.tags['completed'] = True
media.tags['args'] = "%s %s"%(relpath, dest)
""")
factory = PythonFunctionFactory(code=code, dest=self.root1)
p = Project(name='test', path=self.root)
p.add_tags([TagInfo(name='args', type='string')])
p.scan()
# When
jobs = factory.make_jobs(p.keys(), p)
for job in jobs:
job.run()
job.thread.join()
# Then.
self.assertEqual(len(jobs), 5)
for key in p.keys():
media = p.get(key)
self.assertEqual(media.tags['completed'], True)
expect = "%s %s" % (key, self.root1)
self.assertEqual(media.tags['args'], expect)
# When
jobs = factory.make_jobs(p.keys(), p)
# Then
self.assertEqual(len(jobs), 0)
# When.
data = dump(factory)
f1 = load(data)
# Then.
# The func should not be dumped.
self.assertEqual(f1._func, None)
self.assertNotIn('_func', data[1])
f = factory
for attr in ['code', '_done']:
self.assertEqual(getattr(f1, attr), getattr(f, attr))
def test_export_to_csv_with_unicode(self):
# Given
tags = [
TagInfo(name='completed', type='bool'),
TagInfo(name='comment', type='string')
]
p = Project(name='test', path=self.root, tags=tags)
p.scan()
m = p.get('root.txt')
m.tags['completed'] = True
m.tags['comment'] = u'hello, world; न Kévin'
out_fname = tempfile.mktemp(dir=self.root, suffix='.csv')
# When
p.export_csv(out_fname)
# Then
with io.open(out_fname, newline='', encoding='utf-8') as fp:
reader = csv.reader(fp)
cols = next(reader)
expected = [
'comment', 'completed', 'ctime', 'file_name', 'mtime', 'path',
'relpath', 'size', 'type'
]
self.assertEqual(cols, expected)
expected = {'hello.py': 'False', 'root.txt': 'True'}
data = [next(reader), next(reader), next(reader), next(reader)]
data = sorted(data, key=lambda x: x[6])
row = data[0]
self.assertEqual(basename(row[5]), u'hello.py')
self.assertEqual(row[1], u'False')
self.assertEqual(row[0], u'')
row = data[1]
self.assertEqual(basename(row[5]), u'root.txt')
self.assertEqual(row[1], u'True')
self.assertEqual(row[0], u'hello, world; न Kévin')
row = data[2]
self.assertTrue(basename(row[5]).startswith(u'sub'))
self.assertEqual(row[1], u'False')
self.assertEqual(row[0], u'')
row = data[3]
self.assertTrue(basename(row[5]).startswith(u'sub'))
self.assertEqual(row[1], u'False')
self.assertEqual(row[0], u'')
def test_command_factory_commands(self):
# Given.
cf = CommandFactory(dest=self.root1, input_extension='.py',
output_extension='.rst',
command="echo $input $output")
p = Project(name='test', path=self.root)
p.scan()
# When
jobs = cf.make_jobs(p.keys(), p)
# Then.
self.assertEqual(len(jobs), 1)
job = jobs[0]
m = p.get('hello.py')
dest = os.path.join(self.root1, 'hello.rst')
expect = ('echo %s %s' % (m.path, dest)).replace('\\', '\\\\')
self.assertEqual(job.args, [expect.split(), m.path, dest])
def test_load(self):
# Given
vixen = Vixen()
# When
vixen.load()
# Then
self.assertEqual(len(vixen.projects), 1)
self.assertEqual(vixen.projects[0].name, '__hidden__')
# When
p = Project(
name='test', path=self.root,
description='desc', extensions=['.py', '.txt']
)
p.scan()
p.save()
vixen.add(p)
# Then
self.assertEqual(len(vixen.projects), 1)
self.assertEqual(vixen.projects[0].name, 'test')
# Given
vixen.save()
vixen = Vixen()
vixen.load()
# Then
self.assertEqual(len(vixen.projects), 1)
p = vixen.projects[0]
self.assertEqual(p.name, 'test')
self.assertEqual(p.number_of_files, 0)
# When
p.load()
# Then
self.assertEqual(p.number_of_files, 5)
m = p.get('root.txt')
self.assertEqual(m.relpath, 'root.txt')
self.assertEqual(m.type, 'text')
self.assertEqual(len(m.tags), 1)
def test_project_copy_does_not_copy_data(self):
# Given
tags = [TagInfo(name='completed', type='bool'),
TagInfo(name='comment', type='string')]
p = Project(name='test', path=self.root,
extensions=['.txt', '.py'], tags=tags)
cf = CommandFactory(dest=self.root,
input_extension='.py',
output_extension='.rst',
command='echo $input $output')
p.processors = [cf]
p.scan()
# Update the _done trait the processors to check if it is copied.
m = p.get('root.txt')
cf._done[m.path] = True
# When
p1 = p.copy()
# Then
self.assertEqual(p.number_of_files, 5)
self.assertEqual(p1.number_of_files, 0)
self.assertEqual(p1.name, p.name + ' copy')
self.assertEqual(p1.path, p.path)
tag_info = [(x.name, x.type) for x in p.tags]
tag_info1 = [(x.name, x.type) for x in p1.tags]
self.assertEqual(tag_info, tag_info1)
self.assertEqual(p1.extensions, p.extensions)
self.assertEqual(len(p1._relpath2index), 0)
self.assertEqual(len(p1.processors), len(p.processors))
p1_proc_traits = p1.processors[0].trait_get()
p1_proc_traits.pop('_done')
p_proc_traits = p.processors[0].trait_get()
p_proc_traits.pop('_done')
self.assertEqual(p1_proc_traits, p_proc_traits)
self.assertEqual(len(p.processors[0]._done), 1)
self.assertEqual(len(p1.processors[0]._done), 0)
# When
p.tags[0].type = 'int'
# Then
# This just checks that p1's tags are not a reference to p's.
self.assertEqual(p1.tags[0].type, 'bool')
def test_command_factory_jobs(self):
# Given.
import sys
command = """\
%r -c 'import shutil;shutil.copy("$input", "$output")'\
""" % sys.executable
cf = CommandFactory(dest=self.root1,
input_extension='.py',
output_extension='.rst',
command=command,
copy_timestamps=True)
p = Project(name='test', path=self.root)
p.scan()
# When
jobs = cf.make_jobs(p.keys(), p)
job = jobs[0]
job.run()
job.thread.join()
# Then.
self.assertEqual(len(jobs), 1)
self.assertEqual(job.status, 'success')
m = p.get('hello.py')
dest = os.path.join(self.root1, 'hello.rst')
self.assertTrue(os.path.exists(dest))
self.assertEqual(cf._done[dest], True)
s_stat = os.stat(m.path)
d_stat = os.stat(dest)
self.assertTrue(abs(s_stat.st_mtime - d_stat.st_mtime) < 2)
self.assertTrue(abs(s_stat.st_ctime - d_stat.st_ctime) < 2)
jobs = cf.make_jobs(p.keys(), p)
self.assertEqual(len(jobs), 0)
# When.
data = dump(cf)
cf1 = load(data)
# Then.
for attr in cf.__dict__.keys():
self.assertEqual(getattr(cf1, attr), getattr(cf, attr))
def test_tagger_factory_skips_unknown_tags(self):
# Given.
code = 'import sys; print("\nlength:10\nxxx:yes\n")'
command = "python -c %r" % code
factory = TaggerFactory(command=command)
p = Project(name='test', path=self.root)
p.scan()
# When
jobs = factory.make_jobs(p.keys(), p)
for job in jobs:
job.run()
job.thread.join()
# Then.
self.assertEqual(len(jobs), 5)
for key in p.keys():
media = p.get(key)
self.assertTrue('length' not in media.tags)
self.assertTrue('xxx' not in media.tags)
self.assertEqual(media.tags['completed'], False)
def test_tagger_factory_tags_known_tags(self):
# Given.
code = 'import sys; print("args:"+sys.argv[1]'\
'+"\nlength:10\ncompleted:yes\n")'
command = "python -c %r" % code
factory = TaggerFactory(command=command)
p = Project(name='test', path=self.root)
p.add_tags(
[
TagInfo(name='args', type='string'),
TagInfo(name='length', type='int')
]
)
p.scan()
# When
jobs = factory.make_jobs(p.keys(), p)
for job in jobs:
job.run()
job.thread.join()
# Then.
self.assertEqual(len(jobs), 5)
for job in jobs:
self.assertEqual(job.status, 'success')
for key in p.keys():
media = p.get(key)
self.assertEqual(media.tags['completed'], True)
expect = "%s" % (media.path)
self.assertEqual(media.tags['args'], expect)
self.assertEqual(media.tags['length'], 10)
# When
jobs = factory.make_jobs(p.keys(), p)
# Then
self.assertEqual(len(jobs), 0)
def test_numeric_tags_and_ranges_are_searchable(self):
# Given
tags = [
TagInfo(name='fox', type='int'),
TagInfo(name='age', type='float')
]
p = Project(name='test', path=self.root, tags=tags)
p.scan()
p.get(join('sub2', 'sub2.txt')).tags['fox'] = 1
# When
result = list(p.search("fox:1"))
# Then
self.assertEqual(len(result), 1)
self.assertEqual(result[0][0], 'sub2.txt')
# When
# This is an exclusive range, i.e. only the value 1 is searched.
result = list(p.search("fox:{0 TO 2}"))
# Then
self.assertEqual(len(result), 1)
self.assertEqual(result[0][0], 'sub2.txt')
# When
# Here we have 1 and 2.
result = list(p.search("fox:{0 TO 2]"))
# Then
self.assertEqual(len(result), 1)
self.assertEqual(result[0][0], 'sub2.txt')
# When
result = list(p.search("fox:>=1"))
# Then
self.assertEqual(len(result), 1)
self.assertEqual(result[0][0], 'sub2.txt')
# When
result = list(p.search("fox:<1"))
# Then
self.assertEqual(len(result), 4)
self.assertNotIn('sub2.txt', [x[0] for x in result])
# When
p.get('root.txt').tags['age'] = 50.5
result = list(p.search("age:50.5"))
# Then
self.assertEqual(len(result), 1)
self.assertEqual(result[0][0], 'root.txt')
# When
result = list(p.search("age:>50"))
# Then
self.assertEqual(len(result), 1)
self.assertEqual(result[0][0], 'root.txt')