Struct simics_test::TestEnv

pub struct TestEnv {
    pub(crate) test_base: PathBuf,
    pub(crate) test_dir: PathBuf,
    pub(crate) project_dir: PathBuf,
    pub(crate) simics_home_dir: PathBuf,
}

A test environment, which is a directory that consists of a simics directory with a set of installed packages and a project directory, where test scripts and resources can be placed.

Fields

test_base: PathBuf

The base of the test environment, e.g. the CARGO_TARGET_TMPDIR directory

test_dir: PathBuf

The subdirectory in the test environment for this test

project_dir: PathBuf

The project subdirectory in the test environment for this test

simics_home_dir: PathBuf

The simics home subdirectory in the test environment for this test

Implementations

impl TestEnv

pub fn default_simics_base_dir<P>(simics_home_dir: P) -> Result<PathBuf>

where P: AsRef<Path>,

Return a reference to the test base directory

pub fn simics_base_dir<S, P>(version: S, simics_home_dir: P) -> Result<PathBuf>

where P: AsRef<Path>, S: AsRef<str>,

Return a reference to the base directory specified by a version

impl TestEnv

pub fn install_files<P>( project_dir: P, files: &Vec<(String, Vec<u8>)>, ) -> Result<()>

where P: AsRef<Path>,

Install a set of files into a project directory, with the files specified as relative paths inside the project directory and their raw contents

pub fn install_directories<P>( project_dir: P, directories: &Vec<PathBuf>, ) -> Result<()>

where P: AsRef<Path>,

Install a set of existing directories into a project, where each directory will be copied recursively into the project

pub(crate) fn build(spec: &TestEnvSpec) -> Result<Self>

pub fn cleanup(&mut self) -> Result<(), CommandExtError>

Clean up the test environment

pub fn cleanup_if_env(&mut self) -> Result<(), CommandExtError>

Clean up the test environment if the SIMICS_TEST_CLEANUP_EACH environment variable is set

pub fn test<S>(&mut self, script: S) -> Result<Output, CommandExtError>

where S: AsRef<str>,

Run a test in the environment in the form of a Simics script. To fail the test, either exit Simics with an error or check the output result.

pub fn test_python<S>(&mut self, script: S) -> Result<Output, CommandExtError>

where S: AsRef<str>,

Run a test in the environment in the form of a Simics script. To fail the test, either exit Simics with an error or check the output result.