Struct TestProject

pub struct TestProject<T: ArtifactOutput = ConfigurableArtifacts> {
    exe_root: PathBuf,
    inner: Arc<TempProject<MultiCompiler, T>>,
}

TestProject represents a temporary project to run tests against.

Test projects are created from a global atomic counter to avoid duplicates.

Fields

exe_root: PathBuf

The directory in which this test executable is running.

inner: Arc<TempProject<MultiCompiler, T>>

The project in which the test should run.

Implementations

impl TestProject

pub fn new(name: &str, style: PathStyle) -> Self

Create a new test project with the given name. The name does not need to be distinct for each invocation, but should correspond to a logical grouping of tests.

pub fn with_project(project: TempProject) -> Self

pub fn root(&self) -> &Path

Returns the root path of the project’s workspace.

pub fn paths(&self) -> &ProjectPathsConfig

Returns the paths config.

pub fn config(&self) -> PathBuf

Returns the path to the project’s foundry.toml file.

pub fn cache(&self) -> &PathBuf

Returns the path to the project’s cache file.

pub fn artifacts(&self) -> &PathBuf

Returns the path to the project’s artifacts directory.

pub fn clear(&self)

Removes the project’s cache and artifacts directory.

pub fn clear_cache(&self)

Removes this project’s cache file.

pub fn clear_artifacts(&self)

Removes this project’s artifacts directory.

pub fn write_config(&self, config: Config)

Writes the given config as toml to foundry.toml.

pub fn add_source(&self, name: &str, contents: &str) -> SolcResult<PathBuf>

Adds a source file to the project.

pub fn add_raw_source(&self, name: &str, contents: &str) -> SolcResult<PathBuf>

Adds a source file to the project. Prefer using add_source instead.

pub fn add_script(&self, name: &str, contents: &str) -> SolcResult<PathBuf>

Adds a script file to the project.

pub fn add_test(&self, name: &str, contents: &str) -> SolcResult<PathBuf>

Adds a test file to the project.

pub fn add_lib(&self, name: &str, contents: &str) -> SolcResult<PathBuf>

Adds a library file to the project.

fn add_source_prelude(s: &str) -> String

pub fn assert_config_exists(&self)

Asserts that the <root>/foundry.toml file exists.

pub fn assert_cache_exists(&self)

Asserts that the <root>/cache/sol-files-cache.json file exists.

pub fn assert_artifacts_dir_exists(&self)

Asserts that the <root>/out file exists.

pub fn assert_create_dirs_exists(&self)

Creates all project dirs and ensure they were created

pub fn assert_style_paths_exist(&self, style: PathStyle)

Ensures that the given layout exists

pub fn copy_to(&self, target: impl AsRef<Path>)

Copies the project’s root directory to the given target

pub fn create_file(&self, path: impl AsRef<Path>, contents: &str) -> PathBuf

Creates a file with contents contents in the test project’s directory. The file will be deleted when the project is dropped.

pub fn insert_ds_test(&self) -> PathBuf

Adds DSTest as a source under “test.sol”

pub fn insert_console(&self) -> PathBuf

Adds console.sol as a source under “console.sol”

pub fn insert_vm(&self) -> PathBuf

Adds Vm.sol as a source under “Vm.sol”

pub fn assert_all_paths_exist(&self)

Asserts all project paths exist. These are:

• sources
• artifacts
• libs
• cache

pub fn assert_cleaned(&self)

Asserts that the artifacts dir and cache don’t exist

pub fn forge_command(&self) -> TestCommand

Creates a new command that is set to use the forge executable for this project

pub fn cast_command(&self) -> TestCommand

Creates a new command that is set to use the cast executable for this project

pub fn forge_bin(&self) -> Command

Returns the path to the forge executable.

pub fn cast_bin(&self) -> Command

Returns the path to the cast executable.

pub fn config_from_output<I, A>(&self, args: I) -> Config

where I: IntoIterator<Item = A>, A: AsRef<OsStr>,

Returns the Config as spit out by forge config

pub fn wipe(&self)

Removes all files and dirs inside the project’s root dir

pub fn wipe_contracts(&self)

Removes all contract files from src, test, script

Trait Implementations

impl<T: Clone + ArtifactOutput> Clone for TestProject<T>

fn clone(&self) -> TestProject<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + ArtifactOutput> Debug for TestProject<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes