Programming APIs

• Test API Reference
  • Test Base Classes
    • CompileOnlyRegressionTest
    • RegressionMixin
    • RegressionTest
    • RunOnlyRegressionTest
  • Test Decorators
    • simple_test()
  • Builtins
    • reframe.core.pipeline.RegressionMixin.bind()
    • deferrable()
    • fixture()
    • loggable_as()
    • loggable()
    • parameter()
    • performance_function()
    • require_deps()
    • run_after()
    • run_before()
    • sanity_function()
    • variable()
  • Pipeline Hooks
  • Test variants
    • RegressionMixin.num_variants
    • RegressionMixin.get_variant_nums()
    • RegressionMixin.variant_name()
  • Dynamic Creation of Tests
    • make_test()
  • Environments and Systems
    • Environment
    • ProgEnvironment
    • _EnvironmentSnapshot
    • snapshot()
    • DeviceInfo
    • ProcessorInfo
    • System
    • SystemPartition
  • Jobs and Parallel Launchers
    • Job
    • JobLauncher
    • LauncherWrapper
    • getlauncher()
    • getscheduler()
  • Runtime Services
    • RuntimeContext
    • is_env_loaded()
    • loadenv()
    • module_use
    • runtime()
    • temp_config
    • temp_environment
  • Modules Systems
    • ModulesSystem
  • Build Systems
    • Autotools
    • BuildSystem
    • BuildSystemMeta
    • CMake
    • ConfigureBasedBuildSystem
    • CustomBuild
    • EasyBuild
    • Make
    • SingleSource
    • Spack
  • Container Platforms
    • Apptainer
    • ContainerPlatform
    • Docker
    • Sarus
    • Shifter
    • Singularity
  • The reframe module
    • reframe.CompileOnlyRegressionTest
    • reframe.RegressionTest
    • reframe.RunOnlyRegressionTest
    • reframe.simple_test()
  • Mapping of Test Attributes to Job Scheduler Backends
• Deferrable Functions Reference
  • Explicit evaluation of deferrable functions
  • Implicit evaluation of deferrable functions
  • Categories of deferrable functions
    • Deferrable performance functions
  • List of deferrable functions and utilities
    • reframe.utility.sanity.deferrable()
    • abs()
    • all()
    • allx()
    • and_()
    • any()
    • assert_bounded()
    • assert_eq()
    • assert_false()
    • assert_found()
    • assert_found_s()
    • assert_ge()
    • assert_gt()
    • assert_in()
    • assert_le()
    • assert_lt()
    • assert_ne()
    • assert_not_found()
    • assert_not_found_s()
    • assert_not_in()
    • assert_reference()
    • assert_true()
    • avg()
    • chain()
    • contains()
    • count()
    • count_uniq()
    • defer()
    • enumerate()
    • evaluate()
    • extractall()
    • extractall_s()
    • extractiter()
    • extractiter_s()
    • extractsingle()
    • extractsingle_s()
    • filter()
    • findall()
    • findall_s()
    • finditer()
    • finditer_s()
    • getattr()
    • getitem()
    • glob()
    • hasattr()
    • iglob()
    • len()
    • make_performance_function()
    • map()
    • max()
    • min()
    • not_()
    • or_()
    • path_exists()
    • path_isdir()
    • path_isfile()
    • path_islink()
    • print()
    • reversed()
    • round()
    • setattr()
    • sorted()
    • sum()
    • zip()
• Utility Functions
  • General Utilities
    • MappingView
    • OrderedSet
    • ScopedDict
    • SequenceView
    • allx()
    • attr_validator()
    • cache_return_value()
    • decamelize()
    • find_modules()
    • import_module_from_file()
    • is_copyable()
    • is_picklable()
    • is_trivially_callable()
    • longest()
    • nodelist_abbrev()
    • nodelist_expand()
    • ppretty()
    • repr()
    • shortest()
    • temp_setattr
  • System Utilities
    • change_dir
    • concat_files()
    • copytree()
    • copytree_virtual()
    • cray_cdt_version()
    • cray_cle_info()
    • expandvars()
    • follow_link()
    • force_remove_file()
    • git_clone()
    • git_repo_exists()
    • git_repo_hash()
    • inpath()
    • is_interactive()
    • is_url()
    • mkstemp_path()
    • osgroup()
    • osuser()
    • rmtree()
    • run_command()
    • run_command_async()
    • samefile()
    • subdirs()
    • unique_abs_paths()
  • Type Checking Utilities
    • Implementation details
    • Bool
    • ConvertibleType
  • Test Case Dependencies Management
    • by_case()
    • by_env()
    • by_part()
    • by_xcase()
    • by_xenv()
    • by_xpart()
    • fully()
• ReFrame Errors
  • AbortTaskError
  • BuildError
  • BuildSystemError
  • CommandLineError
  • ConfigError
  • ContainerError
  • DependencyError
  • EnvironError
  • FailureLimitError
  • ForceExitError
  • JobBlockedError
  • JobError
    • JobError.jobid
  • JobNotStartedError
  • JobSchedulerError
  • LoggingError
  • NameConflictError
  • PerformanceError
  • PipelineError
  • ReframeBaseError
  • ReframeError
  • ReframeFatalError
  • ReframeSyntaxError
  • RegressionTestLoadError
  • SanityError
  • SkipTestError
  • SpawnedProcessError
    • SpawnedProcessError.command
    • SpawnedProcessError.exitcode
    • SpawnedProcessError.stderr
    • SpawnedProcessError.stdout
  • SpawnedProcessTimeout
    • SpawnedProcessTimeout.timeout
  • StatisticsError
  • TaskDependencyError
  • TaskExit
  • is_exit_request()
  • is_severe()
  • is_user_error()
  • user_frame()
  • what()