zulip/api/bots/virtual_fs/test_virtual_fs.py

#!/usr/bin/env python

from __future__ import absolute_import
from __future__ import print_function

import os
import sys

our_dir = os.path.dirname(os.path.abspath(__file__))
sys.path.insert(0, os.path.normpath(os.path.join(our_dir)))
# For dev setups, we can find the API in the repo itself.
if os.path.exists(os.path.join(our_dir, '..')):
    sys.path.insert(0, '..')
from bots_test_lib import BotTestCase

class TestVirtualFsBot(BotTestCase):
    bot_name = "virtual_fs"

    def test_bot(self):
        self.assert_bot_output(
            {'content': "cd /home", 'type': "private", 'display_recipient': "foo", 'sender_email': "foo_sender@zulip.com"},
            "foo_sender@zulip.com:\nERROR: invalid path"
        )
        self.assert_bot_output(
            {'content': "mkdir home", 'type': "stream", 'display_recipient': "foo", 'subject': "foo", 'sender_email': "foo_sender@zulip.com"},
            "foo_sender@zulip.com:\ndirectory created"
        )
        self.assert_bot_output(
            {'content': "pwd", 'type': "stream", 'display_recipient': "foo", 'subject': "foo", 'sender_email': "foo_sender@zulip.com"},
            "foo_sender@zulip.com:\n/"
        )
        self.assert_bot_output(
            {'content': "help", 'type': "stream", 'display_recipient': "foo", 'subject': "foo", 'sender_email': "foo_sender@zulip.com"},
            ('foo_sender@zulip.com:\n\nThis bot implements a virtual file system for a stream.\n'
             'The locations of text are persisted for the lifetime of the bot\n'
             'running, and if you rename a stream, you will lose the info.\n'
             'Example commands:\n\n```\n'
             '@mention-bot sample_conversation: sample conversation with the bot\n'
             '@mention-bot mkdir: create a directory\n'
             '@mention-bot ls: list a directory\n'
             '@mention-bot cd: change directory\n'
             '@mention-bot pwd: show current path\n'
             '@mention-bot write: write text\n'
             '@mention-bot read: read text\n'
             '@mention-bot rm: remove a file\n'
             '@mention-bot rmdir: remove a directory\n'
             '```\n'
             'Use commands like `@mention-bot help write` for more details on specific\ncommands.\n'),
        )
        self.assert_bot_output(
            {'content': "help ls", 'type': "stream", 'display_recipient': "foo", 'subject': "foo", 'sender_email': "foo_sender@zulip.com"},
            "foo_sender@zulip.com:\nsyntax: ls <optional_path>"
        )
        self.assert_bot_output(
            {'content': "", 'type': "stream", 'display_recipient': "foo", 'subject': "foo", 'sender_email': "foo_sender@zulip.com"},
            ('foo_sender@zulip.com:\n\nThis bot implements a virtual file system for a stream.\n'
             'The locations of text are persisted for the lifetime of the bot\n'
             'running, and if you rename a stream, you will lose the info.\n'
             'Example commands:\n\n```\n'
             '@mention-bot sample_conversation: sample conversation with the bot\n'
             '@mention-bot mkdir: create a directory\n'
             '@mention-bot ls: list a directory\n'
             '@mention-bot cd: change directory\n'
             '@mention-bot pwd: show current path\n'
             '@mention-bot write: write text\n'
             '@mention-bot read: read text\n'
             '@mention-bot rm: remove a file\n'
             '@mention-bot rmdir: remove a directory\n'
             '```\n'
             'Use commands like `@mention-bot help write` for more details on specific\ncommands.\n'),
        )