Struct Sandbox 

pub(crate) struct Sandbox<'a> {
    config: &'a Config,
    forge: PathBuf,
    skipped: Vec<PathBuf>,
    build_cache: Option<TempDir>,
    home: PathBuf,
    root: TempDir,
}

Builds and runs generated code in temporary copies of the project. Generated code runs outside the sandbox of whatever wrote it, so a copy leaves out hidden root entries such as .env and agent settings, and Forge runs in it with only a few environment variables.

Fields

config: &'a Config

forge: PathBuf

skipped: Vec<PathBuf>

Project paths that workspaces leave out, besides the build output and the cache.

build_cache: Option<TempDir>

The workspace whose build output every new workspace copies.

home: PathBuf

The home directory of builds and test runs, whose .svm links to the installed compilers.

root: TempDir

The temporary directory that holds the home directory and every workspace, so one removal cleans up after an interrupt. It drops last.

Implementations

impl<'a> Sandbox<'a>

pub(crate) fn new(config: &'a Config, skipped: Vec<PathBuf>) -> Result<Self>

Returns a sandbox for the project of config, whose workspaces leave out the skipped project paths.

pub(crate) fn end_on_interrupt(&self, reserved: Vec<PathBuf>) -> Result<()>

Makes an interrupt end every session and test run and remove the workspaces before Forge exits. They run in their own process groups, so a terminal interrupt does not reach them.

pub(crate) fn build(&mut self) -> Result<Option<String>>

Builds the project once in a workspace whose build output later workspaces copy, so a test run compiles only the files that it adds. Returns the compiler errors of a project that does not build; it gets no shared output, and each test run builds it in full.

pub(crate) fn build_errors(&self, workspace: &Path) -> Result<Option<String>>

Builds a workspace and returns the compiler errors, if any. If the project denies warnings, the warnings are errors. A workspace starts from a build without such warnings, so only the files that this build compiles can warn.

pub(crate) fn workspace(&self, files: &[TestFile]) -> Result<TempDir>

Copies the project and the shared build output into a temporary workspace and adds the files.

fn dependencies(&self) -> Vec<PathBuf>

Returns the dependency directories of the project, whose entries workspaces link instead of copying them.

pub(crate) fn command(&self, workspace: &Path) -> Command

Returns a Forge command in a workspace. A workspace has its own resolved foundry.toml, so the command needs only the selected profile from the environment. Generated tests cannot read other variables.

pub(crate) fn output(&self, command: &mut Command) -> Result<Option<Output>>

Runs a command of Sandbox::command and returns its output, or None if it reached RUN_TIMEOUT. Generated tests can loop for as long as their gas lasts, so Forge ends the command and every process that it started at the timeout.

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: 128 bytes