test_parsing.py 14.1 KB
Newer Older
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
from io import StringIO
import json
17
import numpy as np
18
import pytest
19
import os
20
from shutil import copyfile
21

22
from nomad import utils, files
23
from nomad.parsing import JSONStreamWriter, parser_dict, match_parser, BrokenParser
24
from nomad.parsing import LocalBackend, BadContextURI
25

26
parser_examples = [
27
    ('parsers/random', 'test/data/parsers/random_0'),
28
    ('parsers/template', 'tests/data/parsers/template.json'),
29
30
    ('parsers/exciting', 'tests/data/parsers/exciting/Ag/INFO.OUT'),
    ('parsers/exciting', 'tests/data/parsers/exciting/GW/INFO.OUT'),
31
32
    ('parsers/exciting', 'tests/data/parsers/exciting/nitrogen/INFO.OUT_nitrogen'),
    ('parsers/exciting', 'tests/data/parsers/exciting/nitrogen/INFO.OUT_carbon'),
Markus Scheidgen's avatar
Markus Scheidgen committed
33
    ('parsers/vasp', 'tests/data/parsers/vasp/vasp.xml'),
34
    ('parsers/vasp', 'tests/data/parsers/vasp_compressed/vasp.xml.gz'),
35
    ('parsers/vaspoutcar', 'tests/data/parsers/vasp_outcar/OUTCAR'),
speckhard's avatar
speckhard committed
36
    ('parsers/fhi-aims', 'tests/data/parsers/fhi-aims/aims.out'),
37
    ('parsers/cp2k', 'tests/data/parsers/cp2k/si_bulk8.out'),
38
39
    ('parsers/crystal', 'tests/data/parsers/crystal/si.out'),
    ('parsers/cpmd', 'tests/data/parsers/cpmd/geo_output.out'),
speckhard's avatar
speckhard committed
40
    ('parsers/nwchem', 'tests/data/parsers/nwchem/single_point/output.out'),
41
    ('parsers/bigdft', 'tests/data/parsers/bigdft/n2_output.out'),
42
    ('parsers/wien2k', 'tests/data/parsers/wien2k/AlN/AlN_ZB.scf'),
43
    ('parsers/band', 'tests/data/parsers/band_adf.out'),
44
    ('parsers/gaussian', 'tests/data/parsers/gaussian/aniline.out'),
Daniel Speckhard's avatar
Daniel Speckhard committed
45
    ('parsers/abinit', 'tests/data/parsers/abinit/Fe.out'),
Daniel Speckhard's avatar
Daniel Speckhard committed
46
    ('parsers/quantumespresso', 'tests/data/parsers/quantum-espresso/benchmark.out'),
47
    ('parsers/orca', 'tests/data/parsers/orca/orca3dot2706823.out'),
Daniel Speckhard's avatar
Daniel Speckhard committed
48
    ('parsers/castep', 'tests/data/parsers/castep/BC2N-Pmm2-Raman.castep'),
49
    # ('parsers/dl-poly', 'tests/data/parsers/dl-poly/OUTPUT'),  # timeout on Matid System Classification
Daniel Speckhard's avatar
Daniel Speckhard committed
50
    ('parsers/lib-atoms', 'tests/data/parsers/lib-atoms/gp.xml'),
Daniel Speckhard's avatar
Daniel Speckhard committed
51
    ('parsers/octopus', 'tests/data/parsers/octopus/stdout.txt'),
52
    ('parsers/phonopy', 'tests/data/parsers/phonopy/phonopy-FHI-aims-displacement-01/control.in'),
Daniel Speckhard's avatar
Daniel Speckhard committed
53
54
    ('parsers/gpaw', 'tests/data/parsers/gpaw/Fe2.gpw'),
    ('parsers/gpaw2', 'tests/data/parsers/gpaw2/H2_lcao.gpw2'),
Daniel Speckhard's avatar
Daniel Speckhard committed
55
    ('parsers/atk', 'tests/data/parsers/atk/Si2.nc'),
56
57
    ('parsers/gulp', 'tests/data/parsers/gulp/example6.got'),
    ('parsers/siesta', 'tests/data/parsers/siesta/Fe/out'),
Markus Scheidgen's avatar
Markus Scheidgen committed
58
    ('parsers/elk', 'tests/data/parsers/elk/Al/INFO.OUT'),
59
60
    ('parsers/elastic', 'dependencies/parsers/elastic/test/examples/2nd/INFO_ElaStic'),  # 70Mb file 2big4git
    ('parsers/turbomole', 'tests/data/parsers/turbomole/acrolein.out'),
61
62
63
64
65
66
    ('parsers/gamess', 'tests/data/parsers/gamess/exam01.out'),
    ('parsers/dmol', 'tests/data/parsers/dmol3/h2o.outmol'),
    ('parser/fleur', 'tests/data/parsers/fleur/out'),
    ('parser/molcas', 'tests/data/parsers/molcas/test000.input.out'),
    ('parsers/qbox', 'tests/data/parsers/qbox/01_h2ogs.r'),
    ('parser/onetep', 'tests/data/parsers/onetep/single_point_2.out')
Daniel Speckhard's avatar
Daniel Speckhard committed
67
]
68

69
70
# We need to remove some cases with external mainfiles, which might not exist
# in all testing environments (e.g. in the nomad docker image)
Markus Scheidgen's avatar
Markus Scheidgen committed
71
fixed_parser_examples = []
72
73
74
for parser, mainfile in parser_examples:
    if os.path.exists(mainfile) or mainfile.startswith('tests'):
        fixed_parser_examples.append((parser, mainfile))
Markus Scheidgen's avatar
Markus Scheidgen committed
75
parser_examples = fixed_parser_examples
76

77

Markus Scheidgen's avatar
Markus Scheidgen committed
78
correct_num_output_files = 46
79

Daniel Speckhard's avatar
Daniel Speckhard committed
80

81
82
83
84
85
86
class TestLocalBackend(object):

    @pytest.fixture(scope='function')
    def backend(self, meta_info):
        return LocalBackend(meta_info, debug=True)

87
    def test_meta_info(self, meta_info, no_warn):
88
89
        assert 'section_topology' in meta_info

90
    def test_section(self, backend, no_warn):
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
        g_index = backend.openSection('section_run')
        assert g_index == 0
        backend.addValue('program_name', 't0')
        backend.closeSection('section_run', 0)

        g_index = backend.openSection('section_run')
        assert g_index == 1

        g_index = backend.openSection('section_run')
        assert g_index == 2

        backend.addValue('program_name', 't1', 1)
        backend.addValue('program_name', 't2', 2)

        backend.closeSection('section_run', 1)
        backend.closeSection('section_run', 2)

        assert backend.get_sections('section_run') == [0, 1, 2]
        for i in range(0, 3):
            assert backend.get_value('program_name', i) == 't%d' % i

112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
    def test_sub_section(self, backend, no_warn):
        backend.openSection('section_run')

        backend.openNonOverlappingSection('section_system')
        assert backend.openSection('section_symmetry') == 0
        backend.closeSection('section_symmetry', 0)
        backend.closeNonOverlappingSection('section_system')

        backend.openNonOverlappingSection('section_system')
        backend.closeNonOverlappingSection('section_system')

        backend.openNonOverlappingSection('section_system')
        assert backend.openSection('section_symmetry') == 1
        backend.closeSection('section_symmetry', 1)
        backend.closeNonOverlappingSection('section_system')

        assert backend.get_sections('section_system') == [0, 1, 2]
        assert backend.get_sections('section_symmetry') == [0, 1]
        assert backend.get_sections('section_symmetry', 0) == [0]
        assert backend.get_sections('section_symmetry', 1) == []
        assert backend.get_sections('section_symmetry', 2) == [1]

134
135
136
137
138
139
140
141
142
143
144
145
146
147
    def test_section_override(self, backend, no_warn):
        """ Test whether we can overwrite values already in the backend."""
        expected_value = ['Cl', 'Zn']
        backend.openSection('section_run')
        backend.openSection('section_system')
        backend.addArrayValues('atom_labels', np.array(['Al', 'Zn']))
        backend.addArrayValues('atom_labels', np.array(expected_value), override=True)
        backend.closeSection('section_system', 0)

        backend.closeSection('section_run', 0)
        output = StringIO()
        backend.write_json(output)
        assert backend.get_value('atom_labels').tolist() == expected_value

148
149
150
151
152
153
    def test_two_sections(self, backend, no_warn):
        g_index = backend.openSection('section_run')
        assert g_index == 0
        backend.addValue('program_name', 't0')
        backend.closeSection('section_run', 0)

154
        g_index = backend.openSection('section_entry_info')
155
156
        assert g_index == 0
        backend.addValue('parser_name', 'p0')
157
        backend.closeSection('section_entry_info', 0)
158
159

        assert backend.get_sections('section_run') == [0]
160
        assert backend.get_sections('section_entry_info') == [0]
161
162
163
164
165

        output = StringIO()
        backend.write_json(output)
        archive = json.loads(output.getvalue())
        assert 'section_run' in archive
166
        assert 'section_entry_info' in archive
167

168
    def test_subsection(self, backend: LocalBackend, no_warn):
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
        backend.openSection('section_run')
        backend.openSection('section_method')
        backend.closeSection('section_method', -1)

        backend.openSection('section_method')
        backend.closeSection('section_method', -1)

        backend.openSection('section_run')
        backend.closeSection('section_run', 0)
        backend.closeSection('section_run', 1)

        backend.openSection('section_method')
        backend.closeSection('section_method', -1)

        runs = backend.data['section_run']
        assert len(runs) == 2
        assert len(runs[0]['section_method']) == 2
        assert len(runs[1]['section_method']) == 1

188
    def test_context(self, backend: LocalBackend, no_warn):
189
190
191
192
193
        backend.openSection('section_run')
        backend.openSection('section_method')
        backend.closeSection('section_method', -1)
        backend.closeSection('section_run', -1)

194
195
        backend.openSection('section_run')
        backend.closeSection('section_run', -1)
196

197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
        backend.openContext('/section_run/0')
        backend.addValue('program_name', 't1')
        backend.closeContext('/section_run/0')

        backend.openContext('/section_run/1')
        backend.addValue('program_name', 't2')
        backend.closeContext('/section_run/1')

        backend.openContext('/section_run/0/section_method/0')
        backend.closeContext('/section_run/0/section_method/0')

        runs = backend.data['section_run']
        assert runs[0]['program_name'] == 't1'
        assert runs[1]['program_name'] == 't2'

212
    def test_multi_context(self, backend: LocalBackend, no_warn):
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
        backend.openSection('section_run')
        backend.closeSection('section_run', -1)

        backend.openContext('/section_run/0')
        backend.openSection('section_method')
        backend.closeSection('section_method', -1)
        backend.closeContext('/section_run/0')

        backend.openContext('/section_run/0')
        backend.openSection('section_method')
        backend.closeSection('section_method', -1)
        backend.closeContext('/section_run/0')

        assert len(backend.data['section_method']) == 1

228
    def test_bad_context(self, backend: LocalBackend, no_warn):
229
230
231
232
233
234
235
236
237
238
239
240
        try:
            backend.openContext('section_run/0')
            assert False
        except BadContextURI:
            pass

        try:
            backend.openContext('dsfds')
            assert False
        except BadContextURI:
            pass

241
242
243
244
245
246
247
248
249

def create_reference(data, pretty):
    if (pretty):
        return json.dumps(data, indent=2)
    else:
        return json.dumps(data, separators=(',', ':'))


@pytest.mark.parametrize("pretty", [False, True])
250
def test_stream_generator(pretty, no_warn):
251
252
253
254
255
256
257
258
259
260
261
262
263
    example_data = [
        {
            'key1': 'value',
            'key2': 1
        },
        {
            'key': {
                'key': 'value'
            }
        }
    ]

    out = StringIO()
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
    writer = JSONStreamWriter(out, pretty=pretty)
    writer.open_array()
    writer.open_object()
    writer.key('key1')
    writer.value('value')
    writer.key('key2')
    writer.value(1)
    writer.close_object()
    writer.open_object()
    writer.key('key')
    writer.open_object()
    writer.key('key')
    writer.value('value')
    writer.close_object()
    writer.close_object()
    writer.close_array()
    writer.close()
281
282
283

    assert create_reference(example_data, pretty) == out.getvalue()

284

285
def assert_parser_result(backend, error=False):
286
    status, errors = backend.status
287
    assert status == 'ParseSuccess'
288
289
290
291
    if error:
        assert len(errors) > 0
    else:
        assert errors is None or len(errors) == 0
292
293


Daniel Speckhard's avatar
Daniel Speckhard committed
294
295
296
297
298
def assert_parser_dir_unchanged(previous_wd, current_wd):
    """Assert working directory has not been changed from parser."""
    assert previous_wd == current_wd


299
300
def run_parser(parser_name, mainfile):
    parser = parser_dict[parser_name]
301
    result = parser.run(mainfile, logger=utils.get_logger(__name__))
302
    return add_calculation_info(result, parser_name=parser_name)
Markus Scheidgen's avatar
Markus Scheidgen committed
303
304


305
306
307
@pytest.fixture
def parsed_vasp_example() -> LocalBackend:
    return run_parser(
308
        'parsers/vasp', 'dependencies/parsers/vasp/test/examples/xml/perovskite.xml')
Markus Scheidgen's avatar
Markus Scheidgen committed
309
310


311
312
313
314
315
316
@pytest.fixture
def parsed_template_example() -> LocalBackend:
    return run_parser(
        'parsers/template', 'tests/data/parsers/template.json')


317
318
def parse_file(parser_name_and_mainfile) -> LocalBackend:
    parser_name, mainfile = parser_name_and_mainfile
319
320
321
    return run_parser(parser_name, mainfile)


322
323
324
@pytest.fixture(params=parser_examples, ids=lambda spec: '%s-%s' % spec)
def parsed_example(request) -> LocalBackend:
    parser_name, mainfile = request.param
Markus Scheidgen's avatar
Markus Scheidgen committed
325
326
    result = run_parser(parser_name, mainfile)
    return result
327
328


329
def add_calculation_info(backend: LocalBackend, **kwargs) -> LocalBackend:
330
    backend.openNonOverlappingSection('section_entry_info')
331
    backend.addValue('upload_id', 'test_upload_id')
332
333
    backend.addValue('calc_id', 'test_calc_id')
    backend.addValue('calc_hash', 'test_calc_hash')
334
    backend.addValue('mainfile', 'test/mainfile.txt')
335
336
    for key, value in kwargs.items():
        backend.addValue(key, value)
337
    backend.closeNonOverlappingSection('section_entry_info')
338
    return backend
339
340


341
@pytest.mark.parametrize('parser_name, mainfile', parser_examples)
342
def test_parser(parser_name, mainfile):
Daniel Speckhard's avatar
Daniel Speckhard committed
343
    previous_wd = os.getcwd()  # Get Working directory before parsing.
344
    parsed_example = run_parser(parser_name, mainfile)
345
    assert_parser_result(parsed_example)
Daniel Speckhard's avatar
Daniel Speckhard committed
346
347
    # Check that cwd has not changed.
    assert_parser_dir_unchanged(previous_wd, current_wd=os.getcwd())
Markus Scheidgen's avatar
Markus Scheidgen committed
348
349


350
351
352
353
354
355
356
357
358
def test_broken_xml_vasp():
    parser_name, mainfile = 'parsers/vasp', 'tests/data/parsers/vasp/broken.xml'
    previous_wd = os.getcwd()  # Get Working directory before parsing.
    parsed_example = run_parser(parser_name, mainfile)
    assert_parser_result(parsed_example, error=True)
    # Check that cwd has not changed.
    assert_parser_dir_unchanged(previous_wd, current_wd=os.getcwd())


359
360
361
362
363
364
365
366
@pytest.fixture(scope='function')
def with_latin_1_file(raw_files):
    copyfile('tests/data/latin-1.out', 'tests/data/parsers/latin-1.out')
    yield
    os.remove('tests/data/parsers/latin-1.out')


def test_match(raw_files, with_latin_1_file, no_warn):
367
368
369
370
    example_upload_id = 'example_upload_id'
    upload_files = files.StagingUploadFiles(example_upload_id, create=True, is_authorized=lambda: True)
    upload_files.add_rawfiles('tests/data/parsers')

371
    matched_mainfiles = {}
372
373
    for mainfile in upload_files.raw_file_manifest():
        parser = match_parser(mainfile, upload_files)
374
        if parser is not None and not isinstance(parser, BrokenParser):
375
            matched_mainfiles[mainfile] = parser
376

377
378
379
    assert len(matched_mainfiles) == correct_num_output_files, ', '.join([
        '%s: %s' % (parser.name, mainfile)
        for mainfile, parser in matched_mainfiles.items()])