Ivan Boldyrev 4e86da7eda
feat(testing-framework): Testing framework major refactoring (#372)
1. Network can be shared between several execution, being used by an Rc-handle.
2. The neighborhood is just network's all peers with removed/inserted hosts delta with respect to network.
3. An AIR script is transformed into a separate value of type `TransformedAirScript`.  It allows running several
particles on the same parsed AIR script, sharing state.
4. `TestExecutor` was renamed to `AirScriptExecutor`.  It also has a constructor that accepts a `TransformedAirScript`.
2022-11-24 23:33:55 +07:00

117 lines
3.5 KiB
Rust

/*
* Copyright 2022 Fluence Labs Limited
*
* 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.
*/
use crate::ephemeral::{Data, Network, PeerId};
use air_test_utils::{test_runner::TestRunParameters, RawAVMOutcome};
use std::{
borrow::Borrow,
cell::RefCell,
collections::{HashMap, VecDeque},
hash::Hash,
ops::Deref,
rc::Rc,
};
#[derive(Debug, Default)]
pub(crate) struct PeerQueueCell {
queue: RefCell<VecDeque<Data>>,
data: RefCell<Data>,
}
impl PeerQueueCell {
pub(crate) fn pop_data(&self) -> Option<Data> {
let mut cell_ref = self.queue.borrow_mut();
cell_ref.pop_front()
}
pub(crate) fn push_data(&self, data: Data) {
let mut cell_ref = self.queue.borrow_mut();
cell_ref.push_back(data);
}
pub(crate) fn take_prev_data(&self) -> Data {
let cell_ref = self.data.borrow_mut();
(*cell_ref).clone()
}
pub(crate) fn set_prev_data(&self, data: Data) {
let mut cell_ref = self.data.borrow_mut();
*cell_ref = data;
}
}
/// Per-particle message queue.
#[derive(Debug, Clone, Default)]
// TODO make it pub(crate) and see what is broken
pub(crate) struct ExecutionQueue {
queues: Rc<RefCell<HashMap<PeerId, Rc<PeerQueueCell>>>>,
}
impl ExecutionQueue {
pub(crate) fn new() -> Self {
Default::default()
}
pub(crate) fn get_peer_queue_cell(&self, peer_id: PeerId) -> Rc<PeerQueueCell> {
let mut queues_ref = RefCell::borrow_mut(&self.queues);
queues_ref.entry(peer_id).or_default().clone()
}
/// Iterator for handling al the queued data. It borrows peer env's `RefCell` only temporarily.
/// Following test-utils' call_vm macro, it panics on failed VM.
pub fn execution_iter<'ctx, Id>(
&'ctx self,
air: &'ctx str,
network: Rc<Network>,
test_parameters: &'ctx TestRunParameters,
peer_id: &Id,
) -> Option<impl Iterator<Item = RawAVMOutcome> + 'ctx>
where
PeerId: Borrow<Id>,
Id: Eq + Hash + ?Sized,
{
let peer_env = network.get_peer_env(peer_id);
peer_env.map(|peer_env_cell| {
std::iter::from_fn(move || {
let mut peer_env = peer_env_cell.borrow_mut();
peer_env
.execute_once(air, &network, self, test_parameters)
.map(|r| r.unwrap_or_else(|err| panic!("VM call failed: {}", err)))
})
})
}
pub fn distribute_to_peers<Id>(&self, network: &Network, peers: &[Id], data: &Data)
where
Id: Deref<Target = str>,
{
for peer_id in peers {
let peer_id: &str = peer_id;
match network.get_peer_env::<str>(peer_id) {
Some(peer_env_cell) => {
let peer_env_ref = RefCell::borrow(&peer_env_cell);
self.get_peer_queue_cell(peer_env_ref.peer.peer_id.clone())
.push_data(data.clone());
}
None => panic!("Unknown peer"),
}
}
}
}