test_api.py 49.1 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
from typing import Any
16
17
18
import pytest
import time
import json
19
import base64
20
21
import zipfile
import io
22
import inspect
23
from passlib.hash import bcrypt
Markus Scheidgen's avatar
Markus Scheidgen committed
24
import datetime
25
import os.path
26
from urllib.parse import urlencode
27

Markus Scheidgen's avatar
Markus Scheidgen committed
28
from nomad.api.app import rfc3339DateTime
29
from nomad import search, parsing, files, config, utils
30
31
from nomad.files import UploadFiles, PublicUploadFiles
from nomad.processing import Upload, Calc, SUCCESS
32
from nomad.datamodel import UploadWithMetadata, CalcWithMetadata, User
33

34
from tests.conftest import create_auth_headers, clear_elastic
35
from tests.test_files import example_file, example_file_mainfile, example_file_contents
36
from tests.test_files import create_staging_upload, create_public_upload, assert_upload_files
37
from tests.test_search import assert_search_upload
38
39


40
41
logger = utils.get_logger(__name__)

Markus Scheidgen's avatar
Markus Scheidgen committed
42

43
44
45
46
47
def test_alive(client):
    rv = client.get('/alive')
    assert rv.status_code == 200


48
49
50
51
52
53
54
@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']


55
56
57
58
59
60
61
62
def get_upload_with_metadata(upload: dict) -> UploadWithMetadata:
    """ Create a :class:`UploadWithMetadata` from a API upload json record. """
    return UploadWithMetadata(
        upload_id=upload['upload_id'], calcs=[
            CalcWithMetadata(calc_id=calc['calc_id'], mainfile=calc['mainfile'])
            for calc in upload['calcs']['results']])


63
64
65
class TestInfo:
    def test_info(self, client):
        rv = client.get('/info/')
66
67
68
69
        data = json.loads(rv.data)
        assert 'codes' in data
        assert 'parsers' in data
        assert len(data['parsers']) >= len(data['codes'])
70
71
        assert rv.status_code == 200

72

73
class TestAdmin:
Markus Scheidgen's avatar
Markus Scheidgen committed
74
    @pytest.mark.timeout(config.tests.default_timeout)
75
    def test_reset(self, client, admin_user_auth, monkeypatch):
76
        monkeypatch.setattr('nomad.config.services.disable_reset', False)
77
78
79
        rv = client.post('/admin/reset', headers=admin_user_auth)
        assert rv.status_code == 200

Markus Scheidgen's avatar
Markus Scheidgen committed
80
    @pytest.mark.timeout(config.tests.default_timeout)
81
    def test_remove(self, client, admin_user_auth, monkeypatch):
82
        monkeypatch.setattr('nomad.config.services.disable_reset', False)
83
84
        rv = client.post('/admin/remove', headers=admin_user_auth)
        assert rv.status_code == 200
85
86
87
88
89
90

    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
91
        rv = client.post('/admin/reset', headers=test_user_auth)
92
93
        assert rv.status_code == 401

94
    def test_disabled(self, client, admin_user_auth, monkeypatch):
95
        monkeypatch.setattr('nomad.config.services.disable_reset', True)
96
97
98
99
        rv = client.post('/admin/reset', headers=admin_user_auth)
        assert rv.status_code == 400


100
class TestAuth:
101
102
103
104
105
106
107
108
    def test_auth_wo_credentials(self, client, keycloak, no_warn):
        rv = client.get('/auth/')
        assert rv.status_code == 401

    def test_auth(self, client, test_user_auth, keycloak):
        rv = client.get('/auth/', headers=test_user_auth)
        assert rv.status_code == 200

109
    def test_xtoken_auth(self, client, test_user: User, no_warn):
110
        rv = client.get('/uploads/', headers={
111
            'X-Token': test_user.first_name.lower()  # the test users have their firstname as tokens for convinience
112
        })
113

114
        assert rv.status_code == 200
Markus Scheidgen's avatar
Markus Scheidgen committed
115

116
    def test_xtoken_auth_denied(self, client, no_warn):
117
118
119
        rv = client.get('/uploads/', headers={
            'X-Token': 'invalid'
        })
Markus Scheidgen's avatar
Markus Scheidgen committed
120

121
        assert rv.status_code == 401
122

123
124
125
    def test_basic_auth(self, client, test_user_auth, no_warn):
        rv = client.get('/uploads/', headers=test_user_auth)
        assert rv.status_code == 200
126

127
128
129
130
131
132
133
    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

134
    def test_get_user(self, client, test_user_auth, test_user: User, no_warn):
135
136
        rv = client.get('/auth/user', headers=test_user_auth)
        assert rv.status_code == 200
137
138
139
        self.assert_user(client, json.loads(rv.data))

    def assert_user(self, client, user):
140
141
142
143
144
145
146
        for key in ['first_name', 'last_name', 'email', 'token']:
            assert key in user

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

147
148
        assert rv.status_code == 200

149
150
151
    def test_signature_token(self, test_user_signature_token, no_warn):
        assert test_user_signature_token is not None

152
153
154
    @pytest.mark.parametrize('token, affiliation', [
        ('test_token', dict(name='HU Berlin', address='Unter den Linden 6')),
        (None, None)])
155
    def test_put_user(self, client, admin_user_auth, token, affiliation):
156
157
158
159
160
161
162
        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}

163
164
        rv = client.put(
            '/auth/user', headers=admin_user_auth,
165
            content_type='application/json', data=json.dumps(data))
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184

        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

185
    def test_post_user(self, client, admin_user_auth):
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
        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))

203
204
205
206
207

class TestUploads:

    def assert_uploads(self, upload_json_str, count=0, **kwargs):
        data = json.loads(upload_json_str)
208
209
210
211
        assert 'pagination' in data
        assert 'page' in data['pagination']

        data = data['results']
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
        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
234
        upload = self.block_until_completed(client, upload_id, test_user_auth)
235
236

        assert len(upload['tasks']) == 4
237
        assert upload['tasks_status'] == SUCCESS
238
        assert upload['current_task'] == 'cleanup'
239
        assert not upload['process_running']
240

241
242
        calcs = upload['calcs']['results']
        for calc in calcs:
243
            assert calc['tasks_status'] == SUCCESS
244
245
            assert calc['current_task'] == 'archiving'
            assert len(calc['tasks']) == 3
246
            assert client.get('/archive/logs/%s/%s' % (calc['upload_id'], calc['calc_id']), headers=test_user_auth).status_code == 200
247
248

        if upload['calcs']['pagination']['total'] > 1:
249
            rv = client.get('%s?page=2&per_page=1&order_by=tasks_status' % upload_endpoint, headers=test_user_auth)
250
251
252
253
            assert rv.status_code == 200
            upload = self.assert_upload(rv.data)
            assert len(upload['calcs']['results']) == 1

254
255
        upload_with_metadata = get_upload_with_metadata(upload)
        assert_upload_files(upload_with_metadata, files.StagingUploadFiles)
256
        assert_search_upload(upload_with_metadata, additional_keys=['atoms', 'system'])
257

258
    def assert_published(self, client, test_user_auth, upload_id, proc_infra, metadata={}, publish_with_metadata: bool = True):
259
260
        rv = client.get('/uploads/%s' % upload_id, headers=test_user_auth)
        upload = self.assert_upload(rv.data)
261
262

        upload_with_metadata = get_upload_with_metadata(upload)
263

264
265
266
        rv = client.post(
            '/uploads/%s' % upload_id,
            headers=test_user_auth,
267
            data=json.dumps(dict(operation='publish', metadata=metadata if publish_with_metadata else {})),
268
            content_type='application/json')
269
        assert rv.status_code == 200
270
        upload = self.assert_upload(rv.data)
271
        assert upload['current_process'] == 'publish_upload'
272
        assert upload['process_running']
273

274
        additional_keys = ['with_embargo']
275

276
277
278
279
280
        self.block_until_completed(client, upload_id, test_user_auth)
        upload_proc = Upload.objects(upload_id=upload_id).first()
        assert upload_proc is not None
        assert upload_proc.published is True

281
        assert_upload_files(upload_with_metadata, files.PublicUploadFiles, published=True)
282
283
284
        assert_search_upload(upload_with_metadata, additional_keys=additional_keys, published=True)

    def block_until_completed(self, client, upload_id: str, test_user_auth):
285
286
287
288
289
        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)
290
291
                if not upload['process_running'] and not upload['tasks_running']:
                    return upload
292
            elif rv.status_code == 404:
293
                return None
294
295
296
297
            else:
                raise Exception(
                    'unexpected status code while blocking for upload processing: %s' %
                    str(rv.status_code))
298
299
300

    def assert_upload_does_not_exist(self, client, upload_id: str, test_user_auth):
        self.block_until_completed(client, upload_id, test_user_auth)
301

302
303
304
305
306
307
        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
308

309
310
311
312
313
314
315
    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

316
317
    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
318

319
320
        assert rv.status_code == 200
        self.assert_uploads(rv.data, count=0)
Markus Scheidgen's avatar
Markus Scheidgen committed
321

322
323
324
    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
325

326
327
    @pytest.mark.parametrize('mode', ['multipart', 'stream', 'local_path'])
    @pytest.mark.parametrize('name', [None, 'test_name'])
Markus Scheidgen's avatar
Markus Scheidgen committed
328
    def test_put(self, client, test_user_auth, proc_infra, example_upload, mode, name, no_warn):
329
        file = example_upload
330
331
332
333
334
335
336
        if name:
            url = '/uploads/?name=%s' % name
        else:
            url = '/uploads/'

        if mode == 'multipart':
            rv = client.put(
337
338
339
                url, data=dict(file=(open(file, 'rb'), 'the_name')), headers=test_user_auth)
            if not name:
                name = 'the_name'
340
341
342
343
344
345
346
347
348
        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
349

350
351
        assert rv.status_code == 200
        if mode == 'local_path':
352
            upload = self.assert_upload(rv.data, upload_path=file, name=name)
353
354
        else:
            upload = self.assert_upload(rv.data, name=name)
355
        assert upload['tasks_running']
356

357
        self.assert_processing(client, test_user_auth, upload['upload_id'])
358

359
360
361
362
363
364
365
366
    def test_upload_limit(self, client, mongo, test_user, test_user_auth, proc_infra):
        for _ in range(0, config.services.upload_limit):
            Upload.create(user=test_user)
        file = example_file
        rv = client.put('/uploads/?local_path=%s' % file, headers=test_user_auth)
        assert rv.status_code == 400
        assert Upload.user_uploads(test_user).count() == config.services.upload_limit

367
368
369
    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
370

371
372
373
374
375
376
377
378
379
380
381
382
    @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)

383
    def test_delete_published(self, client, test_user_auth, proc_infra, no_warn):
384
385
386
        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'])
387
        self.assert_published(client, test_user_auth, upload['upload_id'], proc_infra)
388
        rv = client.delete('/uploads/%s' % upload['upload_id'], headers=test_user_auth)
389
        assert rv.status_code == 400
390

Markus Scheidgen's avatar
Markus Scheidgen committed
391
    def test_delete(self, client, test_user_auth, proc_infra, no_warn):
392
393
394
395
396
        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
397
        self.assert_upload_does_not_exist(client, upload['upload_id'], test_user_auth)
398

399
400
401
402
403
404
405
406
407
408
409
    def test_post_empty(self, client, test_user_auth, empty_upload, proc_infra, no_warn):
        rv = client.put('/uploads/?local_path=%s' % empty_upload, headers=test_user_auth)
        assert rv.status_code == 200
        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,
            data=json.dumps(dict(operation='publish')),
            content_type='application/json')
        assert rv.status_code == 400

410
    def test_post(self, client, test_user_auth, non_empty_example_upload, proc_infra, no_warn):
411
412
        rv = client.put('/uploads/?local_path=%s' % non_empty_example_upload, headers=test_user_auth)
        assert rv.status_code == 200
413
414
        upload = self.assert_upload(rv.data)
        self.assert_processing(client, test_user_auth, upload['upload_id'])
415
        self.assert_published(client, test_user_auth, upload['upload_id'], proc_infra)
416

417
418
419
        # still visible
        assert client.get('/uploads/%s' % upload['upload_id'], headers=test_user_auth).status_code == 200
        # still listed with all=True
420
        rv = client.get('/uploads/?state=all', headers=test_user_auth)
421
        assert rv.status_code == 200
422
        data = json.loads(rv.data)['results']
423
424
425
426
427
        assert len(data) > 0
        assert any(item['upload_id'] == upload['upload_id'] for item in data)
        # not listed with all=False
        rv = client.get('/uploads/', headers=test_user_auth)
        assert rv.status_code == 200
428
        data = json.loads(rv.data)['results']
429
430
        assert not any(item['upload_id'] == upload['upload_id'] for item in data)

431
432
    def test_post_metadata(
            self, client, proc_infra, admin_user_auth, test_user_auth, test_user,
433
            other_test_user, no_warn, example_user_metadata):
434
435
436
        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'])
437
        metadata = dict(**example_user_metadata)
438
        metadata['_upload_time'] = datetime.datetime.utcnow().isoformat()
439
        self.assert_published(client, admin_user_auth, upload['upload_id'], proc_infra, metadata)
440

Markus Scheidgen's avatar
Markus Scheidgen committed
441
    def test_post_metadata_forbidden(self, client, proc_infra, test_user_auth, no_warn):
442
443
444
445
446
447
        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,
448
            data=json.dumps(dict(operation='publish', metadata=dict(_pid=256))),
449
450
451
            content_type='application/json')
        assert rv.status_code == 401

452
453
454
455
456
457
458
    def test_post_metadata_and_republish(
            self, client, proc_infra, admin_user_auth, test_user_auth, test_user,
            other_test_user, no_warn, example_user_metadata):
        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'])
        metadata = dict(**example_user_metadata)
459
        metadata['_upload_time'] = datetime.datetime.utcnow().isoformat()
460
461
462
        self.assert_published(client, admin_user_auth, upload['upload_id'], proc_infra, metadata)
        self.assert_published(client, admin_user_auth, upload['upload_id'], proc_infra, metadata, publish_with_metadata=False)

463
464
465
466
467
468
469
470
471
472
473
474
475
476
    def test_post_re_process(self, client, published, test_user_auth, monkeypatch):
        monkeypatch.setattr('nomad.config.version', 're_process_test_version')
        monkeypatch.setattr('nomad.config.commit', 're_process_test_commit')

        upload_id = published.upload_id
        rv = client.post(
            '/uploads/%s' % upload_id,
            headers=test_user_auth,
            data=json.dumps(dict(operation='re-process')),
            content_type='application/json')

        assert rv.status_code == 200
        assert self.block_until_completed(client, upload_id, test_user_auth) is not None

477
    # TODO validate metadata (or all input models in API for that matter)
478
    # def test_post_bad_metadata(self, client, proc_infra, test_user_auth):
479
480
481
482
483
484
    #     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,
485
    #         data=json.dumps(dict(operation='publish', metadata=dict(doesnotexist='hi'))),
486
487
488
    #         content_type='application/json')
    #     assert rv.status_code == 400

489
    def test_potcar(self, client, proc_infra, test_user_auth):
490
        # only the owner, shared with people are supposed to download the original potcar file
491
492
493
494
495
496
        example_file = 'tests/data/proc/examples_potcar.zip'
        rv = client.put('/uploads/?local_path=%s' % example_file, headers=test_user_auth)

        upload = self.assert_upload(rv.data)
        upload_id = upload['upload_id']
        self.assert_processing(client, test_user_auth, upload_id)
497
        self.assert_published(client, test_user_auth, upload_id, proc_infra)
498
499
500
501
502
503
504
        rv = client.get('/raw/%s/examples_potcar/POTCAR' % upload_id)
        assert rv.status_code == 401
        rv = client.get('/raw/%s/examples_potcar/POTCAR' % upload_id, headers=test_user_auth)
        assert rv.status_code == 200
        rv = client.get('/raw/%s/examples_potcar/POTCAR.stripped' % upload_id)
        assert rv.status_code == 200

505

Markus Scheidgen's avatar
Markus Scheidgen committed
506
507
508
today = datetime.datetime.utcnow().date()


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
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
563

564
    @pytest.fixture(scope='function')
565
    def test_data(self, request, mongo, raw_files, no_warn, test_user, other_test_user):
566
567
568
569
570
        # delete potential old test files
        for _ in [0, 1]:
            upload_files = UploadFiles.get('test_upload')
            if upload_files:
                upload_files.delete()
571

572
        in_staging, restricted, for_uploader = request.param
573

574
575
576
577
        if in_staging:
            authorized = for_uploader
        else:
            authorized = not restricted or for_uploader
578

579
580
581
582
583
584
        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
585

586
587
        calc_specs = 'r' if restricted else 'p'
        if in_staging:
588
            Upload.create(user=test_user, upload_id='test_upload')
589
            _, upload_files = create_staging_upload('test_upload', calc_specs=calc_specs)
590
        else:
591
            _, upload_files = create_public_upload('test_upload', calc_specs=calc_specs)
592

593
        yield 'test_upload', authorized, auth_headers
594

595
        upload_files.delete()
596
597


598
599
600
601
class TestArchive(UploadFilesBasedTests):
    @UploadFilesBasedTests.check_authorizaton
    def test_get(self, client, upload, auth_headers):
        rv = client.get('/archive/%s/0' % upload, headers=auth_headers)
602
        assert rv.status_code == 200
603
        assert json.loads(rv.data) is not None
604

605
606
607
608
609
610
    @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

611
612
613
    @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)
614
        assert rv.status_code == 200
615
        assert len(rv.data) > 0
616

617
618
619
620
621
622
    @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

623
624
625
    @UploadFilesBasedTests.ignore_authorization
    def test_get_non_existing_archive(self, client, upload, auth_headers):
        rv = client.get('/archive/%s' % 'doesnt/exist', headers=auth_headers)
626
        assert rv.status_code == 404
Markus Scheidgen's avatar
Markus Scheidgen committed
627

628
629
630
631
632
633
634
    @pytest.mark.parametrize('info', [
        'all.nomadmetainfo.json',
        'all.experimental.nomadmetainfo.json',
        'vasp.nomadmetainfo.json',
        'mpes.nomadmetainfo.json'])
    def test_get_metainfo(self, client, info):
        rv = client.get('/archive/metainfo/%s' % info)
635
        assert rv.status_code == 200
636
637
        metainfo = json.loads((rv.data))
        assert len(metainfo) > 0
638

Markus Scheidgen's avatar
Markus Scheidgen committed
639

640
class TestRepo():
641
642
643
    @pytest.fixture(scope='class')
    def example_elastic_calcs(
            self, elastic_infra, normalized: parsing.LocalBackend,
644
            test_user: User, other_test_user: User):
645
646
        clear_elastic(elastic_infra)

Markus Scheidgen's avatar
Markus Scheidgen committed
647
        calc_with_metadata = CalcWithMetadata(upload_id=0, calc_id=0, upload_time=today)
648
        calc_with_metadata.files = ['test/mainfile.txt']
649
        calc_with_metadata.apply_domain_metadata(normalized)
650

Markus Scheidgen's avatar
Markus Scheidgen committed
651
652
        calc_with_metadata.update(
            calc_id='1', uploader=test_user.to_popo(), published=True, with_embargo=False)
653
654
        search.Entry.from_calc_with_metadata(calc_with_metadata).save(refresh=True)

Markus Scheidgen's avatar
Markus Scheidgen committed
655
656
        calc_with_metadata.update(
            calc_id='2', uploader=other_test_user.to_popo(), published=True, with_embargo=False,
Markus Scheidgen's avatar
Markus Scheidgen committed
657
            upload_time=today - datetime.timedelta(days=5))
Markus Scheidgen's avatar
Markus Scheidgen committed
658
659
        calc_with_metadata.update(
            atoms=['Fe'], comment='this is a specific word', formula='AAA', basis_set='zzz')
660
661
        search.Entry.from_calc_with_metadata(calc_with_metadata).save(refresh=True)

Markus Scheidgen's avatar
Markus Scheidgen committed
662
663
        calc_with_metadata.update(
            calc_id='3', uploader=other_test_user.to_popo(), published=False, with_embargo=False)
664
665
        search.Entry.from_calc_with_metadata(calc_with_metadata).save(refresh=True)

Markus Scheidgen's avatar
Markus Scheidgen committed
666
667
        calc_with_metadata.update(
            calc_id='4', uploader=other_test_user.to_popo(), published=True, with_embargo=True)
668
669
        search.Entry.from_calc_with_metadata(calc_with_metadata).save(refresh=True)

670
    def assert_search(self, rv: Any, number_of_calcs: int) -> dict:
671
672
        if rv.status_code != 200:
            print(rv.data)
673
        assert rv.status_code == 200
674

675
676
677
678
679
680
681
682
683
        data = json.loads(rv.data)

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

        return data

684
685
    def test_own_calc(self, client, example_elastic_calcs, no_warn, test_user_auth):
        rv = client.get('/repo/0/1', headers=test_user_auth)
686
687
        assert rv.status_code == 200

688
689
690
691
692
693
694
695
    def test_public_calc(self, client, example_elastic_calcs, no_warn, other_test_user_auth):
        rv = client.get('/repo/0/1', headers=other_test_user_auth)
        assert rv.status_code == 200

    def test_embargo_calc(self, client, example_elastic_calcs, no_warn, test_user_auth):
        rv = client.get('/repo/0/4', headers=test_user_auth)
        assert rv.status_code == 401

696
697
698
699
    def test_own_embargo_calc(self, client, example_elastic_calcs, no_warn, other_test_user_auth):
        rv = client.get('/repo/0/4', headers=other_test_user_auth)
        assert rv.status_code == 200

700
701
702
703
    def test_staging_calc(self, client, example_elastic_calcs, no_warn, test_user_auth):
        rv = client.get('/repo/0/3', headers=test_user_auth)
        assert rv.status_code == 401

704
705
706
707
    def test_own_staging_calc(self, client, example_elastic_calcs, no_warn, other_test_user_auth):
        rv = client.get('/repo/0/3', headers=other_test_user_auth)
        assert rv.status_code == 200

708
709
    def test_non_existing_calcs(self, client, example_elastic_calcs, test_user_auth):
        rv = client.get('/repo/0/10', headers=test_user_auth)
710
711
        assert rv.status_code == 404

712
713
714
    @pytest.mark.parametrize('calcs, owner, auth', [
        (2, 'all', 'none'),
        (2, 'all', 'test_user'),
715
        (4, 'all', 'other_test_user'),
716
        (1, 'user', 'test_user'),
717
        (3, 'user', 'other_test_user'),
718
        (0, 'staging', 'test_user'),
719
        (1, 'staging', 'other_test_user')
720
    ])
721
    def test_search_owner(self, client, example_elastic_calcs, no_warn, test_user_auth, other_test_user_auth, calcs, owner, auth):
722
723
        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)
724
        data = self.assert_search(rv, calcs)
725
726
727
728
729
        results = data.get('results', None)
        if calcs > 0:
            for key in ['uploader', 'calc_id', 'formula', 'upload_id']:
                assert key in results[0]

Markus Scheidgen's avatar
Markus Scheidgen committed
730
    @pytest.mark.parametrize('calcs, start, end', [
Markus Scheidgen's avatar
Markus Scheidgen committed
731
732
733
734
735
736
        (2, today - datetime.timedelta(days=6), today),
        (2, today - datetime.timedelta(days=5), today),
        (1, today - datetime.timedelta(days=4), today),
        (1, today, today),
        (1, today - datetime.timedelta(days=6), today - datetime.timedelta(days=5)),
        (0, today - datetime.timedelta(days=7), today - datetime.timedelta(days=6)),
Markus Scheidgen's avatar
Markus Scheidgen committed
737
        (2, None, None),
Markus Scheidgen's avatar
Markus Scheidgen committed
738
739
        (1, today, None),
        (2, None, today)
Markus Scheidgen's avatar
Markus Scheidgen committed
740
741
742
743
744
745
746
747
748
749
750
751
752
    ])
    def test_search_time(self, client, example_elastic_calcs, no_warn, calcs, start, end):
        query_string = ''
        if start is not None:
            query_string = 'from_time=%s' % rfc3339DateTime.format(start)
        if end is not None:
            if query_string != '':
                query_string += '&'
            query_string += 'until_time=%s' % rfc3339DateTime.format(end)
        if query_string != '':
            query_string = '?%s' % query_string

        rv = client.get('/repo/%s' % query_string)
753
        self.assert_search(rv, calcs)
Markus Scheidgen's avatar
Markus Scheidgen committed
754

755
    @pytest.mark.parametrize('calcs, quantity, value', [
756
757
        (2, 'system', 'bulk'),
        (0, 'system', 'atom'),
758
759
        (1, 'atoms', 'Br'),
        (1, 'atoms', 'Fe'),
760
        (0, 'atoms', ['Fe', 'Br', 'A', 'B']),
761
762
        (0, 'only_atoms', ['Br', 'Si']),
        (1, 'only_atoms', ['Fe']),
763
764
        (1, 'only_atoms', ['Br', 'K', 'Si']),
        (1, 'only_atoms', ['Br', 'Si', 'K']),
765
766
767
768
769
770
771
772
773
        (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):
774
        query_string = urlencode({quantity: value}, doseq=True)
775

776
        rv = client.get('/repo/?%s' % query_string, headers=test_user_auth)
777
        logger.debug('run search quantities test', query_string=query_string)
778
        data = self.assert_search(rv, calcs)
779

780
781
        quantities = data.get('quantities', None)
        assert quantities is not None
782
        if quantity == 'system' and calcs != 0:
783
784
785
786
            # for simplicity we only assert on quantities for this case
            assert 'system' in quantities
            assert len(quantities['system']) == 1
            assert value in quantities['system']
787

788
789
    metrics_permutations = [[], search.metrics_names] + [[metric] for metric in search.metrics_names]

790
791
792
793
794
795
796
797
798
799
800
    def test_search_admin(self, client, example_elastic_calcs, no_warn, admin_user_auth):
        rv = client.get('/repo/?owner=admin', headers=admin_user_auth)
        self.assert_search(rv, 4)

    def test_search_admin_auth(self, client, example_elastic_calcs, no_warn, test_user_auth):
        rv = client.get('/repo/?owner=admin', headers=test_user_auth)
        assert rv.status_code == 401

        rv = client.get('/repo/?owner=admin')
        assert rv.status_code == 401

801
    @pytest.mark.parametrize('metrics', metrics_permutations)
Markus Scheidgen's avatar
Markus Scheidgen committed
802
    def test_search_total_metrics(self, client, example_elastic_calcs, no_warn, metrics):
803
804
        rv = client.get('/repo/?%s' % urlencode(dict(metrics=metrics), doseq=True))
        assert rv.status_code == 200, str(rv.data)
Markus Scheidgen's avatar
Markus Scheidgen committed
805
        data = json.loads(rv.data)
806
807
808
        total_metrics = data.get('quantities', {}).get('total', {}).get('all', None)
        assert total_metrics is not None
        assert 'code_runs' in total_metrics
Markus Scheidgen's avatar
Markus Scheidgen committed
809
        for metric in metrics:
810
            assert metric in total_metrics
Markus Scheidgen's avatar
Markus Scheidgen committed
811

812
    @pytest.mark.parametrize('metrics', metrics_permutations)
Markus Scheidgen's avatar
Markus Scheidgen committed
813
    def test_search_aggregation_metrics(self, client, example_elastic_calcs, no_warn, metrics):
814
        rv = client.get('/repo/?%s' % urlencode(dict(metrics=metrics), doseq=True))
Markus Scheidgen's avatar
Markus Scheidgen committed
815
816
        assert rv.status_code == 200
        data = json.loads(rv.data)
817
818
        for name, quantity in data.get('quantities').items():
            for metrics_result in quantity.values():
Markus Scheidgen's avatar
Markus Scheidgen committed
819
                assert 'code_runs' in metrics_result
820
821
822
823
824
                if name != 'authors':
                    for metric in metrics:
                        assert metric in metrics_result
                else:
                    assert len(metrics_result) == 1  # code_runs is the only metric for authors
Markus Scheidgen's avatar
Markus Scheidgen committed
825

826
827
828
829
830
831
832
833
    def test_search_date_histogram(self, client, example_elastic_calcs, no_warn):
        rv = client.get('/repo/?date_histogram=true&metrics=total_energies')
        assert rv.status_code == 200
        data = json.loads(rv.data)
        histogram = data.get('quantities').get('date_histogram')
        print(histogram)
        assert len(histogram) > 0

834
835
836
    @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))
837
838
839
        assert rv.status_code == 200
        data = json.loads(rv.data)
        results = data.get('results', None)
840
        assert data['pagination']['total'] == 2
841
        assert results is not None
842
        assert len(results) == n_results
843

844
845
    @pytest.mark.parametrize('first, order_by, order', [
        ('1', 'formula', -1), ('2', 'formula', 1),
846
847
        ('2', 'basis_set', -1), ('1', 'basis_set', 1),
        (None, 'authors', -1)])
848
849
850
851
852
853
854
    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
855
856
        if first is not None:
            assert results[0]['calc_id'] == first
857

858
859
860
861
862
863
864
865
866
867
    @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)
868
        assert data.get('scroll', {}).get('size', -1) > 0
869
870
        assert results is not None
        assert len(results) == n_results
871
        scroll_id = data.get('scroll', {}).get('scroll_id', None)
872
873
874
875
876
877
        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)
878
            scroll_id = data.get('scroll', {}).get('scroll_id', None)
879
880
881
882
883
            has_another_page |= len(data.get('results')) > 0

        if n_results < 2:
            assert has_another_page

884
885
886
    def test_search_user_authrequired(self, client, example_elastic_calcs, no_warn):
        rv = client.get('/repo/?owner=user')
        assert rv.status_code == 401
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
    @pytest.mark.parametrize('calcs, quantity, value', [
        (2, 'system', 'bulk'),
        (0, 'system', 'atom'),
        (1, 'atoms', 'Br'),
        (1, 'atoms', 'Fe'),
        (1, 'authors', 'Hofstadter, Leonard'),
        (2, 'files', 'test/mainfile.txt'),
        (0, 'quantities', 'dos')
    ])
    def test_quantity_search(self, client, example_elastic_calcs, no_warn, test_user_auth, calcs, quantity, value):
        rv = client.get('/repo/%s' % quantity, headers=test_user_auth)
        assert rv.status_code == 200
        data = json.loads(rv.data)

        quantities = data['quantities']
        assert quantity in quantities
        values = quantities[quantity]['values']
        assert (value in values) == (calcs > 0)
        assert values.get(value, 0) == calcs

    def test_quantity_search_after(self, client, example_elastic_calcs, no_warn, test_user_auth):
        rv = client.get('/repo/atoms?size=1')
        assert rv.status_code == 200
        data = json.loads(rv.data)

        quantity = data['quantities']['atoms']
        assert 'after' in quantity
        after = quantity['after']
        assert len(quantity['values']) == 1
        value = list(quantity['values'].keys())[0]

        while True:
            rv = client.get('/repo/atoms?size=1&after=%s' % after)
            assert rv.status_code == 200
            data = json.loads(rv.data)

            quantity = data['quantities']['atoms']

            if 'after' not in quantity:
                assert len(quantity['values']) == 0
                break

            assert len(quantity['values']) == 1
            assert value != list(quantity['values'].keys())[0]
            assert after != quantity['after']
            after = quantity['after']

935

936
class TestRaw(UploadFilesBasedTests):
Markus Scheidgen's avatar
Markus Scheidgen committed
937

938
939
940
941
942
943
944
945
946
947
948
949
950
951
    def test_raw_file_from_calc(self, client, non_empty_processed, test_user_auth):
        calc = list(non_empty_processed.calcs)[0]
        url = '/raw/calc/%s/%s/%s' % (
            non_empty_processed.upload_id, calc.calc_id, os.path.basename(calc.mainfile))
        rv = client.get(url, headers=test_user_auth)
        assert rv.status_code == 200
        assert len(rv.data) > 0

        url = '/raw/calc/%s/%s/' % (non_empty_processed.upload_id, calc.calc_id)
        rv = client.get(url, headers=test_user_auth)
        assert rv.status_code == 200
        result = json.loads(rv.data)
        assert len(result['contents']) > 0

952
953
    @UploadFilesBasedTests.check_authorizaton
    def test_raw_file(self, client, upload, auth_headers):
954
        url = '/raw/%s/%s' % (upload, example_file_mainfile)
955
        rv = client.get(url, headers=auth_headers)
956
957
958
        assert rv.status_code == 200
        assert len(rv.data) > 0

959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
    @UploadFilesBasedTests.check_authorizaton
    def test_raw_file_partial(self, client, upload, auth_headers):
        url = '/raw/%s/%s?offset=0&length=20' % (upload, example_file_mainfile)
        rv = client.get(url, headers=auth_headers)
        assert rv.status_code == 200
        start_data = rv.data
        assert len(start_data) == 20

        url = '/raw/%s/%s?offset=10&length=10' % (upload, example_file_mainfile)
        rv = client.get(url, headers=auth_headers)
        assert rv.status_code == 200
        next_data = rv.data
        assert len(rv.data) == 10
        assert start_data[10:] == next_data

974
975
976
977
978
979
980
    @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

981
982
    @UploadFilesBasedTests.ignore_authorization
    def test_raw_file_missing_file(self, client, upload, auth_headers):
983
        url = '/raw/%s/does/not/exist' % upload
984
        rv = client.get(url, headers=auth_headers)
985
        assert rv.status_code == 404
986
987
988
        data = json.loads(rv.data)
        assert 'files' not in data

989
    @pytest.mark.parametrize('compress', [True, False])
990
991
    @UploadFilesBasedTests.ignore_authorization
    def test_raw_file_wildcard(self, client, upload, auth_headers, compress):
992
        url = '/raw/%s/examples*' % upload
993
994
        if compress:
            url = '%s?compress=1' % url
995
        rv = client.get(url, headers=auth_headers)
996
997
998
999
1000
1001
1002

        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)

1003
1004
1005
1006
    @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)
1007
        assert rv.status_code == 404
1008

1009
1010
    @UploadFilesBasedTests.ignore_authorization
    def test_raw_file_missing_upload(self, client, upload, auth_headers):
1011
        url = '/raw/doesnotexist/%s' % example_file_mainfile
1012
        rv = client.get(url, headers=auth_headers)
1013
1014
        assert rv.status_code == 404

1015
    @pytest.mark.parametrize('compress', [True, False])
1016
1017
    @UploadFilesBasedTests.check_authorizaton
    def test_raw_files(self, client, upload, auth_headers, compress):
1018
        url = '/raw/%s?files=%s' % (
1019