pallet-sudo 46.0.0

// 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.

//! Tests for the module.

use super::*;
use frame_support::{assert_noop, assert_ok, weights::Weight};
use mock::{
	new_test_ext, Logger, LoggerCall, RuntimeCall, RuntimeEvent as TestEvent, RuntimeOrigin, Sudo,
	SudoCall, System, Test,
};

#[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!(Key::<Test>::get(), Some(1u64));
		assert!(Logger::i32_log().is_empty());
		assert!(Logger::account_log().is_empty());
	});
}

#[docify::export]
#[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(RuntimeCall::Logger(LoggerCall::privileged_i32_log {
			i: 42,
			weight: Weight::from_parts(1_000, 0),
		}));
		assert_ok!(Sudo::sudo(RuntimeOrigin::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(RuntimeCall::Logger(LoggerCall::privileged_i32_log {
			i: 42,
			weight: Weight::from_parts(1_000, 0),
		}));
		assert_noop!(Sudo::sudo(RuntimeOrigin::signed(2), call), Error::<Test>::RequireSudo);
	});
}

#[test]
fn sudo_emits_events_correctly() {
	new_test_ext(1).execute_with(|| {
		// Should emit event to indicate success when called with the root `key` and `call` is `Ok`.
		let call = Box::new(RuntimeCall::Logger(LoggerCall::privileged_i32_log {
			i: 42,
			weight: Weight::from_parts(1, 0),
		}));
		assert_ok!(Sudo::sudo(RuntimeOrigin::signed(1), call));
		System::assert_has_event(TestEvent::Sudo(Event::Sudid { sudo_result: Ok(()) }));
	})
}

#[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(RuntimeCall::Logger(LoggerCall::privileged_i32_log {
			i: 42,
			weight: Weight::from_parts(1_000, 0),
		}));
		assert_ok!(Sudo::sudo_unchecked_weight(
			RuntimeOrigin::signed(1),
			call,
			Weight::from_parts(1_000, 0)
		));
		assert_eq!(Logger::i32_log(), vec![42i32]);

		// A privileged function should not work when called with a non-root `key`.
		let call = Box::new(RuntimeCall::Logger(LoggerCall::privileged_i32_log {
			i: 42,
			weight: Weight::from_parts(1_000, 0),
		}));
		assert_noop!(
			Sudo::sudo_unchecked_weight(
				RuntimeOrigin::signed(2),
				call,
				Weight::from_parts(1_000, 0)
			),
			Error::<Test>::RequireSudo,
		);
		// `I32Log` is unchanged after unsuccessful call.
		assert_eq!(Logger::i32_log(), vec![42i32]);

		// Controls the dispatched weight.
		let call = Box::new(RuntimeCall::Logger(LoggerCall::privileged_i32_log {
			i: 42,
			weight: Weight::from_parts(1, 0),
		}));
		let sudo_unchecked_weight_call =
			SudoCall::sudo_unchecked_weight { call, weight: Weight::from_parts(1_000, 0) };
		let info = sudo_unchecked_weight_call.get_dispatch_info();
		assert_eq!(info.call_weight, Weight::from_parts(1_000, 0));
	});
}

#[test]
fn sudo_unchecked_weight_emits_events_correctly() {
	new_test_ext(1).execute_with(|| {
		// Should emit event to indicate success when called with the root `key` and `call` is `Ok`.
		let call = Box::new(RuntimeCall::Logger(LoggerCall::privileged_i32_log {
			i: 42,
			weight: Weight::from_parts(1, 0),
		}));
		assert_ok!(Sudo::sudo_unchecked_weight(
			RuntimeOrigin::signed(1),
			call,
			Weight::from_parts(1_000, 0)
		));
		System::assert_has_event(TestEvent::Sudo(Event::Sudid { sudo_result: Ok(()) }));
	})
}

#[docify::export]
#[test]
fn set_key_basics() {
	new_test_ext(1).execute_with(|| {
		// A root `key` can change the root `key`
		assert_ok!(Sudo::set_key(RuntimeOrigin::signed(1), 2));
		assert_eq!(Key::<Test>::get(), Some(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(RuntimeOrigin::signed(2), 3), Error::<Test>::RequireSudo);
	});
}

#[test]
fn set_key_emits_events_correctly() {
	new_test_ext(1).execute_with(|| {
		// A root `key` can change the root `key`.
		assert_ok!(Sudo::set_key(RuntimeOrigin::signed(1), 2));
		System::assert_has_event(TestEvent::Sudo(Event::KeyChanged { old: Some(1), new: 2 }));
		// Double check.
		assert_ok!(Sudo::set_key(RuntimeOrigin::signed(2), 4));
		System::assert_has_event(TestEvent::Sudo(Event::KeyChanged { old: Some(2), new: 4 }));
	});
}

#[test]
fn remove_key_works() {
	new_test_ext(1).execute_with(|| {
		assert_ok!(Sudo::remove_key(RuntimeOrigin::signed(1)));
		assert!(Key::<Test>::get().is_none());
		System::assert_has_event(TestEvent::Sudo(Event::KeyRemoved {}));

		assert_noop!(Sudo::remove_key(RuntimeOrigin::signed(1)), Error::<Test>::RequireSudo);
		assert_noop!(Sudo::set_key(RuntimeOrigin::signed(1), 1), Error::<Test>::RequireSudo);
	});
}

#[test]
fn using_root_origin_works() {
	new_test_ext(1).execute_with(|| {
		assert_ok!(Sudo::remove_key(RuntimeOrigin::root()));
		assert!(Key::<Test>::get().is_none());
		System::assert_has_event(TestEvent::Sudo(Event::KeyRemoved {}));

		assert_ok!(Sudo::set_key(RuntimeOrigin::root(), 1));
		assert_eq!(Some(1), Key::<Test>::get());
	});
}

#[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(RuntimeCall::Logger(LoggerCall::privileged_i32_log {
			i: 42,
			weight: Weight::from_parts(1_000, 0),
		}));
		assert_ok!(Sudo::sudo_as(RuntimeOrigin::signed(1), 2, call));
		assert!(Logger::i32_log().is_empty());
		assert!(Logger::account_log().is_empty());

		// A non-privileged function should not work when called with a non-root `key`.
		let call = Box::new(RuntimeCall::Logger(LoggerCall::non_privileged_log {
			i: 42,
			weight: Weight::from_parts(1, 0),
		}));
		assert_noop!(Sudo::sudo_as(RuntimeOrigin::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(RuntimeCall::Logger(LoggerCall::non_privileged_log {
			i: 42,
			weight: Weight::from_parts(1, 0),
		}));
		assert_ok!(Sudo::sudo_as(RuntimeOrigin::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]);
	});
}

#[docify::export]
#[test]
fn sudo_as_emits_events_correctly() {
	new_test_ext(1).execute_with(|| {
		// A non-privileged function will work when passed to `sudo_as` with the root `key`.
		let call = Box::new(RuntimeCall::Logger(LoggerCall::non_privileged_log {
			i: 42,
			weight: Weight::from_parts(1, 0),
		}));
		assert_ok!(Sudo::sudo_as(RuntimeOrigin::signed(1), 2, call));
		System::assert_has_event(TestEvent::Sudo(Event::SudoAsDone { sudo_result: Ok(()) }));
	});
}