pezkuwi-sdk/bizinikiwi/pezframe/society/src/mock.rs

// This file is part of Bizinikiwi.

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

//! Test utilities

use super::*;
use crate as pezpallet_society;

use pezframe_support::{
	assert_noop, assert_ok, derive_impl, ord_parameter_types, parameter_types,
	traits::{ConstU32, ConstU64},
};
use pezframe_support_test::TestRandomness;
use pezframe_system::EnsureSignedBy;
use pezsp_runtime::{traits::IdentityLookup, BuildStorage};

use RuntimeOrigin as Origin;

type Block = pezframe_system::mocking::MockBlock<Test>;

pezframe_support::construct_runtime!(
	pub enum Test
	{
		System: pezframe_system,
		Balances: pezpallet_balances,
		Society: pezpallet_society,
	}
);

parameter_types! {
	pub const SocietyPalletId: PalletId = PalletId(*b"py/socie");
}

ord_parameter_types! {
	pub const ChallengePeriod: u64 = 8;
	pub const ClaimPeriod: u64 = 1;
	pub const VotingPeriod: u64 = 3;
	pub const FounderSetAccount: u128 = 1;
	pub const SuspensionJudgementSetAccount: u128 = 2;
	pub const MaxPayouts: u32 = 10;
	pub const MaxBids: u32 = 10;
}

#[derive_impl(pezframe_system::config_preludes::TestDefaultConfig)]
impl pezframe_system::Config for Test {
	type AccountId = u128;
	type Block = Block;
	type AccountData = pezpallet_balances::AccountData<u64>;
	type Lookup = IdentityLookup<Self::AccountId>;
}

#[derive_impl(pezpallet_balances::config_preludes::TestDefaultConfig)]
impl pezpallet_balances::Config for Test {
	type ReserveIdentifier = [u8; 8];
	type AccountStore = System;
}

impl Config for Test {
	type RuntimeEvent = RuntimeEvent;
	type PalletId = SocietyPalletId;
	type Currency = pezpallet_balances::Pezpallet<Self>;
	type Randomness = TestRandomness<Self>;
	type GraceStrikes = ConstU32<1>;
	type PeriodSpend = ConstU64<1000>;
	type VotingPeriod = VotingPeriod;
	type ClaimPeriod = ClaimPeriod;
	type MaxLockDuration = ConstU64<100>;
	type FounderSetOrigin = EnsureSignedBy<FounderSetAccount, u128>;
	type ChallengePeriod = ChallengePeriod;
	type MaxPayouts = MaxPayouts;
	type MaxBids = MaxBids;
	type WeightInfo = ();
	type BlockNumberProvider = System;
}

pub struct EnvBuilder {
	balance: u64,
	balances: Vec<(u128, u64)>,
	pot: u64,
	founded: bool,
}

impl EnvBuilder {
	pub fn new() -> Self {
		Self {
			balance: 10_000,
			balances: vec![
				(10, 50),
				(20, 50),
				(30, 50),
				(40, 50),
				(50, 50),
				(60, 50),
				(70, 50),
				(80, 50),
				(90, 50),
			],
			pot: 0,
			founded: true,
		}
	}

	pub fn execute<R, F: FnOnce() -> R>(mut self, f: F) -> R {
		let mut t = pezframe_system::GenesisConfig::<Test>::default().build_storage().unwrap();
		self.balances.push((Society::account_id(), self.balance.max(self.pot)));
		pezpallet_balances::GenesisConfig::<Test> { balances: self.balances, ..Default::default() }
			.assimilate_storage(&mut t)
			.unwrap();
		pezpallet_society::GenesisConfig::<Test> { pot: self.pot }
			.assimilate_storage(&mut t)
			.unwrap();
		let mut ext: pezsp_io::TestExternalities = t.into();
		ext.execute_with(|| {
			// Initialize the block number to 1 for event registration
			System::set_block_number(1);
			if self.founded {
				let r = b"be cool".to_vec();
				assert!(Society::found_society(Origin::signed(1), 10, 10, 8, 2, 25, r).is_ok());
			}
			let r = f();
			migrations::assert_internal_consistency::<Test, ()>();
			r
		})
	}
	pub fn founded(mut self, f: bool) -> Self {
		self.founded = f;
		self
	}
}

/// Creates a bid struct using input parameters.
pub fn bid<AccountId, Balance>(
	who: AccountId,
	kind: BidKind<AccountId, Balance>,
	value: Balance,
) -> Bid<AccountId, Balance> {
	Bid { who, kind, value }
}

/// Creates a candidate struct using input parameters.
pub fn candidacy<AccountId, Balance>(
	round: RoundIndex,
	bid: Balance,
	kind: BidKind<AccountId, Balance>,
	approvals: VoteCount,
	rejections: VoteCount,
) -> Candidacy<AccountId, Balance> {
	Candidacy { round, kind, bid, tally: Tally { approvals, rejections }, skeptic_struck: false }
}

pub fn next_challenge() {
	let challenge_period: u64 = <Test as Config>::ChallengePeriod::get();
	let now = System::block_number();
	System::run_to_block::<AllPalletsWithSystem>(now + challenge_period - now % challenge_period);
}

pub fn next_voting() {
	if let Period::Voting { more, .. } = Society::period() {
		System::run_to_block::<AllPalletsWithSystem>(System::block_number() + more);
	}
}

pub fn conclude_intake(allow_resignation: bool, judge_intake: Option<bool>) {
	next_voting();
	let round = RoundCount::<Test>::get();
	for (who, candidacy) in Candidates::<Test>::iter() {
		if candidacy.tally.clear_approval() {
			assert_ok!(Society::claim_membership(Origin::signed(who)));
			assert_noop!(
				Society::claim_membership(Origin::signed(who)),
				Error::<Test>::NotCandidate
			);
			continue;
		}
		if candidacy.tally.clear_rejection() && allow_resignation {
			assert_noop!(
				Society::claim_membership(Origin::signed(who)),
				Error::<Test>::NotApproved
			);
			assert_ok!(Society::resign_candidacy(Origin::signed(who)));
			continue;
		}
		if let (Some(founder), Some(approve)) = (Founder::<Test>::get(), judge_intake) {
			if !candidacy.tally.clear_approval() && !approve {
				// can be rejected by founder
				assert_ok!(Society::kick_candidate(Origin::signed(founder), who));
				continue;
			}
			if !candidacy.tally.clear_rejection() && approve {
				// can be rejected by founder
				assert_ok!(Society::bestow_membership(Origin::signed(founder), who));
				continue;
			}
		}
		if candidacy.tally.clear_rejection() && round > candidacy.round + 1 {
			assert_noop!(
				Society::claim_membership(Origin::signed(who)),
				Error::<Test>::NotApproved
			);
			assert_ok!(Society::drop_candidate(Origin::signed(0), who));
			assert_noop!(
				Society::drop_candidate(Origin::signed(0), who),
				Error::<Test>::NotCandidate
			);
			continue;
		}
		if !candidacy.skeptic_struck {
			assert_ok!(Society::punish_skeptic(Origin::signed(who)));
		}
	}
}

pub fn next_intake() {
	let claim_period: u64 = <Test as Config>::ClaimPeriod::get();
	match Society::period() {
		Period::Voting { more, .. } => System::run_to_block::<AllPalletsWithSystem>(
			System::block_number() + more + claim_period,
		),
		Period::Claim { more, .. } =>
			System::run_to_block::<AllPalletsWithSystem>(System::block_number() + more),
		Period::Intake { .. } => {},
	}
}

pub fn place_members(members: impl AsRef<[u128]>) {
	for who in members.as_ref() {
		assert_ok!(Society::insert_member(who, 0));
	}
}

pub fn members() -> Vec<u128> {
	let mut r = Members::<Test>::iter_keys().collect::<Vec<_>>();
	r.sort();
	r
}

pub fn membership() -> Vec<(u128, MemberRecord)> {
	let mut r = Members::<Test>::iter().collect::<Vec<_>>();
	r.sort_by_key(|x| x.0);
	r
}

pub fn candidacies() -> Vec<(u128, Candidacy<u128, u64>)> {
	let mut r = Candidates::<Test>::iter().collect::<Vec<_>>();
	r.sort_by_key(|x| x.0);
	r
}

pub fn candidates() -> Vec<u128> {
	let mut r = Candidates::<Test>::iter_keys().collect::<Vec<_>>();
	r.sort();
	r
}