GprMaxBaseTest

class reframe_tests.tests.base_tests.GprMaxBaseTest(*args, **kwargs)

Base class that all GprMax tests should inherit from.

Test functionality can be augmented by using Mixin classes.

model

ReFrame parameter to specify the model name(s).

Type: parameter[str]

sourcesdir

Relative path to the test’s src directory.

Type: str

regression_checks

List of regression checks to perform.

Type: list[RegressionCheck]

test_dependency

Optional test dependency. If specified, regression checks will use reference files created by the test dependency.

Type: type[GprMaxBaseTest] | None

__init__()

Methods

`__init__`()
`build_output_file_path`(filename)	Build output file Path object from filename.
`build_reference_filepath`(name[, suffix])	Build path to the specified reference file.
`check_performance`()	The performance checking phase of the regression test pipeline.
`check_sanity`()	The sanity checking phase of the regression test pipeline.
`cleanup`([remove_files])	The cleanup phase of the regression test pipeline.
`combine_task_outputs`()	Split output from each MPI rank.
`compile`()	The compilation phase of the regression test pipeline.
`compile_complete`()	Check if the build phase has completed.
`compile_wait`()	Wait for compilation phase to finish.
`configure_test_run`()	Configure gprMax commandline arguments and files to keep.
`depends_on`(target[, how])	Add a dependency to another test.
`disable_hook`(hook_name)	Disable pipeline hook by name.
`extract_average_memory_use`()	Extract average memory use for each rank.
`extract_memory_use_per_rank`()	Extract gprMax report of the estimated memory use per rank.
`extract_run_time`()	Extract total runtime from SLURM.
`extract_simulation_time`()	Extract average simulation time reported by gprMax.
`extract_simulation_time_per_rank`()	Extract simulation time reported by gprMax from each rank.
`extract_total_memory_use`()	Extract total memory use across all ranks.
`get_pyenv_path`(CreatePyenvTest)	Add prerun command to load the built Python environment.
`get_test_dependency`()	Get correct ReFrame test case from the test dependency.
`get_test_dependency_variant_name`(**kwargs)	Get unique ReFrame name of the test dependency variant.
`getdep`(target[, environ, part])	Retrieve the test case of a target dependency.
`info`()	Provide live information for this test.
`inject_dependencies`()	Specify test dependencies.
`is_dry_run`()	Check if the test runs in dry-run mode.
`is_fixture`()	Check if the test is a fixture.
`is_local`()	Check if the test will execute locally.
`is_performance_check`()	Return `True` if the test is a performance test.
`performance`()
`pipeline_hooks`()
`regression_check`()	Run sanity checks and regression checks.
`run`()	The run phase of the regression test pipeline.
`run_complete`()	Check if the run phase has completed.
`run_wait`()	Wait for the run phase of this test to finish.
`sanity`()
`set_file_paths`()	Set default test input and output files.
`set_var_default`(name, value)	Set the default value of a variable if variable is undefined.
`setup`(partition, environ, **job_opts)	The setup stage of the regression test pipeline.
`setup_env_vars`()	Set necessary environment variables.
`skip`([msg])	Skip test.
`skip_if`(cond[, msg])	Skip test if condition is true.
`skip_if_no_procinfo`([msg])	Skip test if no processor topology information is available.
`test_reference_files_exist`()	Check all reference files exist and create any missing ones.
`test_simulation_complete`()	Check simulation completed successfully.
`user_deps`()

Attributes

`build_job`
`build_stderr`
`build_stdout`
`current_environ`	The programming environment that the regression test is currently executing with.
`current_partition`	The system partition the regression test is currently executing on.
`current_system`	The system the regression test is currently executing on.
`disabled_hooks`
`display_name`	A human-readable version of the name this test.
`fixture_variant`	The point in the fixture space for the test.
`hashcode`
`job`	The job descriptor associated with this test.
`logger`	A logger associated with this test.
`name`	The name of the test.
`outputdir`	The output directory of the test.
`param_variant`	The point in the parameter space for the test.
`perfvalues`	The obtained performance values for this test.
`prefix`	The prefix directory of the test.
`short_name`	A short version of the test's display name.
`stagedir`	The stage directory of the test.
`stderr`	The name of the file containing the standard error of the test.
`stdout`	The name of the file containing the standard output of the test.
`test_dependency`
`unique_name`	The unique name of this test.
`variant_num`	The variant number of the test.
`valid_prog_environs`	List of programming environments supported by this test.
`valid_systems`	List of systems or system features or system properties required by this test.
`descr`	A detailed description of the test.
`sourcepath`	The path to the source file or source directory of the test.
`sourcesdir`	The directory containing the test's resources.
`build_system`	New in version 2.14.
`prebuild_cmds`	New in version 3.0.
`postbuild_cmds`	New in version 3.0.
`executable`	The name of the executable to be launched during the run phase.
`executable_opts`	List of options to be passed to the `executable`.
`container_platform`	New in version 2.20.
`prerun_cmds`	New in version 3.0.
`postrun_cmds`	New in version 3.0.
`keep_files`	List of files to be kept after the test finishes.
`readonly_files`	List of files or directories (relative to the `sourcesdir`) that will be symlinked in the stage directory and not copied.
`tags`	Set of tags associated with this test.
`maintainers`	List of people responsible for this test.
`strict_check`	Mark this test as a strict performance test.
`num_tasks`	Number of tasks required by this test.
`num_tasks_per_node`	Number of tasks per node required by this test.
`num_gpus_per_node`	Number of GPUs per node required by this test.
`num_cpus_per_task`	Number of CPUs per task required by this test.
`num_tasks_per_core`	Number of tasks per core required by this test.
`num_tasks_per_socket`	Number of tasks per socket required by this test.
`use_multithreading`	Specify whether this tests needs simultaneous multithreading enabled.
`max_pending_time`	New in version 3.0.
`exclusive_access`	Specify whether this test needs exclusive access to nodes.
`local`	Always execute this test locally.
`reference`	The performance reference values for this test.
`require_reference`	Require that a reference is defined for each system that this test is run on.
`sanity_patterns`	Patterns for checking the sanity of this test.
`perf_patterns`	Patterns for verifying the performance of this test.
`perf_variables`	The performance variables associated with the test.
`modules`	List of modules to be loaded before running this test.
`env_vars`	Environment variables to be set before running this test.
`variables`	Environment variables to be set before running this test.
`time_limit`	Time limit for this test.
`build_time_limit`	New in version 3.5.1.
`extra_resources`	New in version 2.8.
`build_locally`	New in version 3.3.
`ci_extras`	New in version 4.2.