Benchmarking pallet-example (#8301)

Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>

substrate/frame/example/src/benchmarking.rs

@@ -0,0 +1,76 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2019-2021 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.
+
+//! Benchmarking for pallet-example.
+
+#![cfg(feature = "runtime-benchmarks")]
+
+use crate::*;
+use frame_benchmarking::{benchmarks, whitelisted_caller, impl_benchmark_test_suite};
+use frame_system::RawOrigin;
+
+// To actually run this benchmark on pallet-example, we need to put this pallet into the
+//   runtime and compile it with `runtime-benchmarks` feature. The detail procedures are
+//   documented at:
+//   https://substrate.dev/docs/en/knowledgebase/runtime/benchmarking#how-to-benchmark
+//
+// The auto-generated weight estimate of this pallet is copied over to the `weights.rs` file.
+// The exact command of how the estimate generated is printed at the top of the file.
+
+// Details on using the benchmarks macro can be seen at:
+//   https://substrate.dev/rustdocs/v3.0.0/frame_benchmarking/macro.benchmarks.html
+benchmarks!{
+	// This will measure the execution time of `set_dummy` for b in [1..1000] range.
+	set_dummy_benchmark {
+		// This is the benchmark setup phase
+		let b in 1 .. 1000;
+	}: set_dummy(RawOrigin::Root, b.into()) // The execution phase is just running `set_dummy` extrinsic call
+	verify {
+		// This is the optional benchmark verification phase, asserting certain states.
+		assert_eq!(Pallet::<T>::dummy(), Some(b.into()))
+	}
+
+	// This will measure the execution time of `accumulate_dummy` for b in [1..1000] range.
+	// The benchmark execution phase is shorthanded. When the name of the benchmark case is the same
+	// as the extrinsic call. `_(...)` is used to represent the extrinsic name.
+	// The benchmark verification phase is omitted.
+	accumulate_dummy {
+		let b in 1 .. 1000;
+		// The caller account is whitelisted for DB reads/write by the benchmarking macro.
+		let caller: T::AccountId = whitelisted_caller();
+	}: _(RawOrigin::Signed(caller), b.into())
+
+	// This will measure the execution time of sorting a vector.
+	sort_vector {
+		let x in 0 .. 10000;
+		let mut m = Vec::<u32>::new();
+		for i in (0..x).rev() {
+			m.push(i);
+		}
+	}: {
+		// The benchmark execution phase could also be a closure with custom code
+		m.sort();
+	}
+}
+
+// This line generates test cases for benchmarking, and could be run by:
+//   `cargo test -p pallet-example --all-features`, you will see an additional line of:
+//   `test benchmarking::benchmark_tests::test_benchmarks ... ok` in the result.
+//
+// The line generates three steps per benchmark, with repeat=1 and the three steps are
+//   [low, mid, high] of the range.
+impl_benchmark_test_suite!(Pallet, crate::tests::new_test_ext(), crate::tests::Test);