From adf41261c1e883a12c9c890168772d2b12b394fa Mon Sep 17 00:00:00 2001
From: bgallois <benjamin@gallois.cc>
Date: Wed, 22 Mar 2023 19:12:43 +0100
Subject: [PATCH] feat: add pallet certification benchmark
---
pallets/certification/Cargo.toml | 9 +-
pallets/certification/src/benchmarking.rs | 106 ++++++++++++++++++++++
pallets/certification/src/lib.rs | 2 +
runtime/gdev/src/lib.rs | 2 +
4 files changed, 115 insertions(+), 4 deletions(-)
create mode 100644 pallets/certification/src/benchmarking.rs
diff --git a/pallets/certification/Cargo.toml b/pallets/certification/Cargo.toml
index 7615c6f00..b1fb85001 100644
--- a/pallets/certification/Cargo.toml
+++ b/pallets/certification/Cargo.toml
@@ -11,7 +11,7 @@ version = '3.0.0'
[features]
default = ['std']
-runtime-benchmarks = ['frame-benchmarking']
+runtime-benchmarks = ["frame-benchmarking/runtime-benchmarks"]
std = [
'codec/std',
'frame-support/std',
@@ -41,6 +41,7 @@ git = 'https://github.com/duniter/substrate'
optional = true
branch = 'duniter-substrate-v0.9.32'
+
[dependencies.frame-support]
default-features = false
git = 'https://github.com/duniter/substrate'
@@ -71,6 +72,9 @@ default-features = false
git = 'https://github.com/duniter/substrate'
branch = 'duniter-substrate-v0.9.32'
+[dependencies.maplit]
+version = '1.0.2'
+
### DOC ###
[package.metadata.docs.rs]
@@ -80,9 +84,6 @@ version = '1.0.119'
### DEV ###
-[dev-dependencies.maplit]
-version = '1.0.2'
-
[dev-dependencies.sp-io]
default-features = false
git = 'https://github.com/duniter/substrate'
diff --git a/pallets/certification/src/benchmarking.rs b/pallets/certification/src/benchmarking.rs
new file mode 100644
index 000000000..08b8bb55f
--- /dev/null
+++ b/pallets/certification/src/benchmarking.rs
@@ -0,0 +1,106 @@
+// Copyright 2021-2023 Axiom-Team
+//
+// This file is part of Duniter-v2S.
+//
+// Duniter-v2S is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, version 3 of the License.
+//
+// Duniter-v2S 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 Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with Duniter-v2S. If not, see <https://www.gnu.org/licenses/>.
+
+#![cfg(feature = "runtime-benchmarks")]
+
+use super::*;
+
+use frame_benchmarking::benchmarks_instance_pallet;
+use frame_system::RawOrigin;
+use sp_runtime::traits::Convert;
+
+#[cfg(test)]
+use maplit::btreemap;
+
+use crate::Pallet;
+
+fn assert_has_event<T: Config<I>, I: 'static>(generic_event: <T as Config<I>>::RuntimeEvent) {
+ frame_system::Pallet::<T>::assert_has_event(generic_event.into());
+}
+
+fn add_certs<T: Config<I>, I: 'static>(i: u32, receiver: T::IdtyIndex) -> Result<(), &'static str> {
+ Pallet::<T, I>::remove_all_certs_received_by(RawOrigin::Root.into(), receiver)?;
+ for j in 1..i {
+ Pallet::<T, I>::force_add_cert(RawOrigin::Root.into(), j.into(), receiver, false)?;
+ }
+ assert!(
+ CertsByReceiver::<T, I>::get(receiver).len() as u32 == i - 1,
+ "Certs not added",
+ );
+ Ok(())
+}
+
+benchmarks_instance_pallet! {
+ where_clause {
+ where
+ T::IdtyIndex: From<u32>,
+ }
+ force_add_cert {
+ let issuer: T::IdtyIndex = 1.into();
+ let receiver: T::IdtyIndex = 2.into();
+ let receiver_cert: u32 = StorageIdtyCertMeta::<T, I>::get(receiver).received_count;
+ let issuer_cert: u32 = StorageIdtyCertMeta::<T, I>::get(issuer).issued_count;
+ }: _<T::RuntimeOrigin>(RawOrigin::Root.into(), issuer, receiver, true)
+ verify {
+ assert_has_event::<T, I>(Event::<T, I>::NewCert{ issuer: issuer, issuer_issued_count: issuer_cert + 1, receiver: receiver, receiver_received_count: receiver_cert + 1 }.into());
+ }
+ add_cert {
+ let issuer: T::IdtyIndex = 1.into();
+ let issuer_cert: u32 = StorageIdtyCertMeta::<T, I>::get(issuer).issued_count;
+ let caller: T::AccountId = T::OwnerKeyOf::convert(issuer).unwrap();
+ let caller_origin: <T as frame_system::Config>::RuntimeOrigin = RawOrigin::Signed(caller.clone()).into();
+ let receiver: T::IdtyIndex = 2.into();
+ let receiver_cert: u32 = StorageIdtyCertMeta::<T, I>::get(receiver).received_count;
+ }: _<T::RuntimeOrigin>(caller_origin, issuer, receiver)
+ verify {
+ assert_has_event::<T, I>(Event::<T, I>::NewCert{ issuer: issuer, issuer_issued_count: issuer_cert + 1, receiver: receiver, receiver_received_count: receiver_cert + 1 }.into());
+ }
+ del_cert {
+ let issuer: T::IdtyIndex = 1.into();
+ let receiver: T::IdtyIndex = 0.into();
+ Pallet::<T, I>::force_add_cert(RawOrigin::Root.into(), issuer, receiver, false)?;
+ let receiver_cert: u32 = StorageIdtyCertMeta::<T, I>::get(receiver).received_count;
+ let issuer_cert: u32 = StorageIdtyCertMeta::<T, I>::get(issuer).issued_count;
+ }: _<T::RuntimeOrigin>(RawOrigin::Root.into(), issuer, receiver)
+ verify {
+ assert_has_event::<T, I>(Event::<T, I>::RemovedCert{ issuer: issuer, issuer_issued_count: issuer_cert - 1, receiver: receiver, receiver_received_count: receiver_cert - 1, expiration: false }.into());
+ }
+ remove_all_certs_received_by {
+ let receiver: T::IdtyIndex = 0.into();
+ let i in 2..1000 => add_certs::<T, I>(i, receiver)?;
+ }: _<T::RuntimeOrigin>(RawOrigin::Root.into(), receiver)
+ verify {
+ assert!(CertsByReceiver::<T, I>::get(receiver).len() == 0 );
+ }
+
+ impl_benchmark_test_suite!(
+ Pallet,
+ crate::mock::new_test_ext(crate::mock::DefaultCertificationConfig {
+ apply_cert_period_at_genesis: true,
+ certs_by_receiver: btreemap![
+ 0 => btreemap![
+ 1 => Some(7),
+ 2 => Some(9),
+ ],
+ 1 => btreemap![
+ 0 => Some(10),
+ 2 => Some(3),
+ ],
+ ] ,
+ }),
+ crate::mock::Test
+ );
+}
diff --git a/pallets/certification/src/lib.rs b/pallets/certification/src/lib.rs
index 7099ab19a..12d6852a0 100644
--- a/pallets/certification/src/lib.rs
+++ b/pallets/certification/src/lib.rs
@@ -16,6 +16,8 @@
#![cfg_attr(not(feature = "std"), no_std)]
+mod benchmarking;
+
pub mod traits;
mod types;
diff --git a/runtime/gdev/src/lib.rs b/runtime/gdev/src/lib.rs
index e8f0bf6a7..71f4bb92a 100644
--- a/runtime/gdev/src/lib.rs
+++ b/runtime/gdev/src/lib.rs
@@ -147,6 +147,8 @@ mod benches {
[common_runtime::provide_randomness, ProvideRandomness]
[common_runtime::upgrade_origin, UpgradeOrigin]
[common_runtime::duniter_account, Account]
+ [pallet_certification, Cert]
+ [pallet_certification, SmithsCert]
// Substrate
[pallet_balances, Balances]
[frame_benchmarking::baseline, Baseline::<Runtime>]
--
GitLab