Struct exonum_testkit::TestKitApi

pub struct TestKitApi { /* fields omitted */ }

API encapsulation for the testkit. Allows to execute and synchronously retrieve results for REST-ful endpoints of services.

Methods

impl TestKitApi

pub fn public_handler(&self) -> &Chain

Returns the mounting point for public APIs. Useful for intricate testing not covered by get* and post* functions.

pub fn private_handler(&self) -> &Chain

Returns the mounting point for private APIs. Useful for intricate testing not covered by get* and post* functions.

pub fn send<T>(&self, transaction: T) where
    T: Into<Box<Transaction>>, 

Sends a transaction to the node via ApiSender.

pub fn get<D>(&self, kind: ApiKind, endpoint: &str) -> D where
    D: Deserialize<'de>, 

Gets information from a public endpoint of the node.

Panics

• Panics if an error occurs during request processing (e.g., the requested endpoint is unknown), or if the response has a non-20x response status.

pub fn get_private<D>(&self, kind: ApiKind, endpoint: &str) -> D where
    D: Deserialize<'de>, 

Gets information from a private endpoint of the node.

Panics

• Panics if an error occurs during request processing (e.g., the requested endpoint is unknown), or if the response has a non-20x response status.

pub fn get_err<D>(&self, kind: ApiKind, endpoint: &str) -> D where
    D: Deserialize<'de>, 

Gets an error from a public endpoint of the node.

Panics

• Panics if the response has a non-40x response status.

pub fn post<T, D>(&self, kind: ApiKind, endpoint: &str, transaction: &T) -> D where
    T: Serialize,
    D: Deserialize<'de>, 

Posts a transaction to the service using the public API. The returned value is the result of synchronous transaction processing, which includes running the API shim and Transaction.verify(). Transaction.execute() is not run until the transaction gets to a block via one of create_block*() methods.

Panics

• Panics if an error occurs during request processing (e.g., the requested endpoint is unknown).

pub fn post_private<T, D>(
    &self,
    kind: ApiKind,
    endpoint: &str,
    transaction: &T
) -> D where
    T: Serialize,
    D: Deserialize<'de>, 

Posts a transaction to the service using the private API. The returned value is the result of synchronous transaction processing, which includes running the API shim and Transaction.verify(). Transaction.execute() is not run until the transaction gets to a block via one of create_block*() methods.

Panics

• Panics if an error occurs during request processing (e.g., the requested endpoint is unknown).

Trait Implementations

impl Debug for TestKitApi

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

Formats the value using the given formatter.