Newer
Older
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Tests for `lemi_metadata` module."""
import logging
import unittest
from obspy import UTCDateTime
from pathlib import Path
from lemi2seed.lemi_data import LemiData, VALID_COMPONENTS
from lemi2seed.lemi_metadata import (BaseSurvey, Survey, BaseStation, Station_,
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
OUTPUT_MSEED = Path(__file__).parent.joinpath('MSEED')
TEST_DIR = Path(__file__).parent.joinpath('test_data')
SCR_DIR = "lemi2seed.lemi_metadata"
logging.config.fileConfig(log_file_path)
logger = logging.getLogger(SCR_DIR)
class TestBaseSurvey(unittest.TestCase):
"""Test suite for BaseSurvey data class."""
def setUp(self):
"""Set up test fixtures."""
lemi_data = LemiData(TEST_DIR.joinpath('DATA0110'), OUTPUT_MSEED)
lemi_data.prep_data()
self.data_stats = lemi_data.stats
def test_validate_time_period_start_not_utc(self):
"""Test basic functionality of validate_time_period_start."""
data_input = self.data_stats['time_period_start']
metadata_input = 2021.167
bs = BaseSurvey()
self.assertFalse(bs.validate_time_period_start(metadata_input, data_input))
def test_validate_time_period_start_greater_than_acquisition_start(self):
"""Test basic functionality of validate_time_period_start."""
data_input = self.data_stats['time_period_start']
metadata_input = UTCDateTime('2020-10-01T00:00:00.000000Z')
bs = BaseSurvey()
self.assertFalse(bs.validate_time_period_start(metadata_input, data_input))
def test_validate_time_period_start_valid(self):
"""Test basic functionality of validate_time_period_start."""
data_input = self.data_stats['time_period_start']
metadata_input = UTCDateTime('2020-09-30T00:00:00.000000Z')
bs = BaseSurvey()
self.assertTrue(bs.validate_time_period_start(metadata_input, data_input))
def test_validate_time_period_end_not_utc(self):
"""Test basic functionality of validate_time_period_end."""
data_input = self.data_stats['time_period_end']
metadata_input = 2021.167
bs = BaseSurvey()
self.assertFalse(bs.validate_time_period_end(metadata_input, data_input))
def test_validate_time_period_end_lower_than_acquisition_end(self):
"""Test basic functionality of validate_time_period_end."""
data_input = self.data_stats['time_period_end']
metadata_input = UTCDateTime('2020-09-30T00:00:00.000000Z')
bs = BaseSurvey()
self.assertFalse(bs.validate_time_period_end(metadata_input, data_input))
def test_validate_time_period_end_valid(self):
"""Test basic functionality of validate_time_period_end."""
data_input = self.data_stats['time_period_end']
metadata_input = UTCDateTime('2020-10-02T00:00:00.000000Z')
bs = BaseSurvey()
self.assertTrue(bs.validate_time_period_end(metadata_input, data_input))
class TestSurvey(unittest.TestCase):
"""Test suite for Survey data class."""
def test_validate_archive_network_undefined(self):
"""Test basic functionality of validate_archive_network."""
with self.assertLogs(logger, level='ERROR') as cmd:
Survey.validate_archive_network(None)
msg = "The network code should be a string."
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_archive_network_erroneous_type(self):
"""Test basic functionality of validate_archive_network."""
with self.assertLogs(logger, level='ERROR') as cmd:
Survey.validate_archive_network(12)
msg = "The network code should be a string."
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_archive_network_invalid(self):
"""Test basic functionality of validate_archive_network."""
with self.assertLogs(logger, level='ERROR') as cmd:
Survey.validate_archive_network('EMX')
msg = "The network code should be two alphanumeric character long."
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_archive_network_valid(self):
"""Test basic functionality of validate_archive_network."""
self.assertTrue(Survey.validate_archive_network('EM'))
def test_validate_citation_dataset_doi_undefined(self):
"""Test basic functionality of validate_citation_dataset_doi."""
with self.assertLogs(logger, level='ERROR') as cmd:
Survey.validate_citation_dataset_doi(None)
msg = "The DOI number(s) should be a string."
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_citation_dataset_doi_erroneous_type(self):
"""Test basic functionality of validate_citation_dataset_doi."""
with self.assertLogs(logger, level='ERROR') as cmd:
Survey.validate_citation_dataset_doi(10.7914)
msg = "The DOI number(s) should be a string."
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_citation_dataset_doi_invalid_doi(self):
"""Test basic functionality of validate_citation_dataset_doi."""
with self.assertLogs(logger, level='ERROR') as cmd:
Survey.validate_citation_dataset_doi('10.7914/SN/EM')
msg = ("Invalid DOI(s). The DOI number(s) provided by the archive "
"should be strings formatted as follows: 'scheme: path'.")
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_citation_dataset_doi_invalid_dois(self):
"""Test basic functionality of validate_citation_dataset_doi."""
dois = '10.7914/SN/EM, DOI:10.3421/SN/EG'
with self.assertLogs(logger, level='ERROR') as cmd:
Survey.validate_citation_dataset_doi(dois)
msg = ("Invalid DOI(s). The DOI number(s) provided by the archive "
"should be strings formatted as follows: 'scheme: path'.")
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_citation_dataset_doi_valid_doi(self):
"""Test basic functionality of validate_citation_dataset_doi."""
doi = 'DOI:10.7914/SN/EM'
self.assertTrue(Survey.validate_citation_dataset_doi(doi))
def test_validate_citation_dataset_doi_valid_dois(self):
"""Test basic functionality of validate_citation_dataset_doi."""
dois = 'DOI:10.7914/SN/EM, DOI:10.3421/SN/EG'
self.assertTrue(Survey.validate_citation_dataset_doi(dois))
def test_validate_project_lead_email_undefined(self):
"""Test basic functionality of validate_project_lead_email."""
self.assertTrue(Survey.validate_project_lead_email(None))
def test_validate_project_lead_email_erroneous_type(self):
"""Test basic functionality of validate_project_lead_email."""
with self.assertLogs(logger, level='ERROR') as cmd:
Survey.validate_project_lead_email(12)
msg = "The project lead email(s) should be a string."
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_project_lead_email_invalid_email(self):
"""Test basic functionality of validate_project_lead_email."""
email = 'mpasscal.edu'
self.assertFalse(Survey.validate_project_lead_email(email))
def test_validate_project_lead_email_invalid_emails(self):
"""Test basic functionality of validate_project_lead_email."""
emails = 'mpasscal.edu, d@passcal.edu'
self.assertFalse(Survey.validate_project_lead_email(emails))
def test_validate_project_lead_email_valid_email(self):
"""Test basic functionality of validate_citation_dataset_doi."""
email = 'm@passcal.edu'
self.assertTrue(Survey.validate_project_lead_email(email))
def test_validate_project_lead_email_valid_emails(self):
"""Test basic functionality of validate_citation_dataset_doi."""
emails = 'm@passcal.edu, d@passcal.edu'
self.assertTrue(Survey.validate_project_lead_email(emails))
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
class TestBaseStation(unittest.TestCase):
"""Test suite for BaseStation data class."""
def setUp(self):
"""Set up test fixtures"""
data_input = 2201.77
min_elev, max_elev = [abs(data_input) * x for x in [0.99, 1.01]]
param = ("Station elevation", -500, 8500, min_elev, max_elev, 'm', '')
self.param = param
def test_validate_geographics_undefined(self):
"""Test basic functionality of validate_geographics."""
with self.assertLogs(logger, level='ERROR') as cmd:
BaseStation.validate_geographics(self.param, None)
msg = "Station elevation should be a float. "
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_geographics_erroneous_type(self):
"""Test basic functionality of validate_geographics."""
with self.assertLogs(logger, level='ERROR') as cmd:
BaseStation.validate_geographics(self.param, 'a')
msg = "Station elevation should be a float. "
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_geographics_not_in_range(self):
"""Test basic functionality of validate_geographics."""
geo, min_range, max_range, min_val, max_val, units, msg = self.param
with self.assertLogs(logger, level='ERROR') as cmd:
BaseStation.validate_geographics(self.param, 9000)
msg = ("Unexpected {0}! The {0} should be between {1}{3} and {2}{3}."
.format(geo, min_range, max_range, units))
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_geographics_do_not_match_logger_recorded_metadata(self):
"""Test basic functionality of validate_geographics."""
geo = 'Station elevation'
with self.assertLogs(logger, level='ERROR') as cmd:
BaseStation.validate_geographics(self.param, 2250)
msg = ("Unexpected {0}! Provided {0} should roughly match the {0} "
"recorded by the on-site GPS.".format(geo))
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
class TestStation_(unittest.TestCase):
"""Test suite for Station_ data class."""
def test_validate_archive_id_undefined(self):
"""Test basic functionality of validate_archive_id."""
with self.assertLogs(logger, level='ERROR') as cmd:
Station_.validate_archive_id(None)
msg = "The station name should be a string."
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_archive_id_erroneous_type(self):
"""Test basic functionality of validate_archive_id."""
with self.assertLogs(logger, level='ERROR') as cmd:
Station_.validate_archive_id(12)
msg = "The station name should be a string."
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_archive_id_invalid(self):
"""Test basic functionality of validate_archive_id."""
with self.assertLogs(logger, level='ERROR') as cmd:
Station_.validate_archive_id('KELLYA')
msg = ("The station name should be between three and five "
"alphanumeric character long.")
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_archive_id_valid(self):
"""Test basic functionality of validate_archive_id."""
self.assertTrue(Station_.validate_archive_id('KELLY'))
def test_validate_submitter_email_undefined(self):
"""Test basic functionality of validate_submitter_email."""
self.assertTrue(Station_.validate_submitter_email(None))
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
class TestRun(unittest.TestCase):
"""Test suite for Run data class."""
def setUp(self):
"""Set up test fixtures"""
self.run = Run(resource_id='mt.run.id:a')
lemi_data = LemiData(TEST_DIR.joinpath('DATA0110'), OUTPUT_MSEED)
lemi_data.prep_data()
self.data_stats = lemi_data.stats
def test_validate_components_recorded_undefined(self):
"""Test basic functionality of validate_components_recorded."""
with self.assertLogs(logger, level='ERROR') as cmd:
self.run.validate_components_recorded(None)
msg = ("The list of components recorded for run '{}' should be a "
"string.".format(self.run.run_id))
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_components_recorded_erroneous_type(self):
"""Test basic functionality of validate_components_recorded."""
with self.assertLogs(logger, level='ERROR') as cmd:
self.run.validate_components_recorded(12)
msg = ("The list of components recorded for run '{}' should be a "
"string.".format(self.run.run_id))
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_components_recorded_invalid(self):
"""Test basic functionality of validate_components_recorded."""
components = 'E1, E2, Hx, Hy, Hn'
with self.assertLogs(logger, level='ERROR') as cmd:
self.run.validate_components_recorded(components)
msg = ("Some of the listed components for run '{}' are not valid. "
"List of valid components: {}."
.format(self.run.run_id, VALID_COMPONENTS))
self.assertEqual(cmd.output, [":".join(['ERROR', SCR_DIR, msg])])
def test_validate_components_recorded_valid(self):
"""Test basic functionality of validate_components_recorded."""
components = 'E1, E2, Hx, Hy, Hz'
self.assertTrue(self.run.validate_components_recorded(components))
def test_validate_time_period_start_lower_than_acquisition_start(self):
"""Test basic functionality of validate_time_period_start."""
data_input = self.data_stats['time_period_start']
metadata_input = UTCDateTime('2020-09-30T00:00:00.000000Z')
self.assertFalse(self.run.validate_time_period_start(metadata_input, data_input))
def test_validate_time_period_start_valid(self):
"""Test basic functionality of validate_time_period_start."""
data_input = self.data_stats['time_period_start']
metadata_input = UTCDateTime('2020-10-01T00:00:00.000000Z')
self.assertTrue(self.run.validate_time_period_start(metadata_input, data_input))
def test_validate_time_period_end_greater_than_acquisition_end(self):
"""Test basic functionality of validate_time_period_end."""
data_input = self.data_stats['time_period_end']
metadata_input = UTCDateTime('2020-10-02T00:00:00.000000Z')
self.assertFalse(self.run.validate_time_period_end(metadata_input, data_input))
def test_validate_time_period_end_valid(self):
"""Test basic functionality of validate_time_period_end."""
data_input = self.data_stats['time_period_end']
metadata_input = UTCDateTime('2020-09-30T00:00:00.000000Z')
self.assertTrue(self.run.validate_time_period_end(metadata_input, data_input))