Crate teloxide_tests

Expand description

This crate aims to make a mocked bot for unit testing teloxide bots with an actual fake server!

[examples/hello_world]

use teloxide::{
    dispatching::{UpdateFilterExt, UpdateHandler},
    prelude::*,
};

type HandlerResult = Result<(), Box<dyn std::error::Error + Send + Sync>>;

async fn hello_world(bot: Bot, message: Message) -> HandlerResult {
    bot.send_message(message.chat.id, "Hello World!").await?;
    Ok(())
}

fn handler_tree() -> UpdateHandler<Box<dyn std::error::Error + Send + Sync + 'static>> {
    dptree::entry().branch(Update::filter_message().endpoint(hello_world))
}

#[tokio::main]
async fn main() {  // A regular bot dispatch
    dotenv::dotenv().ok();
    let bot = Bot::from_env();
    Dispatcher::builder(bot, handler_tree())
        .enable_ctrlc_handler()
        .build()
        .dispatch()
        .await;
}

#[cfg(test)]
mod tests {
    use super::*;
    use teloxide_tests::{MockBot, MockMessageText};

    #[tokio::test]
    async fn test_hello_world() {  // A testing bot dispatch
        let bot = MockBot::new(MockMessageText::new().text("Hi!"), handler_tree());
        bot.dispatch().await;
        let message = bot.get_responses().sent_messages.last().unwrap();
        // This is a regular teloxide::types::Message!
        assert_eq!(message.text(), Some("Hello World!"));
    }
}

To run the tests, just run cargo test in the terminal! It’s that easy! No internet connection required!

I haven’t seen telegram bot testing tools that are up to my standards (for any bot api wrapper, not just teloxide), so I decided to write this. This crate tries to give as much tooling for testing as reasonably possible, while keeping it simple to work with and implement. The goal of this crate is to test most of the teloxide and telegram features. This crate is not yet complete, but you still can use it for what it has!

§Supported Endpoints

/AnswerCallbackQuery
/DeleteMessage
/EditMessageText
/EditMessageReplyMarkup
/EditMessageCaption
/GetFile
/SendMessage
/SendDocument
/SendPhoto
/SendVideo
/SendAudio
/SendVoice
/SendVideoNote
/SendAnimation
/SendLocation
/SendVenue
/SendContact
/SendDice
/SendPoll
/SendSticker
/SendChatAction
/SendMediaGroup
/PinChatMessage
/UnpinChatMessage
/UnpinAllChatMessages
/ForwardMessage
/CopyMessage
/BanChatMember
/UnbanChatMember
/RestrictChatMember

More endpoints will be added as time goes on!

(do not worry about /GetMe and /GetUpdates, they are not needed for this bot!)

And also fake file downloading!

§Why even use unit tests?

I’ve always found manual bot testing to be very time consuming and unreliable, especially when the bot becomes large and very complex. This crate can solve this problem!

As an example, here is a bot that i did not run once before i have written all of the code: examples/phrase_bot
(dont forget to read the README.md in the examples directory!)

§Other

If you see something that works in teloxide, but doesn’t work in this crate, while it should (a missing endpoint doesn’t qualify as a bug), please open an issue on the GitHub repo! All feedback and suggestions are very welcome! Or you can write to the @teloxide_tests group!

And huge thanks to the teloxide team, their code was amazing to work with! Without all of the code comments, i would’ve gone insane. The crate itself is also just amazing!

To start, i recommend you look at the [examples github] folder

Or MockBot struct documentation

The only thing you need to change in your existing bots is to shift your dptree (handler tree) to some function, because the sole reason for this crates existance is to test that tree, and we need easy access to it! Just follow the examples!

And try to not use the raw bot fields unless you know what you are doing! They are public only to give more options to those who seek it.

§!!! IMPORTANT !!!

If you want to use the database or something that is shared across all tests, DO IT AFTER THE MockBot::new()!!!!! The creation of the bot creates a safe lock that prevents other tests from starting, before this bot becomes out of scope. If you encounter issues regarding this, try to manually add drop(bot); at the end of your tests! Or use the serial_test crate

Please refer to the phrase_bot example for more information

Re-exports§

pub use mock_bot::MockBot;

Modules§

chat
message
message_common
mock_bot: Mock bot that sends requests to the fake server
queries

Structs§

Traits§

IntoUpdate

Crate teloxide_testsCopy item path