tests: WIP: Add tests for the 2 new functions introduced.

This commit is meant to be replaced later.
The current tests are too tightly tied to the functions introduced,
new tests will be written calling main([]).
And with more test cases added.

Author: Niloth-p

tests/cli/test_run.py

@@ -7,18 +7,21 @@
 import pytest
 import requests
 from pytest import CaptureFixture
+from pytest import param as case
 from pytest_mock import MockerFixture
 
 from zulipterminal.api_types import ServerSettings
 from zulipterminal.cli.run import (
     NotAZulipOrganizationError,
     _write_zuliprc,
+    check_for_default_zuliprc,
     exit_with_error,
     get_login_label,
     get_server_settings,
     in_color,
     main,
     parse_args,
+    path_to_realm_zuliprc,
 )
 from zulipterminal.model import ServerConnectionFailure
 from zulipterminal.version import ZT_VERSION
@@ -410,6 +413,146 @@ def test_main_cannot_write_zuliprc_given_good_credentials(
     assert lines[-1] == expected_line
 
 
+# NOTE: Fixture is necessary to ensure unreadable dir is garbage-collected
+# See pytest issue #7821
+@pytest.fixture
+def mock_config_dir_with_no_zuliprc(tmp_path: Path) -> Generator[Path, None, None]:
+    config_dir_path = tmp_path / "config"
+    config_dir_path.parent.mkdir(parents=True, exist_ok=True)
+    yield (tmp_path / "config")
+
+
+def test_no_zuliprc_files_found(mocker: MockerFixture) -> None:
+    mocker.patch("pathlib.Path.exists", return_value=False)
+    result = check_for_default_zuliprc()
+    assert result == ""
+
+
+def test_one_zuliprc_file_found(
+    mocker: MockerFixture, mock_config_dir_with_no_zuliprc: Path
+) -> None:
+    mocker.patch("pathlib.Path.exists", side_effect=[False, True])
+    mocker.patch(
+        "zulipterminal.cli.run.ZULIP_CONFIG_PATH", str(mock_config_dir_with_no_zuliprc)
+    )
+    mocker.patch("zulipterminal.cli.run.DOWNLOADED_PATH_ZULIPRC")
+    mock_HOME_PATH_ZULIPRC = mocker.patch("zulipterminal.cli.run.HOME_PATH_ZULIPRC")
+
+    result = check_for_default_zuliprc()
+
+    assert result == mock_HOME_PATH_ZULIPRC
+
+
+def test_multiple_zuliprc_files_found(
+    mocker: MockerFixture, mock_config_dir_with_no_zuliprc: Path
+) -> None:
+    mocker.patch("pathlib.Path.exists", side_effect=[True, True])
+    mocker.patch(
+        "zulipterminal.cli.run.ZULIP_CONFIG_PATH", str(mock_config_dir_with_no_zuliprc)
+    )
+    mock_DOWNLOADED_PATH_ZULIPRC = mocker.patch(
+        "zulipterminal.cli.run.DOWNLOADED_PATH_ZULIPRC", "downloads"
+    )
+    mock_HOME_PATH_ZULIPRC = mocker.patch(
+        "zulipterminal.cli.run.HOME_PATH_ZULIPRC", "home"
+    )
+    mock_exit_with_error = mocker.patch("zulipterminal.cli.run.exit_with_error")
+
+    check_for_default_zuliprc()
+
+    mock_exit_with_error.assert_called_once_with(
+        "Found multiple zuliprc files at:\n"
+        f"{mock_DOWNLOADED_PATH_ZULIPRC}\n{mock_HOME_PATH_ZULIPRC}\n"
+        "Please retry by specifying the path to your target zuliprc file."
+    )
+
+
+# NOTE: Fixture is necessary to ensure unreadable dir is garbage-collected
+# See pytest issue #7821
+@pytest.fixture
+def mock_config_dir_with_multiple_zuliprc(
+    tmp_path: Path,
+) -> Generator[Path, None, None]:
+    config_dir_zuliprc_path = tmp_path / "config" / "zuliprc"
+    config_dir_zuliprc_path.parent.mkdir(parents=True, exist_ok=True)
+    config_dir_zuliprc_path.touch()
+
+    org1_zuliprc_path = tmp_path / "config" / "org1" / "zuliprc"
+    org1_zuliprc_path.parent.mkdir(parents=True, exist_ok=True)
+    org1_zuliprc_path.touch()
+
+    org2_subdir_zuliprc_path = tmp_path / "config" / "org2" / "subdir" / "zuliprc"
+    org2_subdir_zuliprc_path.parent.mkdir(parents=True, exist_ok=True)
+    org2_subdir_zuliprc_path.touch()
+
+    yield (tmp_path / "config")
+
+
+def test_multiple_zuliprc_files_found_in_config_dir(
+    mocker: MockerFixture,
+    mock_config_dir_with_multiple_zuliprc: Path,
+) -> None:
+    config_dir = mock_config_dir_with_multiple_zuliprc
+    mocker.patch("zulipterminal.cli.run.DOWNLOADED_PATH_ZULIPRC")
+    mocker.patch("zulipterminal.cli.run.HOME_PATH_ZULIPRC")
+    mocker.patch("zulipterminal.cli.run.ZULIP_CONFIG_PATH", str(config_dir))
+    mock_exit_with_error = mocker.patch("zulipterminal.cli.run.exit_with_error")
+
+    check_for_default_zuliprc()
+
+    mock_exit_with_error.assert_called_once_with(
+        "Found multiple zuliprc files at:\n"
+        f"{str(config_dir / 'zuliprc')}\n"
+        f"{config_dir / 'org1' / 'zuliprc'}\n"
+        "Please retry by specifying the path to your target zuliprc file."
+    )
+
+
+@pytest.mark.parametrize(
+    "prefix, expected_str",
+    [
+        case(
+            "or",
+            "Organization name prefix must be at least 3 characters long",
+            id="too_short",
+        ),
+        case(
+            "org",
+            "Found multiple organizations starting with 'org':\n"
+            "config/org1\nconfig/org2\n",
+            id="multiple_dirs",
+        ),
+        case(
+            "org3",
+            "Could not find any organizations starting with 'org3'",
+            id="no_dirs",
+        ),
+        case(
+            "org2",
+            "Could not find any zuliprc files at:\nconfig/org2\n",
+            id="no_zuliprc",
+        ),
+    ],
+)
+def test_path_to_realm_zuliprc(
+    mocker: MockerFixture,
+    mock_config_dir_with_multiple_zuliprc: Path,
+    prefix: str,
+    expected_str: str,
+) -> None:
+    config_dir = mock_config_dir_with_multiple_zuliprc
+    mocker.patch("zulipterminal.cli.run.ZULIP_CONFIG_PATH", str(config_dir))
+    mock_exit_with_error = mocker.patch(
+        "zulipterminal.cli.run.exit_with_error", side_effect=SystemExit(1)
+    )
+    expected_str = expected_str.replace("config", str(config_dir))
+
+    with pytest.raises(SystemExit):
+        path_to_realm_zuliprc(prefix)
+
+    mock_exit_with_error.assert_called_once_with(expected_str)
+
+
 @pytest.fixture
 def parameterized_zuliprc(tmp_path: Path) -> Callable[[Dict[str, str]], str]:
     def func(config: Dict[str, str]) -> str: