Struct exonum_time::MockTimeProvider

pub struct MockTimeProvider { /* fields omitted */ }

Mock time provider for service testing.

In terms of use, the mock time provider is similar to Arc; that is, clones of the provider control the same time record as the original instance. Therefore, to use the mock provider, one may clone its instance and use the clone to construct a TimeService, while keeping the original instance to adjust the time reported to the validators along various test scenarios.

Examples

use chrono::{Utc, Duration, TimeZone};
use exonum::{helpers::Height, runtime::SnapshotExt};
use exonum_testkit::TestKit;
use exonum_time::{MockTimeProvider, TimeSchema, TimeServiceFactory};

let service_name = "time";
let service_id = 12;

let mock_provider = MockTimeProvider::default();
let mut testkit = TestKit::for_rust_service(
    TimeServiceFactory::with_provider(mock_provider.clone()),
    service_name,
    service_id,
    ()
);
mock_provider.add_time(Duration::seconds(15));
testkit.create_blocks_until(Height(2));

// The time reported by the mock time provider is reflected by the service.
let snapshot = testkit.snapshot();
let schema: TimeSchema<_> = snapshot.service_schema(service_name).unwrap();
assert_eq!(
    Utc.timestamp(15, 0),
    schema.time.get().unwrap()
);

Methods

impl MockTimeProvider

pub fn new(time: DateTime<Utc>) -> Self

Creates a new MockTimeProvider with time value equal to time.

pub fn time(&self) -> DateTime<Utc>

Gets the time value currently reported by the provider.

pub fn set_time(&self, new_time: DateTime<Utc>)

Sets the time value to new_time.

pub fn add_time(&self, duration: Duration)

Adds duration to the value of time.

Trait Implementations

impl Clone for MockTimeProvider

fn clone(&self) -> MockTimeProvider

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MockTimeProvider

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

Formats the value using the given formatter.

impl Default for MockTimeProvider

fn default() -> Self

Initializes the provider with the time set to the Unix epoch start.

impl From<MockTimeProvider> for Arc<dyn TimeProvider>

fn from(time_provider: MockTimeProvider) -> Self

Performs the conversion.

impl TimeProvider for MockTimeProvider

fn current_time(&self) -> DateTime<Utc>

Returns the current time.