Add tests to Sudo Pallet (#5963)

* transition treasury to configurable moduleids * make election module id configurable * convert runtime and pallet to accept module id config elections-phragmen * add ModuleId to evm pallet * change society pallet to configurable module id * delete commented out module_id * fix merge residual compile errors * setup initial mock structure * establish privelleged function test * save progress * first pass new_test_ext * test sudo to make sure it error when non-root * add set keys tests * fix unused result from set_key call * remove unused imports warnings * pre master merge * Expose BlockHashCount on system metadata constants (#5960) * squash * fix whitespace * spelling and whitespace * a single pesky space * add logger module to mock * add logger dispatch to privlleged function * sub logger in for dummy functions * create first of several event tests * first pass at test coverage for events * comment house keeping * spell check * Expose BlockHashCount on system metadata constants (#5960) * establish privelleged function test * save progress * first pass new_test_ext * test sudo to make sure it error when non-root * add set keys tests * fix unused result from set_key call * remove unused imports warnings * pre master merge * squash * fix whitespace * spelling and whitespace * a single pesky space * add logger module to mock * add logger dispatch to privlleged function * sub logger in for dummy functions * create first of several event tests * first pass at test coverage for events * comment house keeping * implement last_seen_account storage item, event, and, logger function * create vec account log and use in tests * allow weight to be passed into account log * refactor all log dispatchables * save progress * complete initial transition to refactored logger * cleaning * fix merge residual compile errors setup initial mock structure establish privelleged function test save progress first pass new_test_ext test sudo to make sure it error when non-root add set keys tests fix unused result from set_key call parent 5151bd784545ededa6153052a93fcc309f7b3885 author zeke <emostov@middlebury.edu> 1589076740 -0700 committer zeke <emostov@middlebury.edu> 1589350443 -0700 parent 5151bd784545ededa6153052a93fcc309f7b3885 author zeke <emostov@middlebury.edu> 1589076740 -0700 committer zeke <emostov@middlebury.edu> 1589350442 -0700 remove unused imports warnings fix unused result from set_key call remove unused imports warnings pre master merge Expose BlockHashCount on system metadata constants (#5960) squash fix whitespace spelling and whitespace a single pesky space add logger module to mock add logger dispatch to privlleged function sub logger in for dummy functions create first of several event tests first pass at test coverage for events comment house keeping pre master merge Expose BlockHashCount on system metadata constants (#5960) Expose BlockHashCount on system metadata constants (#5960) fix whitespace spell check implement last_seen_account storage item, event, and, logger function create vec account log and use in tests allow weight to be passed into account log refactor all log dispatchables save progress complete initial transition to refactored logger cleaning * clean up * cleaning * condense non_privileged logs into 1 fn * Apply suggestions from code review Co-authored-by: Jaco Greeff <jacogr@gmail.com> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
2026-04-26 15:47:58 +00:00 · 2020-05-13 13:48:49 -07:00
parent 91d93be9b5
commit 71da6e96e6
3 changed files with 347 additions and 0 deletions
@@ -0,0 +1,168 @@
+// Copyright 2020 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
+
+// Substrate is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Substrate is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Tests for the module.
+
+use super::*;
+use mock::{ 
+	Sudo, SudoCall, Origin, Call, Test, new_test_ext, LoggerCall, Logger, System, TestEvent,
+}; 
+use frame_support::{assert_ok, assert_noop};
+
+#[test]
+fn test_setup_works() {
+	// Environment setup, logger storage, and sudo `key` retrieval should work as expected.
+	new_test_ext(1).execute_with(|| {
+		assert_eq!(Sudo::key(),  1u64);
+		assert_eq!(Logger::i32_log(), vec![]);
+		assert_eq!(Logger::account_log(), vec![]);
+	});
+}
+
+#[test]
+fn sudo_basics() {
+	// Configure a default test environment and set the root `key` to 1.
+	new_test_ext(1).execute_with(|| {
+		// A privileged function should work when `sudo` is passed the root `key` as `origin`.
+		let call = Box::new(Call::Logger(LoggerCall::privileged_i32_log(42, 1_000)));
+		assert_ok!(Sudo::sudo(Origin::signed(1), call));
+		assert_eq!(Logger::i32_log(), vec![42i32]); 
+		
+		// A privileged function should not work when `sudo` is passed a non-root `key` as `origin`.
+		let call = Box::new(Call::Logger(LoggerCall::privileged_i32_log(42, 1_000)));
+		assert_noop!(Sudo::sudo(Origin::signed(2), call), Error::<Test>::RequireSudo);
+	});
+}
+
+#[test]
+fn sudo_emits_events_correctly() {
+	new_test_ext(1).execute_with(|| {
+		// Set block number to 1 because events are not emitted on block 0.
+		System::set_block_number(1);
+
+		// Should emit event to indicate success when called with the root `key` and `call` is `Ok`.
+		let call = Box::new(Call::Logger(LoggerCall::privileged_i32_log(42, 1)));
+		assert_ok!(Sudo::sudo(Origin::signed(1), call));
+		let expected_event = TestEvent::sudo(RawEvent::Sudid(Ok(())));
+		assert!(System::events().iter().any(|a| a.event == expected_event)); 
+	})
+}
+
+#[test]
+fn sudo_unchecked_weight_basics() {
+	new_test_ext(1).execute_with(|| {
+		// A privileged function should work when `sudo` is passed the root `key` as origin.
+		let call = Box::new(Call::Logger(LoggerCall::privileged_i32_log(42, 1_000)));
+		assert_ok!(Sudo::sudo_unchecked_weight(Origin::signed(1), call, 1_000));
+		assert_eq!(Logger::i32_log(), vec![42i32]); 
+
+		// A privileged function should not work when called with a non-root `key`.
+		let call = Box::new(Call::Logger(LoggerCall::privileged_i32_log(42, 1_000)));
+		assert_noop!(
+			Sudo::sudo_unchecked_weight(Origin::signed(2), call, 1_000), 
+			Error::<Test>::RequireSudo,
+		);
+		// `I32Log` is unchanged after unsuccessful call.
+		assert_eq!(Logger::i32_log(), vec![42i32]); 
+
+		// Controls the dispatched weight.
+		let call = Box::new(Call::Logger(LoggerCall::privileged_i32_log(42, 1)));
+		let sudo_unchecked_weight_call = SudoCall::sudo_unchecked_weight(call, 1_000);
+		let info = sudo_unchecked_weight_call.get_dispatch_info();
+		assert_eq!(info.weight, 1_000);
+	});
+}
+
+#[test]
+fn sudo_unchecked_weight_emits_events_correctly() {
+	new_test_ext(1).execute_with(|| {
+		// Set block number to 1 because events are not emitted on block 0.
+		System::set_block_number(1);
+
+		// Should emit event to indicate success when called with the root `key` and `call` is `Ok`.
+		let call = Box::new(Call::Logger(LoggerCall::privileged_i32_log(42, 1)));
+		assert_ok!(Sudo::sudo_unchecked_weight(Origin::signed(1), call, 1_000));
+		let expected_event = TestEvent::sudo(RawEvent::Sudid(Ok(())));
+		assert!(System::events().iter().any(|a| a.event == expected_event));
+	})
+}
+
+#[test]
+fn set_key_basics() {
+	new_test_ext(1).execute_with(|| {	
+		// A root `key` can change the root `key`
+		assert_ok!(Sudo::set_key(Origin::signed(1), 2));
+		assert_eq!(Sudo::key(),  2u64);
+	});
+
+	new_test_ext(1).execute_with(|| {
+		// A non-root `key` will trigger a `RequireSudo` error and a non-root `key` cannot change the root `key`.
+		assert_noop!(Sudo::set_key(Origin::signed(2), 3), Error::<Test>::RequireSudo);
+	});
+}
+
+#[test]
+fn set_key_emits_events_correctly() {
+	new_test_ext(1).execute_with(|| {	
+		// Set block number to 1 because events are not emitted on block 0.
+		System::set_block_number(1);
+
+		// A root `key` can change the root `key`.
+		assert_ok!(Sudo::set_key(Origin::signed(1), 2));
+		let expected_event = TestEvent::sudo(RawEvent::KeyChanged(1));
+		assert!(System::events().iter().any(|a| a.event == expected_event));
+		// Double check.
+		assert_ok!(Sudo::set_key(Origin::signed(2), 4));
+		let expected_event = TestEvent::sudo(RawEvent::KeyChanged(2));
+		assert!(System::events().iter().any(|a| a.event == expected_event));
+	});
+}
+
+#[test]
+fn sudo_as_basics() {
+	new_test_ext(1).execute_with(|| {
+		// A privileged function will not work when passed to `sudo_as`.
+		let call = Box::new(Call::Logger(LoggerCall::privileged_i32_log(42, 1_000)));
+		assert_ok!(Sudo::sudo_as(Origin::signed(1), 2, call));
+		assert_eq!(Logger::i32_log(), vec![]); 
+		assert_eq!(Logger::account_log(), vec![]);
+
+		// A non-privileged function should not work when called with a non-root `key`.
+		let call = Box::new(Call::Logger(LoggerCall::non_privileged_log(42, 1)));
+		assert_noop!(Sudo::sudo_as(Origin::signed(3), 2, call), Error::<Test>::RequireSudo);
+
+		// A non-privileged function will work when passed to `sudo_as` with the root `key`.
+		let call = Box::new(Call::Logger(LoggerCall::non_privileged_log(42, 1)));
+		assert_ok!(Sudo::sudo_as(Origin::signed(1), 2, call));
+		assert_eq!(Logger::i32_log(), vec![42i32]);
+		 // The correct user makes the call within `sudo_as`.
+		assert_eq!(Logger::account_log(), vec![2]);
+	});
+}
+
+#[test]
+fn sudo_as_emits_events_correctly() {
+		new_test_ext(1).execute_with(|| {	
+		// Set block number to 1 because events are not emitted on block 0.
+		System::set_block_number(1);
+
+		// A non-privileged function will work when passed to `sudo_as` with the root `key`.
+		let call = Box::new(Call::Logger(LoggerCall::non_privileged_log(42, 1)));
+		assert_ok!(Sudo::sudo_as(Origin::signed(1), 2, call));
+		let expected_event = TestEvent::sudo(RawEvent::SudoAsDone(true));
+		assert!(System::events().iter().any(|a| a.event == expected_event));
+	});
+}