test_csiactcopy.py
9.95 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
#! /usr/bin/env python
# ==========================================================================
# This scripts performs unit tests for the csiactcopy script.
#
# Copyright (C) 2016-2017 Juergen Knoedlseder
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# ==========================================================================
import os
import gammalib
import cscripts
from testing import test
# ================================ #
# Test class for csiactcopy script #
# ================================ #
class Test(test):
"""
Test class for csiactcopy script
This test class makes unit tests for the csiactcopy script by using it
from the command line and from Python.
"""
# Constructor
def __init__(self):
"""
Constructor.
"""
# Call base class constructor
test.__init__(self)
# Set data members
self._remote = self._datadir + '/iactdata/master.json'
self._runlist1 = self._datadir + '/iact_runlist_1.dat'
self._runlist2 = self._datadir + '/iact_runlist_2.dat'
# Return
return
# Set test functions
def set(self):
"""
Set all test functions
"""
# Set test name
self.name('csiactcopy')
# Append tests
self.append(self._test_cmd, 'Test csiactcopy on command line')
self.append(self._test_python, 'Test csiactcopy from Python')
# Return
return
# Test csiactcopy on command line
def _test_cmd(self):
"""
Test csiactcopy on the command line
"""
# Set script name
csiactcopy = self._script('csiactcopy')
# Setup csiactcopy command
cmd = csiactcopy+' remote_master="'+self._remote+'"'+ \
' prodname="unit-test"'+ \
' outpath="csiactcopy_cmd1"'+ \
' logfile="csiactcopy_cmd1.log" chatter=1'
# Check if execution of wrong command fails
self.test_assert(self._execute('command_that_does_not_exist') != 0,
'Self test of test script')
# Check if execution was successful
self.test_assert(self._execute(cmd) == 0,
'Check successful execution from command line')
# Check copy
self._check_copy('csiactcopy_cmd1')
# Setup csiactcopy command
cmd = csiactcopy+' remote_master="master_that_does_not_exist"'+ \
' prodname="unit-test"'+ \
' outpath="csiactcopy_cmd2"'+ \
' logfile="csiactcopy_cmd2.log"'
# Check if execution failed
self.test_assert(self._execute(cmd) != 0,
'Check invalid input file when executed from command line')
# Check csiactcopy --help
self._check_help(csiactcopy)
# Return
return
# Test csiactcopy from Python
def _test_python(self):
"""
Test csiactcopy from Python
"""
# Set-up csiactcopy
iactcopy = cscripts.csiactcopy()
iactcopy['remote_master'] = self._remote
iactcopy['prodname'] = 'unit-test'
iactcopy['outpath'] = 'csiactcopy_py1'
iactcopy['logfile'] = 'csiactcopy_py1.log'
iactcopy['chatter'] = 2
# Run csiactcopy script and save run list
iactcopy.logFileOpen() # Make sure we get a log file
iactcopy.run()
iactcopy.save()
# Check IACT data store
self._check_copy('csiactcopy_py1')
self._check_n_obs('csiactcopy_py1', 9)
# Set-up csiactcopy with clobber=True, should lead to skipping
# of files
iactcopy = cscripts.csiactcopy()
iactcopy['remote_master'] = self._remote
iactcopy['prodname'] = 'unit-test'
iactcopy['outpath'] = 'csiactcopy_py1'
iactcopy['logfile'] = 'csiactcopy_py2.log'
iactcopy['chatter'] = 3
iactcopy['clobber'] = True
# Execute csiactcopy script
iactcopy.logFileOpen() # Make sure we get a log file
iactcopy.execute()
# Check copy
self._check_copy('csiactcopy_py1')
self._check_n_obs('csiactcopy_py1', 9)
# Set-up csiactcopy with clobber=False, should also lead to skipping
# of files, but for the reason that it's not allowed to overwrite
# the file
iactcopy = cscripts.csiactcopy()
iactcopy['remote_master'] = self._remote
iactcopy['prodname'] = 'unit-test'
iactcopy['outpath'] = 'csiactcopy_py1'
iactcopy['logfile'] = 'csiactcopy_py3.log'
iactcopy['chatter'] = 4
iactcopy['clobber'] = False
# Run csiactcopy script and save run list
iactcopy.logFileOpen() # Make sure we get a log file
iactcopy.run()
iactcopy.save()
# Check copy
self._check_copy('csiactcopy_py1')
self._check_n_obs('csiactcopy_py1', 9)
# Remove the copied IACT data store before continuing
if os.path.isdir('csiactcopy_py2'):
os.system('rm -r csiactcopy_py2')
# Set-up csiactcopy using a run list with 5 runs
iactcopy = cscripts.csiactcopy()
iactcopy['runlist'] = self._runlist1
iactcopy['remote_master'] = self._remote
iactcopy['prodname'] = 'unit-test'
iactcopy['outpath'] = 'csiactcopy_py2'
iactcopy['logfile'] = 'csiactcopy_py4.log'
iactcopy['chatter'] = 4
# Run csiactcopy script and save run list
iactcopy.logFileOpen() # Make sure we get a log file
iactcopy.run()
iactcopy.save()
# Check copy
self._check_copy('csiactcopy_py2')
self._check_n_obs('csiactcopy_py2', 5)
# Set-up csiactcopy using another run list with 4 runs. Should have
# 9 runs in total in the data store afterwards
iactcopy = cscripts.csiactcopy()
iactcopy['runlist'] = self._runlist2
iactcopy['remote_master'] = self._remote
iactcopy['prodname'] = 'unit-test'
iactcopy['outpath'] = 'csiactcopy_py2'
iactcopy['logfile'] = 'csiactcopy_py5.log'
iactcopy['chatter'] = 4
# Run csiactcopy script and save run list
iactcopy.logFileOpen() # Make sure we get a log file
iactcopy.run()
iactcopy.save()
# Check copy
self._check_copy('csiactcopy_py2')
self._check_n_obs('csiactcopy_py2', 9)
# Set-up csiactcopy using the same run list with 4 runs again, should
# lead to skipping of files, and we should still have 9 runs at the
# end in the datastore.
iactcopy = cscripts.csiactcopy()
iactcopy['runlist'] = self._runlist2
iactcopy['remote_master'] = self._remote
iactcopy['prodname'] = 'unit-test'
iactcopy['outpath'] = 'csiactcopy_py2'
iactcopy['logfile'] = 'csiactcopy_py6.log'
iactcopy['chatter'] = 4
iactcopy['clobber'] = True
# Run csiactcopy script and save run list
iactcopy.logFileOpen() # Make sure we get a log file
iactcopy.run()
iactcopy.save()
# Check copy
self._check_copy('csiactcopy_py2')
self._check_n_obs('csiactcopy_py2',9)
# Return
return
# Check copy of IACT data store
def _check_copy(self, pathname):
"""
Check copy of IACT data store
Parameters
----------
pathname : str
Path to copied IACT data store
"""
# Set file names
hdu_index_name = gammalib.GFilename(pathname+'/hdu-index.fits')
obs_index_name = gammalib.GFilename(pathname+'/obs-index.fits')
master_name = gammalib.GFilename(pathname+'/master.json')
# Check for existence of files
self.test_assert(hdu_index_name.exists(),
'Check if file "hdu-index.fits" exists')
self.test_assert(obs_index_name.exists(),
'Check if file "obs-index.fits" exists')
self.test_assert(master_name.exists(),
'Check if file "master.json" exists')
# Check if index files are FITS file
self.test_assert(hdu_index_name.is_fits(),
'Check if file "hdu-index.fits" is FITS file')
self.test_assert(obs_index_name.is_fits(),
'Check if file "obs-index.fits" is FITS file')
# Return
return
# Check copy
def _check_n_obs(self, pathname, n_expected):
"""
Check number of available observations
Parameters
----------
pathname : str
Path to copied IACT data store
n_expected : int
Expected number of observations in IACT data store
"""
# Set file name
obs_index_name = gammalib.GFilename(pathname+'/obs-index.fits[OBS_INDEX]')
# Open index file
fits = gammalib.GFits(obs_index_name)
# Get number of observations
n_obs = fits[obs_index_name.extname()].nrows()
# Close FITS file
fits.close()
# Check for existence of observations
self.test_value(n_obs, n_expected, 'Check for number of observations')
# Return
return