Struct ScriptedUser 

pub struct ScriptedUser { /* private fields */ }

A user for tests, who answers every prompt from a script

ScriptedUser reads the events of a command in place of a presenter. It answers each prompt with the next answer of its script, and it uses each answer once.

A prompt fails with AnswerPromptError::UnscriptedPrompt when the script has ended, and when the next answer is for another kind of prompt. That answer is used up as well.

Build the Context or the Prompt of the test with Interactivity::Interactive. Otherwise the prompt fails before it sends a request.

Examples

use clawless_core::context::Interactivity;
use clawless_core::event::event_channel;
use clawless_core::output::Output;
use clawless_core::prompt::{Confirmation, Prompt, ScriptedAnswer, ScriptedUser};

let (sender, receiver) = event_channel();
let user = ScriptedUser::new([ScriptedAnswer::Confirm(Confirmation::Yes)]);
tokio::spawn(user.attend(receiver));

let prompt = Prompt::builder()
    .output(Output::new(sender))
    .interactivity(Interactivity::Interactive)
    .build();

let answer = prompt.confirm("Delete the branch?").await.expect("should answer");

assert_eq!(answer, Confirmation::Yes);

Implementations

impl ScriptedUser

pub fn new(answers: impl IntoIterator<Item = ScriptedAnswer>) -> Self

Creates a user who gives the answers in the order of the script

Examples

use clawless_core::prompt::{Confirmation, ScriptedAnswer, ScriptedUser};

let user = ScriptedUser::new([
    ScriptedAnswer::Confirm(Confirmation::Yes),
    ScriptedAnswer::Confirm(Confirmation::No),
]);

pub async fn attend(self, receiver: EventReceiver) -> Vec<Event>

Reads the events of a command and answers its prompts, until the command is done

The call returns when the channel closes, which happens when the command drops its output. It returns every event that was not a prompt, in the order of arrival.

Run this in a task of its own, because the command waits for each answer.

Trait Implementations

impl Clone for ScriptedUser

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScriptedUser

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScriptedUser

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ScriptedUser

impl Hash for ScriptedUser

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ScriptedUser

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ScriptedUser