Add unit tests for fishbans. These /probably/ work :)

Author: dmptrluke

plugins/fishbans.py

@@ -1,26 +1,22 @@
 from urllib.parse import quote_plus
-import asyncio
 
 import requests
 import requests.exceptions
-import functools
 
 from cloudbot import hook
 from cloudbot.util import formatting
 
 api_url = "http://api.fishbans.com/stats/{}/"
 
 
-@asyncio.coroutine
 @hook.command("bans", "fishbans")
-def fishbans(text, bot, loop):
+def fishbans(text, bot):
     """<user> - gets information on <user>'s minecraft bans from fishbans"""
     user = text.strip()
     headers = {'User-Agent': bot.user_agent}
 
     try:
-        _func = functools.partial(requests.get, api_url.format(quote_plus(user)), headers=headers)
-        request = yield from loop.run_in_executor(None, _func)
+        request = requests.get(api_url.format(quote_plus(user)), headers=headers)
         request.raise_for_status()
     except (requests.exceptions.HTTPError, requests.exceptions.ConnectionError) as e:
         return "Could not fetch ban data from the Fishbans API: {}".format(e)
@@ -44,16 +40,14 @@ def fishbans(text, bot, loop):
         return "The user \x02{}\x02 has no bans - {}".format(user, user_url)
 
 
-@asyncio.coroutine
 @hook.command()
-def bancount(text, bot, loop):
+def bancount(text, bot):
     """<user> - gets a count of <user>'s minecraft bans from fishbans"""
     user = text.strip()
     headers = {'User-Agent': bot.user_agent}
 
     try:
-        _func = functools.partial(requests.get, api_url.format(quote_plus(user)), headers=headers)
-        request = yield from loop.run_in_executor(None, _func)
+        request = requests.get(api_url.format(quote_plus(user)), headers=headers)
         request.raise_for_status()
     except (requests.exceptions.HTTPError, requests.exceptions.ConnectionError) as e:
         return "Could not fetch ban data from the Fishbans API: {}".format(e)
@@ -63,6 +57,9 @@ def bancount(text, bot, loop):
     except ValueError:
         return "Could not fetch ban data from the Fishbans API: Invalid Response"
 
+    if not json["success"]:
+        return "Could not fetch ban data for {}.".format(user)
+
     user_url = "http://fishbans.com/u/{}/".format(user)
     services = json["stats"]["service"]
 

plugins/test/test_fishbans.py

@@ -1 +1,123 @@
-__author__ = 'Luke'
+import httpretty
+import pytest
+
+from plugins.fishbans import fishbans, bancount
+
+test_user = "notch"
+
+test_api = """
+{"success":true,"stats":{"username":"notch","uuid":"069a79f444e94726a5befca90e38aaf5","totalbans":11,"service":{"mcbans":0,"mcbouncer":11,"mcblockit":0,"minebans":0,"glizer":0}}}
+"""
+test_api_single = """
+{"success":true,"stats":{"username":"notch","uuid":"069a79f444e94726a5befca90e38aaf5","totalbans":1,"service":{"mcbans":0,"mcbouncer":1,"mcblockit":0,"minebans":0,"glizer":0}}}
+"""
+test_api_none = """
+{"success":true,"stats":{"username":"notch","uuid":"069a79f444e94726a5befca90e38aaf5","totalbans":0,"service":{"mcbans":0,"mcbouncer":0,"mcblockit":0,"minebans":0,"glizer":0}}}
+"""
+test_api_failed = """
+{"success":false}
+"""
+
+bans_reply = "The user \x02notch\x02 has \x0211\x02 bans - http://fishbans.com/u/notch/"
+count_reply = "Bans for \x02notch\x02: mcbouncer: \x0211\x02 - http://fishbans.com/u/notch/"
+
+bans_reply_single = "The user \x02notch\x02 has \x021\x02 ban - http://fishbans.com/u/notch/"
+
+bans_reply_none = "The user \x02notch\x02 has no bans - http://fishbans.com/u/notch/"
+count_reply_none = "The user \x02notch\x02 has no bans - http://fishbans.com/u/notch/"
+
+reply_failed = "Could not fetch ban data for notch."
+reply_error = "Could not fetch ban data from the Fishbans API: 404 Client Error: Not Found"
+
+
+class DummyBot():
+    user_agent = "CloudBot/3.0"
+
+
+@pytest.mark.httpretty
+def test_bans():
+    """
+    tests fishbans with a successful API response having multiple bans
+    """
+    httpretty.register_uri(httpretty.GET, 'http://api.fishbans.com/stats/notch/', body=test_api)
+
+    assert fishbans(test_user, DummyBot) == bans_reply
+
+
+@pytest.mark.httpretty
+def test_bans_single():
+    """
+    tests fishbans with a successful API response having a single ban
+    """
+    httpretty.register_uri(httpretty.GET, 'http://api.fishbans.com/stats/notch/', body=test_api_single)
+
+    assert fishbans(test_user, DummyBot) == bans_reply_single
+
+@pytest.mark.httpretty
+def test_bans_failed():
+    """
+    tests fishbans with a failed API response
+    """
+    httpretty.register_uri(httpretty.GET, 'http://api.fishbans.com/stats/notch/', body=test_api_failed)
+
+    assert fishbans(test_user, DummyBot) == reply_failed
+
+
+@pytest.mark.httpretty
+def test_bans_none():
+    """
+    tests fishbans with a successful API response having no bans
+    """
+    httpretty.register_uri(httpretty.GET, 'http://api.fishbans.com/stats/notch/', body=test_api_none)
+
+    assert fishbans(test_user, DummyBot) == bans_reply_none
+
+
+@pytest.mark.httpretty
+def test_bans_error():
+    """
+    tests fishbans with a HTTP error
+    """
+    httpretty.register_uri(httpretty.GET, 'http://api.fishbans.com/stats/notch/', status=404)
+
+    assert fishbans(test_user, DummyBot) == reply_error
+
+
+@pytest.mark.httpretty
+def test_count():
+    """
+    tests bancount with a successful API response having multiple bans
+    """
+    httpretty.register_uri(httpretty.GET, 'http://api.fishbans.com/stats/notch/', body=test_api)
+
+    assert bancount(test_user, DummyBot) == count_reply
+
+
+@pytest.mark.httpretty
+def test_count_failed():
+    """
+    tests bancount with a failed API response
+    """
+    httpretty.register_uri(httpretty.GET, 'http://api.fishbans.com/stats/notch/', body=test_api_failed)
+
+    assert bancount(test_user, DummyBot) == reply_failed
+
+
+@pytest.mark.httpretty
+def test_count_none():
+    """
+    tests bancount with a successful API response having no bans
+    """
+    httpretty.register_uri(httpretty.GET, 'http://api.fishbans.com/stats/notch/', body=test_api_none)
+
+    assert bancount(test_user, DummyBot) == count_reply_none
+
+
+@pytest.mark.httpretty
+def test_count_error():
+    """
+    tests bancount with a HTTP error
+    """
+    httpretty.register_uri(httpretty.GET, 'http://api.fishbans.com/stats/notch/', status=404)
+
+    assert bancount(test_user, DummyBot) == reply_error

travis/requirements.txt

@@ -1,5 +1,7 @@
 pytest
+httpretty
 pytest-cov
 pytest-pep8
+pytest-httpretty
 flake8
 python-coveralls