1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
//! Mocking mechanisms for Dash Platform SDK.
//!
//! See [MockDashPlatformSdk] for more details.
use crate::{
platform::{types::identity::IdentityRequest, DocumentQuery, Fetch, FetchMany, Query},
Error, Sdk,
};
use arc_swap::ArcSwapOption;
use dapi_grpc::platform::v0::{Proof, ResponseMetadata};
use dapi_grpc::{
mock::Mockable,
platform::v0::{self as proto},
};
use dpp::dashcore::Network;
use dpp::version::PlatformVersion;
use drive_proof_verifier::{error::ContextProviderError, ContextProvider, FromProof};
use rs_dapi_client::mock::MockError;
use rs_dapi_client::{
mock::{Key, MockDapiClient},
transport::TransportRequest,
DapiClient, DumpData,
};
use std::{collections::BTreeMap, path::PathBuf, sync::Arc};
use tokio::sync::Mutex;
use super::MockResponse;
/// Mechanisms to mock Dash Platform SDK.
///
/// This object is returned by [Sdk::mock()](crate::Sdk::mock()) and is used to define mock expectations.
///
/// Use [MockDashPlatformSdk::expect_fetch_many()] to define expectations for [FetchMany] requests
/// and [MockDashPlatformSdk::expect_fetch()] for [Fetch] requests.
///
/// ## Panics
///
/// Can panic on errors.
#[derive(Debug)]
pub struct MockDashPlatformSdk {
from_proof_expectations: BTreeMap<Key, Vec<u8>>,
platform_version: &'static PlatformVersion,
dapi: Arc<Mutex<MockDapiClient>>,
sdk: ArcSwapOption<Sdk>,
}
impl MockDashPlatformSdk {
/// Returns true when requests should use proofs.
///
/// ## Panics
///
/// Panics when sdk is not set during initialization.
pub fn prove(&self) -> bool {
if let Some(sdk) = self.sdk.load().as_ref() {
sdk.prove()
} else {
panic!("sdk must be set when creating mock ")
}
}
/// Create new mock SDK.
///
/// ## Note
///
/// You have to call [MockDashPlatformSdk::with_sdk()] to set sdk, otherwise Mock SDK will panic.
pub(crate) fn new(version: &'static PlatformVersion, dapi: Arc<Mutex<MockDapiClient>>) -> Self {
Self {
from_proof_expectations: Default::default(),
platform_version: version,
dapi,
sdk: ArcSwapOption::new(None),
}
}
pub(crate) fn set_sdk(&mut self, sdk: Sdk) {
self.sdk.store(Some(Arc::new(sdk)));
}
pub(crate) fn version<'v>(&self) -> &'v PlatformVersion {
self.platform_version
}
/// Load all expectations from files in a directory.
///
///
/// By default, mock expectations are loaded when Sdk is built with [SdkBuilder::build()](crate::SdkBuilder::build()).
/// This function can be used to load expectations after the Sdk is created, or use alternative location.
/// Expectation files must be prefixed with [DapiClient::DUMP_FILE_PREFIX] and
/// have `.json` extension.
pub async fn load_expectations<P: AsRef<std::path::Path>>(
&mut self,
dir: P,
) -> Result<&mut Self, Error> {
let prefix = DapiClient::DUMP_FILE_PREFIX;
let entries = dir.as_ref().read_dir().map_err(|e| {
Error::Config(format!(
"cannot load mock expectations from {}: {}",
dir.as_ref().display(),
e
))
})?;
let files: Vec<PathBuf> = entries
.into_iter()
.filter_map(|x| x.ok())
.filter(|f| {
f.file_type().is_ok_and(|t| t.is_file())
&& f.file_name().to_string_lossy().starts_with(prefix)
&& f.file_name().to_string_lossy().ends_with(".json")
})
.map(|f| f.path())
.collect();
for filename in &files {
let basename = filename.file_name().unwrap().to_str().unwrap();
let request_type = basename.split('_').nth(1).unwrap_or_default();
match request_type {
"DocumentQuery" => self.load_expectation::<DocumentQuery>(filename).await?,
"GetEpochsInfoRequest" => {
self.load_expectation::<proto::GetEpochsInfoRequest>(filename)
.await?
}
"GetDataContractRequest" => {
self.load_expectation::<proto::GetDataContractRequest>(filename)
.await?
}
"GetDataContractsRequest" => {
self.load_expectation::<proto::GetDataContractsRequest>(filename)
.await?
}
"GetDataContractHistoryRequest" => {
self.load_expectation::<proto::GetDataContractHistoryRequest>(filename)
.await?
}
"IdentityRequest" => self.load_expectation::<IdentityRequest>(filename).await?,
"GetIdentityRequest" => {
self.load_expectation::<proto::GetIdentityRequest>(filename)
.await?
}
"GetIdentityBalanceRequest" => {
self.load_expectation::<proto::GetIdentityBalanceRequest>(filename)
.await?
}
"GetIdentityContractNonceRequest" => {
self.load_expectation::<proto::GetIdentityContractNonceRequest>(filename)
.await?
}
"GetIdentityBalanceAndRevisionRequest" => {
self.load_expectation::<proto::GetIdentityBalanceAndRevisionRequest>(filename)
.await?
}
"GetIdentityKeysRequest" => {
self.load_expectation::<proto::GetIdentityKeysRequest>(filename)
.await?
}
"GetProtocolVersionUpgradeStateRequest" => {
self.load_expectation::<proto::GetProtocolVersionUpgradeStateRequest>(filename)
.await?
}
"GetProtocolVersionUpgradeVoteStatusRequest" => {
self.load_expectation::<proto::GetProtocolVersionUpgradeVoteStatusRequest>(
filename,
)
.await?
}
"GetContestedResourcesRequest" => {
self.load_expectation::<proto::GetContestedResourcesRequest>(filename)
.await?
}
"GetContestedResourceVoteStateRequest" => {
self.load_expectation::<proto::GetContestedResourceVoteStateRequest>(filename)
.await?
}
"GetContestedResourceVotersForIdentityRequest" => {
self.load_expectation::<proto::GetContestedResourceVotersForIdentityRequest>(
filename,
)
.await?
}
"GetContestedResourceIdentityVotesRequest" => {
self.load_expectation::<proto::GetContestedResourceIdentityVotesRequest>(
filename,
)
.await?
}
"GetVotePollsByEndDateRequest" => {
self.load_expectation::<proto::GetVotePollsByEndDateRequest>(filename)
.await?
}
"GetPrefundedSpecializedBalanceRequest" => {
self.load_expectation::<proto::GetPrefundedSpecializedBalanceRequest>(filename)
.await?
}
"GetPathElementsRequest" => {
self.load_expectation::<proto::GetPathElementsRequest>(filename)
.await?
}
"GetTotalCreditsInPlatformRequest" => {
self.load_expectation::<proto::GetTotalCreditsInPlatformRequest>(filename)
.await?
}
_ => {
return Err(Error::Config(format!(
"unknown request type {} in {}",
request_type,
filename.display()
)))
}
};
}
Ok(self)
}
async fn load_expectation<T: TransportRequest>(&mut self, path: &PathBuf) -> Result<(), Error> {
let data = DumpData::<T>::load(path)
.map_err(|e| {
Error::Config(format!(
"cannot load mock expectations from {}: {}",
path.display(),
e
))
})?
.deserialize();
self.dapi.lock().await.expect(&data.0, &data.1)?;
Ok(())
}
/// Expect a [Fetch] request and return provided object.
///
/// This method is used to define mock expectations for [Fetch] requests.
///
/// ## Generic Parameters
///
/// - `O`: Type of the object that will be returned in response to the query. Must implement [Fetch] and [MockResponse].
/// - `Q`: Type of the query that will be sent to Platform. Must implement [Query] and [Mockable].
///
/// ## Arguments
///
/// - `query`: Query that will be sent to Platform.
/// - `object`: Object that will be returned in response to `query`, or None if the object is expected to not exist.
///
/// ## Returns
///
/// * Reference to self on success, to allow chaining
/// * Error when expectation cannot be set or is already defined for this request
///
/// ## Panics
///
/// Can panic on errors.
///
/// ## Example
///
/// ```no_run
/// # let r = tokio::runtime::Runtime::new().unwrap();
/// #
/// # r.block_on(async {
/// use dash_sdk::{Sdk, platform::{Identity, Fetch, dpp::identity::accessors::IdentityGettersV0}};
///
/// let mut api = Sdk::new_mock();
/// // Define expected response
/// let expected: Identity = Identity::random_identity(1, None, api.version())
/// .expect("create expected identity");
/// // Define query that will be sent
/// let query = expected.id();
/// // Expect that in response to `query`, `expected` will be returned
/// api.mock().expect_fetch(query, Some(expected.clone())).await.unwrap();
///
/// // Fetch the identity
/// let retrieved = dpp::prelude::Identity::fetch(&api, query)
/// .await
/// .unwrap()
/// .expect("object should exist");
///
/// // Check that the identity is the same as expected
/// assert_eq!(retrieved, expected);
/// # });
/// ```
pub async fn expect_fetch<O: Fetch + MockResponse, Q: Query<<O as Fetch>::Request>>(
&mut self,
query: Q,
object: Option<O>,
) -> Result<&mut Self, Error>
where
<<O as Fetch>::Request as TransportRequest>::Response: Default,
{
let grpc_request = query.query(self.prove()).expect("query must be correct");
self.expect(grpc_request, object).await?;
Ok(self)
}
/// Expect a [FetchMany] request and return provided object.
///
/// This method is used to define mock expectations for [FetchMany] requests.
///
/// ## Generic Parameters
///
/// - `O`: Type of the object that will be returned in response to the query.
/// Must implement [FetchMany]. `Vec<O>` must implement [MockResponse].
/// - `Q`: Type of the query that will be sent to Platform. Must implement [Query] and [Mockable].
///
/// ## Arguments
///
/// - `query`: Query that will be sent to Platform.
/// - `objects`: Vector of objects that will be returned in response to `query`, or None if no objects are expected.
///
/// ## Returns
///
/// * Reference to self on success, to allow chaining
/// * Error when expectation cannot be set or is already defined for this request
///
/// ## Panics
///
/// Can panic on errors.
///
/// ## Example
///
/// Usage example is similar to
/// [MockDashPlatformSdk::expect_fetch()], but the expected
/// object must be a vector of objects.
pub async fn expect_fetch_many<
K: Ord,
O: FetchMany<K, R>,
Q: Query<<O as FetchMany<K, R>>::Request>,
R: FromIterator<(K, Option<O>)> + MockResponse + Send + Default,
>(
&mut self,
query: Q,
objects: Option<R>,
) -> Result<&mut Self, Error>
where
R: MockResponse,
<<O as FetchMany<K, R>>::Request as TransportRequest>::Response: Default,
R: FromProof<
<O as FetchMany<K, R>>::Request,
Request = <O as FetchMany<K, R>>::Request,
Response = <<O as FetchMany<K, R>>::Request as TransportRequest>::Response,
> + Sync,
{
let grpc_request = query.query(self.prove()).expect("query must be correct");
self.expect(grpc_request, objects).await?;
Ok(self)
}
/// Save expectations for a request.
async fn expect<I: TransportRequest, O: MockResponse>(
&mut self,
grpc_request: I,
returned_object: Option<O>,
) -> Result<(), Error>
where
I::Response: Default,
{
let key = Key::new(&grpc_request);
// detect duplicates
if self.from_proof_expectations.contains_key(&key) {
return Err(MockError::MockExpectationConflict(format!(
"proof expectation key {} already defined for {} request: {:?}",
key,
std::any::type_name::<I>(),
grpc_request
))
.into());
}
// This expectation will work for from_proof
self.from_proof_expectations
.insert(key, returned_object.mock_serialize(self));
// This expectation will work for execute
let mut dapi_guard = self.dapi.lock().await;
// We don't really care about the response, as it will be mocked by from_proof, so we provide default()
dapi_guard.expect(&grpc_request, &Ok(Default::default()))?;
Ok(())
}
/// Wrapper around [FromProof] that uses mock expectations instead of executing [FromProof] trait.
pub(crate) fn parse_proof_with_metadata<I, O: FromProof<I>>(
&self,
request: O::Request,
response: O::Response,
) -> Result<(Option<O>, ResponseMetadata, Proof), drive_proof_verifier::Error>
where
O::Request: Mockable,
Option<O>: MockResponse,
// O: FromProof<<O as FromProof<I>>::Request>,
{
let key = Key::new(&request);
let data = match self.from_proof_expectations.get(&key) {
Some(d) => (
Option::<O>::mock_deserialize(self, d),
ResponseMetadata::default(),
Proof::default(),
),
None => {
let version = self.version();
let provider = self.context_provider()
.ok_or(ContextProviderError::InvalidQuorum(
"expectation not found and quorum info provider not initialized with sdk.mock().quorum_info_dir()".to_string()
))?;
O::maybe_from_proof_with_metadata(
request,
response,
Network::Regtest,
version,
&provider,
)?
}
};
Ok(data)
}
/// Return context provider implementation defined for upstreeam Sdk object.
fn context_provider(&self) -> Option<impl ContextProvider> {
if let Some(sdk) = self.sdk.load_full() {
sdk.clone().context_provider()
} else {
None
}
}
}