Refactoring Checkpoint: (WIP)

pezcumulus/pezpallets/dmp-queue/src/benchmarking.rs

@@ -0,0 +1,108 @@
+// 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.
+
+//! Benchmarking for the `pezcumulus-pezpallet-dmp-queue`.
+
+#![cfg(feature = "runtime-benchmarks")]
+
+use crate::*;
+
+use alloc::vec;
+use pezframe_benchmarking::v2::*;
+use pezframe_support::{pezpallet_prelude::*, traits::Hooks};
+
+#[benchmarks]
+mod benchmarks {
+	use super::*;
+
+	/// This benchmark uses the proper maximal message length.
+	#[benchmark]
+	fn on_idle_good_msg() {
+		let msg = vec![123; MaxDmpMessageLenOf::<T>::get() as usize];
+
+		Pages::<T>::insert(0, vec![(123, msg.clone())]);
+		PageIndex::<T>::put(PageIndexData { begin_used: 0, end_used: 1, overweight_count: 0 });
+		MigrationStatus::<T>::set(MigrationState::StartedExport { next_begin_used: 0 });
+
+		#[block]
+		{
+			Pallet::<T>::on_idle(0u32.into(), Weight::MAX);
+		}
+
+		assert_last_event::<T>(Event::Exported { page: 0 }.into());
+	}
+
+	/// This benchmark uses 64 KiB messages to emulate a large old message.
+	#[benchmark]
+	fn on_idle_large_msg() {
+		let msg = vec![123; 1 << 16];
+
+		Pages::<T>::insert(0, vec![(123, msg.clone())]);
+		PageIndex::<T>::put(PageIndexData { begin_used: 0, end_used: 1, overweight_count: 0 });
+		MigrationStatus::<T>::set(MigrationState::StartedExport { next_begin_used: 0 });
+
+		#[block]
+		{
+			Pallet::<T>::on_idle(0u32.into(), Weight::MAX);
+		}
+
+		assert_last_event::<T>(Event::Exported { page: 0 }.into());
+	}
+
+	#[benchmark]
+	fn on_idle_overweight_good_msg() {
+		let msg = vec![123; MaxDmpMessageLenOf::<T>::get() as usize];
+
+		Overweight::<T>::insert(0, (123, msg.clone()));
+		PageIndex::<T>::put(PageIndexData { begin_used: 0, end_used: 1, overweight_count: 1 });
+		MigrationStatus::<T>::set(MigrationState::StartedOverweightExport {
+			next_overweight_index: 0,
+		});
+
+		#[block]
+		{
+			Pallet::<T>::on_idle(0u32.into(), Weight::MAX);
+		}
+
+		assert_last_event::<T>(Event::ExportedOverweight { index: 0 }.into());
+	}
+
+	#[benchmark]
+	fn on_idle_overweight_large_msg() {
+		let msg = vec![123; 1 << 16];
+
+		Overweight::<T>::insert(0, (123, msg.clone()));
+		PageIndex::<T>::put(PageIndexData { begin_used: 0, end_used: 1, overweight_count: 1 });
+		MigrationStatus::<T>::set(MigrationState::StartedOverweightExport {
+			next_overweight_index: 0,
+		});
+
+		#[block]
+		{
+			Pallet::<T>::on_idle(0u32.into(), Weight::MAX);
+		}
+
+		assert_last_event::<T>(Event::ExportOverweightFailed { index: 0 }.into());
+	}
+
+	impl_benchmark_test_suite!(Pallet, crate::mock::new_test_ext(), crate::mock::Runtime);
+}
+
+fn assert_last_event<T: Config>(generic_event: <T as Config>::RuntimeEvent) {
+	let events = pezframe_system::Pallet::<T>::events();
+	let system_event: <T as pezframe_system::Config>::RuntimeEvent = generic_event.into();
+	let pezframe_system::EventRecord { event, .. } = events.last().expect("Event expected");
+	assert_eq!(event, &system_event.into());
+}