Skip to main content

JumperBot

In a previous blog I described a simple echo bot, that echoes back anything you say to it. This time I will talk about a bot that generates traffic for the chat server, that can be used for load-testing both the chat server as well as any chat clients connected to it.
I've dubbed it JumperBot - it jumps between chat rooms, saying a few random phrases in each room, then jumping to the next one. This bot builds on the same framework as the EchoBot - refer to the previous blog if you are interested in the details. The source lives on GitHub: https://github.com/snorristurluson/xmpp-chatbot

Configure the server

In an earlier blog I described the setup of Prosody as the chat server to run against. Before we can connect bots to the server we have to make sure they can log in, either by creating accounts for them:
prosodyctl register jumperbot_0 localhost jumperbot
prosodyctl register jumperbot_1 localhost jumperbot
...
or by setting the authentication up so that anyone can log in.
We also need to enable multi-room chat - do this by adding this to the Prosody configuration file (near the bottom of the file, in the Components section):
Component "conference.localhost" "muc"

JumperBot

The Jumperbot is similar to the EchoBot, but rather than handling incoming messages we set up an asyncio task as this bot is proactive where the echo bot was reactive. The task is created when the connection is made:
    self.task = asyncio.get_event_loop().create_task(self.run())
The run method looks like this:
    async def run(self):
        while True:
            self.join_random_room()
            n = random.randint(5, 10)
            for i in range(n):
                if self.transport.is_closing():
                    return
                self.say_random_phrase()
                try:
                    await asyncio.sleep(random.random() * 10.0 + 5.0)
                except asyncio.CancelledError:
                    return
This implements the bot behavior as described above - joins a random room, says a few random phrases, then repeats the process in the next room. The asyncio.sleep command is very important - this allows other tasks to run concurrently with this loop.

BotManager

Running a single JumperBot doesn't really generate much traffic and rather than running multiple processes, let's make use of asyncio and create multiple bots as tasks. For that, we set up a BotManager to create and monitor bots:
    manager = BotManager()

    manager.create_bots(args)
    loop = asyncio.get_event_loop()

    loop.create_task(manager.monitor_status(args.monitor))
The bot manager looks like this:
class BotManager(object):
    def __init__(self):
        self.bots_running = {}
        self.bots_logged_in = {}
        self.args = None

    def create_bot(self, botname, args):
        bot = JumperBot(self, args.host_name, botname, "jumperbot",
                        args.num_rooms)
        if args.listener:
            bot.listener = True

        self.connect_bot(bot, args)

        return bot

    def connect_bot(self, bot, args):
        loop = asyncio.get_event_loop()
        handler = loop.create_connection(lambda: bot, args.server_name, 5222)
        loop.create_task(handler)

    def create_bots(self, args):
        self.args = args
        for i in range(args.num_bots):
            botname = "jumperbot_{0}".format(i)
            bot = self.create_bot(botname, args)
            self.bots_running[bot.username] = bot
Each bot is a protocol instance associated with its connection and gets a callback, data_received whenever something is received from the server. The bot also runs its own task for initiating its chattiness, as described above.
There is one more task - the monitor:
    async def monitor_status(self, display_stats):
        blinkers = [" ", ".", ":", "."]
        blinker_index = 0
        template = "{2} bots running, {3} logged in {4}"
        while True:
            await asyncio.sleep(1)
            if display_stats:
                print(template.format(
                    len(self.bots_running),
                    len(self.bots_logged_in),
                    blinkers[blinker_index]),
                    end="\r"
                )
            blinker_index += 1
            blinker_index %= len(blinkers)

            if len(self.bots_running) == 0:
                asyncio.get_event_loop().stop()
                return
If no bots are running, the loop is stopped.

Trying it out

The bots do their chatter in rooms named bot_room_0 through bot_room_9. Connect to the server with Swift (or your favorite chat client) and join one or more of those rooms to listen in. You can also run the jumperbot with a --verbose flag to see all the XMPP traffic in the log.

Popular posts from this blog

Waiting for an answer

I want to describe my first iteration of exsim, the core server for the large scale simulation I described in my last blog post. A Listener module opens a socket for listening to incoming connections. Once a connection is made, a process is spawned for handling the login and the listener continues listening for new connections. Once logged in, a Player is created, and a Solarsystem is started (if it hasn't already). The solar system also starts a PhysicsProxy, and the player starts a Ship. These are all GenServer processes. The source for this is up on GitHub: https://github.com/snorristurluson/exsim Player The player takes ownership of the TCP connection and handles communication with the game client (or bot). Incoming messages are parsed in handle_info/2 and handled by the player or routed to the ship, as appropriate. The player creates the ship in its init/1 function. The state for the player holds the ship and the name of the player. Ship The ship holds the state of the ship - …

Mnesia queries

I've added search and trim to my expiring records module in Erlang. This started out as an in-memory key/value store, that I then migrated over to using Mnesia and eventually to a replicated Mnesia table. The fetch/1 function is already doing a simple query, with match_object. Result=mnesia:match_object(expiring_records, #record{key=Key, value='_', expires_at='_'}, read) The three parameters there are the name of the table - expiring_records, the matching pattern and the lock type (read lock). The fetch/1 function looks up the key as it was added to the table with store/3. If the key is a tuple, we can also do a partial match: Result=mnesia:match_object(expiring_records, #record{key= {'_', "bongo"}, value='_', expires_at='_'}, read) I've added a search/1 function the module that takes in a matching pattern and returns a list of items where the key matches the pattern. Here's the test for the search/1 function: search_partial_…

Large scale ambitions

Learning new things is important for every developer. I've mentioned this before, and in the spirit of doing just that, I've started a somewhat ambitious project.

I want to do a large-scale simulation, using Elixir and Go, coupled with a physics simulation in C++. I've never done anything in Elixir before, and only played a little bit with Go, but I figure, how hard can it be?



Exsim I've dubbed this project exsim - it's a simulation done in Elixir. Someday I'll think about a more catchy name - for now I'm just focusing on the technical bits. Here's an overview of the system as I see it today:

exsim sits at the heart of it - this is the main server, implemented in Elixir. exsim-physics is the physics simulation. It is implemented in C++, using the Bullet physics library. exsim-physics-viewer is a simple viewer for the state of the physics simulation, written in Go. exsim-bot is a bot for testing exsim, written in Go. exsim-client is the game client, for inter…