Update mcstatus lib and refactor minecraft_ping.py

Author: linuxdaemon

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Refactor tests to remove dependency on mock library
 - Change link_announcer.py to only warn on connection errors
 - Change user lookup logic in last.fm plugin
+- Refactor minecraft_ping plugin for updated mcstatus library
 ### Fixed
 - Fix matching exception in horoscope test
 - Fix youtube.py ISO time parse

plugins/minecraft_ping.py

@@ -1,15 +1,35 @@
 import socket
 
 from mcstatus import MinecraftServer
+from mcstatus.pinger import PingResponse
 
 from cloudbot import hook
+from cloudbot.util import colors
 
-mc_colors = [('\xa7f', '\x0300'), ('\xa70', '\x0301'), ('\xa71', '\x0302'), ('\xa72', '\x0303'),
-             ('\xa7c', '\x0304'), ('\xa74', '\x0305'), ('\xa75', '\x0306'), ('\xa76', '\x0307'),
-             ('\xa7e', '\x0308'), ('\xa7a', '\x0309'), ('\xa73', '\x0310'), ('\xa7b', '\x0311'),
-             ('\xa71', '\x0312'), ('\xa7d', '\x0313'), ('\xa78', '\x0314'), ('\xa77', '\x0315'),
-             ('\xa7l', '\x02'), ('\xa79', '\x0310'), ('\xa7o', ''), ('\xa7m', '\x13'),
-             ('\xa7r', '\x0f'), ('\xa7n', '\x15')]
+mc_colors = [
+    ("\xa7f", "\x0300"),
+    ("\xa70", "\x0301"),
+    ("\xa71", "\x0302"),
+    ("\xa72", "\x0303"),
+    ("\xa7c", "\x0304"),
+    ("\xa74", "\x0305"),
+    ("\xa75", "\x0306"),
+    ("\xa76", "\x0307"),
+    ("\xa7e", "\x0308"),
+    ("\xa7a", "\x0309"),
+    ("\xa73", "\x0310"),
+    ("\xa7b", "\x0311"),
+    ("\xa71", "\x0312"),
+    ("\xa7d", "\x0313"),
+    ("\xa78", "\x0314"),
+    ("\xa77", "\x0315"),
+    ("\xa7l", "\x02"),
+    ("\xa79", "\x0310"),
+    ("\xa7o", ""),
+    ("\xa7m", "\x13"),
+    ("\xa7r", "\x0f"),
+    ("\xa7n", "\x15"),
+]
 
 
 def format_colors(description):
@@ -24,10 +44,10 @@ def mcping(text):
     try:
         server = MinecraftServer.lookup(text)
     except (IOError, ValueError) as e:
-        return e
+        return str(e)
 
     try:
-        s = server.status()
+        s = server.status()  # type: PingResponse
     except socket.gaierror:
         return "Invalid hostname"
     except socket.timeout:
@@ -44,13 +64,10 @@ def mcping(text):
     else:
         description = format_colors(" ".join(s.description.split()))
 
-    # I really hate people for putting colors IN THE VERSION
-    # WTF REALLY THIS IS A THING NOW?
+    output_format = colors.parse(
+        "{}$(clear) - $(bold){}$(clear) - $(bold){:.1f}ms$(clear) - $(bold){}/{}$(clear) players"
+    )
 
-    if s.latency:
-        return "{}\x0f - \x02{}\x0f - \x02{:.1f}ms\x02" \
-               " - \x02{}/{}\x02 players".format(description, s.version.name_clean, s.latency,
-                                                 s.players.online, s.players.max).replace("\n", "\x0f - ")
-    return "{}\x0f - \x02{}\x0f" \
-           " - \x02{}/{}\x02 players".format(description, s.version.name_clean,
-                                             s.players.online, s.players.max).replace("\n", "\x0f - ")
+    return output_format.format(
+        description, s.version.name, s.latency, s.players.online, s.players.max
+    ).replace("\n", colors.parse("$(clear) - "))

requirements.txt

@@ -3,7 +3,7 @@ cleverwrap==0.3.0.2
 feedparser==5.2.1
 forecastiopy==0.22
 geoip2==3.0.0
-git+https://github.com/CloudBotIRC/mcstatus.git@master
+mcstatus==3.1.0
 googlemaps==4.2.0
 imgurpython==1.1.7
 isodate==0.6.0

tests/plugin_tests/test_minecraft_ping.py

@@ -0,0 +1,79 @@
+import socket
+from unittest.mock import MagicMock, patch
+
+import mcstatus
+import pytest
+
+from plugins import minecraft_ping
+
+
+@pytest.fixture()
+def mock_mcserver():
+    with patch.object(mcstatus.MinecraftServer, "lookup") as mock:
+        yield mock
+
+
+def test_mcping(mock_mcserver):
+    mock_mcserver.return_value = server = MagicMock()
+    server.status.return_value = status = MagicMock()
+    status.version.name = "1.12.2"
+    status.latency = 12.345
+    status.players.online = 2
+    status.players.max = 10
+    status.description = {"text": "A description"}
+    res = minecraft_ping.mcping("host.invalid")
+    assert (
+        res
+        == "A description\x0f - \x021.12.2\x0f - \x0212.3ms\x0f - \x022/10\x0f players"
+    )
+
+
+def test_mcping_text(mock_mcserver):
+    mock_mcserver.return_value = server = MagicMock()
+    server.status.return_value = status = MagicMock()
+    status.version.name = "1.12.2"
+    status.latency = 12.345
+    status.players.online = 2
+    status.players.max = 10
+    status.description = "A description"
+    res = minecraft_ping.mcping("host.invalid")
+    assert (
+        res
+        == "A description\x0f - \x021.12.2\x0f - \x0212.3ms\x0f - \x022/10\x0f players"
+    )
+
+
+@pytest.mark.parametrize(
+    "error,reply",
+    [
+        (IOError("Some IOError"), "Some IOError"),
+        (ValueError("Some other ValueError"), "Some other ValueError"),
+    ],
+)
+def test_mcping_lookup_errors(error, reply, mock_mcserver):
+    mock_mcserver.side_effect = error
+    res = minecraft_ping.mcping("host.invalid")
+
+    assert res == reply
+
+
+@pytest.mark.parametrize(
+    "error,reply",
+    [
+        (socket.gaierror(2, "Foo"), "Invalid hostname"),
+        (socket.timeout(), "Request timed out"),
+        (ConnectionRefusedError(), "Connection refused"),
+        (ConnectionError(), "Connection error"),
+        (IOError("Some IOError"), "Error pinging server: Some IOError"),
+        (
+            ValueError("Some other ValueError"),
+            "Error pinging server: Some other ValueError",
+        ),
+    ],
+)
+def test_mcping_status_errors(error, reply, mock_mcserver):
+    mock_mcserver.return_value = server = MagicMock()
+    server.status.side_effect = error
+    res = minecraft_ping.mcping("host.invalid")
+
+    assert res == reply