Merge pull request #2408 from CosmWasm/memory-to-mock

Move `MemoryStorage` to `cosmwasm_std::testing::MockStorage`

Author: webmaster128

CHANGELOG.md

@@ -53,6 +53,8 @@ and this project adheres to
   `Decimal::new(Uint128::new(value))`. ([#2399])
 - cosmwasm-std: Deprecate `Uint256::from_u128` and `Int256::from_i128` in favour
   of `::new`. ([#2399])
+- cosmwasm-std: Move `MemoryStorage` to `cosmwasm_std::testing::MockStorage`.
+  ([#2237])
 
 ## Fixed
 
@@ -63,6 +65,7 @@ and this project adheres to
 [#2155]: https://github.com/CosmWasm/cosmwasm/issues/2155
 [#2156]: https://github.com/CosmWasm/cosmwasm/issues/2156
 [#2201]: https://github.com/CosmWasm/cosmwasm/issues/2201
+[#2237]: https://github.com/CosmWasm/cosmwasm/issues/2237
 [#2262]: https://github.com/CosmWasm/cosmwasm/issues/2262
 [#2268]: https://github.com/CosmWasm/cosmwasm/issues/2268
 [#2269]: https://github.com/CosmWasm/cosmwasm/issues/2269

packages/std/src/lib.rs

@@ -39,7 +39,6 @@ mod results;
 mod sections;
 mod serde;
 mod stdack;
-mod storage;
 mod timestamp;
 mod traits;
 mod types;
@@ -113,7 +112,6 @@ pub use crate::results::{DistributionMsg, StakingMsg};
 pub use crate::results::{GovMsg, VoteOption};
 pub use crate::serde::{from_json, to_json_binary, to_json_string, to_json_vec};
 pub use crate::stdack::StdAck;
-pub use crate::storage::MemoryStorage;
 pub use crate::timestamp::Timestamp;
 pub use crate::traits::{Api, HashFunction, Querier, QuerierResult, QuerierWrapper, Storage};
 pub use crate::types::{BlockInfo, ContractInfo, Env, MessageInfo, MigrateInfo, TransactionInfo};

packages/std/src/testing/mock.rs

@@ -38,7 +38,6 @@ use crate::query::{
 #[cfg(feature = "cosmwasm_1_3")]
 use crate::query::{DelegatorWithdrawAddressResponse, DistributionQuery};
 use crate::results::{ContractResult, Empty, SystemResult};
-use crate::storage::MemoryStorage;
 use crate::traits::{Api, Querier, QuerierResult};
 use crate::types::{BlockInfo, ContractInfo, Env, MessageInfo, TransactionInfo};
 use crate::{from_json, to_json_binary, Binary, Uint128};
@@ -54,6 +53,8 @@ use crate::{ChannelResponse, IbcQuery, ListChannelsResponse, PortIdResponse};
 use crate::{Decimal256, DelegationRewardsResponse, DelegatorValidatorsResponse};
 use crate::{RecoverPubkeyError, StdError, StdResult, SystemError, VerificationError};
 
+use super::MockStorage;
+
 pub const MOCK_CONTRACT_ADDR: &str =
     "cosmwasm1jpev2csrppg792t22rn8z8uew8h3sjcpglcd0qv9g8gj8ky922tscp8avs";
 
@@ -92,10 +93,6 @@ pub fn mock_dependencies_with_balances(
     }
 }
 
-// Use MemoryStorage implementation (which is valid in non-testcode)
-// We can later make simplifications here if needed
-pub type MockStorage = MemoryStorage;
-
 /// Default prefix used when creating Bech32 encoded address.
 const BECH32_PREFIX: &str = "cosmwasm";
 

packages/std/src/testing/mod.rs

@@ -6,6 +6,7 @@
 mod assertions;
 mod message_info;
 mod mock;
+mod storage;
 
 pub use assertions::assert_approx_eq_impl;
 #[cfg(test)]
@@ -23,11 +24,13 @@ pub use mock::StakingQuerier;
 pub use mock::{
     mock_dependencies, mock_dependencies_with_balance, mock_dependencies_with_balances, mock_env,
     mock_wasmd_attr, BankQuerier, MockApi, MockQuerier, MockQuerierCustomHandlerResult,
-    MockStorage, MOCK_CONTRACT_ADDR,
+    MOCK_CONTRACT_ADDR,
 };
 #[cfg(feature = "stargate")]
 pub use mock::{
     mock_ibc_channel, mock_ibc_channel_close_confirm, mock_ibc_channel_close_init,
     mock_ibc_channel_connect_ack, mock_ibc_channel_connect_confirm, mock_ibc_channel_open_init,
     mock_ibc_channel_open_try, mock_ibc_packet_ack, mock_ibc_packet_recv, mock_ibc_packet_timeout,
 };
+
+pub use storage::MockStorage;

packages/std/src/storage.rs renamed to packages/std/src/testing/storage.rs

@@ -11,17 +11,17 @@ use crate::prelude::*;
 use crate::traits::Storage;
 
 #[derive(Default)]
-pub struct MemoryStorage {
+pub struct MockStorage {
     data: BTreeMap<Vec<u8>, Vec<u8>>,
 }
 
-impl MemoryStorage {
+impl MockStorage {
     pub fn new() -> Self {
-        MemoryStorage::default()
+        MockStorage::default()
     }
 }
 
-impl Storage for MemoryStorage {
+impl Storage for MockStorage {
     fn get(&self, key: &[u8]) -> Option<Vec<u8>> {
         self.data.get(key).cloned()
     }
@@ -68,7 +68,7 @@ impl Storage for MemoryStorage {
 
 /// This debug implementation is made for inspecting storages in unit testing.
 /// It is made for human readability only and the output can change at any time.
-impl fmt::Debug for MemoryStorage {
+impl fmt::Debug for MockStorage {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         write!(f, "MemoryStorage ({} entries)", self.data.len())?;
         f.write_str(" {\n")?;
@@ -113,7 +113,7 @@ mod tests {
 
     #[test]
     fn get_and_set() {
-        let mut store = MemoryStorage::new();
+        let mut store = MockStorage::new();
         assert_eq!(store.get(b"foo"), None);
         store.set(b"foo", b"bar");
         assert_eq!(store.get(b"foo"), Some(b"bar".to_vec()));
@@ -125,13 +125,13 @@ mod tests {
         expected = "Getting empty values from storage is not well supported at the moment."
     )]
     fn set_panics_for_empty() {
-        let mut store = MemoryStorage::new();
+        let mut store = MockStorage::new();
         store.set(b"foo", b"");
     }
 
     #[test]
     fn delete() {
-        let mut store = MemoryStorage::new();
+        let mut store = MockStorage::new();
         store.set(b"foo", b"bar");
         store.set(b"food", b"bank");
         store.remove(b"foo");
@@ -143,7 +143,7 @@ mod tests {
     #[test]
     #[cfg(feature = "iterator")]
     fn iterator() {
-        let mut store = MemoryStorage::new();
+        let mut store = MockStorage::new();
         store.set(b"foo", b"bar");
 
         // ensure we had previously set "foo" = "bar"
@@ -283,15 +283,15 @@ mod tests {
 
     #[test]
     fn memory_storage_implements_debug() {
-        let store = MemoryStorage::new();
+        let store = MockStorage::new();
         assert_eq!(
             format!("{store:?}"),
             "MemoryStorage (0 entries) {\n\
             }"
         );
 
         // With one element
-        let mut store = MemoryStorage::new();
+        let mut store = MockStorage::new();
         store.set(&[0x00, 0xAB, 0xDD], &[0xFF, 0xD5]);
         assert_eq!(
             format!("{store:?}"),
@@ -301,7 +301,7 @@ mod tests {
         );
 
         // Sorted by key
-        let mut store = MemoryStorage::new();
+        let mut store = MockStorage::new();
         store.set(&[0x00, 0xAB, 0xDD], &[0xFF, 0xD5]);
         store.set(&[0x00, 0xAB, 0xEE], &[0xFF, 0xD5]);
         store.set(&[0x00, 0xAB, 0xCC], &[0xFF, 0xD5]);
@@ -315,7 +315,7 @@ mod tests {
         );
 
         // Different lengths
-        let mut store = MemoryStorage::new();
+        let mut store = MockStorage::new();
         store.set(&[0xAA], &[0x11]);
         store.set(&[0xAA, 0xBB], &[0x11, 0x22]);
         store.set(&[0xAA, 0xBB, 0xCC], &[0x11, 0x22, 0x33]);