1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
|
import logging
import os.path
import shutil
import tempfile
import unittest
import git
import ruamel.yaml
import lesana
class testCollection(unittest.TestCase):
def tearDown(self):
shutil.rmtree(os.path.join(self.collection.basedir, '.lesana'))
def test_empty(self):
self.collection = lesana.Collection('tests/data/empty')
self.assertEqual(self.collection.settings, {})
self.collection.update_cache()
self.assertIsNotNone(self.collection.stemmer)
def test_load_simple(self):
self.collection = lesana.Collection('tests/data/simple')
self.assertIsNotNone(self.collection.settings)
self.assertEqual(
self.collection.settings['name'],
"Simple lesana collection"
)
self.assertEqual(len(self.collection.settings['fields']), 5)
self.assertEqual(len(self.collection.indexed_fields), 2)
self.collection.update_cache()
self.assertIsNotNone(self.collection.stemmer)
def test_load_wrong_language(self):
# This loads a collection with an invalid value in lang
with self.assertLogs(level=logging.WARNING) as cm:
self.collection = lesana.Collection('tests/data/wrong')
self.assertEqual(len(cm.output), 1)
self.assertIn("Invalid language", cm.output[0])
# The collection will default to english, but should still work.
self.collection.update_cache()
self.assertIsNotNone(self.collection.settings)
self.assertIsNotNone(self.collection.stemmer)
def test_load_no_index_for_one_entry(self):
# This loads a collection where some of the entries have no
# "index" field
with self.assertLogs(level=logging.WARNING):
self.collection = lesana.Collection('tests/data/wrong')
self.collection.update_cache()
self.assertIsNotNone(self.collection.settings)
self.assertIsNotNone(self.collection.stemmer)
# Fields with no "index" entry are not indexed
self.assertEqual(len(self.collection.settings['fields']), 4)
self.assertEqual(len(self.collection.indexed_fields), 1)
def test_load_safe(self):
self.collection = lesana.Collection('tests/data/simple')
self.collection.safe = True
self.collection.update_cache()
def test_full_search(self):
self.collection = lesana.Collection('tests/data/simple')
self.collection.start_search('Item')
res = self.collection.get_all_search_results()
matches = list(res)
self.assertEqual(len(matches), 2)
for m in matches:
self.assertIsInstance(m, lesana.Entry)
def test_search(self):
self.collection = lesana.Collection('tests/data/simple')
self.collection.start_search('Item')
res = self.collection.get_search_results()
matches = list(res)
self.assertEqual(len(matches), 2)
for m in matches:
self.assertIsInstance(m, lesana.Entry)
def test_search_wildcard(self):
self.collection = lesana.Collection('tests/data/simple')
self.collection.start_search('Ite*')
res = self.collection.get_search_results()
matches = list(res)
self.assertEqual(len(matches), 2)
for m in matches:
self.assertIsInstance(m, lesana.Entry)
def test_search_non_init(self):
self.collection = lesana.Collection('tests/data/simple')
matches = list(self.collection.get_search_results())
self.assertEqual(matches, [])
matches = list(self.collection.get_all_search_results())
self.assertEqual(matches, [])
def test_all_entries(self):
self.collection = lesana.Collection('tests/data/simple')
res = self.collection.get_all_documents()
matches = list(res)
self.assertEqual(len(matches), 3)
for m in matches:
self.assertIsInstance(m, lesana.Entry)
def test_entry_from_eid(self):
self.collection = lesana.Collection('tests/data/simple')
entry = self.collection.entry_from_eid(
'11189ee47ddf4796b718a483b379f976'
)
self.assertEqual(entry.eid, '11189ee47ddf4796b718a483b379f976')
self.collection.safe = True
entry = self.collection.entry_from_eid(
'11189ee47ddf4796b718a483b379f976'
)
self.assertEqual(entry.eid, '11189ee47ddf4796b718a483b379f976')
def test_entry_from_short_eid(self):
self.collection = lesana.Collection('tests/data/simple')
entries = self.collection.entries_from_short_eid(
'11189ee4'
)
self.assertEqual(len(entries), 1)
self.assertEqual(entries[0].eid, '11189ee47ddf4796b718a483b379f976')
entries = self.collection.entries_from_short_eid(
'11189ee47ddf4796b718a483b379f976'
)
self.assertEqual(len(entries), 1)
self.assertEqual(entries[0].eid, '11189ee47ddf4796b718a483b379f976')
entries = self.collection.entries_from_short_eid(
'12345678'
)
self.assertEqual(len(entries), 0)
def test_index_missing_file(self):
self.collection = lesana.Collection('tests/data/simple')
with self.assertLogs(level=logging.WARNING) as cm:
self.collection.update_cache(['non_existing_file'])
self.assertEqual(len(cm.output), 1)
self.assertIn("non_existing_file", cm.output[0])
def test_get_entry_missing_eid(self):
self.collection = lesana.Collection('tests/data/simple')
entry = self.collection.entry_from_eid('this is not an eid')
self.assertIsNone(entry)
def test_render_collection(self):
self.collection = lesana.Collection('tests/data/simple')
template = self.collection.get_template(
'tests/data/simple/templates/collection_template.txt'
)
res = template.render(entries=self.collection.get_all_documents())
self.assertIn('11189ee4: Another item', res)
class testEntries(unittest.TestCase):
def setUp(self):
self.collection = lesana.Collection('tests/data/simple')
self.basepath = 'tests/data/simple/items'
self.filenames = []
def tearDown(self):
for fname in self.filenames:
os.remove(fname)
shutil.rmtree(os.path.join(self.collection.basedir, '.lesana'))
def test_simple(self):
fname = '085682ed-6792-499d-a3ab-9aebd683c011.yaml'
with open(os.path.join(self.basepath, fname)) as fp:
data = ruamel.yaml.safe_load(fp)
entry = lesana.Entry(self.collection, data=data, fname=fname)
self.assertEqual(entry.idterm, 'Q'+data['eid'])
fname = '11189ee47ddf4796b718a483b379f976.yaml'
eid = '11189ee47ddf4796b718a483b379f976'
with open(os.path.join(self.basepath, fname)) as fp:
data = ruamel.yaml.safe_load(fp)
entry = lesana.Entry(self.collection, data=data, fname=fname)
self.assertEqual(entry.idterm, 'Q'+eid)
self.assertEqual(entry.short_id, eid[:8])
def test_write_new(self):
new_entry = lesana.Entry(self.collection)
self.collection.save_entries(entries=[new_entry])
entry_fname = 'tests/data/simple/items/' + new_entry.fname
self.filenames.append(entry_fname)
with open(entry_fname) as fp:
text = fp.read()
self.assertIn('quantity (integer): how many items are there', text)
self.assertIn('other (yaml):', text)
self.assertNotIn('position (string)', text)
written = ruamel.yaml.safe_load(text)
self.assertIsInstance(written['quantity'], int)
self.assertIsInstance(written['name'], str)
def test_entry_representation(self):
eid = '11189ee47ddf4796b718a483b379f976'
entry = self.collection.entry_from_eid(eid)
self.assertEqual(
str(entry),
eid
)
label = '{{ eid }}: {{ name }}'
self.collection.settings['entry_label'] = label
self.assertEqual(
str(entry),
'{eid}: {name}'.format(eid=eid, name='Another item')
)
def test_entry_creation_eid_but_no_filename(self):
fname = '11189ee47ddf4796b718a483b379f976.yaml'
with open(os.path.join(self.basepath, fname)) as fp:
data = ruamel.yaml.safe_load(fp)
data['eid'] = '11189ee47ddf4796b718a483b379f976'
entry = lesana.Entry(self.collection, data=data)
self.assertEqual(entry.fname, fname)
def test_entry_creation_no_eid_no_filename(self):
fname = '11189ee47ddf4796b718a483b379f976.yaml'
with open(os.path.join(self.basepath, fname)) as fp:
data = ruamel.yaml.safe_load(fp)
entry = lesana.Entry(self.collection, data=data)
self.assertIsNotNone(entry.eid)
self.assertIsNotNone(entry.fname)
def test_entry_creation_filename_but_no_eid(self):
fname = '11189ee47ddf4796b718a483b379f976.yaml'
eid = '11189ee47ddf4796b718a483b379f976'
with open(os.path.join(self.basepath, fname)) as fp:
data = ruamel.yaml.safe_load(fp)
entry = lesana.Entry(self.collection, data=data, fname=fname)
self.assertEqual(entry.eid, eid)
def test_entry_str_filename_and_eid(self):
fname = '11189ee47ddf4796b718a483b379f976.yaml'
with open(os.path.join(self.basepath, fname)) as fp:
data = ruamel.yaml.safe_load(fp)
data['eid'] = '11189ee47ddf4796b718a483b379f976'
entry = lesana.Entry(self.collection, data=data)
self.assertEqual(str(entry), data['eid'])
self.collection.settings['entry_label'] = '{{ eid }}: {{ name }}'
self.assertEqual(str(entry), data['eid'] + ': Another item')
def test_entry_str_filename_no_eid(self):
fname = '11189ee47ddf4796b718a483b379f976.yaml'
with open(os.path.join(self.basepath, fname)) as fp:
data = ruamel.yaml.safe_load(fp)
entry = lesana.Entry(self.collection, data=data)
eid = entry.eid
self.assertEqual(str(entry), eid)
self.collection.settings['entry_label'] = '{{ eid }}: {{ name }}'
self.assertEqual(str(entry), eid + ': Another item')
def test_render_entry(self):
fname = '11189ee47ddf4796b718a483b379f976.yaml'
with open(os.path.join(self.basepath, fname)) as fp:
data = ruamel.yaml.safe_load(fp)
entry = lesana.Entry(self.collection, data=data)
eid = entry.eid
res = entry.render('tests/data/simple/templates/trivial_template.txt')
self.assertIn(eid, res)
def test_empty_data(self):
entry = lesana.Entry(self.collection)
self.assertIn("name: ''", entry.yaml_data)
self.assertIn('quantity: 0', entry.yaml_data)
class testComplexCollection(unittest.TestCase):
@classmethod
def setUpClass(self):
self.collection = lesana.Collection('tests/data/complex')
@classmethod
def tearDownClass(self):
shutil.rmtree(os.path.join(self.collection.basedir, '.lesana'))
def test_init(self):
self.assertIsNotNone(self.collection.settings)
self.assertEqual(
self.collection.settings['name'],
"Fully featured lesana collection"
)
self.assertEqual(len(self.collection.settings['fields']), 9)
self.assertIsNotNone(self.collection.stemmer)
self.assertEqual(len(self.collection.indexed_fields), 6)
def test_index(self):
self.collection.update_cache()
def test_indexing_list(self):
self.collection.update_cache(['73097121f1874a6ea2f927db7dc4f11e.yaml'])
self.collection.start_search('tags:this')
res = self.collection.get_search_results()
matches = list(res)
self.assertEqual(len(matches), 1)
for m in matches:
self.assertIsInstance(m, lesana.Entry)
def test_boolean_field(self):
entry = self.collection.entry_from_eid(
'73097121f1874a6ea2f927db7dc4f11e'
)
self.assertIsInstance(entry.data['exists'], bool)
def test_empty_data(self):
entry = lesana.Entry(self.collection)
print(entry.yaml_data)
self.assertIn("name: ''", entry.yaml_data)
self.assertIn('with_default', entry.yaml_data)
self.assertIn('amount: 0', entry.yaml_data)
class testCollectionWithErrors(unittest.TestCase):
@classmethod
def setUpClass(self):
self.collection = lesana.Collection('tests/data/wrong')
@classmethod
def tearDownClass(self):
shutil.rmtree(os.path.join(self.collection.basedir, '.lesana'))
def test_init(self):
self.assertIsNotNone(self.collection.settings)
self.assertEqual(
self.collection.settings['name'],
"Lesana collection with certain errors"
)
self.assertEqual(len(self.collection.settings['fields']), 4)
self.assertIsNotNone(self.collection.stemmer)
self.assertEqual(len(self.collection.indexed_fields), 1)
def test_index(self):
loaded = self.collection.update_cache()
self.assertEqual(loaded, 0)
class testCollectionCreation(unittest.TestCase):
def test_init(self):
tmpdir = tempfile.mkdtemp()
collection = lesana.Collection.init(tmpdir)
self.assertIsInstance(collection, lesana.Collection)
self.assertTrue(os.path.isdir(os.path.join(tmpdir, '.git')))
self.assertTrue(os.path.isdir(os.path.join(tmpdir, '.lesana')))
self.assertTrue(os.path.isfile(os.path.join(tmpdir, 'settings.yaml')))
self.assertTrue(os.path.isfile(os.path.join(tmpdir, '.gitignore')))
# and then run it twice on the same directory, nothing should break
collection = lesana.Collection.init(tmpdir)
self.assertIsInstance(collection, lesana.Collection)
self.assertTrue(os.path.isdir(os.path.join(tmpdir, '.git')))
self.assertTrue(os.path.isdir(os.path.join(tmpdir, '.lesana')))
self.assertTrue(os.path.isfile(os.path.join(tmpdir, 'settings.yaml')))
self.assertTrue(os.path.isfile(os.path.join(tmpdir, '.gitignore')))
created = lesana.Collection(tmpdir)
self.assertTrue(created.settings['git'])
shutil.rmtree(tmpdir)
def do_nothing(*args, **kwargs):
# A function that does nothing instead of editing a file
pass
def test_init_edit_file(self):
tmpdir = tempfile.mkdtemp()
collection = lesana.Collection.init(tmpdir, edit_file=self.do_nothing)
self.assertIsInstance(collection, lesana.Collection)
self.assertTrue(os.path.isdir(os.path.join(tmpdir, '.git')))
self.assertTrue(os.path.isdir(os.path.join(tmpdir, '.lesana')))
self.assertTrue(os.path.isfile(os.path.join(tmpdir, 'settings.yaml')))
self.assertTrue(os.path.isfile(os.path.join(tmpdir, '.gitignore')))
shutil.rmtree(tmpdir)
def test_init_no_git(self):
tmpdir = tempfile.mkdtemp()
collection = lesana.Collection.init(tmpdir, git_enabled=False)
self.assertIsInstance(collection, lesana.Collection)
self.assertFalse(os.path.isdir(os.path.join(tmpdir, '.git')))
self.assertTrue(os.path.isdir(os.path.join(tmpdir, '.lesana')))
self.assertTrue(os.path.isfile(os.path.join(tmpdir, 'settings.yaml')))
self.assertFalse(os.path.isfile(os.path.join(tmpdir, '.gitignore')))
# and then run it twice on the same directory, nothing should break
collection = lesana.Collection.init(tmpdir, git_enabled=False)
self.assertIsInstance(collection, lesana.Collection)
self.assertFalse(os.path.isdir(os.path.join(tmpdir, '.git')))
self.assertTrue(os.path.isdir(os.path.join(tmpdir, '.lesana')))
self.assertTrue(os.path.isfile(os.path.join(tmpdir, 'settings.yaml')))
self.assertFalse(os.path.isfile(os.path.join(tmpdir, '.gitignore')))
created = lesana.Collection(tmpdir)
self.assertFalse(created.settings['git'])
shutil.rmtree(tmpdir)
def test_deletion(self):
tmpdir = tempfile.mkdtemp()
shutil.copy('tests/data/simple/settings.yaml', tmpdir)
shutil.copytree(
'tests/data/simple/items',
os.path.join(tmpdir, 'items'),
)
collection = lesana.Collection.init(tmpdir)
# We start with one item indexed with the term "another"
collection.start_search('another')
mset = collection._enquire.get_mset(0, 10)
self.assertEqual(mset.get_matches_estimated(), 1)
# Then delete it
collection.remove_entries(['11189ee47ddf4796b718a483b379f976'])
# An now we should have none
self.assertFalse(os.path.exists(os.path.join(
tmpdir,
'items',
'11189ee47ddf4796b718a483b379f976.yaml'
)))
collection.start_search('another')
mset = collection._enquire.get_mset(0, 10)
self.assertEqual(mset.get_matches_estimated(), 0)
def test_partial_eid_deletion(self):
tmpdir = tempfile.mkdtemp()
shutil.copy('tests/data/simple/settings.yaml', tmpdir)
shutil.copytree(
'tests/data/simple/items',
os.path.join(tmpdir, 'items'),
)
collection = lesana.Collection.init(tmpdir)
# We start with one item indexed with the term "another"
collection.start_search('another')
mset = collection._enquire.get_mset(0, 10)
self.assertEqual(mset.get_matches_estimated(), 1)
# Then delete it, using the short id
collection.remove_entries(['11189ee4'])
# An now we should have none
self.assertFalse(os.path.exists(os.path.join(
tmpdir,
'items',
'11189ee47ddf4796b718a483b379f976.yaml'
)))
collection.start_search('another')
mset = collection._enquire.get_mset(0, 10)
self.assertEqual(mset.get_matches_estimated(), 0)
def _find_file_in_git_index(self, fname, index):
found = False
for (path, stage) in index.entries:
if fname in path:
found = True
break
return found
def test_git_adding(self):
tmpdir = tempfile.mkdtemp()
shutil.copy('tests/data/simple/settings.yaml', tmpdir)
shutil.copytree(
'tests/data/simple/items',
os.path.join(tmpdir, 'items'),
)
collection = lesana.Collection.init(tmpdir)
fname = '11189ee47ddf4796b718a483b379f976.yaml'
repo = git.Repo(tmpdir)
# By default, this collection doesn't have any git entry in the
# settings (but there is a repo)
collection.git_add_files([os.path.join(collection.itemdir, fname)])
self.assertFalse(self._find_file_in_git_index(fname, repo.index))
# Then we set it to false
collection.settings['git'] = False
collection.git_add_files([os.path.join(collection.itemdir, fname)])
self.assertFalse(self._find_file_in_git_index(fname, repo.index))
# And only when it's set to true we should find the file in the
# staging area
collection.settings['git'] = True
collection.git_add_files([os.path.join(collection.itemdir, fname)])
self.assertTrue(self._find_file_in_git_index(fname, repo.index))
shutil.rmtree(tmpdir)
def test_init_custom_settings(self):
tmpdir = tempfile.mkdtemp()
collection = lesana.Collection.init(
tmpdir,
edit_file=self.do_nothing,
settings={
'name': 'A different name',
'fields': [
{'name': 'title', 'type': 'string'},
{'name': 'author', 'type': 'string'},
],
},
)
self.assertIsInstance(collection, lesana.Collection)
self.assertTrue(os.path.isfile(os.path.join(tmpdir, 'settings.yaml')))
self.assertEqual(collection.settings['name'], 'A different name')
self.assertEqual(len(collection.settings['fields']), 2)
shutil.rmtree(tmpdir)
if __name__ == '__main__':
unittest.main()
|
