Struct sp_state_machine::TestExternalities

pub struct TestExternalities<H>where
    H: Hasher + 'static,
    H::Out: Codec + Ord,{
    pub backend: InMemoryBackend<H>,
    pub extensions: Extensions,
    pub state_version: StateVersion,
    /* private fields */
}

Simple HashMap-based Externalities impl.

Fields

backend: InMemoryBackend<H>

Storage backend.

extensions: Extensions

Extensions.

state_version: StateVersion

State version to use during tests.

Implementations

impl<H> TestExternalities<H>where
    H: Hasher + 'static,
    H::Out: Ord + 'static + Codec,

pub fn ext(&mut self) -> Ext<'_, H, InMemoryBackend<H>>

Get externalities implementation.

Examples found in repository

src/testing.rs (line 197)

	pub fn execute_with<R>(&mut self, execute: impl FnOnce() -> R) -> R {
		let mut ext = self.ext();
		sp_externalities::set_and_run_with_externalities(&mut ext, execute)
	}

	/// Execute the given closure while `self`, with `proving_backend` as backend, is set as
	/// externalities.
	///
	/// This implementation will wipe the proof recorded in between calls. Consecutive calls will
	/// get their own proof from scratch.
	pub fn execute_and_prove<R>(&mut self, execute: impl FnOnce() -> R) -> (R, StorageProof) {
		let proving_backend = TrieBackendBuilder::wrap(&self.backend)
			.with_recorder(Default::default())
			.build();
		let mut proving_ext = Ext::new(
			&mut self.overlay,
			&mut self.storage_transaction_cache,
			&proving_backend,
			Some(&mut self.extensions),
		);

		let outcome = sp_externalities::set_and_run_with_externalities(&mut proving_ext, execute);
		let proof = proving_backend.extract_proof().expect("Failed to extract storage proof");

		(outcome, proof)
	}

	/// Execute the given closure while `self` is set as externalities.
	///
	/// Returns the result of the given closure, if no panics occurred.
	/// Otherwise, returns `Err`.
	pub fn execute_with_safe<R>(
		&mut self,
		f: impl FnOnce() -> R + UnwindSafe,
	) -> Result<R, String> {
		let mut ext = AssertUnwindSafe(self.ext());
		std::panic::catch_unwind(move || {
			sp_externalities::set_and_run_with_externalities(&mut *ext, f)
		})
		.map_err(|e| format!("Closure panicked: {:?}", e))
	}

pub fn new(storage: Storage) -> Self

Create a new instance of TestExternalities with storage.

pub fn new_with_state_version(
    storage: Storage,
    state_version: StateVersion
) -> Self

Create a new instance of TestExternalities with storage for a given state version.

Examples found in repository

src/testing.rs (line 265)

	fn default() -> Self {
		// default to default version.
		Self::new_with_state_version(Storage::default(), Default::default())
	}
}

impl<H: Hasher> From<Storage> for TestExternalities<H>
where
	H::Out: Ord + 'static + codec::Codec,
{
	fn from(storage: Storage) -> Self {
		Self::new_with_state_version(storage, Default::default())
	}
}

impl<H: Hasher> From<(Storage, StateVersion)> for TestExternalities<H>
where
	H::Out: Ord + 'static + codec::Codec,
{
	fn from((storage, state_version): (Storage, StateVersion)) -> Self {
		Self::new_with_state_version(storage, state_version)
	}

pub fn new_empty() -> Self

New empty test externalities.

pub fn new_with_code(code: &[u8], storage: Storage) -> Self

Create a new instance of TestExternalities with code and storage.

pub fn new_with_code_and_state(
    code: &[u8],
    storage: Storage,
    state_version: StateVersion
) -> Self

Create a new instance of TestExternalities with code and storage for a given state version.

Examples found in repository

src/testing.rs (line 79)

	pub fn new(storage: Storage) -> Self {
		Self::new_with_code_and_state(&[], storage, Default::default())
	}

	/// Create a new instance of `TestExternalities` with storage for a given state version.
	pub fn new_with_state_version(storage: Storage, state_version: StateVersion) -> Self {
		Self::new_with_code_and_state(&[], storage, state_version)
	}

	/// New empty test externalities.
	pub fn new_empty() -> Self {
		Self::new_with_code_and_state(&[], Storage::default(), Default::default())
	}

	/// Create a new instance of `TestExternalities` with code and storage.
	pub fn new_with_code(code: &[u8], storage: Storage) -> Self {
		Self::new_with_code_and_state(code, storage, Default::default())
	}

pub fn overlayed_changes(&self) -> &OverlayedChanges

Returns the overlayed changes.

pub fn persist_offchain_overlay(&mut self)

Move offchain changes from overlay to the persistent store.

pub fn offchain_db(&self) -> TestPersistentOffchainDB

A shared reference type around the offchain worker storage.

pub fn insert(&mut self, k: StorageKey, v: StorageValue)

Insert key/value into backend

pub fn insert_child(&mut self, c: ChildInfo, k: StorageKey, v: StorageValue)

Insert key/value into backend.

This only supports inserting keys in child tries.

pub fn register_extension<E: Any + Extension>(&mut self, ext: E)

Registers the given extension for this instance.

pub fn as_backend(&self) -> InMemoryBackend<H>

Return a new backend with all pending changes.

In contrast to commit_all this will not panic if there are open transactions.

Examples found in repository

src/testing.rs (line 255)

	fn eq(&self, other: &TestExternalities<H>) -> bool {
		self.as_backend().eq(&other.as_backend())
	}

pub fn commit_all(&mut self) -> Result<(), String>

Commit all pending changes to the underlying backend.

Panic

This will panic if there are still open transactions.

pub fn execute_with<R>(&mut self, execute: impl FnOnce() -> R) -> R

Execute the given closure while self is set as externalities.

Returns the result of the given closure.

pub fn execute_and_prove<R>(
    &mut self,
    execute: impl FnOnce() -> R
) -> (R, StorageProof)

Execute the given closure while self, with proving_backend as backend, is set as externalities.

This implementation will wipe the proof recorded in between calls. Consecutive calls will get their own proof from scratch.

pub fn execute_with_safe<R>(
    &mut self,
    f: impl FnOnce() -> R + UnwindSafe
) -> Result<R, String>

Execute the given closure while self is set as externalities.

Returns the result of the given closure, if no panics occurred. Otherwise, returns Err.

Trait Implementations

impl<H: Hasher> Debug for TestExternalities<H>where
    H::Out: Ord + Codec,

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

Formats the value using the given formatter.

impl<H: Hasher> Default for TestExternalities<H>where
    H::Out: Ord + 'static + Codec,

fn default() -> Self

Returns the “default value” for a type.

impl<H> ExtensionStore for TestExternalities<H>where
    H: Hasher,
    H::Out: Ord + Codec,

fn extension_by_type_id(&mut self, type_id: TypeId) -> Option<&mut dyn Any>

Tries to find a registered extension by the given type_id and returns it as a &mut dyn Any.

fn register_extension_with_type_id(
    &mut self,
    type_id: TypeId,
    extension: Box<dyn Extension>
) -> Result<(), Error>

Register extension extension with specified type_id.

fn deregister_extension_by_type_id(
    &mut self,
    type_id: TypeId
) -> Result<(), Error>

Deregister extension with specified ‘type_id’ and drop it.

impl<H> ExternalitiesExt for TestExternalities<H>where
    H: Hasher,
    H::Out: Ord + Codec,

fn extension<T: Any + Extension>(&mut self) -> Option<&mut T>

Tries to find a registered extension and returns a mutable reference.

fn register_extension<T: Extension>(&mut self, ext: T) -> Result<(), Error>

Register extension ext.

fn deregister_extension<T: Extension>(&mut self) -> Result<(), Error>

Deregister and drop extension of T type.

impl<H: Hasher> From<(Storage, StateVersion)> for TestExternalities<H>where
    H::Out: Ord + 'static + Codec,

fn from((storage, state_version): (Storage, StateVersion)) -> Self

Converts to this type from the input type.

impl<H: Hasher> From<Storage> for TestExternalities<H>where
    H::Out: Ord + 'static + Codec,

fn from(storage: Storage) -> Self

Converts to this type from the input type.

impl<H: Hasher> PartialEq<TestExternalities<H>> for TestExternalities<H>where
    H::Out: Ord + 'static + Codec,

fn eq(&self, other: &TestExternalities<H>) -> bool

This doesn’t test if they are in the same state, only if they contains the same data at this state

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.