Newer
Older
import os
os.environ["PATH"] = r"c:/Mantid/Code/builds/br_master/bin/Release;"+os.environ["PATH"]
import unittest
import shutil
import datetime
from mantid import config
from Direct.ISISDirecInelasticConfig import UserProperties,MantidConfigDirectInelastic
class ISISDirectInelasticConfigTest(unittest.TestCase):
def __init__(self, methodName):
# This has been copied from ISIS admin script processing user's office data
# and all this has the format below
# if format changes, the class have to change too as the class
# verifies the data are exactly as defined here
self.instrument= "MERLIN"
self.cycle = "CYCLE20151"
nrbnumber = "1310168"
self.rbnumber = "RB" + nrbnumber
self.start_date= '20150503'
return super(ISISDirectInelasticConfigTest, self).__init__(methodName)
def __del__(self):
self._tear_down()
def get_save_dir(self):
targetDir = config['defaultsave.directory']
if targetDir is None or len(targetDir) == 0:
if platform.system() == 'Windows':
targetDir = str(os.environ['TEMP'])
else:
targetDir = '/tmp'
return targetDir
def write_test_file(self,filename):
"""Method writes test file with name provided and
specified contents
"""
dir_name = os.path.dirname(filename)
if not os.path.exists(dir_name):
os.makedirs(dir_name)
fh = open(filename,'w')
fh.write("****************************************\n")
fh.write("first test variable = AAAA # something\n")
fh.write("second test var Test_reduction_file # other\n ")
fh.close()
# Create user's folder structure in default save directory.
# the administrative script (not here) builds all this for real in /home
targetDir = self.get_save_dir()
self.rbdir = os.path.join(targetDir,self.userID,self.rbnumber)
self.UserScriptRepoDir = os.path.join(targetDir,'UserScripts')
self.MapMaskDir = os.path.join(targetDir,'MapMaskDir')
self.userRootDir = os.path.join(targetDir,self.userID)
if not os.path.exists(self.rbdir):
os.makedirs(self.rbdir)
if not os.path.exists(self.UserScriptRepoDir):
os.makedirs(self.UserScriptRepoDir)
if not os.path.exists(self.MapMaskDir):
os.makedirs(self.MapMaskDir)
if not os.path.exists(self.userRootDir):
os.makedirs(self.userRootDir)
def makeFakeSourceReductionFile(self,mcf,contents=None):
file_path = os.path.join(self.UserScriptRepoDir,'direct_inelastic',instr_name.upper())
if not os.path.exists(file_path):
os.makedirs(file_path)
file_name = mcf._sample_reduction_file(instr_name)
full_file = os.path.join(file_path,file_name)
if os.path.isfile(full_file):
os.remove(full_file)
fh=open(full_file,'w')
fh.write('#Test reduction file\n')
fh.write('Contents={0}'.format(contents))
fh.close()
return full_file
# Clean-up user's folder structure
if os.path.exists(self.rbdir):
shutil.rmtree(self.rbdir,ignore_errors=True)
if os.path.exists(self.UserScriptRepoDir):
shutil.rmtree(self.UserScriptRepoDir,ignore_errors=True)
shutil.rmtree(self.MapMaskDir,ignore_errors=True)
if os.path.exists(self.userRootDir):
shutil.rmtree(self.userRootDir,ignore_errors=True)
def test_UserProperties(self):
user.set_user_properties(self.instrument,self.start_date,self.cycle,self.rbdir)
id = user._recent_dateID
self.assertEqual(user._instrument[id],'MERLIN')
self.assertEqual(user._cycle_IDs[id],('2015','1'))
self.assertEqual(user._start_dates[id],datetime.date(2015,05,03))
self.assertEqual(user._rb_dirs[id],self.rbdir)
self.assertEqual(user.userID,self.userID)
self.assertEqual(user.instrument,'MERLIN')
self.assertEqual(user.cycleID,'2015_1')
self.assertEqual(user.start_date,datetime.date(2015,05,03))
self.assertEqual(user.rb_dir,self.rbdir)
self.assertRaises(RuntimeError,user.set_user_properties,'SANS2D',self.start_date,self.cycle,self.rbdir)
self.assertRaises(RuntimeError,user.set_user_properties,'HET','201400000',self.cycle,self.rbdir)
self.assertRaises(RuntimeError,user.set_user_properties,'HET',self.start_date,'20144',self.rbdir)
self.assertRaises(RuntimeError,user.set_user_properties,'HET',self.start_date,'CYC20144',self.rbdir)
self.assertRaises(RuntimeError,user.set_user_properties,'HET',self.start_date,'CYCLE201444',self.rbdir)
self.assertRaises(RuntimeError,user.set_user_properties,'HET',self.start_date,self.cycle,'missing/folder')
rbdir = os.path.join(self.userRootDir,'RB1000666')
if not os.path.exists(rbdir):
os.makedirs(rbdir)
user.set_user_properties('MARI','20000112','CYCLE20001',rbdir)
if os.path.exists(rbdir):
shutil.rmtree(rbdir)
self.assertEqual(len(user.instrument),6)
self.assertEqual(len(user._instrument),2)
self.assertEqual(user._start_dates['2000-01-12'],datetime.date(2000,01,12))
targetDir = self.get_save_dir()
rbdir = os.path.join(self.userRootDir,'RB1999666')
if not os.path.exists(rbdir):
os.makedirs(rbdir)
user.set_user_properties('MERLIN','20161201','CYCLE20163',rbdir)
if os.path.exists(rbdir):
shutil.rmtree(rbdir)
self.assertEqual(len(user._instrument),3)
id = user._recent_dateID
self.assertEqual(id,'2016-12-01')
self.assertEqual(user._instrument[id],'MERLIN')
self.assertEqual(user.instrument,'MERLIN')
# script verifies the presence of a folder, not its contents.
# for the script to work, let's run it on default save directory
MantidDir = os.path.split(os.path.realpath(__file__))[0]
HomeRootDir = self.get_save_dir()
mcf = MantidConfigDirectInelastic(MantidDir,HomeRootDir,self.UserScriptRepoDir,self.MapMaskDir)
self.assertRaises(RuntimeError,MantidConfigDirectInelastic,'MissingMantidFolder',HomeRootDir,self.UserScriptRepoDir,self.MapMaskDir)
self.assertRaises(RuntimeError,MantidConfigDirectInelastic,MantidDir,'MissingUserRootFolder',self.UserScriptRepoDir,self.MapMaskDir)
self.assertRaises(RuntimeError,MantidConfigDirectInelastic,MantidDir,HomeRootDir,'MissingUserScriptRepoDir',self.MapMaskDir)
self.assertRaises(RuntimeError,MantidConfigDirectInelastic,MantidDir,HomeRootDir,self.UserScriptRepoDir,'MissingMapMaskDir')
user = UserProperties()
user.set_user_properties(self.instrument,self.start_date,self.cycle,self.rbdir)
# clear up the previous
if os.path.exists(os.path.join(self.userRootDir,'.mantid')):
shutil.rmtree(os.path.join(self.userRootDir,'.mantid'))
mcf.init_user(self.userID,user)
self.makeFakeSourceReductionFile(mcf)
self.assertEqual(len(mcf._dynamic_configuration),6)
config_file = os.path.join(self.userRootDir,'.mantid','Mantid.user.properties')
self.assertTrue(os.path.exists(os.path.join(self.userRootDir,'.mantid')))
self.assertTrue(os.path.exists(config_file))
cur_cycleID = mcf._user.cycleID
instr = mcf._user.instrument
targ_file = mcf._target_reduction_file(instr,cur_cycleID)
reduction_file = os.path.join(mcf._user.rb_dir,targ_file)
self.assertTrue(os.path.isfile(reduction_file))
self.assertFalse(mcf.config_need_replacing(config_file))
date_in_apast=datetime.date(start_date.year,start_date.month,start_date.day-1)
time_in_a_past = time.mktime(date_in_apast.timetuple())
os.utime(config_file,(time_in_a_past,time_in_a_past))
self.assertTrue(mcf.config_need_replacing(config_file))
# clear up
if os.path.exists(os.path.join(self.userRootDir,'.mantid')):
shutil.rmtree(os.path.join(self.userRootDir,'.mantid'))
def test_build_3Experiments_config(self):
# script verifies the presence of a folder, not its contents.
# for the script to work, let's run it on default save directory
MantidDir = os.path.split(os.path.realpath(__file__))[0]
HomeRootDir = self.get_save_dir()
mcf = MantidConfigDirectInelastic(MantidDir,HomeRootDir,self.UserScriptRepoDir,self.MapMaskDir)
user = UserProperties()
user.set_user_properties(self.instrument,self.start_date,self.cycle,self.rbdir)
rbdir2 = os.path.join(targetDir,self.userID,rbnum2)
if not os.path.exists(rbdir2):
os.makedirs(rbdir2)
user.set_user_properties('MARI','20000124','CYCLE20001',rbdir2)
rbnum3='RB1204000'
rbdir3 = os.path.join(targetDir,self.userID,rbnum3)
if not os.path.exists(rbdir3):
os.makedirs(rbdir3)
user.set_user_properties('MAPS','20041207','CYCLE20044',rbdir3)
# clear up the previous
if os.path.exists(os.path.join(self.userRootDir,'.mantid')):
shutil.rmtree(os.path.join(self.userRootDir,'.mantid'))
mcf.init_user(self.userID,user)
fake_source=self.makeFakeSourceReductionFile(mcf)
self.assertEqual(len(mcf._dynamic_configuration),6)
self.assertEqual(mcf._dynamic_configuration[1],'default.instrument=MERLIN')
mcf.generate_config()
config_file = os.path.join(self.userRootDir,'.mantid','Mantid.user.properties')
self.assertTrue(os.path.exists(os.path.join(self.userRootDir,'.mantid')))
self.assertTrue(os.path.exists(config_file))
self.assertFalse(mcf.config_need_replacing(config_file))
date_in_apast=datetime.date(start_date.year,start_date.month,start_date.day-1)
time_in_a_past = time.mktime(date_in_apast.timetuple())
os.utime(config_file,(time_in_a_past,time_in_a_past))
self.assertTrue(mcf.config_need_replacing(config_file))
#--------------------------------------------------------------------
user1ID = 'tuf299966'
user1RootDir = os.path.join(self.get_save_dir(),user1ID)
if not os.path.exists(user1RootDir):
os.makedirs(user1RootDir)
#
user1 = UserProperties()
user1.set_user_properties('MARI','20990124','CYCLE20991',rbdir2)
mcf.init_user(user1ID,user1)
source_file = self.makeFakeSourceReductionFile(mcf)
mcf.generate_config()
self.assertEqual(len(mcf._dynamic_configuration),6)
self.assertEqual(mcf._dynamic_configuration[1],'default.instrument=MARI')
config_file = os.path.join(self.userRootDir,'.mantid','Mantid.user.properties')
self.assertTrue(os.path.exists(os.path.join(user1RootDir,'.mantid')))
self.assertTrue(os.path.exists(config_file))
#
# Check sample reduction file
#
full_rb_path = rbdir2
cycle_id = user1.cycleID
instr = user1.instrument
target_file = mcf._target_reduction_file(instr,cycle_id)
full_target_file = os.path.join(full_rb_path,target_file)
self.assertTrue(os.path.exists(full_target_file))
# Fresh target file should always be replaced
self.assertTrue(mcf.script_need_replacing(source_file,full_target_file))
# modify target file access time:
access_time = os.path.getmtime(full_target_file)
now = time.time()
os.utime(full_target_file,(access_time ,now))
# should not replace modified target file
self.assertFalse(mcf.script_need_replacing(source_file,full_target_file))
#--------------------------------------------------------------------
# clean up
if os.path.exists(os.path.join(self.userRootDir,'.mantid')):
shutil.rmtree(os.path.join(self.userRootDir,'.mantid'),ignore_errors=True)
shutil.rmtree(rbdir2,ignore_errors=True)
shutil.rmtree(rbdir3,ignore_errors=True)
if os.path.exists(user1RootDir):
shutil.rmtree(user1RootDir,ignore_errors=True)
def test_replace_user_variables(self):
user = UserProperties("wkc26243")
user.set_user_properties(self.instrument,self.start_date,self.cycle,self.rbdir)
targ_string = user.replace_variables('$instrument$ReductionScript$cycleID$.py')
self.assertEqual(self.instrument+'ReductionScript2015_1.py',targ_string)
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
def test_parse_file_description(self):
this_file = os.path.realpath(__file__)
file_dir = os.path.dirname(this_file)
test_xml = os.path.join(file_dir,'User_files_description_test.xml')
self.assertTrue(os.path.exists(test_xml))
MantidDir = os.path.split(os.path.realpath(__file__))[0]
HomeRootDir = self.get_save_dir()
mcf = MantidConfigDirectInelastic(MantidDir,HomeRootDir,self.UserScriptRepoDir,self.MapMaskDir)
user = UserProperties(self.userID)
user.set_user_properties(self.instrument,self.start_date,self.cycle,self.rbdir)
mcf.init_user(self.userID,user)
# test old defaults, deployed if no User_files_description are defined
files_to_copy = mcf._parse_user_files_description(None)
self.assertEqual(len(files_to_copy),1)
source = files_to_copy[0][0]
dest = files_to_copy[0][1]
repl = files_to_copy[0][2]
self.assertEqual(os.path.basename(source),'MERLINReduction_Sample.py')
self.assertEqual(os.path.basename(dest) ,'MERLINReduction_2015_1.py')
self.assertTrue(repl is None)
# test files defined by test xml file
files_to_copy = mcf._parse_user_files_description(test_xml)
self.assertEqual(len(files_to_copy),2)
# define and generate test files to copy.
# We know what files are and what their contents is from User_files_description_test.xml
for file_descr in files_to_copy:
source = file_descr[0]
dest = file_descr[1]
if os.path.exists(dest):
os.remove(dest)
self.write_test_file(source)
# Check copy_reduction_sample
mcf.copy_reduction_sample(test_xml)
for file_pair in files_to_copy:
dest = file_pair[1]
self.assertTrue(os.path.exists(dest))
# Clean up
for file_pair in files_to_copy:
source = file_pair[0]
dest = file_pair[1]
if os.path.exists(dest):
os.remove(dest)
if os.path.exists(source):
os.remove(source)
if __name__=="__main__":
unittest.main()