referrerpolicy=no-referrer-when-downgrade
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
// This file is part of Substrate.

// Copyright (C) Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: Apache-2.0

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// 	http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Feature gated since it can panic.
#![cfg(any(feature = "std", feature = "runtime-benchmarks", feature = "try-runtime", test))]

//! Contains the [`crate::StorageNoopGuard`] for conveniently asserting
//! that no storage mutation has been made by a whole code block.

/// Asserts that no storage changes took place between con- and destruction of [`Self`].
///
/// This is easier than wrapping the whole code-block inside a `assert_storage_noop!`.
///
/// # Example
///
/// ```should_panic
/// use frame_support::{StorageNoopGuard, storage::unhashed::put};
///
/// sp_io::TestExternalities::default().execute_with(|| {
/// 	let _guard = frame_support::StorageNoopGuard::default();
/// 	put(b"key", b"value");
/// 	// Panics since there are storage changes.
/// });
/// ```
#[must_use]
pub struct StorageNoopGuard<'a> {
	storage_root: alloc::vec::Vec<u8>,
	error_message: &'a str,
}

impl<'a> Default for StorageNoopGuard<'a> {
	fn default() -> Self {
		Self {
			storage_root: sp_io::storage::root(sp_runtime::StateVersion::V1),
			error_message: "`StorageNoopGuard` detected an attempted storage change.",
		}
	}
}

impl<'a> StorageNoopGuard<'a> {
	/// Alias to `default()`.
	pub fn new() -> Self {
		Self::default()
	}

	/// Creates a new [`StorageNoopGuard`] with a custom error message.
	pub fn from_error_message(error_message: &'a str) -> Self {
		Self { storage_root: sp_io::storage::root(sp_runtime::StateVersion::V1), error_message }
	}

	/// Sets a custom error message for a [`StorageNoopGuard`].
	pub fn set_error_message(&mut self, error_message: &'a str) {
		self.error_message = error_message;
	}
}

impl<'a> Drop for StorageNoopGuard<'a> {
	fn drop(&mut self) {
		// No need to double panic, eg. inside a test assertion failure.
		#[cfg(feature = "std")]
		if std::thread::panicking() {
			return
		}
		assert_eq!(
			sp_io::storage::root(sp_runtime::StateVersion::V1),
			self.storage_root,
			"{}",
			self.error_message,
		);
	}
}

#[cfg(test)]
mod tests {
	use sp_io::TestExternalities;

	use super::*;

	#[test]
	#[should_panic(expected = "`StorageNoopGuard` detected an attempted storage change.")]
	fn storage_noop_guard_panics_on_changed() {
		TestExternalities::default().execute_with(|| {
			let _guard = StorageNoopGuard::default();
			frame_support::storage::unhashed::put(b"key", b"value");
		});
	}

	#[test]
	fn storage_noop_guard_works_on_unchanged() {
		TestExternalities::default().execute_with(|| {
			let _guard = StorageNoopGuard::default();
			frame_support::storage::unhashed::put(b"key", b"value");
			frame_support::storage::unhashed::kill(b"key");
		});
	}

	#[test]
	#[should_panic(expected = "`StorageNoopGuard` detected an attempted storage change.")]
	fn storage_noop_guard_panics_on_early_drop() {
		TestExternalities::default().execute_with(|| {
			let guard = StorageNoopGuard::default();
			frame_support::storage::unhashed::put(b"key", b"value");
			std::mem::drop(guard);
			frame_support::storage::unhashed::kill(b"key");
		});
	}

	#[test]
	fn storage_noop_guard_works_on_changed_forget() {
		TestExternalities::default().execute_with(|| {
			let guard = StorageNoopGuard::default();
			frame_support::storage::unhashed::put(b"key", b"value");
			std::mem::forget(guard);
		});
	}

	#[test]
	#[should_panic(expected = "Something else")]
	fn storage_noop_guard_does_not_double_panic() {
		TestExternalities::default().execute_with(|| {
			let _guard = StorageNoopGuard::default();
			frame_support::storage::unhashed::put(b"key", b"value");
			panic!("Something else");
		});
	}

	#[test]
	#[should_panic(expected = "`StorageNoopGuard` found unexpected storage changes.")]
	fn storage_noop_guard_panics_created_from_error_message() {
		TestExternalities::default().execute_with(|| {
			let _guard = StorageNoopGuard::from_error_message(
				"`StorageNoopGuard` found unexpected storage changes.",
			);
			frame_support::storage::unhashed::put(b"key", b"value");
		});
	}

	#[test]
	#[should_panic(expected = "`StorageNoopGuard` found unexpected storage changes.")]
	fn storage_noop_guard_panics_with_set_error_message() {
		TestExternalities::default().execute_with(|| {
			let mut guard = StorageNoopGuard::default();
			guard.set_error_message("`StorageNoopGuard` found unexpected storage changes.");
			frame_support::storage::unhashed::put(b"key", b"value");
		});
	}

	#[test]
	#[should_panic(expected = "`StorageNoopGuard` detected an attempted storage change.")]
	fn storage_noop_guard_panics_new_alias() {
		TestExternalities::default().execute_with(|| {
			let _guard = StorageNoopGuard::new();
			frame_support::storage::unhashed::put(b"key", b"value");
		});
	}
}