Merge pull request #1757 from dbcli/RW/add-special-utils-tests

Add unit tests for `mycli/packages/special/utils.py`

Author: rolandwalker

test/pytests/test_dbspecial.py

@@ -4,7 +4,6 @@
 
 from mycli.packages.completion_engine import suggest_type
 from mycli.packages.special.dbcommands import list_tables
-from mycli.packages.special.utils import format_uptime
 from test.pytests.test_completion_engine import sorted_dicts
 
 
@@ -83,20 +82,3 @@ def test_describe_table():
 def test_list_or_show_create_tables():
     suggestions = suggest_type("\\dt+", "\\dt+ ")
     assert sorted_dicts(suggestions) == sorted_dicts([{"type": "table", "schema": []}, {"type": "view", "schema": []}, {"type": "schema"}])
-
-
-def test_format_uptime():
-    seconds = 59
-    assert "59 sec" == format_uptime(seconds)
-
-    seconds = 120
-    assert "2 min 0 sec" == format_uptime(seconds)
-
-    seconds = 54890
-    assert "15 hours 14 min 50 sec" == format_uptime(seconds)
-
-    seconds = 598244
-    assert "6 days 22 hours 10 min 44 sec" == format_uptime(seconds)
-
-    seconds = 522600
-    assert "6 days 1 hour 10 min 0 sec" == format_uptime(seconds)

test/pytests/test_special_utils.py

@@ -0,0 +1,187 @@
+# type: ignore
+
+import os
+import pathlib
+import tempfile
+from unittest.mock import MagicMock
+
+import pymysql
+import pytest
+
+import mycli.packages.special.utils
+from mycli.packages.special.utils import (
+    CACHED_SSL_VERSION,
+    format_uptime,
+    get_ssl_version,
+    get_uptime,
+    get_warning_count,
+    handle_cd_command,
+)
+from test.utils import TEMPFILE_PREFIX
+
+
+@pytest.fixture(autouse=True)
+def clear_ssl_cache() -> None:
+    CACHED_SSL_VERSION.clear()
+
+
+def test_handle_cd_command_rejects_non_cd_command() -> None:
+    handled, message = handle_cd_command(['pwd'])
+
+    assert handled is False
+    assert message == 'Not a cd command.'
+
+
+def test_handle_cd_command_requires_exactly_one_directory() -> None:
+    handled, message = handle_cd_command(['cd'])
+
+    assert handled is False
+    assert message == 'Exactly one directory name must be provided.'
+
+
+def test_handle_cd_command_changes_directory_and_echoes_cwd(monkeypatch) -> None:
+    echoed = []
+
+    monkeypatch.setattr(mycli.packages.special.utils.click, 'echo', lambda message, err=False: echoed.append((message, err)))
+    monkeypatch.chdir(os.getcwd())
+
+    # resolve() is needed for mac /private/var arrangement
+    with tempfile.TemporaryDirectory(prefix=TEMPFILE_PREFIX) as tempdir:
+        tempdir_resolved = str(pathlib.Path(tempdir).resolve())
+        handled, message = handle_cd_command(['cd', tempdir_resolved])
+        assert str(pathlib.Path(os.getcwd()).resolve()) == tempdir_resolved
+        assert handled is True
+        assert message is None
+        assert echoed == [(tempdir_resolved, True)]
+
+
+def test_handle_cd_command_returns_oserror_message(monkeypatch) -> None:
+    def raise_oserror(directory: str) -> None:
+        raise OSError(2, 'No such file or directory')
+
+    monkeypatch.setattr(mycli.packages.special.utils.os, 'chdir', raise_oserror)
+
+    handled, message = handle_cd_command(['cd', '/missing'])
+
+    assert handled is False
+    assert message == 'No such file or directory'
+
+
+def test_format_uptime():
+    seconds = 59
+    assert '59 sec' == format_uptime(seconds)
+
+    seconds = 120
+    assert '2 min 0 sec' == format_uptime(seconds)
+
+    seconds = 54890
+    assert '15 hours 14 min 50 sec' == format_uptime(seconds)
+
+    seconds = 598244
+    assert '6 days 22 hours 10 min 44 sec' == format_uptime(seconds)
+
+    seconds = 522600
+    assert '6 days 1 hour 10 min 0 sec' == format_uptime(seconds)
+
+
+def test_format_uptime_uses_singular_units() -> None:
+    assert format_uptime('90061') == '1 day 1 hour 1 min 1 sec'
+
+
+def test_get_uptime_returns_value_from_status_row() -> None:
+    cur = MagicMock()
+    cur.fetchone.return_value = ('Uptime', '15')
+
+    uptime = get_uptime(cur)
+
+    cur.execute.assert_called_once_with('SHOW STATUS LIKE "Uptime"')
+    assert uptime == 15
+
+
+def test_get_uptime_defaults_to_zero_for_missing_value() -> None:
+    cur = MagicMock()
+    cur.fetchone.return_value = ('Uptime', None)
+
+    assert get_uptime(cur) == 0
+
+
+def test_get_uptime_ignores_operational_error() -> None:
+    cur = MagicMock()
+    cur.execute.side_effect = pymysql.err.OperationalError()
+
+    assert get_uptime(cur) == 0
+
+
+def test_get_warning_count_returns_value_from_count_row() -> None:
+    cur = MagicMock()
+    cur.fetchone.return_value = ('7',)
+
+    warning_count = get_warning_count(cur)
+
+    cur.execute.assert_called_once_with('SHOW COUNT(*) WARNINGS')
+    assert warning_count == 7
+
+
+def test_get_warning_count_defaults_to_zero_for_missing_value() -> None:
+    cur = MagicMock()
+    cur.fetchone.return_value = (None,)
+
+    assert get_warning_count(cur) == 0
+
+
+def test_get_warning_count_ignores_operational_error() -> None:
+    cur = MagicMock()
+    cur.execute.side_effect = pymysql.err.OperationalError()
+
+    assert get_warning_count(cur) == 0
+
+
+def test_get_ssl_version_fetches_and_caches_value() -> None:
+    cur = MagicMock()
+    cur.connection = MagicMock()
+    cur.connection.thread_id.return_value = 42
+    cur.fetchone.return_value = ('Ssl_version', 'TLSv1.3')
+
+    first = get_ssl_version(cur)
+    second = get_ssl_version(cur)
+
+    cur.execute.assert_called_once_with('SHOW STATUS LIKE "Ssl_version"')
+    assert first == 'TLSv1.3'
+    assert second == 'TLSv1.3'
+
+
+def test_get_ssl_version_caches_missing_row_as_none() -> None:
+    cur = MagicMock()
+    cur.connection = MagicMock()
+    cur.connection.thread_id.return_value = 42
+    cur.fetchone.return_value = None
+
+    first = get_ssl_version(cur)
+    second = get_ssl_version(cur)
+
+    cur.execute.assert_called_once_with('SHOW STATUS LIKE "Ssl_version"')
+    assert first is None
+    assert second is None
+
+
+def test_get_ssl_version_returns_none_for_empty_value_and_caches_it() -> None:
+    cur = MagicMock()
+    cur.connection = MagicMock()
+    cur.connection.thread_id.return_value = 42
+    cur.fetchone.return_value = ('Ssl_version', '')
+
+    first = get_ssl_version(cur)
+    second = get_ssl_version(cur)
+
+    cur.execute.assert_called_once_with('SHOW STATUS LIKE "Ssl_version"')
+    assert first is None
+    assert second is None
+
+
+def test_get_ssl_version_ignores_operational_error() -> None:
+    cur = MagicMock()
+    cur.connection = MagicMock()
+    cur.connection.thread_id.return_value = 42
+    cur.execute.side_effect = pymysql.err.OperationalError()
+
+    assert get_ssl_version(cur) is None