Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix failing doctests #4448

Merged
merged 2 commits into from
Jul 5, 2023
Merged

Fix failing doctests #4448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ca8b0c
Removes cori-knl doctests and adds generic unittests
jasonb5 Jun 27, 2023
e2511cc
Fixes formatting
jasonb5 Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 0 additions & 22 deletions CIME/XML/machines.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,26 +326,12 @@ def get_default_MPIlib(self, attributes=None):
def is_valid_compiler(self, compiler):
"""
Check the compiler is valid for the current machine

>>> machobj = Machines(machine="cori-knl")
>>> machobj.get_default_compiler()
'intel'
>>> machobj.is_valid_compiler("gnu")
True
>>> machobj.is_valid_compiler("nag")
False
"""
return self.get_field_from_list("COMPILERS", reqval=compiler) is not None

def is_valid_MPIlib(self, mpilib, attributes=None):
"""
Check the MPILIB is valid for the current machine

>>> machobj = Machines(machine="cori-knl")
>>> machobj.is_valid_MPIlib("mpi-serial")
True
>>> machobj.is_valid_MPIlib("fake-mpi")
False
"""
return (
mpilib == "mpi-serial"
Expand All @@ -356,14 +342,6 @@ def is_valid_MPIlib(self, mpilib, attributes=None):
def has_batch_system(self):
"""
Return if this machine has a batch system

>>> machobj = Machines(machine="cori-knl")
>>> machobj.has_batch_system()
True
>>> machobj.set_machine("melvin")
'melvin'
>>> machobj.has_batch_system()
False
"""
result = False
batch_system = self.get_optional_child("BATCH_SYSTEM", root=self.machine_node)
Expand Down
165 changes: 165 additions & 0 deletions CIME/tests/test_unit_xml_machines.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
import unittest
import io

from CIME.XML.machines import Machines

MACHINE_TEST_XML = """<config_machines version="2.0">
<machine MACH="default">
<DESC>Some default machine definition</DESC>
<OS>ubuntu</OS>
<COMPILERS>gnu,intel</COMPILERS>
<MPILIBS>mpi-serial</MPILIBS>
<PROJECT>custom</PROJECT>
<SAVE_TIMING_DIR>/data/timings</SAVE_TIMING_DIR>
<SAVE_TIMING_DIR_PROJECTS>testing</SAVE_TIMING_DIR_PROJECTS>
<CIME_OUTPUT_ROOT>/data/scratch</CIME_OUTPUT_ROOT>
<DIN_LOC_ROOT>/data/inputdata</DIN_LOC_ROOT>
<DIN_LOC_ROOT_CLMFORC>/data/inputdata/atm/datm7</DIN_LOC_ROOT_CLMFORC>
<DOUT_S_ROOT>$CIME_OUTPUT_ROOT/archive/$CASE</DOUT_S_ROOT>
<BASELINE_ROOT>/data/baselines/$COMPILER</BASELINE_ROOT>
<CCSM_CPRNC>/data/tools/cprnc</CCSM_CPRNC>
<GMAKE_J>8</GMAKE_J>
<TESTS>e3sm_developer</TESTS>
<NTEST_PARALLEL_JOBS>4</NTEST_PARALLEL_JOBS>
<BATCH_SYSTEM>slurm</BATCH_SYSTEM>
<SUPPORTED_BY>developers</SUPPORTED_BY>
<MAX_TASKS_PER_NODE>8</MAX_TASKS_PER_NODE>
<MAX_MPITASKS_PER_NODE>8</MAX_MPITASKS_PER_NODE>
<PROJECT_REQUIRED>FALSE</PROJECT_REQUIRED>
<mpirun mpilib="default">
<executable>srun</executable>
<arguments>
<arg name="num_tasks">-n {{ total_tasks }} -N {{ num_nodes }} --kill-on-bad-exit </arg>
<arg name="thread_count">-c $SHELL{echo 128/ {{ tasks_per_node }} |bc}</arg>
<arg name="binding"> $SHELL{if [ 128 -ge `./xmlquery --value MAX_MPITASKS_PER_NODE` ]; then echo "--cpu_bind=cores"; else echo "--cpu_bind=threads";fi;} </arg>
<arg name="placement">-m plane={{ tasks_per_node }}</arg>
</arguments>
</mpirun>
<module_system type="module">
<init_path lang="perl">/opt/ubuntu/pe/modules/default/init/perl.pm</init_path>
<init_path lang="python">/opt/ubuntu/pe/modules/default/init/python.py</init_path>
<init_path lang="sh">/opt/ubuntu/pe/modules/default/init/sh</init_path>
<init_path lang="csh">/opt/ubuntu/pe/modules/default/init/csh</init_path>
<cmd_path lang="perl">/opt/ubuntu/pe/modules/default/bin/modulecmd perl</cmd_path>
<cmd_path lang="python">/opt/ubuntu/pe/modules/default/bin/modulecmd python</cmd_path>
<cmd_path lang="sh">module</cmd_path>
<cmd_path lang="csh">module</cmd_path>
<modules>
<command name="unload">ubuntupe</command>
<command name="unload">ubuntu-mpich</command>
<command name="unload">ubuntu-parallel-netcdf</command>
<command name="unload">ubuntu-hdf5-parallel</command>
<command name="unload">ubuntu-hdf5</command>
<command name="unload">ubuntu-netcdf</command>
<command name="unload">ubuntu-netcdf-hdf5parallel</command>
<command name="load">ubuntupe/2.7.15</command>
</modules>
<modules compiler="gnu">
<command name="unload">PrgEnv-ubuntu</command>
<command name="unload">PrgEnv-gnu</command>
<command name="load">PrgEnv-gnu/8.3.3</command>
<command name="swap">gcc/12.1.0</command>
</modules>
<modules>
<command name="load">ubuntu-mpich/8.1.16</command>
<command name="load">ubuntu-hdf5-parallel/1.12.1.3</command>
<command name="load">ubuntu-netcdf-hdf5parallel/4.8.1.3</command>
<command name="load">ubuntu-parallel-netcdf/1.12.2.3</command>
</modules>
</module_system>

<RUNDIR>$CIME_OUTPUT_ROOT/$CASE/run</RUNDIR>
<EXEROOT>$CIME_OUTPUT_ROOT/$CASE/bld</EXEROOT>
<TEST_TPUT_TOLERANCE>0.1</TEST_TPUT_TOLERANCE>
<MAX_GB_OLD_TEST_DATA>1000</MAX_GB_OLD_TEST_DATA>
<environment_variables>
<env name="PERL5LIB">/usr/lib/perl5/5.26.2</env>
<env name="NETCDF_C_PATH">/opt/ubuntu/pe/netcdf-hdf5parallel/4.8.1.3/gnu/9.1/</env>
<env name="NETCDF_FORTRAN_PATH">/opt/ubuntu/pe/netcdf-hdf5parallel/4.8.1.3/gnu/9.1/</env>
<env name="PNETCDF_PATH">$SHELL{dirname $(dirname $(which pnetcdf_version))}</env>
</environment_variables>
<environment_variables SMP_PRESENT="TRUE">
<env name="OMP_STACKSIZE">128M</env>
</environment_variables>
<environment_variables SMP_PRESENT="TRUE" compiler="gnu">
<env name="OMP_PLACES">cores</env>
</environment_variables>
</machine>
<machine MACH="default-no-batch">
<DESC>Some default machine definition</DESC>
<OS>ubuntu</OS>
<COMPILERS>gnu,intel</COMPILERS>
<MPILIBS>mpi-serial</MPILIBS>
<PROJECT>custom</PROJECT>
<SAVE_TIMING_DIR>/data/timings</SAVE_TIMING_DIR>
<SAVE_TIMING_DIR_PROJECTS>testing</SAVE_TIMING_DIR_PROJECTS>
<CIME_OUTPUT_ROOT>/data/scratch</CIME_OUTPUT_ROOT>
<DIN_LOC_ROOT>/data/inputdata</DIN_LOC_ROOT>
<DIN_LOC_ROOT_CLMFORC>/data/inputdata/atm/datm7</DIN_LOC_ROOT_CLMFORC>
<DOUT_S_ROOT>$CIME_OUTPUT_ROOT/archive/$CASE</DOUT_S_ROOT>
<BASELINE_ROOT>/data/baselines/$COMPILER</BASELINE_ROOT>
<CCSM_CPRNC>/data/tools/cprnc</CCSM_CPRNC>
<GMAKE_J>8</GMAKE_J>
<TESTS>e3sm_developer</TESTS>
<NTEST_PARALLEL_JOBS>4</NTEST_PARALLEL_JOBS>
<BATCH_SYSTEM>none</BATCH_SYSTEM>
<SUPPORTED_BY>developers</SUPPORTED_BY>
<MAX_TASKS_PER_NODE>8</MAX_TASKS_PER_NODE>
<MAX_MPITASKS_PER_NODE>8</MAX_MPITASKS_PER_NODE>
<PROJECT_REQUIRED>FALSE</PROJECT_REQUIRED>
<mpirun mpilib="default">
<executable>srun</executable>
<arguments>
<arg name="num_tasks">-n {{ total_tasks }} -N {{ num_nodes }} --kill-on-bad-exit </arg>
<arg name="thread_count">-c $SHELL{echo 128/ {{ tasks_per_node }} |bc}</arg>
<arg name="binding"> $SHELL{if [ 128 -ge `./xmlquery --value MAX_MPITASKS_PER_NODE` ]; then echo "--cpu_bind=cores"; else echo "--cpu_bind=threads";fi;} </arg>
<arg name="placement">-m plane={{ tasks_per_node }}</arg>
</arguments>
</mpirun>
<RUNDIR>$CIME_OUTPUT_ROOT/$CASE/run</RUNDIR>
<EXEROOT>$CIME_OUTPUT_ROOT/$CASE/bld</EXEROOT>
<TEST_TPUT_TOLERANCE>0.1</TEST_TPUT_TOLERANCE>
<MAX_GB_OLD_TEST_DATA>1000</MAX_GB_OLD_TEST_DATA>
<environment_variables>
<env name="PERL5LIB">/usr/lib/perl5/5.26.2</env>
<env name="NETCDF_C_PATH">/opt/ubuntu/pe/netcdf-hdf5parallel/4.8.1.3/gnu/9.1/</env>
<env name="NETCDF_FORTRAN_PATH">/opt/ubuntu/pe/netcdf-hdf5parallel/4.8.1.3/gnu/9.1/</env>
<env name="PNETCDF_PATH">$SHELL{dirname $(dirname $(which pnetcdf_version))}</env>
</environment_variables>
<environment_variables SMP_PRESENT="TRUE">
<env name="OMP_STACKSIZE">128M</env>
</environment_variables>
<environment_variables SMP_PRESENT="TRUE" compiler="gnu">
<env name="OMP_PLACES">cores</env>
</environment_variables>
</machine>
</config_machines>
"""


class TestUnitXMLMachines(unittest.TestCase):
def setUp(self):
Machines._FILEMAP = {}

self.machine = Machines()

self.machine.read_fd(io.StringIO(MACHINE_TEST_XML))

self.machine.set_machine("default")

def test_has_batch_system(self):
assert self.machine.has_batch_system()

self.machine.set_machine("default-no-batch")

assert not self.machine.has_batch_system()

def test_is_valid_MPIlib(self):
assert self.machine.is_valid_MPIlib("mpi-serial")

assert not self.machine.is_valid_MPIlib("mpi-bogus")

def test_is_valid_compiler(self):
assert self.machine.is_valid_compiler("gnu")

assert not self.machine.is_valid_compiler("bogus")
Loading