test_api.py 34 KB
Newer Older
Markus Scheidgen's avatar
Markus Scheidgen committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# Copyright 2018 Markus Scheidgen
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an"AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

15
16
17
import pytest
import time
import json
18
import base64
19
20
import zipfile
import io
21
import inspect
22
from passlib.hash import bcrypt
23
from datetime import datetime
24

25
from nomad import coe_repo, search, parsing, files
26
27
from nomad.files import UploadFiles, PublicUploadFiles
from nomad.processing import Upload, Calc, SUCCESS
28

29
from tests.conftest import create_auth_headers, clear_elastic
30
from tests.test_files import example_file, example_file_mainfile, example_file_contents
31
from tests.test_files import create_staging_upload, create_public_upload, assert_upload_files
32
from tests.test_coe_repo import assert_coe_upload
33
from tests.test_search import assert_search_upload
34
35


36
37
38
39
40
def test_alive(client):
    rv = client.get('/alive')
    assert rv.status_code == 200


41
42
43
44
45
46
47
@pytest.fixture(scope='function')
def test_user_signature_token(client, test_user_auth):
    rv = client.get('/auth/token', headers=test_user_auth)
    assert rv.status_code == 200
    return json.loads(rv.data)['token']


48
class TestAdmin:
49
50

    @pytest.mark.timeout(10)
51
52
    def test_reset(self, client, admin_user_auth, expandable_postgres, monkeypatch):
        monkeypatch.setattr('nomad.config.services.disable_reset', False)
53
54
55
        rv = client.post('/admin/reset', headers=admin_user_auth)
        assert rv.status_code == 200

56
    @pytest.mark.timeout(10)
57
58
    def test_remove(self, client, admin_user_auth, expandable_postgres, monkeypatch):
        monkeypatch.setattr('nomad.config.services.disable_reset', False)
59
60
        rv = client.post('/admin/remove', headers=admin_user_auth)
        assert rv.status_code == 200
61
62
63
64
65
66

    def test_doesnotexist(self, client, admin_user_auth):
        rv = client.post('/admin/doesnotexist', headers=admin_user_auth)
        assert rv.status_code == 404

    def test_only_admin(self, client, test_user_auth):
Markus Scheidgen's avatar
Markus Scheidgen committed
67
        rv = client.post('/admin/reset', headers=test_user_auth)
68
69
        assert rv.status_code == 401

70
    def test_disabled(self, client, admin_user_auth, postgres):
71
72
73
74
        rv = client.post('/admin/reset', headers=admin_user_auth)
        assert rv.status_code == 400


75
class TestAuth:
76
    def test_xtoken_auth(self, client, test_user: coe_repo.User, no_warn):
77
        rv = client.get('/uploads/', headers={
78
            'X-Token': test_user.first_name.lower()  # the test users have their firstname as tokens for convinience
79
        })
80

81
        assert rv.status_code == 200
Markus Scheidgen's avatar
Markus Scheidgen committed
82

83
    def test_xtoken_auth_denied(self, client, no_warn, postgres):
84
85
86
        rv = client.get('/uploads/', headers={
            'X-Token': 'invalid'
        })
Markus Scheidgen's avatar
Markus Scheidgen committed
87

88
        assert rv.status_code == 401
89

90
91
92
    def test_basic_auth(self, client, test_user_auth, no_warn):
        rv = client.get('/uploads/', headers=test_user_auth)
        assert rv.status_code == 200
93

94
95
96
97
98
99
100
    def test_basic_auth_denied(self, client, no_warn):
        basic_auth_base64 = base64.b64encode('invalid'.encode('utf-8')).decode('utf-8')
        rv = client.get('/uploads/', headers={
            'Authorization': 'Basic %s' % basic_auth_base64
        })
        assert rv.status_code == 401

101
    def test_get_user(self, client, test_user_auth, test_user: coe_repo.User, no_warn):
102
103
        rv = client.get('/auth/user', headers=test_user_auth)
        assert rv.status_code == 200
104
105
106
        self.assert_user(client, json.loads(rv.data))

    def assert_user(self, client, user):
107
108
109
110
111
112
113
        for key in ['first_name', 'last_name', 'email', 'token']:
            assert key in user

        rv = client.get('/uploads/', headers={
            'X-Token': user['token']
        })

114
115
        assert rv.status_code == 200

116
117
118
    def test_signature_token(self, test_user_signature_token, no_warn):
        assert test_user_signature_token is not None

119
120
121
122
123
124
125
126
127
128
129
    @pytest.mark.parametrize('token, affiliation', [
        ('test_token', dict(name='HU Berlin', address='Unter den Linden 6')),
        (None, None)])
    def test_put_user(self, client, postgres, admin_user_auth, token, affiliation):
        data = dict(
            email='test@email.com', last_name='Tester', first_name='Testi',
            token=token, affiliation=affiliation,
            password=bcrypt.encrypt('test_password', ident='2y'))

        data = {key: value for key, value in data.items() if value is not None}

130
131
        rv = client.put(
            '/auth/user', headers=admin_user_auth,
132
            content_type='application/json', data=json.dumps(data))
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

        assert rv.status_code == 200
        self.assert_user(client, json.loads(rv.data))

    def test_put_user_admin_only(self, client, test_user_auth):
        rv = client.put(
            '/auth/user', headers=test_user_auth,
            content_type='application/json', data=json.dumps(dict(
                email='test@email.com', last_name='Tester', first_name='Testi',
                password=bcrypt.encrypt('test_password', ident='2y'))))
        assert rv.status_code == 401

    def test_put_user_required_field(self, client, admin_user_auth):
        rv = client.put(
            '/auth/user', headers=admin_user_auth,
            content_type='application/json', data=json.dumps(dict(
                email='test@email.com', password=bcrypt.encrypt('test_password', ident='2y'))))
        assert rv.status_code == 400

    def test_post_user(self, client, postgres, admin_user_auth):
        rv = client.put(
            '/auth/user', headers=admin_user_auth,
            content_type='application/json', data=json.dumps(dict(
                email='test@email.com', last_name='Tester', first_name='Testi',
                password=bcrypt.encrypt('test_password', ident='2y'))))

        assert rv.status_code == 200
        user = json.loads(rv.data)

        rv = client.post(
            '/auth/user', headers={'X-Token': user['token']},
            content_type='application/json', data=json.dumps(dict(
                last_name='Tester', first_name='Testi v.',
                password=bcrypt.encrypt('test_password_changed', ident='2y'))))
        assert rv.status_code == 200
        self.assert_user(client, json.loads(rv.data))

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

class TestUploads:

    def assert_uploads(self, upload_json_str, count=0, **kwargs):
        data = json.loads(upload_json_str)
        assert isinstance(data, list)
        assert len(data) == count

        if count > 0:
            self.assert_upload(json.dumps(data[0]), **kwargs)

    def assert_upload(self, upload_json_str, id=None, **kwargs):
        data = json.loads(upload_json_str)
        assert 'upload_id' in data
        if id is not None:
            assert id == data['upload_id']
        assert 'create_time' in data

        for key, value in kwargs.items():
            assert data.get(key, None) == value

        return data

    def assert_processing(self, client, test_user_auth, upload_id):
        upload_endpoint = '/uploads/%s' % upload_id

        # poll until completed
        while True:
            time.sleep(0.1)
            rv = client.get(upload_endpoint, headers=test_user_auth)
            assert rv.status_code == 200
            upload = self.assert_upload(rv.data)
            assert 'upload_time' in upload
203
            if not upload['tasks_running']:
204
205
206
                break

        assert len(upload['tasks']) == 4
207
        assert upload['tasks_status'] == SUCCESS
208
        assert upload['current_task'] == 'cleanup'
209
        assert not upload['process_running']
210

211
        calcs = upload['calcs']['results']
212
        n_calcs = upload['calcs']['pagination']['total']
213
        for calc in calcs:
214
            assert calc['tasks_status'] == SUCCESS
215
216
            assert calc['current_task'] == 'archiving'
            assert len(calc['tasks']) == 3
217
            assert client.get('/archive/logs/%s/%s' % (calc['upload_id'], calc['calc_id']), headers=test_user_auth).status_code == 200
218
219

        if upload['calcs']['pagination']['total'] > 1:
220
            rv = client.get('%s?page=2&per_page=1&order_by=tasks_status' % upload_endpoint, headers=test_user_auth)
221
222
223
224
            assert rv.status_code == 200
            upload = self.assert_upload(rv.data)
            assert len(upload['calcs']['results']) == 1

225
226
227
        assert_upload_files(upload_id, files.StagingUploadFiles, n_calcs)
        assert_search_upload(upload_id, n_calcs)

228
    def assert_unstage(self, client, test_user_auth, upload_id, proc_infra, metadata={}):
229
230
        rv = client.get('/uploads/%s' % upload_id, headers=test_user_auth)
        upload = self.assert_upload(rv.data)
231
        n_calcs = upload['calcs']['pagination']['total']
232

233
234
235
        rv = client.post(
            '/uploads/%s' % upload_id,
            headers=test_user_auth,
236
            data=json.dumps(dict(operation='publish', metadata=metadata)),
237
            content_type='application/json')
238
        assert rv.status_code == 200
239
        upload = self.assert_upload(rv.data)
240
        assert upload['current_process'] == 'publish_upload'
241
        assert upload['process_running']
242

243
        self.assert_upload_does_not_exist(client, upload_id, test_user_auth)
244
        assert_coe_upload(upload_id, user_metadata=metadata)
245
246
        assert_upload_files(upload_id, files.PublicUploadFiles, n_calcs, additional_keys=['with_embargo', 'pid'], published=True)
        assert_search_upload(upload_id, n_calcs, additional_keys=['with_embargo', 'pid'], published=True)
247

248
    def assert_upload_does_not_exist(self, client, upload_id: str, test_user_auth):
249
        # poll until publish/delete completed
250
251
252
253
254
255
256
257
258
259
260
        while True:
            time.sleep(0.1)
            rv = client.get('/uploads/%s' % upload_id, headers=test_user_auth)
            if rv.status_code == 200:
                upload = self.assert_upload(rv.data)
                assert upload['process_running']
            elif rv.status_code == 404:
                break
            else:
                assert False

261
262
263
264
265
266
        rv = client.get('/uploads/%s' % upload_id, headers=test_user_auth)
        assert rv.status_code == 404
        assert Upload.objects(upload_id=upload_id).first() is None
        assert Calc.objects(upload_id=upload_id).count() is 0
        upload_files = UploadFiles.get(upload_id)
        assert upload_files is None or isinstance(upload_files, PublicUploadFiles)
Markus Scheidgen's avatar
Markus Scheidgen committed
267

268
269
270
271
272
273
274
    def test_get_command(self, client, test_user_auth, no_warn):
        rv = client.get('/uploads/command', headers=test_user_auth)
        assert rv.status_code == 200
        data = json.loads(rv.data)
        assert 'upload_command' in data
        assert 'upload_url' in data

275
276
    def test_get_empty(self, client, test_user_auth, no_warn):
        rv = client.get('/uploads/', headers=test_user_auth)
Markus Scheidgen's avatar
Markus Scheidgen committed
277

278
279
        assert rv.status_code == 200
        self.assert_uploads(rv.data, count=0)
Markus Scheidgen's avatar
Markus Scheidgen committed
280

281
282
283
    def test_get_not_existing(self, client, test_user_auth, no_warn):
        rv = client.get('/uploads/123456789012123456789012', headers=test_user_auth)
        assert rv.status_code == 404
284

285
286
    @pytest.mark.parametrize('mode', ['multipart', 'stream', 'local_path'])
    @pytest.mark.parametrize('name', [None, 'test_name'])
Markus Scheidgen's avatar
Markus Scheidgen committed
287
    def test_put(self, client, test_user_auth, proc_infra, example_upload, mode, name, no_warn):
288
        file = example_upload
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
        if name:
            url = '/uploads/?name=%s' % name
        else:
            url = '/uploads/'

        if mode == 'multipart':
            rv = client.put(
                url, data=dict(file=(open(file, 'rb'), 'file')), headers=test_user_auth)
        elif mode == 'stream':
            with open(file, 'rb') as f:
                rv = client.put(url, data=f.read(), headers=test_user_auth)
        elif mode == 'local_path':
            url += '&' if name else '?'
            url += 'local_path=%s' % file
            rv = client.put(url, headers=test_user_auth)
        else:
            assert False
306

307
308
        assert rv.status_code == 200
        if mode == 'local_path':
309
            upload = self.assert_upload(rv.data, upload_path=file, name=name)
310
311
        else:
            upload = self.assert_upload(rv.data, name=name)
312
        assert upload['tasks_running']
313

314
        self.assert_processing(client, test_user_auth, upload['upload_id'])
315

316
317
318
    def test_delete_not_existing(self, client, test_user_auth, no_warn):
        rv = client.delete('/uploads/123456789012123456789012', headers=test_user_auth)
        assert rv.status_code == 404
319

320
321
322
323
324
325
326
327
328
329
330
331
    @pytest.fixture(scope='function')
    def slow_processing(self, monkeypatch):
        old_cleanup = Upload.cleanup

        def slow_cleanup(self):
            time.sleep(0.5)
            old_cleanup(self)

        monkeypatch.setattr('nomad.processing.data.Upload.cleanup', slow_cleanup)
        yield True
        monkeypatch.setattr('nomad.processing.data.Upload.cleanup', old_cleanup)

Markus Scheidgen's avatar
Markus Scheidgen committed
332
    def test_delete_unstaged(self, client, test_user_auth, proc_infra, no_warn):
333
334
335
336
337
        rv = client.put('/uploads/?local_path=%s' % example_file, headers=test_user_auth)
        upload = self.assert_upload(rv.data)
        self.assert_processing(client, test_user_auth, upload['upload_id'])
        self.assert_unstage(client, test_user_auth, upload['upload_id'], proc_infra)
        rv = client.delete('/uploads/%s' % upload['upload_id'], headers=test_user_auth)
338
        assert rv.status_code == 404
339

Markus Scheidgen's avatar
Markus Scheidgen committed
340
    def test_delete(self, client, test_user_auth, proc_infra, no_warn):
341
342
343
344
345
        rv = client.put('/uploads/?local_path=%s' % example_file, headers=test_user_auth)
        upload = self.assert_upload(rv.data)
        self.assert_processing(client, test_user_auth, upload['upload_id'])
        rv = client.delete('/uploads/%s' % upload['upload_id'], headers=test_user_auth)
        assert rv.status_code == 200
346
        self.assert_upload_does_not_exist(client, upload['upload_id'], test_user_auth)
347

Markus Scheidgen's avatar
Markus Scheidgen committed
348
    def test_post(self, client, test_user_auth, example_upload, proc_infra, no_warn):
349
        rv = client.put('/uploads/?local_path=%s' % example_upload, headers=test_user_auth)
350
351
352
        upload = self.assert_upload(rv.data)
        self.assert_processing(client, test_user_auth, upload['upload_id'])
        self.assert_unstage(client, test_user_auth, upload['upload_id'], proc_infra)
353

354
355
    def test_post_metadata(
            self, client, proc_infra, admin_user_auth, test_user_auth, test_user,
356
            other_test_user, no_warn, example_user_metadata):
357
358
359
        rv = client.put('/uploads/?local_path=%s' % example_file, headers=test_user_auth)
        upload = self.assert_upload(rv.data)
        self.assert_processing(client, test_user_auth, upload['upload_id'])
360
361
        metadata = dict(**example_user_metadata)
        metadata['_upload_time'] = datetime.now().isoformat()
362
        self.assert_unstage(client, admin_user_auth, upload['upload_id'], proc_infra, metadata)
363

Markus Scheidgen's avatar
Markus Scheidgen committed
364
    def test_post_metadata_forbidden(self, client, proc_infra, test_user_auth, no_warn):
365
366
367
368
369
370
        rv = client.put('/uploads/?local_path=%s' % example_file, headers=test_user_auth)
        upload = self.assert_upload(rv.data)
        self.assert_processing(client, test_user_auth, upload['upload_id'])
        rv = client.post(
            '/uploads/%s' % upload['upload_id'],
            headers=test_user_auth,
371
            data=json.dumps(dict(operation='publish', metadata=dict(_pid=256))),
372
373
374
375
            content_type='application/json')
        assert rv.status_code == 401

    # TODO validate metadata (or all input models in API for that matter)
376
    # def test_post_bad_metadata(self, client, proc_infra, test_user_auth, postgres):
377
378
379
380
381
382
    #     rv = client.put('/uploads/?local_path=%s' % example_file, headers=test_user_auth)
    #     upload = self.assert_upload(rv.data)
    #     self.assert_processing(client, test_user_auth, upload['upload_id'])
    #     rv = client.post(
    #         '/uploads/%s' % upload['upload_id'],
    #         headers=test_user_auth,
383
    #         data=json.dumps(dict(operation='publish', metadata=dict(doesnotexist='hi'))),
384
385
386
    #         content_type='application/json')
    #     assert rv.status_code == 400

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
class UploadFilesBasedTests:

    @staticmethod
    def fix_signature(func, wrapper):
        additional_args = list(inspect.signature(func).parameters.values())[4:]
        wrapper_sig = inspect.signature(wrapper)
        wrapper_args = list(wrapper_sig.parameters.values())[:3] + additional_args
        wrapper_sig = wrapper_sig.replace(parameters=tuple(wrapper_args))
        wrapper.__signature__ = wrapper_sig

    @staticmethod
    def check_authorizaton(func):
        @pytest.mark.parametrize('test_data', [
            [True, None, True],     # in staging for upload
            [True, None, False],    # in staging for different user
            [True, None, None],     # in staging for guest
            [False, True, True],    # in public, restricted for uploader
            [False, True, False],   # in public, restricted for different user
            [False, True, None],    # in public, restricted for guest
            [False, False, True],   # in public, public, for uploader
            [False, False, False],  # in public, public, for different user
            [False, False, None]    # in public, public, for guest
        ], indirect=True)
        def wrapper(self, client, test_data, *args, **kwargs):
            upload, authorized, auth_headers = test_data
            try:
                func(self, client, upload, auth_headers, *args, **kwargs)
            except AssertionError as assertion:
                assertion_str = str(assertion)
                if not authorized:
                    if '0 == 5' in assertion_str and 'ZipFile' in assertion_str:
                        # the user is not authorized an gets an empty zip as expected
                        return
                    if '401' in assertion_str:
                        # the user is not authorized and gets a 401 as expected
                        return
                raise assertion

            if not authorized:
                assert False
        UploadFilesBasedTests.fix_signature(func, wrapper)
        return wrapper

    @staticmethod
    def ignore_authorization(func):
        @pytest.mark.parametrize('test_data', [
            [True, None, True],      # in staging
            [False, False, None],    # in public
        ], indirect=True)
        def wrapper(self, client, test_data, *args, **kwargs):
            upload, _, auth_headers = test_data
            func(self, client, upload, auth_headers, *args, **kwargs)
        UploadFilesBasedTests.fix_signature(func, wrapper)
        return wrapper
442

443
    @pytest.fixture(scope='function')
444
    def test_data(self, request, postgres, mongo, raw_files, no_warn, test_user, other_test_user):
445
446
447
448
449
        # delete potential old test files
        for _ in [0, 1]:
            upload_files = UploadFiles.get('test_upload')
            if upload_files:
                upload_files.delete()
450

451
        in_staging, restricted, for_uploader = request.param
452

453
454
455
456
        if in_staging:
            authorized = for_uploader
        else:
            authorized = not restricted or for_uploader
457

458
459
460
461
462
463
        if for_uploader:
            auth_headers = create_auth_headers(test_user)
        elif for_uploader is False:
            auth_headers = create_auth_headers(other_test_user)
        else:
            auth_headers = None
464

465
466
        calc_specs = 'r' if restricted else 'p'
        if in_staging:
467
            Upload.create(user=test_user, upload_id='test_upload')
468
469
470
            upload_files = create_staging_upload('test_upload', calc_specs=calc_specs)
        else:
            upload_files = create_public_upload('test_upload', calc_specs=calc_specs)
471
            postgres.begin()
472
473
474
            coe_upload = coe_repo.Upload(
                upload_name='test_upload',
                user_id=test_user.user_id, is_processed=True)
475
476
            postgres.add(coe_upload)
            postgres.commit()
477

478
        yield 'test_upload', authorized, auth_headers
479

480
        upload_files.delete()
481
482


483
484
485
486
class TestArchive(UploadFilesBasedTests):
    @UploadFilesBasedTests.check_authorizaton
    def test_get(self, client, upload, auth_headers):
        rv = client.get('/archive/%s/0' % upload, headers=auth_headers)
487
        assert rv.status_code == 200
488
        assert json.loads(rv.data) is not None
489

490
491
492
493
494
495
    @UploadFilesBasedTests.ignore_authorization
    def test_get_signed(self, client, upload, _, test_user_signature_token):
        rv = client.get('/archive/%s/0?token=%s' % (upload, test_user_signature_token))
        assert rv.status_code == 200
        assert json.loads(rv.data) is not None

496
497
498
    @UploadFilesBasedTests.check_authorizaton
    def test_get_calc_proc_log(self, client, upload, auth_headers):
        rv = client.get('/archive/logs/%s/0' % upload, headers=auth_headers)
499
        assert rv.status_code == 200
500
        assert len(rv.data) > 0
501

502
503
504
505
506
507
    @UploadFilesBasedTests.ignore_authorization
    def test_get_calc_proc_log_signed(self, client, upload, _, test_user_signature_token):
        rv = client.get('/archive/logs/%s/0?token=%s' % (upload, test_user_signature_token))
        assert rv.status_code == 200
        assert len(rv.data) > 0

508
509
510
    @UploadFilesBasedTests.ignore_authorization
    def test_get_non_existing_archive(self, client, upload, auth_headers):
        rv = client.get('/archive/%s' % 'doesnt/exist', headers=auth_headers)
511
        assert rv.status_code == 404
Markus Scheidgen's avatar
Markus Scheidgen committed
512

513
514
515
516
    def test_get_metainfo(self, client):
        rv = client.get('/archive/metainfo/all.nomadmetainfo.json')
        assert rv.status_code == 200

Markus Scheidgen's avatar
Markus Scheidgen committed
517

518
class TestRepo(UploadFilesBasedTests):
519
520
521
522
523
524
525
526
527
    @pytest.fixture(scope='class')
    def example_elastic_calcs(
            self, elastic_infra, normalized: parsing.LocalBackend,
            test_user: coe_repo.User, other_test_user: coe_repo.User):

        clear_elastic(elastic_infra)

        calc_with_metadata = normalized.to_calc_with_metadata()

528
        calc_with_metadata.update(calc_id='1', uploader=test_user.to_popo(), published=True, with_embargo=False)
529
530
        search.Entry.from_calc_with_metadata(calc_with_metadata).save(refresh=True)

531
        calc_with_metadata.update(calc_id='2', uploader=other_test_user.to_popo(), published=True, with_embargo=False)
532
        calc_with_metadata.update(atoms=['Fe'], comment='this is a specific word', formula='AAA', basis_set='zzz')
533
534
        search.Entry.from_calc_with_metadata(calc_with_metadata).save(refresh=True)

535
536
537
538
        calc_with_metadata.update(calc_id='3', uploader=other_test_user.to_popo(), published=False, with_embargo=False)
        search.Entry.from_calc_with_metadata(calc_with_metadata).save(refresh=True)

        calc_with_metadata.update(calc_id='4', uploader=other_test_user.to_popo(), published=True, with_embargo=True)
539
540
        search.Entry.from_calc_with_metadata(calc_with_metadata).save(refresh=True)

541
542
543
544
545
546
547
548
549
550
    @UploadFilesBasedTests.ignore_authorization
    def test_calc(self, client, upload, auth_headers):
        rv = client.get('/repo/%s/0' % upload, headers=auth_headers)
        assert rv.status_code == 200

    @UploadFilesBasedTests.ignore_authorization
    def test_non_existing_calcs(self, client, upload, auth_headers):
        rv = client.get('/repo/doesnt/exist', headers=auth_headers)
        assert rv.status_code == 404

551
552
553
    @pytest.mark.parametrize('calcs, owner, auth', [
        (2, 'all', 'none'),
        (2, 'all', 'test_user'),
554
        (4, 'all', 'other_test_user'),
555
        (1, 'user', 'test_user'),
556
        (3, 'user', 'other_test_user'),
557
        (0, 'staging', 'test_user'),
558
        (1, 'staging', 'other_test_user')
559
    ])
560
    def test_search_owner(self, client, example_elastic_calcs, no_warn, test_user_auth, other_test_user_auth, calcs, owner, auth):
561
562
563
564
565
566
567
568
569
570
571
572
        auth = dict(none=None, test_user=test_user_auth, other_test_user=other_test_user_auth).get(auth)
        rv = client.get('/repo/?owner=%s' % owner, headers=auth)
        assert rv.status_code == 200
        data = json.loads(rv.data)
        results = data.get('results', None)
        assert results is not None
        assert isinstance(results, list)
        assert len(results) == calcs
        if calcs > 0:
            for key in ['uploader', 'calc_id', 'formula', 'upload_id']:
                assert key in results[0]

573
    @pytest.mark.parametrize('calcs, quantity, value', [
574
575
        (2, 'system', 'bulk'),
        (0, 'system', 'atom'),
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
        (1, 'atoms', 'Br'),
        (1, 'atoms', 'Fe'),
        (0, 'atoms', ['Fe', 'Br']),
        (1, 'comment', 'specific'),
        (1, 'authors', 'Hofstadter, Leonard'),
        (2, 'files', 'test/mainfile.txt'),
        (2, 'paths', 'mainfile.txt'),
        (2, 'paths', 'test'),
        (2, 'quantities', ['wyckoff_letters_primitive', 'hall_number']),
        (0, 'quantities', 'dos')
    ])
    def test_search_quantities(self, client, example_elastic_calcs, no_warn, test_user_auth, calcs, quantity, value):
        if isinstance(value, list):
            query_string = '&'.join('%s=%s' % (quantity, item) for item in value)
        else:
            query_string = '%s=%s' % (quantity, value)

        rv = client.get('/repo/?%s' % query_string, headers=test_user_auth)

        assert rv.status_code == 200
        data = json.loads(rv.data)

        results = data.get('results', None)
        assert results is not None
        assert isinstance(results, list)
        assert len(results) == calcs

        aggregations = data.get('aggregations', None)
        assert aggregations is not None
        if quantity == 'system' and calcs != 0:
            # for simplicity we only assert on aggregations for this case
            assert 'system' in aggregations
            assert len(aggregations['system']) == 1
            assert value in aggregations['system']

Markus Scheidgen's avatar
Markus Scheidgen committed
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
    @pytest.mark.parametrize('metrics', [[], ['total_energies'], ['geometries'], ['datasets'], ['total_energies', 'geometries', 'datasets']])
    def test_search_total_metrics(self, client, example_elastic_calcs, no_warn, metrics):
        rv = client.get('/repo/?total_metrics=%s' % ','.join(metrics))
        assert rv.status_code == 200
        data = json.loads(rv.data)
        metrics_result = data.get('metrics', None)
        assert 'code_runs' in metrics_result
        for metric in metrics:
            assert metric in metrics_result

    @pytest.mark.parametrize('metrics', [[], ['total_energies'], ['geometries'], ['datasets'], ['total_energies', 'geometries', 'datasets']])
    def test_search_aggregation_metrics(self, client, example_elastic_calcs, no_warn, metrics):
        rv = client.get('/repo/?aggregation_metrics=%s' % ','.join(metrics))
        assert rv.status_code == 200
        data = json.loads(rv.data)
        for aggregations in data.get('aggregations').values():
            for metrics_result in aggregations.values():
                assert 'code_runs' in metrics_result
                for metric in metrics:
                    assert metric in metrics_result

632
633
634
    @pytest.mark.parametrize('n_results, page, per_page', [(2, 1, 5), (1, 1, 1), (0, 2, 3)])
    def test_search_pagination(self, client, example_elastic_calcs, no_warn, n_results, page, per_page):
        rv = client.get('/repo/?page=%d&per_page=%d' % (page, per_page))
635
636
637
        assert rv.status_code == 200
        data = json.loads(rv.data)
        results = data.get('results', None)
638
        assert data['pagination']['total'] == 2
639
        assert results is not None
640
        assert len(results) == n_results
641

642
643
644
645
646
647
648
649
650
651
652
653
    @pytest.mark.parametrize('first, order_by, order', [
        ('1', 'formula', -1), ('2', 'formula', 1),
        ('2', 'basis_set', -1), ('1', 'basis_set', 1)])
    def test_search_order(self, client, example_elastic_calcs, no_warn, first, order_by, order):
        rv = client.get('/repo/?order_by=%s&order=%d' % (order_by, order))
        assert rv.status_code == 200
        data = json.loads(rv.data)
        results = data.get('results', None)
        assert data['pagination']['total'] == 2
        assert len(results) == 2
        assert results[0]['calc_id'] == first

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
    @pytest.mark.parametrize('n_results, size', [(2, None), (2, 5), (1, 1)])
    def test_search_scroll(self, client, example_elastic_calcs, no_warn, n_results, size):
        if size is not None:
            rv = client.get('/repo/?scroll=1,&per_page=%d' % size)
        else:
            rv = client.get('/repo/?scroll=1')

        assert rv.status_code == 200
        data = json.loads(rv.data)
        results = data.get('results', None)
        assert data['pagination']['total'] == 2
        assert results is not None
        assert len(results) == n_results
        scroll_id = data.get('scroll_id', None)
        assert scroll_id is not None

        has_another_page = False
        while scroll_id is not None:
            rv = client.get('/repo/?scroll=1&scroll_id=%s' % scroll_id)
            data = json.loads(rv.data)
            scroll_id = data.get('scroll_id', None)
            has_another_page |= len(data.get('results')) > 0

        if n_results < 2:
            assert has_another_page

680
681
682
    def test_search_user_authrequired(self, client, example_elastic_calcs, no_warn):
        rv = client.get('/repo/?owner=user')
        assert rv.status_code == 401
683
684


685
class TestRaw(UploadFilesBasedTests):
Markus Scheidgen's avatar
Markus Scheidgen committed
686

687
688
    @UploadFilesBasedTests.check_authorizaton
    def test_raw_file(self, client, upload, auth_headers):
689
        url = '/raw/%s/%s' % (upload, example_file_mainfile)
690
        rv = client.get(url, headers=auth_headers)
691
692
693
        assert rv.status_code == 200
        assert len(rv.data) > 0

694
695
696
697
698
699
700
    @UploadFilesBasedTests.ignore_authorization
    def test_raw_file_signed(self, client, upload, _, test_user_signature_token):
        url = '/raw/%s/%s?token=%s' % (upload, example_file_mainfile, test_user_signature_token)
        rv = client.get(url)
        assert rv.status_code == 200
        assert len(rv.data) > 0

701
702
    @UploadFilesBasedTests.ignore_authorization
    def test_raw_file_missing_file(self, client, upload, auth_headers):
703
        url = '/raw/%s/does/not/exist' % upload
704
        rv = client.get(url, headers=auth_headers)
705
        assert rv.status_code == 404
706
707
708
        data = json.loads(rv.data)
        assert 'files' not in data

709
710
    @UploadFilesBasedTests.ignore_authorization
    def test_raw_file_listing(self, client, upload, auth_headers):
711
        url = '/raw/%s/examples' % upload
712
        rv = client.get(url, headers=auth_headers)
713
714
715
716
        assert rv.status_code == 404
        data = json.loads(rv.data)
        assert len(data['files']) == 5

717
    @pytest.mark.parametrize('compress', [True, False])
718
719
    @UploadFilesBasedTests.ignore_authorization
    def test_raw_file_wildcard(self, client, upload, auth_headers, compress):
720
        url = '/raw/%s/examples*' % upload
721
722
        if compress:
            url = '%s?compress=1' % url
723
        rv = client.get(url, headers=auth_headers)
724
725
726
727
728
729
730

        assert rv.status_code == 200
        assert len(rv.data) > 0
        with zipfile.ZipFile(io.BytesIO(rv.data)) as zip_file:
            assert zip_file.testzip() is None
            assert len(zip_file.namelist()) == len(example_file_contents)

731
732
733
734
    @UploadFilesBasedTests.ignore_authorization
    def test_raw_file_wildcard_missing(self, client, upload, auth_headers):
        url = '/raw/%s/does/not/exist*' % upload
        rv = client.get(url, headers=auth_headers)
735
        assert rv.status_code == 404
736

737
738
    @UploadFilesBasedTests.ignore_authorization
    def test_raw_file_missing_upload(self, client, upload, auth_headers):
739
        url = '/raw/doesnotexist/%s' % example_file_mainfile
740
        rv = client.get(url, headers=auth_headers)
741
742
        assert rv.status_code == 404

743
    @pytest.mark.parametrize('compress', [True, False])
744
745
    @UploadFilesBasedTests.check_authorizaton
    def test_raw_files(self, client, upload, auth_headers, compress):
746
        url = '/raw/%s?files=%s' % (
747
            upload, ','.join(example_file_contents))
748
749
        if compress:
            url = '%s&compress=1' % url
750
        rv = client.get(url, headers=auth_headers)
Markus Scheidgen's avatar
Markus Scheidgen committed
751

752
753
754
755
        assert rv.status_code == 200
        assert len(rv.data) > 0
        with zipfile.ZipFile(io.BytesIO(rv.data)) as zip_file:
            assert zip_file.testzip() is None
756
            assert len(zip_file.namelist()) == len(example_file_contents)
Markus Scheidgen's avatar
Markus Scheidgen committed
757

758
759
760
761
762
763
764
765
766
767
768
769
    @UploadFilesBasedTests.ignore_authorization
    def test_raw_files_signed(self, client, upload, _, test_user_signature_token):
        url = '/raw/%s?files=%s&token=%s' % (
            upload, ','.join(example_file_contents), test_user_signature_token)
        rv = client.get(url)

        assert rv.status_code == 200
        assert len(rv.data) > 0
        with zipfile.ZipFile(io.BytesIO(rv.data)) as zip_file:
            assert zip_file.testzip() is None
            assert len(zip_file.namelist()) == len(example_file_contents)

770
    @pytest.mark.parametrize('compress', [True, False, None])
771
772
773
    @UploadFilesBasedTests.check_authorizaton
    def test_raw_files_post(self, client, upload, auth_headers, compress):
        url = '/raw/%s' % upload
774
        data = dict(files=example_file_contents)
775
776
        if compress is not None:
            data.update(compress=compress)
777
        rv = client.post(url, data=json.dumps(data), content_type='application/json', headers=auth_headers)
778
779
780
781
782

        assert rv.status_code == 200
        assert len(rv.data) > 0
        with zipfile.ZipFile(io.BytesIO(rv.data)) as zip_file:
            assert zip_file.testzip() is None
783
            assert len(zip_file.namelist()) == len(example_file_contents)
784

785
    @pytest.mark.parametrize('compress', [True, False])
786
787
    @UploadFilesBasedTests.ignore_authorization
    def test_raw_files_missing_file(self, client, upload, auth_headers, compress):
788
        url = '/raw/%s?files=%s,missing/file.txt' % (upload, example_file_mainfile)
789
790
        if compress:
            url = '%s&compress=1' % url
791
        rv = client.get(url, headers=auth_headers)
Markus Scheidgen's avatar
Markus Scheidgen committed
792

793
794
795
796
797
        assert rv.status_code == 200
        assert len(rv.data) > 0
        with zipfile.ZipFile(io.BytesIO(rv.data)) as zip_file:
            assert zip_file.testzip() is None
            assert len(zip_file.namelist()) == 1
798

799
800
    @UploadFilesBasedTests.ignore_authorization
    def test_raw_files_missing_upload(self, client, upload, auth_headers):
801
        url = '/raw/doesnotexist?files=shoud/not/matter.txt'
802
        rv = client.get(url, headers=auth_headers)
803

804
        assert rv.status_code == 404
805
806
807
808
809
810


def test_docs(client):
    rv = client.get('/docs/index.html')
    rv = client.get('/docs/introduction.html')
    assert rv.status_code == 200