This repository has been archived by the owner on Jan 30, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 20
/
Copy pathSiteInformation.py
2361 lines (1944 loc) · 103 KB
/
SiteInformation.py
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
296
297
298
299
300
301
302
303
304
305
306
307
308
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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
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
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
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
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Class definition:
# SiteInformation
# This class is responsible for downloading, verifying and manipulating queuedata
# Note: not compatible with Singleton Design Pattern due to the subclassing
import os
import re
import commands
import random
import time
import urlparse
import urllib2
from datetime import datetime, timedelta
from pUtil import tolog, replace, getDirectAccessDic
from pUtil import getExperiment as getExperimentObject
from FileHandling import getExtension, readJSON, writeJSON, getJSONDictionary, getDirectAccess
from PilotErrors import PilotErrors
try:
import json
except ImportError:
import simplejson as json
class SiteInformation(object):
"""
Should this class ask the Experiment class which the current experiment is?
Not efficient if every readpar() calls some Experiment method unless Experiment is a singleton class as well
"""
# private data members
__experiment = "generic"
__instance = None # Boolean used by subclasses to become a Singleton
__error = PilotErrors() # PilotErrors object
__securityKeys = {} # S3 secret keys (for object store)
__queuename = "" # Name of the queue
__benchmarks = None # The benchmarks dictionary
ddmconf = {} # DDMEndpoints data dict with protocols definition
ddmblacklistingconf = {} # DDMBlacklisting Endpoints, dict
def __init__(self):
""" Default initialization """
# e.g. self.__errorLabel = errorLabel
pass
def getQueueName(self):
""" Getter for __queuename """
return self.__queuename
def setQueueName(self, queuename):
""" Setter for __queuename """
self.__queuename = queuename
def readpar(self, par, alt=False, version=0, queuename=None):
""" Read parameter variable from queuedata """
value = ""
# tolog("par: %s, alt: %s, version:%s, queuename: %s" % (par, alt, version, queuename))
# Should we should use the new queuedata JSON version?
if version == 1:
return self.getField(par, queuename=queuename)
# Use olf queuedata version
fileName = self.getQueuedataFileName(alt=alt)
try:
fh = open(fileName)
except:
try:
# Try without the path
fh = open(os.path.basename(fileName))
except Exception, e:
tolog("!!WARNING!!2999!! Could not read queuedata file: %s" % str(e))
fh = None
if fh:
#
queuedata = fh.read()
fh.close()
if queuedata != "":
value = self.getpar(par, queuedata, containsJson=fileName.endswith("json"))
# repair JSON issue
if value == None:
value = ""
return value
def getpar(self, par, s, containsJson=False):
""" Extract par from s """
parameter_value = ""
if containsJson:
# queuedata is a json string
from json import loads
pars = loads(s)
if pars.has_key(par):
parameter_value = pars[par]
if type(parameter_value) == unicode: # avoid problem with unicode for strings
parameter_value = parameter_value.encode('ascii')
else:
tolog("WARNING: Could not find parameter %s in queuedata" % (par))
parameter_value = ""
else:
# queuedata is a string on the form par1=value1|par2=value2|...
matches = re.findall("(^|\|)([^\|=]+)=",s)
for tmp,tmpPar in matches:
if tmpPar == par:
patt = "%s=(.*)" % par
idx = matches.index((tmp,tmpPar))
if idx+1 == len(matches):
patt += '$'
else:
patt += "\|%s=" % matches[idx+1][1]
mat = re.search(patt,s)
if mat:
parameter_value = mat.group(1)
else:
parameter_value = ""
return parameter_value
def getQueuedataFileName(self, useExtension=None, check=True, alt=False, version=0, queuename=None, os_bucket_id=-1):
""" Define the queuedata filename """
# alt: alternative extension
# version: 0 (default, old queuedata version), 1 (new AGIS JSON format)
# use a forced extension if necessary
if useExtension:
extension = useExtension
else:
extension = getExtension(alternative='dat')
# prepend alt. for alternative stage-out site queuedata
if alt:
extension = "alt." + extension
if version == 1:
if queuename and False: # skip this for now (in case of alt stage-out to OS, e.g. JobLog won't know which is the queuename)
filename = "queuedata-%s.%s" % (queuename, extension)
else:
if os_bucket_id != -1:
filename = "new_queuedata_%d.%s" % (os_bucket_id, extension)
else:
filename = "new_queuedata.%s" % (extension)
else:
filename = "queuedata.%s" % (extension)
path = os.path.join(os.environ['PilotHomeDir'], filename)
# remove the json extension if the file cannot be found (complication due to wrapper)
if not os.path.exists(path) and check:
if extension == 'json':
_path = path.replace('.json', '.dat')
if os.path.exists(_path):
tolog("Updating queuedata file name to: %s" % (_path))
path = _path
else:
tolog("!!WARNING!! Queuedata paths do not exist: %s, %s" % (path, _path))
if extension == 'dat':
_path = path.replace('.dat', '.json')
if os.path.exists(_path):
tolog("Updating queuedata file name to: %s" % (_path))
path = _path
else:
tolog("!!WARNING!! Queuedata paths do not exist: %s, %s" % (path, _path))
return path
def replaceQueuedataField(self, field, value, verbose=True):
""" replace a given queuedata field with a new value """
# copytool = <whatever> -> lcgcp
# replaceQueuedataField("copytool", "lcgcp")
status = False
verbose = True
queuedata_filename = self.getQueuedataFileName()
if "json" in queuedata_filename.lower():
if self.replaceJSON(queuedata_filename, field, value):
if verbose:
tolog("Successfully changed %s to: %s" % (field, value))
status = True
else:
stext = field + "=" + self.readpar(field)
rtext = field + "=" + value
if replace(queuedata_filename, stext, rtext):
if verbose:
tolog("Successfully changed %s to: %s" % (field, value))
status = True
else:
tolog("!!WARNING!!1999!! Failed to change %s to: %s" % (field, value))
return status
def replaceJSON(self, queuedata_filename, field, value):
""" Replace/update queuedata field in JSON file """
status = False
from json import load, dump
try:
fp = open(queuedata_filename, "r")
except Exception, e:
tolog("!!WARNING!!4003!! Failed to open file: %s, %s" % (queuedata_filename, e))
else:
try:
dic = load(fp)
except Exception, e:
tolog("!!WARNING!!4004!! Failed to load dictionary: %s" % (e))
else:
fp.close()
if dic.has_key(field):
dic[field] = value
try:
fp = open(queuedata_filename, "w")
except Exception, e:
tolog("!!WARNING!!4005!! Failed to open file: %s, %s" % (queuedata_filename, e))
else:
try:
dump(dic, fp)
except Exception, e:
tolog("!!WARNING!!4005!! Failed to dump dictionary: %s" % (e))
else:
fp.close()
status = True
else:
tolog("!!WARNING!!4005!! No such field in queuedata dictionary: %s" % (field))
return status
def evaluateQueuedata(self):
""" Evaluate environmental variables if used and replace the value in the queuedata """
tolog("Evaluating queuedata")
# the following fields are allowed to contain environmental variables
fields = ["appdir", "copysetup", "copysetupin", "recoverdir", "wntmpdir", "sepath", "seprodpath", "lfcpath", "lfcprodpath"]
# process each field and evaluate the environment variables if present
for field in fields:
# grab the field value and split it since some fields can contain ^-separators
old_values = self.readpar(field)
new_values = []
try:
for value in old_values.split("^"):
pipe = ""
if value.startswith("$"):
# get rid of any |-signs (e.g. appdir containing nightlies bit)
if "|" in value:
pipe = value[value.find('|'):] # add this back later (e.g. pipe = "|nightlies")
value = value[:value.find('|')]
# evaluate the environmental variable
new_value = os.path.expandvars(value)
if new_value == "":
tolog("!!WARNING!!2999!! Environmental variable not set: %s" % (value))
value = new_value + pipe
new_values.append(value)
# rebuild the string (^-separated if necessary)
new_values_joined = '^'.join(new_values)
# replace the field value in the queuedata with the new value
if new_values_joined != old_values:
if self.replaceQueuedataField(field, new_values_joined, verbose=False):
tolog("Updated field %s in queuedata (replaced \'%s\' with \'%s\')" % (field, old_values, new_values_joined))
except:
# ignore None values
continue
def verifyQueuedata(self, queuename, filename, _i, _N, url):
""" Verify the consistency of the queuedata """
hasQueuedata = False
try:
f = open(filename, "r")
except Exception, e:
tolog("!!WARNING!!1999!! Open failed with %s" % (e))
else:
output = f.read()
f.close()
if not ('appdir' in output and 'copytool' in output):
if len(output) == 0:
tolog("!!WARNING!!1999!! curl command returned empty queuedata (wrong queuename %s?)" % (queuename))
else:
tolog("!!WARNING!!1999!! Attempt %d/%d: curl command did not return valid queuedata from config DB server %s" %\
(_i, _N, url))
output = output.replace('\n', '')
output = output.replace(' ', '')
tolog("!!WARNING!!1999!! Output begins with: %s" % (output[:64]))
try:
os.remove(filename)
except Exception, e:
tolog("!!WARNING!!1999!! Failed to remove file %s: %s" % (filename, e))
else:
# found valid queuedata info, break the for-loop
tolog("schedconfigDB returned: %s" % (output))
hasQueuedata = True
return hasQueuedata
def getQueuedata(self, queuename, forceDownload=False, alt=False, url=""):
""" Download the queuedata if not already downloaded """
# Queuedata means the dump of all geometrical data for a given site. This method downloads and stores queuedata in a JSON or pickle
# file called queuedata.[json|dat]. JSON format is preferable and is used for python versions >= 2.6.
#
# Exeute the following command for a queuedata example:
# curl --connect-timeout 20 --max-time 120 -sS "http://pandaserver.cern.ch:25085/cache/schedconfig/CERN-PROD-all-prod-CEs.pilot.json"
# Input:
# queuename = name of the PanDA queue (e.g. CERN-PROD-all-prod-CEs)
# forceDownload = False (default),
# alt = False (default), if alternative queuedata should be downloaded (if stage-out to an alternative SE, new queuedata is needed
# but it will not overwrite the old queuedata)
# Returns:
# error code (int), status for queuedata download (boolean)
if url == "":
exp = getExperimentObject(self.__experiment) # this is a bug and should not work as expected if getQueuedata() is called from child class (e.g. from ATLASSiteInformation) since self.__experiment is PRIVATE in this scope! (anisyonk)
url = exp.getSchedconfigURL()
tolog("The schedconfig URL was not set by the wrapper - Will use default server url = %s (hardcoded)" % (url))
if not os.environ.has_key('PilotHomeDir'):
os.environ['PilotHomeDir'] = commands.getoutput('pwd')
hasQueuedata = False
# try the config servers one by one in case one of them is not responding
# in case the wrapper has already downloaded the queuedata, it might have a .dat extension
# otherwise, give it a .json extension if possible
filename_dat = self.getQueuedataFileName(useExtension='dat', check=False, alt=alt)
if os.path.exists(filename_dat):
filename = filename_dat
else:
filename = self.getQueuedataFileName(check=False, alt=alt)
if os.path.exists(filename) and not forceDownload:
tolog("Queuedata has already been downloaded by pilot wrapper script (will confirm validity)")
hasQueuedata = self.verifyQueuedata(queuename, filename, 1, 1, "(see batch log for url)")
if hasQueuedata:
tolog("Queuedata was successfully downloaded by pilot wrapper script")
else:
tolog("Queuedata was not downloaded successfully by pilot wrapper script, will try again")
if not hasQueuedata:
# loop over pandaserver round robin _N times until queuedata has been verified, or fail
ret = -1
if os.environ.has_key('X509_USER_PROXY'):
sslCert = os.environ['X509_USER_PROXY']
else:
sslCert = '/tmp/x509up_u%s' % str(os.getuid())
cmd = 'curl --connect-timeout 20 --max-time 120 --cacert %s -sS "%s:25085/cache/schedconfig/%s.all.%s" > %s' % \
(sslCert, url, queuename, getExtension(alternative='pilot'), filename)
_N = 3
for _i in range(_N):
tolog("Executing command: %s" % (cmd))
try:
# output will be empty since we pipe into a file
ret, output = commands.getstatusoutput(cmd)
except Exception, e:
tolog("!!WARNING!!1999!! Failed with curl command: %s" % str(e))
return -1, False
else:
if ret == 0:
# read back the queuedata to verify its validity
hasQueuedata = self.verifyQueuedata(queuename, filename, _i, _N, url)
if hasQueuedata:
break
else:
tolog("!!WARNING!!1999!! curl command exited with code %d" % (ret))
return 0, hasQueuedata
def postProcessQueuedata(self, queuename, pshttpurl, thisSite, _jobrec, force_devpilot):
""" Update queuedata fields if necessary """
if 'pandadev' in pshttpurl or force_devpilot or thisSite.sitename == "CERNVM":
ec = self.replaceQueuedataField("status", "online")
_status = self.readpar('status')
if _status != None and _status != "":
if _status.upper() == "OFFLINE":
tolog("Site %s is currently in %s mode - aborting pilot" % (thisSite.sitename, _status.lower()))
return -1, None, None
else:
tolog("Site %s is currently in %s mode" % (thisSite.sitename, _status.lower()))
# override pilot run options
temp_jobrec = self.readpar('retry')
if temp_jobrec.upper() == "TRUE":
tolog("Job recovery turned on")
_jobrec = True
elif temp_jobrec.upper() == "FALSE":
tolog("Job recovery turned off")
_jobrec = False
else:
tolog("Job recovery variable (retry) not set")
# evaluate the queuedata if needed
self.evaluateQueuedata()
# set pilot variables in case they have not been set by the pilot launcher
thisSite = self.setUnsetVars(thisSite)
return 0, thisSite, _jobrec
def removeContainerImage(self, jobParameters):
""" Remove the container image option from the job parameters """
# Note : --containerimage is a Pilot 2 feature and full support for it will only be implemented in Pilot 2
# This function only removes the string from job parameters
# define regexp pattern for the full container image option
pattern = re.compile(r'(\ \-\-containerimage\=?\s?[\S]+)')
fullCommand = re.findall(pattern, jobParameters)
if fullCommand and fullCommand[0] != "":
# remove the overwriteQueuedata command from the job parameters
jobParameters = jobParameters.replace(fullCommand[0], "")
tolog("Removed the --containerimage XYZ option from job parameters: %s" % (jobParameters))
return jobParameters
def extractQueuedataOverwrite(self, jobParameters):
""" Extract the queuedata overwrite key=value pairs from the job parameters """
# The dictionary will be used to overwrite existing queuedata values
# --overwriteQueuedata={key1=value1,key2=value2}
queuedataUpdateDictionary = {}
# define regexp pattern for the full overwrite command
pattern = re.compile(r'\ \-\-overwriteQueuedata\=\{.+}')
fullCommand = re.findall(pattern, jobParameters)
if fullCommand[0] != "":
# tolog("Extracted the full command from the job parameters: %s" % (fullCommand[0]))
# e.g. fullCommand[0] = '--overwriteQueuedata={key1=value1 key2=value2}'
# remove the overwriteQueuedata command from the job parameters
jobParameters = jobParameters.replace(fullCommand[0], "")
tolog("Removed the queuedata overwrite command from job parameters: %s" % (jobParameters))
# define regexp pattern for the full overwrite command
pattern = re.compile(r'\-\-overwriteQueuedata\=\{(.+)\}')
# extract the key value pairs string from the already extracted full command
keyValuePairs = re.findall(pattern, fullCommand[0])
# e.g. keyValuePairs[0] = 'key1=value1,key2=value2'
if keyValuePairs[0] != "":
# tolog("Extracted the key value pairs from the full command: %s" % (keyValuePairs[0]))
# remove any extra spaces if present
keyValuePairs[0] = keyValuePairs[0].replace(" ", "")
commaDictionary = {}
if "\'" in keyValuePairs[0] or '\"' in keyValuePairs[0]:
tolog("Detected quotation marks in the job parameters: %s" % (keyValuePairs[0]))
# e.g. key1=value1,key2=value2,key3='value3,value4'
# handle quoted key-values separately
# replace any simple qoutation marks with double quotation marks to simplify the regexp below
keyValuePairs[0] = keyValuePairs[0].replace("\'",'\"')
keyValuePairs[0] = keyValuePairs[0].replace('\\"','\"') # in case double backslashes are present
# extract all values containing commas
commaList = re.findall('"([^"]*)"', keyValuePairs[0])
# create a dictionary with key-values using format "key_%d" = value, where %d is the id of the found value
# e.g. { key_1: valueX,valueY,valueZ, key_2: valueA,valueB }
# replace the original comma-containing value with "key_%d", and replace it later
commaDictionary = {}
counter = 0
for commaValue in commaList:
counter += 1
key = 'key_%d' % (counter)
commaDictionary[key] = commaValue
keyValuePairs[0] = keyValuePairs[0].replace('\"'+commaValue+'\"', key)
tolog("keyValuePairs=%s" % (keyValuePairs[0]))
tolog("commaDictionary=%s" % str(commaDictionary))
# define the regexp pattern for the actual key=value pairs
# full backslash escape, see (adjusted for python):
# http://stackoverflow.com/questions/168171/regular-expression-for-parsing-name-value-pairs
pattern = re.compile( r'((?:\\.|[^=,]+)*)=("(?:\\.|[^"\\]+)*"|(?:\\.|[^,"\\]+)*)' )
# finally extract the key=value parameters
keyValueList = re.findall(pattern, keyValuePairs[0])
# e.g. keyValueList = [('key1', 'value1'), ('key2', 'value_2')]
# put the extracted pairs in a proper dictionary
if keyValueList != []:
tolog("Extracted the following key value pairs from job parameters: %s" % str(keyValueList))
for keyValueTuple in keyValueList:
key = keyValueTuple[0]
value = keyValueTuple[1]
if key != "":
# extract the value from the commaDictionary if it exists
if commaDictionary.has_key(value):
value = commaDictionary[value]
queuedataUpdateDictionary[key] = value
else:
tolog("!!WARNING!!1223!! Bad key detected in key value tuple: %s" % str(keyValueTuple))
else:
tolog("!!WARNING!!1223!! Failed to extract the key value pair list from: %s" % (keyValuePairs[0]))
else:
tolog("!!WARNING!!1223!! Failed to extract the key value pairs from: %s" % (keyValuePairs[0]))
else:
tolog("!!WARNING!!1223!! Failed to extract the full queuedata overwrite command from jobParameters=%s" % (jobParameters))
return jobParameters, queuedataUpdateDictionary
def get_key_value_for_queuedata(self, parameter):
m = parameter.split('=', 1)
key = m[0]
value = True
if len(m) > 1:
try:
value = json.loads(m[1])
except ValueError:
value = m[1]
return key, value
def fixQueuedataFromParams(self, key, value):
if key.lower() == 'transfertype':
self.transferTypeFix = value
else:
tolog("Overwriting queuedata parameter \"%s\" to %s" % (key, json.dumps(value)))
self.replaceQueuedataField(key, value)
tolog("Updated %s in queuedata: %s (read back from file)" % (key, self.readpar(key)))
def updateQueuedataFromJobParameters(self, jobParameters):
""" Extract queuedata overwrite command from job parameters and update queuedata """
tolog("called updateQueuedataFromJobParameters with: %s" % (jobParameters))
self.transferTypeFix = ""
# remove any --containerimage XYZ option since that will only be supported by Pilot 2
if "--containerimage" in jobParameters:
jobParameters = self.removeContainerImage(jobParameters)
# extract and remove queuedata overwrite command from job parameters (the old way)
if "--overwriteQueuedata={" in jobParameters:
tolog("Old --overwriteQueuedata parameter type, please check your HammerCloud configs!", label='WARNING')
tolog("Encountered an --overwriteQueuedata command in the job parameters")
# (jobParameters might be updated [queuedata overwrite command should be removed if present], so they needs to be returned)
jobParameters, queuedataUpdateDictionary = self.extractQueuedataOverwrite(jobParameters)
# update queuedata
if queuedataUpdateDictionary != {}:
tolog("Queuedata will be updated from job parameters")
for field in queuedataUpdateDictionary.keys():
self.fixQueuedataFromParams(field, queuedataUpdateDictionary[field])
import shlex, pipes
"""
Splits command parameters and extracts queuedata modifications if present.
Queuedata modification principles:
Extraction is done from one of the parameter strings:
1) ... --overwriteQueuedata key1=val1[ key2=val2[ ...]] -- ...
2) ... --overwriteQueuedata key1=val1[ key2=val2[ ...]] -...
3) ... --overwriteQueuedata key1=val1[ key2=val2[ ...]]
3) ... --overwriteQueuedata '{"key1":"any valid JSON","key2":"..."}' ...
Extraction starts from --overwriteQueuedata, then goes number of key=value pairs.
Each value in pairs is either valid JSON or simple string.
Example:
'parameter list --overwriteQueuedata k1 k2=val k3=\'{"a":"b"}\' k4=false k5=23 -- will lead to'
modification in queuedata:
{
k1: True
k2: "val"
k3: {a: "b"}
k4: False
k5: (int)23
}
and parameter list:
'parameter list will lead to'
The end of the list is marked with:
1) "--" (two dashes exactly), which is also stripped from parameter list;
2) some parameter starting with "-" and is not just two dashes;
3) EOL.
4) If the arguments are presented as a solid valid JSON.
If the next parameter (case 2) is --overwriteQueuedata, it is parsed all the same.
"""
try:
job_args = shlex.split(jobParameters)
except ValueError as e:
tolog("Unparsable job arguments. Shlex exception: " + e.message, label='WARNING')
return jobParameters, self.transferTypeFix
overwriting = False
new_args = []
if not hasattr(self, 'xrootd_test'):
self.xrootd_test = False
if not hasattr(self, 'ALRB_asetupVersion'):
self.ALRB_asetupVersion = None
for arg in job_args:
if overwriting:
if arg.startswith('-'):
overwriting = False
if arg == '--':
continue # variant to end the parameter list
elif arg.startswith('{'): # the argument is a piece of JSON
array = json.loads(arg)
for k in array.keys():
self.fixQueuedataFromParams(k, array[k])
overwriting = False
continue
else:
key, value = self.get_key_value_for_queuedata(arg)
self.fixQueuedataFromParams(key, value)
if not overwriting:
if arg == '--overwriteQueuedata':
tolog("overwriteQueuedata found")
overwriting = True
elif arg == '--disableFAX':
tolog("Encountered a --disableFAX command in the job parameters")
# update queuedata if necessary
if self.readpar("allowfax").lower() == "true":
field = "allowfax"
ec = self.replaceQueuedataField(field, "False")
tolog("Updated %s in queuedata: %s (read back from file)" % (field, self.readpar(field)))
else:
tolog("No need to update queuedata for --disableFAX (allowfax is not set to True)")
elif arg == '--useTestASetup':
os.environ['ALRB_asetupVersion'] = 'testing'
self.ALRB_asetupVersion = 'testing'
elif arg == '--useTestXRootD':
os.environ['TestXRootD'] = 'True'
self.xrootd_test = True
else:
new_args.append(arg)
jobParameters = " ".join(pipes.quote(x) for x in new_args)
tolog("Prepared parameters: %s" % jobParameters)
return jobParameters, self.transferTypeFix
def setUnsetVars(self, thisSite):
""" Set pilot variables in case they have not been set by the pilot launcher """
# thisSite will be updated and returned
tolog('Setting unset pilot variables using queuedata')
if thisSite.appdir == "":
scappdir = self.readpar('appdir')
if os.environ.has_key("OSG_APP") and not os.environ.has_key("VO_ATLAS_SW_DIR"):
if scappdir == "":
scappdir = os.environ["OSG_APP"]
if scappdir == "":
scappdir = "/usatlas/projects/OSG"
tolog('!!WARNING!!4000!! appdir not set in queuedata or $OSG_APP: using default %s' % (scappdir))
else:
tolog('!!WARNING!!4000!! appdir not set in queuedata - using $OSG_APP: %s' % (scappdir))
tolog('appdir: %s' % (scappdir))
thisSite.appdir = scappdir
if thisSite.wntmpdir == "":
_wntmpdir = self.readpar('wntmpdir')
if _wntmpdir == "":
_wntmpdir = thisSite.workdir
tolog('!!WARNING!!4000!! wntmpdir not set - using site workdir: %s' % (_wntmpdir))
tolog('wntmpdir: %s' % (_wntmpdir))
thisSite.wntmpdir = _wntmpdir
return thisSite
def isTier1(self, sitename):
""" Is the given site a Tier-1? """
return False
def isTier2(self, sitename):
""" Is the given site a Tier-2? """
return False
def isTier3(self):
""" Is the given site a Tier-3? """
# Note: defined by DB
return False
def updateCopysetup(self, jobParameters, field, _copysetup, transferType=None, useCT=None, directIn=None, useFileStager=None):
"""
Update copysetup in the presence of directIn and/or useFileStager in jobParameters
Possible copysetup's are:
"setup^oldPrefix^newPrefix^useFileStager^directIn"
"setup^oldPrefix1,oldPrefix2^newPrefix1,newPrefix2^useFileStager^directIn"
"setup^useFileStager^directIn"
"setup"
"None"
"""
# get copysetup from queuedata
copysetup = _copysetup
tolog("updateCopysetup: copysetup=%s" % (copysetup))
if "^" in copysetup:
fields = copysetup.split("^")
n = len(fields)
# fields[0] = setup
# fields[1] = useFileStager
# fields[2] = directIn
# or
# fields[0] = setup
# fields[1] = oldPrefix or oldPrefix1, oldPrefix2
# fields[2] = newPrefix or newPrefix1, newPrefix2
# fields[3] = useFileStager
# fields[4] = directIn
if n == 3 or n == 5:
# update the relevant fields if necessary
if useCT:
tolog("Copy tool is enforced, turning off any set remote I/O or file stager options")
fields[n-1] = "False"
fields[n-2] = "False"
else:
# in case directIn or useFileStager were set by accessmode via jobParameters
if directIn or useFileStager:
if useFileStager and directIn:
fields[n-1] = "True" # directIn
fields[n-2] = "True" # useFileStager
elif directIn and not useFileStager:
fields[n-1] = "True" # directIn
fields[n-2] = "False" # useFileStager
if transferType == "direct":
fields[n-1] = "True" # directIn
fields[n-2] = "False" # make sure file stager is turned off
# in case directIn or useFileStager were set in jobParameters or with transferType
else:
if fields[n-1].lower() == "false" and ("--directIn" in jobParameters or transferType == "direct"):
fields[n-1] = "True" # directIn
fields[n-2] = "False" # useFileStager
if fields[n-2].lower() == "false" and "--useFileStager" in jobParameters:
fields[n-1] = "True" # directIn
fields[n-2] = "True" # useFileStager
if "," in copysetup:
tolog("Multiple old/new prefices, turning off any set remote I/O or file stager options")
fields[n-1] = "False"
fields[n-2] = "False"
copysetup = "^".join(fields)
else:
tolog("!!WARNING!!2990!! This site is not setup properly for using direct access/file stager: copysetup=%s" % (copysetup))
else:
if transferType == "direct" or directIn and not useFileStager:
copysetup += "^False^True"
elif useFileStager:
copysetup += "^True^True"
# undo remote I/O copysetup modification if requested
if transferType == "undodirect" and "^" in copysetup:
tolog("Requested re-modification of copysetup due to previous error")
fields = copysetup.split("^")
copysetup = fields[0]
copysetup += "^False^False"
# update copysetup if updated
if copysetup != _copysetup:
ec = self.replaceQueuedataField(field, copysetup)
tolog("Updated %s in queuedata: %s (read back from file)" % (field, self.readpar(field)))
else:
tolog("copysetup does not need to be updated")
def getAppdirs(self, appdir):
""" Create a list of all appdirs in appdir """
# appdir = '/cvmfs/atlas.cern.ch/repo/sw|nightlies^/cvmfs/atlas-nightlies.cern.ch/repo/sw/nightlies'
# -> ['/cvmfs/atlas.cern.ch/repo/sw', '/cvmfs/atlas-nightlies.cern.ch/repo/sw/nightlies']
appdirs = []
if "|" in appdir:
for a in appdir.split("|"):
# remove any processingType
if "^" in a:
a = a.split("^")[1]
appdirs.append(a)
else:
appdirs.append(appdir)
return appdirs
def extractAppdir(self, appdir, processingType, homePackage):
""" extract and (re-)confirm appdir from possibly encoded schedconfig.appdir """
# e.g. for CERN:
# processingType = unvalid
# schedconfig.appdir = /afs/cern.ch/atlas/software/releases|release^/afs/cern.ch/atlas/software/releases|unvalid^/afs/cern.ch/atlas/software/unvalidated/caches
# -> appdir = /afs/cern.ch/atlas/software/unvalidated/caches
# if processingType does not match anything, use the default first entry (/afs/cern.ch/atlas/software/releases)
# NOTE: this function can only be called after a job has been downloaded since processType is unknown until then
ec = 0
tolog("Extracting appdir (current value=%s)" % (appdir))
# override processingType for analysis jobs that use nightlies
if "rel_" in homePackage:
tolog("Temporarily modifying processingType from %s to nightlies" % (processingType))
processingType = "nightlies"
_appdir = appdir
if "|" in _appdir and "^" in _appdir:
# extract appdir by matching with processingType
appdir_split = _appdir.split("|")
appdir_default = appdir_split[0]
# loop over all possible appdirs
sub_appdir = ""
for i in range(1, len(appdir_split)):
# extract the processingType and sub appdir
sub_appdir_split = appdir_split[i].split("^")
if processingType == sub_appdir_split[0]:
# found match
sub_appdir = sub_appdir_split[1]
break
if sub_appdir == "":
_appdir = appdir_default
tolog("Using default appdir: %s (processingType = \'%s\')" % (_appdir, processingType))
else:
_appdir = sub_appdir
tolog("Matched processingType %s to appdir %s" % (processingType, _appdir))
else:
# check for empty appdir's on LCG
if _appdir == "":
if os.environ.has_key("VO_ATLAS_SW_DIR"):
_appdir = os.environ["VO_ATLAS_SW_DIR"]
tolog("Set site.appdir to %s" % (_appdir))
else:
tolog("Got plain appdir: %s" % (_appdir))
# should the software directory be verified? (at the beginning of the pilot)
if self.verifySoftwareDirectory():
# verify the existence of appdir
if os.path.exists(_appdir):
tolog("Software directory %s exists" % (_appdir))
# force queuedata update
_ec = self.replaceQueuedataField("appdir", _appdir)
del _ec
else:
if _appdir != "":
tolog("!!FAILED!!1999!! Software directory does not exist: %s" % (_appdir))
else:
tolog("!!FAILED!!1999!! Software directory (appdir) is not set")
ec = self.__error.ERR_NOSOFTWAREDIR
else:
tolog("WARNING: Software directory will not be verified")
return ec, _appdir
def verifySoftwareDirectory(self):
""" Should the software directory (schedconfig.appdir) be verified? """
return True
def getExperiment(self):
""" Return a string with the experiment name """
return self.__experiment
def getExperimentObject(self): # quick stub: to be properly implemented later
return getExperimentObject(self.getExperiment())
def allowAlternativeStageOut(self, **pdict):
""" Is alternative stage-out allowed? """
# E.g. if stage-out to primary SE (at Tier-2) fails repeatedly, is it allowed to attempt stage-out to secondary SE (at Tier-1)?
# Argument 'pdict' can be used for special conditions
return False
def forceAlternativeStageOut(self, **pdict):
""" Force stage-out to use alternative SE """
# Argument 'flag' can be used for special conditions
# See allowAlternativeStageOut()
return False
def getSSLCertificate(self):
""" Return the path to the SSL certificate """
if os.environ.has_key('X509_USER_PROXY'):
sslCertificate = os.environ['X509_USER_PROXY']
else:
sslCertificate = '/tmp/x509up_u%s' % str(os.getuid())
return sslCertificate
def getSSLCertificatesDirectory(self):
""" Return the path to the SSL certificates directory """
sslCertificatesDirectory = ''
if os.environ.has_key('X509_CERT_DIR'):
sslCertificatesDirectory = os.environ['X509_CERT_DIR']
else:
_dir = '/etc/grid-security/certificates'
if os.path.exists(_dir):
sslCertificatesDirectory = _dir
else:
tolog("!!WARNING!!2999!! $X509_CERT_DIR is not set and default location %s does not exist" % (_dir))
return sslCertificatesDirectory
def getProperPaths(self, error, analyJob, token, prodSourceLabel, dsname, filename, **pdict):
""" Return proper paths for the storage element used during stage-out """
# Implement in sub-class
return ""
def getTier1Queue(self, cloud):
""" Download the queuedata for the Tier-1 in the corresponding cloud and get the queue name """
# Implement in sub-class
# This method is used during stage-out to alternative [Tier-1] site when primary stage-out on a Tier-2 fails
# See methods in ATLASSiteInformation
return None
def getCopySetup(self, stageIn=False):
"""Get the setup string from queuedata"""
copysetup = ""
if stageIn:
copysetup = self.readpar('copysetupin')
if copysetup == "":
copysetup = self.readpar('copysetup')
tolog("Using copysetup = %s" % (copysetup))
else:
tolog("Using copysetupin = %s" % (copysetup))
if copysetup != '':
# discard the directAccess info also stored in this variable
_count = copysetup.count('^')
if _count > 0:
# make sure the DB entry doesn't start with directAccess info
if _count == 2 or _count == 4 or _count == 5:
copysetup = copysetup.split('^')[0]
else:
tolog('!!WARNING!!2999!! Could not figure out copysetup: %s' % (copysetup))
tolog('!!WARNING!!2999!! Resetting copysetup to an empty string')
copysetup = ''
# Check copysetup actually exists!
if copysetup != '' and os.access(copysetup, os.R_OK) == False:
tolog('WARNING: copysetup %s is not readable - resetting to empty string' % (copysetup))
copysetup = ''
else:
tolog("copysetup is: %s (file access verified)" % (copysetup))
else:
tolog("No copysetup found in queuedata")
return copysetup
def getCopyTool(self, stageIn=False):
"""
Selects the correct copy tool (SiteMover id) given a site name
'mode' is used to distinguish between different copy commands
"""
copytoolname = ''
if stageIn:
copytoolname = self.readpar('copytoolin')
if copytoolname == "":
# not set, use same copytool for stage-in as for stage-out
copytoolname = self.readpar('copytool')
if copytoolname.find('^') > -1:
copytoolname, pstage = copytoolname.split('^')
if copytoolname == '':
tolog("!!WARNING!!2999!! copytool not found (using default cp)")
copytoolname = 'cp'
copysetup = self.getCopySetup(stageIn)
return (copytoolname, copysetup)
def getCopyPrefix(self, stageIn=False):
"""Get Copy Prefix"""