/
tests.py
3065 lines (2795 loc) · 115 KB
/
tests.py
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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import aiohttp
import asyncio
import concurrent.futures
from datetime import datetime
import functools
import io
import itertools
import json
import logging
import os
import random
import re
import sqlalchemy
from sqlalchemy.orm import close_all_sessions
import string
import tempfile
import textwrap
import time
from tornado.testing import AsyncTestCase, gen_test, AsyncHTTPTestCase
import unittest
from unittest import mock
from urllib.parse import urlencode, urlparse
from xml.etree import ElementTree
from taguette import exact_version
from taguette import convert, database, extract, import_codebook, main, \
validate, web
from taguette.utils import sanitize_filename
if 'TAGUETTE_TEST_DB' in os.environ:
DATABASE_URI = os.environ['TAGUETTE_TEST_DB']
else:
DATABASE_URI = 'sqlite://'
if 'TAGUETTE_TEST_REDIS' in os.environ:
REDIS = os.environ['TAGUETTE_TEST_REDIS']
else:
REDIS = None
def _compare_xml(e1, e2):
assert e1.tag == e2.tag
assert e1.attrib == e2.attrib
for c1, c2 in itertools.zip_longest(e1, e2):
assert c1 is not None and c2 is not None
_compare_xml(c1, c2)
def compare_xml(str1, str2):
et1 = ElementTree.fromstring(str1)
et2 = ElementTree.fromstring(str2)
_compare_xml(et1, et2)
def with_tempdir(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
with tempfile.TemporaryDirectory() as tmp:
return func(*args, **kwargs, tmp=tmp)
return wrapper
class TestMain(unittest.TestCase):
def test_join_url(self):
class FakeApp(object):
def __init__(self, token, config):
self.single_user_token = token
self.config = config
self.assertEqual(
main.get_join_url(FakeApp(
'secret',
{'PORT': 80, 'BASE_PATH': '/'},
)),
'http://localhost/?token=secret',
)
self.assertEqual(
main.get_join_url(FakeApp(
None,
{'PORT': 80, 'BASE_PATH': '/'},
)),
'http://localhost/',
)
self.assertEqual(
main.get_join_url(FakeApp(
None,
{'PORT': 8080, 'BASE_PATH': '/'},
)),
'http://localhost:8080/',
)
self.assertEqual(
main.get_join_url(FakeApp(
'secret',
{'PORT': 8080, 'BASE_PATH': '/some/dir/'},
)),
'http://localhost:8080/some/dir/?token=secret',
)
class TestConvert(AsyncTestCase):
config = dict(
CONVERT_TO_HTML_TIMEOUT=60,
)
@gen_test
async def test_convert_html(self):
"""Tests converting HTML, using BeautifulSoup and Bleach"""
body = (
b'<!DOCTYPE html>\n'
b'<html>\n <head>\n <title>Test</title>\n</head>\n<body>'
b'<h1>Example</h1><p>This is an <a>example</a> text document.\n'
b'It should be <blink>converted</blink>.</p>\n\n'
b'<p>It has another paragraph <strong>here</strong>, '
b'images: <img width=\"50\" src=\"here.png\"> '
b'<img title=\"important\" src=\"/over/there.png\" width=\"30\"> '
b'<img src=\"http://and/the/last/one.png\" class=\"a\">, and '
b'links: <a href=\"here\">1</a> '
b'<a title=\"important\" href=\"/over/there\">2</a> '
b'<a title=\"t\"href=\"http://last/one\" class=\"a\">3</a></p>\n'
b'<table><thead><tr><th>Header1</th><th>Another</th></tr></thead>'
b'<tbody><tr><td>1</td><td>34.9</td><td>2</td><td>98.1</td></tr>'
b'</tbody></table>'
b'</body></html>\n'
)
with mock.patch('tornado.process.Subprocess', object()):
body = await convert.to_html(body, 'text/html', 'test.html',
self.config)
self.assertEqual(
body,
'<h1>Example</h1><p>This is an example text document.\n'
'It should be converted.</p>\n\n'
'<p>It has another paragraph <strong>here</strong>, '
'images: <img src="/static/missing.png"> '
'<img src="/static/missing.png"> '
'<img src="/static/missing.png">, and '
'links: <a title="here">1</a> '
'<a title="/over/there">2</a> '
'<a href="http://last/one">3</a></p>\n'
'<table><thead><tr><th>Header1</th><th>Another</th></tr></thead>'
'<tbody><tr><td>1</td><td>34.9</td><td>2</td><td>98.1</td></tr>'
'</tbody></table>'
)
self.assertTrue(convert.is_html_safe(body))
def test_filename(self):
old_windows_flag = sanitize_filename.windows
sanitize_filename.windows = True # escape device names
try:
self.assertEqual(sanitize_filename('/etc/passwd'), 'passwd')
self.assertEqual(sanitize_filename('/etc/pass.txt'), 'pass.txt')
self.assertEqual(sanitize_filename('ééé'), '_')
self.assertEqual(sanitize_filename('ééé.pdf'), '_.pdf')
self.assertEqual(sanitize_filename('/tmp/NUL.pdf'), '_NUL.pdf')
self.assertEqual(sanitize_filename('/tmp/nul.pdf'), '_nul.pdf')
self.assertEqual(
sanitize_filename('a_very_long_file_name.pdf'),
'a_very_long_file_nam.pdf',
)
self.assertEqual(
sanitize_filename('a_very_long_file_name'),
'a_very_long_file_nam',
)
self.assertEqual(
sanitize_filename('a_long.file_extension'),
'a_long.file_ex',
)
finally:
sanitize_filename.windows = old_windows_flag
@gen_test
async def test_webvtt(self):
body = (
b'WEBVTT\n\nSTYLE\n::cue {\n background-image: linear-gradient('
b'to bottom, dimgray, lightgray);\n color: papayawhip;\n}\n'
b'/* Style blocks cannot use blank lines nor arrows */\n\n'
b'NOTE comment blocks can be used between style blocks.\n\n'
b'STYLE\n::cue(b) {\n color: peachpuff;\n}\n\n'
b'1\n00:00:00,123 --> 00:00:03,456\nHi there\n\n'
b'00:01:04,843 --> 00:01:05,428\n'
b'This is an example of a\nsubtitle file in SRT format\n\n'
b'NOTE style blocks cannot appear after the first cue.\n'
)
with mock.patch('tornado.process.Subprocess', object()):
body = await convert.to_html(body, 'text/vtt', 'test.vtt',
self.config)
self.assertEqual(
body,
(
'<p>00:00:00.123 Hi there</p>\n'
'<p>00:01:04.843 This is an example of a<br>'
'subtitle file in SRT format</p>\n'
),
)
class TestPassword(AsyncTestCase):
@staticmethod
def random_password():
alphabet = (
string.ascii_letters + string.digits +
string.punctuation + string.whitespace
)
password = [random.choice(alphabet) for _ in range(4, 16)]
return ''.join(password)
@gen_test(timeout=15)
async def test_default(self):
has_scrypt = True
try:
from hashlib import scrypt as _scrypt # noqa: F401
except ImportError:
has_scrypt = False
user = database.User(login='user')
self.assertFalse(await user.check_password('hackme'))
await user.set_password('test')
if has_scrypt:
self.assertTrue(user.hashed_password.startswith('scrypt:'))
else:
self.assertTrue(user.hashed_password.startswith('pbkdf2:'))
@gen_test(timeout=15)
async def test_scrypt(self):
try:
from hashlib import scrypt as _scrypt # noqa: F401
except ImportError:
self.skipTest("Doesn't have scrypt")
for _ in range(3):
password = self.random_password()
user = database.User(login='user')
await user.set_password(password, 'scrypt')
self.assertTrue(user.hashed_password.startswith('scrypt:'))
self.assertTrue(await user.check_password(password))
self.assertFalse(await user.check_password(password[:-1]))
@gen_test(timeout=15)
async def test_pbkdf2(self):
for _ in range(3):
password = self.random_password()
user = database.User(login='user')
await user.set_password(password, 'pbkdf2')
self.assertTrue(user.hashed_password.startswith('pbkdf2:'))
self.assertTrue(await user.check_password(password))
self.assertFalse(await user.check_password(password[:-1]))
@gen_test(timeout=15)
async def test_bcrypt(self):
for _ in range(3):
password = self.random_password()
user = database.User(login='user')
await user.set_password(password, 'bcrypt')
self.assertTrue(user.hashed_password.startswith('bcrypt:'))
self.assertTrue(await user.check_password(password))
self.assertFalse(await user.check_password(password[:-1]))
class TestMeasure(unittest.TestCase):
def test_extract_highlight(self):
"""Tests extracting a highlight from an HTML document."""
html = '<p><u>H\xE9llo</u> R\xE9mi <i>what is</i> up ?</p>'
snippet = extract.extract(html, 7, 15)
self.assertEqual(snippet,
'<p>R\xE9mi <i>wh</i></p>')
snippet = extract.extract(html, 1, 5)
self.assertEqual(snippet,
'<p><u>\xE9ll</u></p>')
snippet = extract.extract(html, 7, 12)
self.assertEqual(snippet,
'<p>R\xE9mi</p>')
def test_highlight(self):
"""Tests highlighting an HTML document with only ASCII characters."""
html = '<p><u>Hello</u> there <i>World</i></p>'
highlights = [
(0, 1, ['tag1']), (2, 3, []),
(4, 8, ['tag1', 'tag2']), (10, 14, ['tag2']), (15, 17, ['tag1']),
]
self.assertEqual(
extract.highlight(html, highlights)
.replace('<span class="highlight">', '{')
.replace('</span>', '}'),
'<p><u>{H}e{l}l{o}</u>{ th}er{e }<i>{Wo}r{ld}</i></p>',
)
self.assertEqual(
extract.highlight(html, highlights, show_tags=True)
.replace('<span class="taglist"> [', '[')
.replace(']</span>', ']')
.replace('<span class="highlight">', '{')
.replace('</span>', '}'),
'<p><u>{H}[tag1]e{l}[]l{o}</u>{ th}[tag1, tag2]er{e }' +
'<i>{Wo}[tag2]r{ld}[tag1]</i></p>',
)
def test_highlight_unicode(self):
"""Tests highlighting an HTML document with unicode characters."""
html = '<p><u>H\xE9ll\xF6</u> the\xAEe <i>\u1E84o\xAEld</i>!</p>'
highlights = [
(0, 1, ['tag1']), (3, 4, []),
(6, 10, ['tag1', 'tag2']), (13, 19, ['tag2']), (21, 23, ['tag1']),
]
self.assertEqual(
extract.highlight(html, highlights)
.replace('<span class="highlight">', '{')
.replace('</span>', '}'),
'<p><u>{H}\xE9{l}l{\xF6}</u>{ th}e\xAE'
'{e }<i>{\u1E84o}\xAE{ld}</i>!</p>',
)
self.assertEqual(
extract.highlight(html, highlights, show_tags=True)
.replace('<span class="taglist"> [', '[')
.replace(']</span>', ']')
.replace('<span class="highlight">', '{')
.replace('</span>', '}'),
'<p><u>{H}[tag1]\xE9{l}[]l{\xF6}</u>{ th}[tag1, tag2]e\xAE'
'{e }<i>{\u1E84o}[tag2]\xAE{ld}[tag1]</i>!</p>',
)
def test_highlight_nested(self):
"""Test highlighting an HTML document when highlights are nested."""
html = '<p><u>Hello</u> there <i>World</i></p>'
# Do all the combinations of nesting orders
starts = [0, 3, 10]
for ends in itertools.permutations([14, 15, 17]):
highlights = [
(starts[0], ends[0], ['tag1']), (starts[1], ends[1], []),
(starts[2], ends[2], ['tag1', 'tag2']),
]
self.assertEqual(
extract.highlight(html, highlights)
.replace('<span class="highlight">', '{')
.replace('</span>', '}'),
'<p><u>{Hello}</u>{ there }<i>{World}</i></p>',
)
expected = {
(14, 15, 17): '<p><u>{Hello}</u>{ ther'
'e }<i>{Wo}[tag1]{r}[]{ld}[tag1, tag2]</i></p>',
(14, 17, 15): '<p><u>{Hello}</u>{ ther'
'e }<i>{Wo}[tag1]{r}[tag1, tag2]{ld}[]</i></p>',
(15, 14, 17): '<p><u>{Hello}</u>{ ther'
'e }<i>{Wo}[]{r}[tag1]{ld}[tag1, tag2]</i></p>',
(15, 17, 14): '<p><u>{Hello}</u>{ ther'
'e }<i>{Wo}[tag1, tag2]{r}[tag1]{ld}[]</i></p>',
(17, 14, 15): '<p><u>{Hello}</u>{ ther'
'e }<i>{Wo}[]{r}[tag1, tag2]{ld}[tag1]</i></p>',
(17, 15, 14): '<p><u>{Hello}</u>{ ther'
'e }<i>{Wo}[tag1, tag2]{r}[]{ld}[tag1]</i></p>',
}[ends]
self.assertEqual(
extract.highlight(html, highlights, show_tags=True)
.replace('<span class="taglist"> [', '[')
.replace(']</span>', ']')
.replace('<span class="highlight">', '{')
.replace('</span>', '}'),
expected,
"ends=%r" % (ends,),
)
class TestValidate(unittest.TestCase):
def test_export_filename(self):
self.assertEqual(
web.export.safe_filename('**My sweet project / 2**'),
'My sweet project 2',
)
self.assertEqual(
web.export.safe_filename("Rémi's project"),
"Rmis project",
)
class TestReadCodebook(unittest.TestCase):
def test_valid_csv(self):
self.assertEqual(
import_codebook.list_tags(io.BytesIO(
(
'name,other,description\n'
+ 'interesting,1,\n'
+ 'people,2,Named persons\n'
).encode('utf-8'),
)),
[
{'path': 'interesting', 'description': ''},
{'path': 'people', 'description': 'Named persons'},
]
)
self.assertEqual(
import_codebook.list_tags(io.BytesIO(
(
'other,path\n'
+ '1,interesting\n'
+ '2,people\n'
).encode('utf-8'),
)),
[
{'path': 'interesting', 'description': ''},
{'path': 'people', 'description': ''},
]
)
self.assertEqual(
import_codebook.list_tags(io.BytesIO(
(
'other,path\n'
+ '1,interesting\n'
+ ',\n'
+ '2,people\n'
+ ',\n'
+ ',\n'
).encode('utf-8'),
)),
[
{'path': 'interesting', 'description': ''},
{'path': 'people', 'description': ''},
]
)
def test_invalid_csv(self):
with self.assertRaises(import_codebook.InvalidCodebook) as err:
import_codebook.list_tags(io.BytesIO(
(
'name,other,path\n'
+ 'a,b,c\n'
+ 'd,e,f\n'
).encode('utf-8'),
))
self.assertEqual(
err.exception.message,
"Not sure which column to use for tag name",
)
self.assertIsNone(err.exception.row)
with self.assertRaises(import_codebook.InvalidCodebook) as err:
import_codebook.list_tags(io.BytesIO(
(
'col1,col2,col3\n'
+ 'a,b,c\n'
+ 'd,e,f\n'
).encode('utf-8'),
))
self.assertEqual(
err.exception.message,
"No 'tag', 'name', or 'path' column",
)
self.assertIsNone(err.exception.row)
with self.assertRaises(import_codebook.InvalidCodebook) as err:
import_codebook.list_tags(io.BytesIO(
(
'name,other,description\n'
+ 'interesting,1,\n'
+ ',2,Named persons\n'
).encode('utf-8'),
))
self.assertEqual(
err.exception.message,
"Empty tag name",
)
self.assertEqual(err.exception.row, 3)
class MyHTTPTestCase(AsyncHTTPTestCase):
xsrf = None
def setUp(self):
web.Application.check_messages = lambda s: s.messages_event.set()
validate.filename.windows = True # escape device names
super(MyHTTPTestCase, self).setUp()
# Tornado's http client doesn't support cookies, use aiohttp instead
@self.io_loop.run_sync
async def async_init():
self.http_client = aiohttp.ClientSession(
# Need to set 'unsafe' to work when host is an IP address
cookie_jar=aiohttp.cookiejar.CookieJar(unsafe=True),
)
await self.http_client.__aenter__()
def tearDown(self):
self.io_loop.run_sync(
lambda: self.http_client.close(),
timeout=3,
)
def _fetch(self, url, method='GET', **kwargs):
# Copied from tornado.testing.AsyncHTTPTestCase.fetch()
if not url.lower().startswith(('http://', 'https://')):
url = self.get_url(url)
return getattr(self.http_client, method.lower())(url, **kwargs)
def aget(self, url, headers=None):
return self._fetch(url, headers=headers, allow_redirects=False)
def apost(self, url, **kwargs):
cookies = self.http_client.cookie_jar.filter_cookies(self.get_url('/'))
if '_xsrf' in cookies:
token = cookies['_xsrf'].value
if 'data' in kwargs:
if isinstance(kwargs['data'], dict):
kwargs['data'] = dict(kwargs['data'], _xsrf=token)
else:
url = '%s%s%s' % (url, '&' if '?' in url else '?',
urlencode(dict(_xsrf=token)))
if 'files' in kwargs:
files = kwargs.pop('files')
data = aiohttp.FormData()
for key, value in kwargs.get('data', {}).items():
data.add_field(key, value)
for key, (filename, content_type, value) in files.items():
data.add_field(
key, value,
content_type=content_type,
filename=filename,
)
kwargs['data'] = data
return self._fetch(url, method='POST', allow_redirects=False, **kwargs)
def adelete(self, url):
cookies = self.http_client.cookie_jar.filter_cookies(self.get_url('/'))
if '_xsrf' in cookies:
token = cookies['_xsrf'].value
url = '%s%s%s' % (url, '&' if '?' in url else '?',
urlencode(dict(_xsrf=token)))
return self._fetch(url, method='DELETE')
async def set_dumb_password(DBSession):
db = DBSession()
admin = database.User(login='admin')
await admin.set_password('hackme')
db.add(admin)
db.commit()
db.close()
class TestMultiuser(MyHTTPTestCase):
def get_app(self):
self.application = web.make_app(dict(
main.DEFAULT_CONFIG,
NAME="Test Taguette instance", PORT=7465,
DATABASE=DATABASE_URI,
REDIS_SERVER=REDIS,
TOS_FILE=None,
EMAIL='test@example.com',
MAIL_SERVER={'host': 'localhost', 'port': 25},
COOKIES_PROMPT=True,
MULTIUSER=True,
SECRET_KEY='2PbQ/5Rs005G/nTuWfibaZTUAo3Isng3QuRirmBK',
))
self.io_loop.run_sync(
lambda: set_dumb_password(self.application.DBSession)
)
return self.application
def tearDown(self):
super(TestMultiuser, self).tearDown()
close_all_sessions()
engine = sqlalchemy.create_engine(DATABASE_URI)
database.Base.metadata.drop_all(bind=engine)
@gen_test(timeout=30)
async def test_login(self):
# Fetch index, should have welcome message and register link
async with self.aget('/') as response:
self.assertEqual(response.status, 200)
self.assertIn(b'>Welcome</h1>', await response.read())
self.assertIn(b'Register now</a> for free and get started',
await response.read())
# Only admin so far
db = self.application.DBSession()
self.assertEqual([user.login
for user in db.query(database.User).all()],
['admin'])
# Fetch registration page, should hit cookies prompt
async with self.aget('/register') as response:
self.assertEqual(response.status, 302)
self.assertEqual(response.headers['Location'],
'/cookies?next=%2Fregister')
# Accept cookies
async with self.apost(
'/cookies',
data=dict(next='/register'),
) as response:
self.assertEqual(response.status, 303)
self.assertEqual(response.headers['Location'], '/register')
# Fetch registration page
async with self.aget('/register') as response:
self.assertEqual(response.status, 200)
# Register
async with self.apost(
'/register',
data=dict(login='Tester',
password1='hacktoo', password2='hacktoo'),
) as response:
self.assertEqual(response.status, 303)
self.assertEqual(response.headers['Location'], '/')
# User exists in database
db = self.application.DBSession()
self.assertEqual([user.login
for user in db.query(database.User).all()],
['admin', 'tester'])
# Fetch index, should have project list
async with self.aget('/') as response:
self.assertEqual(response.status, 200)
self.assertIn(b'>Welcome tester</h1>', await response.read())
self.assertIn(b'Here are your projects', await response.read())
# Fetch project creation page
async with self.aget('/project/new') as response:
self.assertEqual(response.status, 200)
# Create a project
async with self.apost(
'/project/new',
data=dict(name='test project', description=''),
) as response:
self.assertEqual(response.status, 303)
self.assertEqual(response.headers['Location'], '/project/1')
# Log out
async with self.aget('/logout') as response:
self.assertEqual(response.status, 302)
self.assertEqual(response.headers['Location'], '/')
# Hit error page
async with self.aget('/api/project/1/highlights/') as response:
self.assertEqual(response.status, 403)
self.assertEqual(await response.json(), {"error": "Not logged in"})
# Fetch login page
async with self.aget(
'/login?' + urlencode(dict(next='/project/1')),
) as response:
self.assertEqual(response.status, 200)
# Log in
async with self.apost(
'/login',
data=dict(next='/project/1', login='admin', password='hackme'),
) as response:
self.assertEqual(response.status, 303)
self.assertEqual(response.headers['Location'], '/project/1')
# Check redirect to account
async with self.aget('/.well-known/change-password') as response:
self.assertEqual(response.status, 301)
self.assertEqual(response.headers['Location'], '/account')
# Check /api/check_user endpoint
async with self.apost(
'/api/check_user',
json=dict(login='admin'),
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(await response.json(), {"exists": True})
async with self.apost(
'/api/check_user',
json=dict(login='\xE9'),
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(await response.json(), {"exists": False})
async with self.apost(
'/api/check_user',
json=dict(login='clay'),
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(await response.json(), {"exists": False})
@gen_test(timeout=30)
async def test_projects(self):
# project 1 project 2
# --------- ---------
# create
# (tag 1 'interesting')
# create
# (tag 2 'interesting')
# tag 3 'people'
# tag 4 'interesting.places'
# doc 1
# doc 2
# hl 1 doc=1 tags=[]
# hl 1 doc=1 tags=[1]
# change project metadata
# doc 3
# hl 2 doc=2 tags=[4]
# hl 3 doc=2 tags=[2, 3]
# hl 4 doc=2 tags=[3]
# delete hl 4 doc=2
# hl 5 doc=3 tags=[3]
# highlights 'people*': [3, 5]
# highlights 'interesting.places*': [2]
# highlights 'interesting*': [2, 3]
# highlights: [2, 3, 5]
# export doc 2
# merge tag 3 -> 2
# highlights: [2, 3, 5]
# delete project
# Accept cookies
async with self.apost('/cookies', data=dict()) as response:
self.assertEqual(response.status, 303)
self.assertEqual(response.headers['Location'], '/')
# Log in
async with self.aget('/login') as response:
self.assertEqual(response.status, 200)
async with self.apost(
'/login',
data=dict(next='/', login='admin', password='hackme'),
) as response:
self.assertEqual(response.status, 303)
self.assertEqual(response.headers['Location'], '/')
# Create project 1
async with self.aget('/project/new') as response:
self.assertEqual(response.status, 200)
async with self.apost(
'/project/new',
data=dict(
name='\uFF9F\uFF65\u273F\u30FE\u2572\x28\uFF61\u25D5\u203F'
'\u25D5\uFF61\x29\u2571\u273F\uFF65\uFF9F',
description="R\xE9mi's project",
),
) as response:
self.assertEqual(response.status, 303)
self.assertEqual(response.headers['Location'], '/project/1')
# Check project page
async with self.aget('/project/1') as response:
self.assertEqual(response.status, 200)
body = await response.text()
self.assertIn('<!-- Initial state -->', body)
idx = body.index('<!-- Initial state -->')
init_js = '\n'.join(body[idx:].splitlines()[1:11])
self.assertEqual(
init_js,
'<script type="text/javascript">\n'
' var user_login = "admin";\n'
' var project_id = 1;\n'
' var last_event = -1;\n'
' var documents = {};\n'
' var highlights = {};\n'
' var tags = %s;\n'
' var members = {"admin": {"privileges": "ADMIN"}};\n'
' var version = \'%s\';\n'
'</script>' % (
json.dumps(
{
"1": {
"count": 0, "id": 1, "path": "interesting",
"description": "Further review required",
},
},
sort_keys=True),
exact_version(),
),
)
# Start polling
poll_proj1 = await self.poll_event(1, -1)
# Create project 2
async with self.aget('/project/new') as response:
self.assertEqual(response.status, 200)
async with self.apost(
'/project/new',
data=dict(name='other project', description=''),
) as response:
self.assertEqual(response.status, 303)
self.assertEqual(response.headers['Location'], '/project/2')
# Start polling
poll_proj2 = await self.poll_event(2, -1)
# Create tags in project 2
async with self.apost(
'/api/project/2/tag/new',
json=dict(path='people', description="People of interest"),
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(
await poll_proj2,
{'type': 'tag_add', 'id': 1, 'tag_id': 3,
'tag_path': 'people', 'description': "People of interest"})
poll_proj2 = await self.poll_event(2, 1)
async with self.apost(
'/api/project/2/tag/new',
json=dict(path='interesting.places', description=''),
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(
await poll_proj2,
{'type': 'tag_add', 'id': 2, 'tag_id': 4,
'tag_path': 'interesting.places', 'description': ''})
poll_proj2 = await self.poll_event(2, 2)
# Create document 1 in project 1
name = '\u03A9\u2248\xE7\u221A\u222B\u02DC\xB5\u2264\u2265\xF7'
async with self.apost(
'/api/project/1/document/new',
data=dict(name=name, description=''),
files=dict(
file=('/dir/r\xE9 mi.html', 'text/plain', b'content here'),
),
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(await response.json(), {"created": 1})
db = self.application.DBSession()
doc = db.query(database.Document).get(1)
self.assertEqual(doc.name, name)
self.assertEqual(doc.description, '')
self.assertEqual(doc.filename, 'ré mi.html')
self.assertEqual(
await poll_proj1,
{'type': 'document_add', 'id': 3, 'document_id': 1,
'text_direction': 'LEFT_TO_RIGHT',
'document_name': name, 'description': ''})
poll_proj1 = await self.poll_event(1, 3)
# Create document 2 in project 2
async with self.apost(
'/api/project/2/document/new',
data=dict(name='otherdoc', description='Other one',
text_direction='LEFT_TO_RIGHT'),
files=dict(
file=('../otherdoc.html', 'text/plain', b'different content'),
),
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(await response.json(), {"created": 2})
db = self.application.DBSession()
doc = db.query(database.Document).get(2)
self.assertEqual(doc.name, 'otherdoc')
self.assertEqual(doc.description, 'Other one')
self.assertEqual(doc.filename, 'otherdoc.html')
self.assertEqual(
await poll_proj2,
{'type': 'document_add', 'id': 4, 'document_id': 2,
'text_direction': 'LEFT_TO_RIGHT',
'document_name': 'otherdoc', 'description': 'Other one'})
poll_proj2 = await self.poll_event(2, 4)
# Create highlight 1 in document 1
async with self.apost(
'/api/project/1/document/1/highlight/new',
json=dict(start_offset=3, end_offset=5, tags=[]),
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(await response.json(), {"id": 1})
self.assertEqual(
await poll_proj1,
{'type': 'highlight_add', 'id': 5, 'highlight_id': 1,
'document_id': 1, 'start_offset': 3, 'end_offset': 5,
'tags': [], 'tag_count_changes': {}})
poll_proj1 = await self.poll_event(1, 5)
# Update highlight 1 in document 1: change position
async with self.apost(
'/api/project/1/document/1/highlight/1',
json=dict(start_offset=3, end_offset=7),
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(await response.json(), {"id": 1})
self.assertEqual(
await poll_proj1,
{'type': 'highlight_add', 'id': 6, 'highlight_id': 1,
'document_id': 1, 'start_offset': 3, 'end_offset': 7,
'tags': [], 'tag_count_changes': {}})
poll_proj1 = await self.poll_event(1, 6)
# Update highlight 1 in document 1: change tags
async with self.apost(
'/api/project/1/document/1/highlight/1',
json=dict(tags=[1]),
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(await response.json(), {"id": 1})
self.assertEqual(
await poll_proj1,
{'type': 'highlight_add', 'id': 7, 'highlight_id': 1,
'document_id': 1, 'start_offset': 3, 'end_offset': 7,
'tags': [1], 'tag_count_changes': {'1': 1}})
poll_proj1 = await self.poll_event(1, 7)
# Change project 2 metadata (invalid)
async with self.apost(
'/api/project/2',
json={'name': '', 'description': "Meaningful"},
) as response:
self.assertEqual(response.status, 400)
self.assertEqual(await response.json(),
{'error': 'Project name cannot be empty'})
time.sleep(0.3)
self.assertFalse(poll_proj2.done())
# Change project 2 metadata
async with self.apost(
'/api/project/2',
json={'name': 'new project', 'description': "Meaningful"},
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(await response.json(), {})
self.assertEqual(
await poll_proj2,
{'type': 'project_meta', 'id': 8,
'project_name': 'new project', 'description': 'Meaningful'})
poll_proj2 = await self.poll_event(2, 8)
# Create document 3 in project 2
async with self.apost(
'/api/project/2/document/new',
data=dict(name='third', description='Last one',
text_direction='RIGHT_TO_LEFT'),
files=dict(file=(
'C:\\Users\\Vicky\\Documents\\study.html',
'text/html',
b'<strong>Opinions</strong> and <em>facts</em>!',
)),
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(await response.json(), {"created": 3})
self.assertEqual(
await poll_proj2,
{'type': 'document_add', 'id': 9, 'document_id': 3,
'text_direction': 'RIGHT_TO_LEFT',
'document_name': 'third', 'description': 'Last one'})
poll_proj2 = await self.poll_event(2, 9)
# Create highlight in document 2, using wrong project id
async with self.apost(
'/api/project/1/document/2/highlight/new',
json=dict(start_offset=0, end_offset=4, tags=[]),
) as response:
self.assertEqual(response.status, 404)
# Create highlight in document 2, using tags that don't exist
async with self.apost(
'/api/project/2/document/2/highlight/new',
json=dict(start_offset=0, end_offset=4, tags=[150]),
) as response:
self.assertEqual(response.status, 400)
self.assertEqual(await response.json(),
{"error": "No such tag"})
# Create highlight in document 2, using tags from project 1
async with self.apost(
'/api/project/2/document/2/highlight/new',
json=dict(start_offset=0, end_offset=4, tags=[1]),
) as response:
self.assertEqual(response.status, 400)
self.assertEqual(await response.json(),
{"error": "No such tag"})
# Create highlight 2 in document 2
async with self.apost(
'/api/project/2/document/2/highlight/new',
json=dict(start_offset=0, end_offset=4, tags=[4]),
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(await response.json(), {"id": 2})
self.assertEqual(
await poll_proj2,
{'type': 'highlight_add', 'id': 10, 'highlight_id': 2,
'document_id': 2, 'start_offset': 0, 'end_offset': 4,
'tags': [4], 'tag_count_changes': {'4': 1}})
poll_proj2 = await self.poll_event(2, 10)
# Create highlight 3 in document 2
async with self.apost(
'/api/project/2/document/2/highlight/new',
json=dict(start_offset=13, end_offset=17, tags=[3, 2]),
) as response:
self.assertEqual(response.status, 200)
self.assertEqual(await response.json(), {"id": 3})
self.assertEqual(
await poll_proj2,
{'type': 'highlight_add', 'id': 11, 'highlight_id': 3,
'document_id': 2, 'start_offset': 13, 'end_offset': 17,
'tags': [2, 3], 'tag_count_changes': {'2': 1, '3': 1}})
poll_proj2 = await self.poll_event(2, 11)