"""
Interface to the env_test.xml file. This class inherits from EnvBase
"""
from CIME.XML.standard_module_setup import *
from CIME.XML.env_base import EnvBase
from CIME.utils import convert_to_type
logger = logging.getLogger(__name__)
[docs]class EnvTest(EnvBase):
# pylint: disable=unused-argument
def __init__(self, case_root=None, infile="env_test.xml", components=None, read_only=False):
"""
initialize an object interface to file env_test.xml in the case directory
"""
EnvBase.__init__(self, case_root, infile, read_only=read_only)
[docs] def add_test(self,testnode):
self.add_child(testnode)
self.write()
[docs] def set_initial_values(self, case):
"""
The values to initialize a test are defined in env_test.xml
copy them to the appropriate case env files to initialize a test
ignore fields set in the BUILD and RUN clauses, they are set in
the appropriate build and run phases.
"""
tnode = self.get_child("test")
for child in self.get_children(root=tnode):
if self.text(child) is not None:
logger.debug("Setting {} to {} for test".format(self.name(child), self.text(child)))
if "$" in self.text(child):
case.set_value(self.name(child),self.text(child),ignore_type=True)
else:
item_type = case.get_type_info(self.name(child))
if item_type:
value = convert_to_type(self.text(child),item_type,self.name(child))
case.set_value(self.name(child),value)
case.flush()
return
[docs] def set_test_parameter(self, name, value):
"""
If a node already exists update the value
otherwise create a node and initialize it to value
"""
case = self.get_value("TESTCASE")
tnode = self.get_child("test",{"NAME":case})
idnode = self.get_optional_child(name, root=tnode)
if idnode is None:
self.make_child(name, root=tnode, text=value)
else:
self.set_text(idnode, value)
[docs] def get_test_parameter(self, name):
case = self.get_value("TESTCASE")
tnode = self.get_child("test",{"NAME":case})
value = None
idnode = self.get_optional_child(name, root=tnode)
if idnode is not None:
value = self.text(idnode)
return value
[docs] def get_step_phase_cnt(self,step):
bldnodes = self.get_children(step)
cnt = 0
for node in bldnodes:
cnt = max(cnt, int(self.get(node, "phase")))
return cnt
[docs] def get_settings_for_phase(self, name, cnt):
node = self.get_optional_child(name,attributes={"phase":cnt})
settings = []
if node is not None:
for child in node:
logger.debug ("Here child is {} with value {}".format(self.name(child), self.text(child)))
settings.append((self.name(child), self.text(child)))
return settings
[docs] def run_phase_get_clone_name(self, phase):
node = self.get_child("RUN",attributes={"phase":str(phase)})
if self.has(node, "clone"):
return self.get(node, "clone")
return None
[docs] def cleanupnode(self, node):
'''
keep the values component set
'''
fnode = self.get_child(name="file", root=node)
self.remove_child(fnode, root=node)
gnode = self.get_child(name="group", root=node)
self.remove_child(gnode, root=node)
dnode = self.get_optional_child(name="default_value", root=node)
if dnode is not None:
self.remove_child(dnode, root=node)
return node
[docs] def set_value(self, vid, value, subgroup=None, ignore_type=False):
"""
check if vid is in test section of file
"""
newval = EnvBase.set_value(self, vid, value, subgroup, ignore_type)
if newval is None:
tnode = self.get_optional_child("test")
if tnode is not None:
newval = self.set_element_text(vid, value, root=tnode)
return newval
[docs] def get_value(self, vid, attribute=None, resolved=True, subgroup=None):
value = EnvBase.get_value(self, vid, attribute, resolved, subgroup)
if value is None:
tnode = self.get_optional_child("test")
if tnode is not None:
value = self.get_element_text(vid, root=tnode)
return value