diff --git a/.vscode/settings.json b/.vscode/settings.json index 043b9fb..58bda0c 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -15,6 +15,7 @@ "freezegun", "hikari", "isort", + "jobstore", "jobstores", "levelname", "Lovinator", diff --git a/tests/test_main.py b/tests/test_main.py index 078de4d..ba0ec96 100644 --- a/tests/test_main.py +++ b/tests/test_main.py @@ -5,9 +5,11 @@ from discord_reminder_bot import main def test_if_send_to_discord_is_in_main() -> None: """send_to_discords needs to be in main for this program to work.""" - assert hasattr(main, "send_to_discord") + assert_msg: str = f"send_to_discord is not in main. Current functions in main: {dir(main)}" + assert hasattr(main, "send_to_discord"), assert_msg def test_if_send_to_user_is_in_main() -> None: """send_to_user needs to be in main for this program to work.""" - assert hasattr(main, "send_to_user") + assert_msg: str = f"send_to_user is not in main. Current functions in main: {dir(main)}" + assert hasattr(main, "send_to_user"), assert_msg diff --git a/tests/test_misc.py b/tests/test_misc.py index b09c930..42d71dc 100644 --- a/tests/test_misc.py +++ b/tests/test_misc.py @@ -16,42 +16,51 @@ def test_calc_time() -> None: """Test the calc_time function with various datetime inputs.""" test_datetime: datetime = datetime(2023, 10, 1, 12, 0, 0, tzinfo=UTC) expected_timestamp: str = f"" - assert calc_time(test_datetime) == expected_timestamp + assert_msg = f"Expected {expected_timestamp}, got {calc_time(test_datetime)}" + assert calc_time(test_datetime) == expected_timestamp, assert_msg now: datetime = datetime.now(tz=UTC) expected_timestamp_now: str = f"" - assert calc_time(now) == expected_timestamp_now + assert_msg = f"Expected {expected_timestamp_now}, got {calc_time(now)}" + assert calc_time(now) == expected_timestamp_now, assert_msg past_datetime: datetime = datetime(2000, 1, 1, 0, 0, 0, tzinfo=UTC) expected_timestamp_past: str = f"" - assert calc_time(past_datetime) == expected_timestamp_past + assert_msg = f"Expected {expected_timestamp_past}, got {calc_time(past_datetime)}" + assert calc_time(past_datetime) == expected_timestamp_past, assert_msg future_datetime: datetime = datetime(2100, 1, 1, 0, 0, 0, tzinfo=UTC) expected_timestamp_future: str = f"" - assert calc_time(future_datetime) == expected_timestamp_future + assert_msg: str = f"Expected {expected_timestamp_future}, got {calc_time(future_datetime)}" + assert calc_time(future_datetime) == expected_timestamp_future, assert_msg def test_get_human_time() -> None: """Test the get_human_time function with various timedelta inputs.""" test_timedelta = timedelta(days=1, hours=2, minutes=3, seconds=4) - expected_output = "1d2h3m4s" - assert get_human_time(test_timedelta) == expected_output + expected_output: str = "1d2h3m4s" + assert_msg: str = f"Expected {expected_output}, got {get_human_time(test_timedelta)}" + assert get_human_time(test_timedelta) == expected_output, assert_msg test_timedelta = timedelta(hours=5, minutes=6, seconds=7) - expected_output = "5h6m7s" - assert get_human_time(test_timedelta) == expected_output + expected_output: str = "5h6m7s" + assert_msg = f"Expected {expected_output}, got {get_human_time(test_timedelta)}" + assert get_human_time(test_timedelta) == expected_output, assert_msg test_timedelta = timedelta(minutes=8, seconds=9) - expected_output = "8m9s" - assert get_human_time(test_timedelta) == expected_output + expected_output: str = "8m9s" + assert_msg = f"Expected {expected_output}, got {get_human_time(test_timedelta)}" + assert get_human_time(test_timedelta) == expected_output, assert_msg test_timedelta = timedelta(seconds=10) - expected_output = "10s" - assert get_human_time(test_timedelta) == expected_output + expected_output: str = "10s" + assert_msg = f"Expected {expected_output}, got {get_human_time(test_timedelta)}" + assert get_human_time(test_timedelta) == expected_output, assert_msg test_timedelta = timedelta(days=0, hours=0, minutes=0, seconds=0) - expected_output = "" - assert get_human_time(test_timedelta) == expected_output + expected_output: str = "" + assert_msg = f"Expected {expected_output}, got {get_human_time(test_timedelta)}" + assert get_human_time(test_timedelta) == expected_output, assert_msg def test_calculate() -> None: @@ -64,14 +73,15 @@ def test_calculate() -> None: job: Job = scheduler.add_job(lambda: None, trigger=DateTrigger(run_date=run_date), id="test_job", name="Test Job") expected_output = "" - assert calculate(job) == expected_output + assert_msg: str = f"Expected {expected_output}, got {calculate(job)}" + assert calculate(job) == expected_output, assert_msg # Modify the job to have a next_run_time job.modify(next_run_time=run_date) - assert calculate(job) == expected_output + assert calculate(job) == expected_output, assert_msg # Paused job should still return the same output job.pause() - assert calculate(job) == expected_output + assert calculate(job) == expected_output, assert_msg scheduler.shutdown() diff --git a/tests/test_parser.py b/tests/test_parser.py index b30a7fd..6b9cc39 100644 --- a/tests/test_parser.py +++ b/tests/test_parser.py @@ -14,8 +14,8 @@ def test_parse_time_valid_date() -> None: date_to_parse = "tomorrow at 5pm" timezone = "UTC" result: datetime.datetime | None = parse_time(date_to_parse, timezone, use_dotenv=False) - assert result is not None - assert result.tzinfo == ZoneInfo(timezone) + assert result is not None, f"Expected a datetime object, got {result}" + assert result.tzinfo == ZoneInfo(timezone), f"Expected timezone {timezone}, got {result.tzinfo}" def test_parse_time_no_date() -> None: @@ -23,15 +23,17 @@ def test_parse_time_no_date() -> None: date_to_parse: str = "" timezone = "UTC" result: datetime.datetime | None = parse_time(date_to_parse, timezone, use_dotenv=False) - assert result is None + assert result is None, f"Expected None, got {result}" def test_parse_time_no_timezone() -> None: """Test the `parse_time` function with no timezone.""" date_to_parse = "tomorrow at 5pm" result: datetime.datetime | None = parse_time(date_to_parse, use_dotenv=False) - assert result is not None - assert result.tzinfo == ZoneInfo(settings.get_timezone(use_dotenv=False)) + assert result is not None, f"Expected a datetime object, got {result}" + + assert_msg: str = f"Expected timezone {settings.get_timezone(use_dotenv=False)}, got {result.tzinfo}" + assert result.tzinfo == ZoneInfo(settings.get_timezone(use_dotenv=False)), assert_msg def test_parse_time_invalid_date() -> None: @@ -39,7 +41,7 @@ def test_parse_time_invalid_date() -> None: date_to_parse = "invalid date" timezone = "UTC" result: datetime.datetime | None = parse_time(date_to_parse, timezone, use_dotenv=False) - assert result is None + assert result is None, f"Expected None, got {result}" @freeze_time("2023-01-01 12:00:00") @@ -48,6 +50,8 @@ def test_parse_time_invalid_timezone() -> None: date_to_parse = "tomorrow at 5pm" timezone = "Invalid/Timezone" result: datetime.datetime | None = parse_time(date_to_parse, timezone, use_dotenv=False) - assert result is not None - assert result.tzinfo == ZoneInfo("UTC") - assert result == datetime.datetime(2023, 1, 2, 17, 0, tzinfo=ZoneInfo("UTC")) + assert result is not None, f"Expected a datetime object, got {result}" + assert result.tzinfo == ZoneInfo("UTC"), f"Expected timezone UTC, got {result.tzinfo}" + + assert_msg: str = f"Expected {datetime.datetime(2023, 1, 2, 17, 0, tzinfo=ZoneInfo('UTC'))}, got {result}" + assert result == datetime.datetime(2023, 1, 2, 17, 0, tzinfo=ZoneInfo("UTC")), assert_msg diff --git a/tests/test_settings.py b/tests/test_settings.py index 585f058..85e8714 100644 --- a/tests/test_settings.py +++ b/tests/test_settings.py @@ -17,18 +17,34 @@ def test_get_settings(monkeypatch: pytest.MonkeyPatch) -> None: settings: dict[str, str | dict[str, SQLAlchemyJobStore] | dict[str, bool] | AsyncIOScheduler] = get_settings(use_dotenv=False) - assert settings["sqlite_location"] == "/test_jobs.sqlite" - assert settings["config_timezone"] == "UTC" - assert settings["bot_token"] == "test_token" # noqa: S105 - assert settings["log_level"] == "DEBUG" - assert settings["webhook_url"] == "http://test_webhook_url" - assert isinstance(settings["jobstores"]["default"], SQLAlchemyJobStore) # type: ignore # noqa: PGH003 + assert_msg = f"Expected /test_jobs.sqlite, got {settings['sqlite_location']}" + assert settings["sqlite_location"] == "/test_jobs.sqlite", assert_msg + + assert_msg = f"Expected UTC, got {settings['config_timezone']}" + assert settings["config_timezone"] == "UTC", assert_msg + + assert_msg = f"Expected test_token, got {settings['bot_token']}" + assert settings["bot_token"] == "test_token", assert_msg # noqa: S105 + + assert_msg = f"Expected DEBUG, got {settings['log_level']}" + assert settings["log_level"] == "DEBUG", assert_msg + + assert_msg = f"Expected http://test_webhook_url, got {settings['webhook_url']}" + assert settings["webhook_url"] == "http://test_webhook_url", assert_msg + + assert_msg = f"Expected dict, got {type(settings['jobstores'])}" + assert isinstance(settings["jobstores"], dict), assert_msg + + assert_msg: str = f"Expected SQLAlchemyJobStore, got {type(settings['jobstores']['default'])}" + assert isinstance(settings["jobstores"]["default"], SQLAlchemyJobStore), assert_msg + + assert_msg = f"Expected AsyncIOScheduler, got {type(settings['scheduler'])}" + assert isinstance(settings["scheduler"], AsyncIOScheduler), assert_msg def test_get_settings_missing_bot_token(monkeypatch: pytest.MonkeyPatch) -> None: """Test get_settings function with missing bot token.""" monkeypatch.delenv("BOT_TOKEN", raising=False) - with pytest.raises(ValueError, match="Missing bot token"): get_settings(use_dotenv=False) @@ -44,10 +60,26 @@ def test_get_settings_default_values(monkeypatch: pytest.MonkeyPatch) -> None: settings: dict[str, str | dict[str, SQLAlchemyJobStore] | dict[str, bool] | AsyncIOScheduler] = get_settings(use_dotenv=False) - assert settings["sqlite_location"] == "/jobs.sqlite" - assert settings["config_timezone"] == "UTC" - assert settings["bot_token"] == "default_token" # noqa: S105 - assert settings["log_level"] == "INFO" - assert not settings["webhook_url"] - assert isinstance(settings["jobstores"]["default"], SQLAlchemyJobStore) # type: ignore # noqa: PGH003 - assert isinstance(settings["scheduler"], AsyncIOScheduler) + assert_msg: str = f"Expected /jobs.sqlite, got {settings['sqlite_location']}" + assert settings["sqlite_location"] == "/jobs.sqlite", assert_msg + + assert_msg = f"Expected UTC, got {settings['config_timezone']}" + assert settings["config_timezone"] == "UTC", assert_msg + + assert_msg = f"Expected default_token, got {settings['bot_token']}" + assert settings["bot_token"] == "default_token", assert_msg # noqa: S105 + + assert_msg = f"Expected INFO, got {settings['log_level']}" + assert settings["log_level"] == "INFO", assert_msg + + assert_msg = f"Expected empty string, got {settings['webhook_url']}" + assert not settings["webhook_url"], assert_msg + + assert_msg = f"Expected dict, got {type(settings['jobstores'])}" + assert isinstance(settings["jobstores"], dict), assert_msg + + assert_msg = f"Expected SQLAlchemyJobStore, got {type(settings['jobstores']['default'])}" + assert isinstance(settings["jobstores"]["default"], SQLAlchemyJobStore), assert_msg + + assert_msg = f"Expected AsyncIOScheduler, got {type(settings['scheduler'])}" + assert isinstance(settings["scheduler"], AsyncIOScheduler), assert_msg diff --git a/tests/test_ui.py b/tests/test_ui.py index 155558a..936a6a6 100644 --- a/tests/test_ui.py +++ b/tests/test_ui.py @@ -28,27 +28,57 @@ class TestCreateJobEmbed(unittest.TestCase): embed: discord.Embed = create_job_embed(self.job) - assert isinstance(embed, discord.Embed) - assert embed.title == "Test message" - assert embed.description is not None - assert "ID: 12345" in embed.description - assert "Next run: 2023-10-10 10:00:00" in embed.description - assert "Interval: 1 day" in embed.description - assert "Channel: <#67890>" in embed.description - assert "Author: <@54321>" in embed.description + assert_msg: str = f"Expected discord.Embed, got {type(embed)}" + assert isinstance(embed, discord.Embed), assert_msg + + assert_msg = f"Expected Test message, got {embed.title}" + assert embed.title == "Test message", assert_msg + + assert_msg = "Expected embed description to not be None" + assert embed.description is not None, assert_msg + + assert_msg = f"Expected ID: 12345 in embed description, got {embed.description}" + assert "ID: 12345" in embed.description, assert_msg + + assert_msg = f"Expected Next run: 2023-10-10 10:00:00 in embed description, got {embed.description}" + assert "Next run: 2023-10-10 10:00:00" in embed.description, assert_msg + + assert_msg = f"Expected Interval: 1 day in embed description, got {embed.description}" + assert "Interval: 1 day" in embed.description, assert_msg + + assert_msg = f"Expected Channel: <#67890> in embed description, got {embed.description}" + assert "Channel: <#67890>" in embed.description, assert_msg + + assert_msg = f"Expected Author: <@54321> in embed description, got {embed.description}" + assert "Author: <@54321>" in embed.description, assert_msg def test_create_job_embed_without_next_run_time(self) -> None: """Test the `create_job_embed` function to ensure it correctly creates a Discord embed for a job without the next run time.""" embed: discord.Embed = create_job_embed(self.job) - assert isinstance(embed, discord.Embed) - assert embed.title == "Test message" - assert embed.description is not None - assert "ID: 12345" in embed.description - assert "Paused" in embed.description - assert "Interval: 1 day" in embed.description - assert "Channel: <#67890>" in embed.description - assert "Author: <@54321>" in embed.description + assert_msg: str = f"Expected discord.Embed, got {type(embed)}" + assert isinstance(embed, discord.Embed), assert_msg + + assert_msg = f"Expected Test message, got {embed.title}" + assert embed.title == "Test message", assert_msg + + assert_msg = "Expected embed description to not be None" + assert embed.description is not None, assert_msg + + assert_msg = f"Expected ID: 12345 in embed description, got {embed.description}" + assert "ID: 12345" in embed.description, assert_msg + + assert_msg = f"Expected Paused in embed description, got {embed.description}" + assert "Paused" in embed.description, assert_msg + + assert_msg = f"Expected Interval: 1 day in embed description, got {embed.description}" + assert "Interval: 1 day" in embed.description, assert_msg + + assert_msg = f"Expected Channel: <#67890> in embed description, got {embed.description}" + assert "Channel: <#67890>" in embed.description, assert_msg + + assert_msg = f"Expected Author: <@54321> in embed description, got {embed.description}" + assert "Author: <@54321>" in embed.description, assert_msg def test_create_job_embed_with_long_message(self) -> None: """Test the `create_job_embed` function to ensure it correctly truncates long messages.""" @@ -56,15 +86,26 @@ class TestCreateJobEmbed(unittest.TestCase): embed: discord.Embed = create_job_embed(self.job) - assert isinstance(embed, discord.Embed) - assert embed.title == "A" * 256 + "..." - assert embed.description is not None - assert "ID: 12345" in embed.description - assert "Paused" in embed.description - assert "Interval: 1 day" in embed.description - assert "Channel: <#67890>" in embed.description - assert "Author: <@54321>" in embed.description + assert_msg: str = f"Expected A{'...' * 84} in embed title, got {embed.title}" + assert isinstance(embed, discord.Embed), assert_msg + assert_msg = f"Expected A{'...' * 84} in embed title, got {embed.title}" + assert embed.title == "A" * 256 + "...", assert_msg -if __name__ == "__main__": - unittest.main() + assert_msg = "Expected embed description to not be None" + assert embed.description is not None, assert_msg + + assert_msg = f"Expected ID: 12345 in embed description, got {embed.description}" + assert "ID: 12345" in embed.description, assert_msg + + assert_msg = f"Expected Paused in embed description, got {embed.description}" + assert "Paused" in embed.description, assert_msg + + assert_msg = f"Expected Interval: 1 day in embed description, got {embed.description}" + assert "Interval: 1 day" in embed.description, assert_msg + + assert_msg = f"Expected Channel: <#67890> in embed description, got {embed.description}" + assert "Channel: <#67890>" in embed.description, assert_msg + + assert_msg = f"Expected Author: <@54321> in embed description, got {embed.description}" + assert "Author: <@54321>" in embed.description, assert_msg