From 4879c05a3b338da2e11bcae794c63aabb8db55eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roman=20Kr=C4=8Dek?= Date: Sun, 13 Oct 2024 11:33:29 +0200 Subject: [PATCH] Add basic unittests --- test-requirements.txt | 3 +- test.py | 6 - tests/{test_bot.py => __init__.py} | 0 tests/integration_tests.py | 1 + tests/test_utils.py | 331 +++++++++++++++++++++++++++++ tox.ini | 10 +- 6 files changed, 341 insertions(+), 10 deletions(-) delete mode 100644 test.py rename tests/{test_bot.py => __init__.py} (100%) create mode 100644 tests/integration_tests.py create mode 100644 tests/test_utils.py diff --git a/test-requirements.txt b/test-requirements.txt index 8cf9f0b..8169ee8 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,4 +1,5 @@ codespell flake8 bandit -pytest \ No newline at end of file +pytest +stestr \ No newline at end of file diff --git a/test.py b/test.py deleted file mode 100644 index 82eeee9..0000000 --- a/test.py +++ /dev/null @@ -1,6 +0,0 @@ -from tiktok_downloader import snaptik - -videos = snaptik("https://vm.tiktok.com/ZGde8k5P7/") - -for video in videos: - print(video.json) \ No newline at end of file diff --git a/tests/test_bot.py b/tests/__init__.py similarity index 100% rename from tests/test_bot.py rename to tests/__init__.py diff --git a/tests/integration_tests.py b/tests/integration_tests.py new file mode 100644 index 0000000..c8ea7a9 --- /dev/null +++ b/tests/integration_tests.py @@ -0,0 +1 @@ +# To be implemented \ No newline at end of file diff --git a/tests/test_utils.py b/tests/test_utils.py new file mode 100644 index 0000000..bd646c7 --- /dev/null +++ b/tests/test_utils.py @@ -0,0 +1,331 @@ +import unittest +import os +import re +import asyncio +import tempfile +import shutil +from unittest.mock import Mock, AsyncMock, patch +from datetime import datetime + +from telegram_downloader_bot.utils import ( + get_user_folder, + handle_media_message_contents, + download_tt_video, + make_fs, + extract_urls, + filter_tt_urls, +) + +from pyrogram.types import Message, User, Chat + +class TestGetUserFolder(unittest.IsolatedAsyncioTestCase): + def setUp(self): + # Create a temporary directory for each test + self.tmp_path = tempfile.mkdtemp() + + def tearDown(self): + # Remove the directory after the test + shutil.rmtree(self.tmp_path) + + async def test_forward_from_full_name(self): + user = Mock() + user.first_name = "John" + user.last_name = "Doe" + user.id = 12345 + + message = Mock() + message.forward_from = user + message.forward_from_chat = None + message.from_user = None + + result = await get_user_folder(self.tmp_path, message) + expected_folder = os.path.join(self.tmp_path, "telegram", "John_Doe") + self.assertEqual(result, expected_folder) + self.assertTrue(os.path.exists(expected_folder)) + + async def test_forward_from_first_name_only(self): + user = Mock() + user.first_name = "John" + user.last_name = None + user.id = 12345 + + message = Mock() + message.forward_from = user + message.forward_from_chat = None + message.from_user = None + + result = await get_user_folder(self.tmp_path, message) + expected_folder = os.path.join(self.tmp_path, "telegram", "12345") + self.assertEqual(result, expected_folder) + self.assertTrue(os.path.exists(expected_folder)) + + async def test_forward_from_no_name(self): + user = Mock() + user.first_name = None + user.last_name = None + user.id = 12345 + + message = Mock() + message.forward_from = user + message.forward_from_chat = None + message.from_user = None + + result = await get_user_folder(self.tmp_path, message) + expected_folder = os.path.join(self.tmp_path, "telegram", "12345") + self.assertEqual(result, expected_folder) + self.assertTrue(os.path.exists(expected_folder)) + + async def test_forward_from_chat_special_chars(self): + chat = Mock() + chat.title = "My *Awesome* Group/Chat!" + + message = Mock() + message.forward_from = None + message.forward_from_chat = chat + message.from_user = None + + result = await get_user_folder(self.tmp_path, message) + expected_folder = os.path.join( + self.tmp_path, "telegram", "My_Awesome_GroupChat" + ) + self.assertEqual(result, expected_folder) + self.assertTrue(os.path.exists(expected_folder)) + + async def test_from_user_full_name(self): + user = Mock() + user.first_name = "Jane" + user.last_name = "Doe" + user.id = 54321 + + message = Mock() + message.forward_from = None + message.forward_from_chat = None + message.from_user = user + + result = await get_user_folder(self.tmp_path, message) + expected_folder = os.path.join(self.tmp_path, "telegram", "Jane_Doe") + self.assertEqual(result, expected_folder) + self.assertTrue(os.path.exists(expected_folder)) + + async def test_from_user_first_name_only(self): + user = Mock() + user.first_name = "Jane" + user.last_name = None + user.id = 54321 + + message = Mock() + message.forward_from = None + message.forward_from_chat = None + message.from_user = user + + result = await get_user_folder(self.tmp_path, message) + expected_folder = os.path.join(self.tmp_path, "telegram", "54321") + self.assertEqual(result, expected_folder) + self.assertTrue(os.path.exists(expected_folder)) + + async def test_special_characters_in_name(self): + user = Mock() + user.first_name = "Ja*ne" + user.last_name = "Do/e" + user.id = 54321 + + message = Mock() + message.forward_from = None + message.forward_from_chat = None + message.from_user = user + + result = await get_user_folder(self.tmp_path, message) + expected_folder = os.path.join(self.tmp_path, "telegram", "Jane_Doe") + self.assertEqual(result, expected_folder) + self.assertTrue(os.path.exists(expected_folder)) + + +class TestHandleMediaMessageContents(unittest.IsolatedAsyncioTestCase): + def setUp(self): + # Create a temporary directory for each test + self.tmp_path = tempfile.mkdtemp() + + def tearDown(self): + # Remove the directory after the test + shutil.rmtree(self.tmp_path) + + @patch("telegram_downloader_bot.utils.get_user_folder") + async def test_document(self, mock_get_user_folder): + user_folder = os.path.join(self.tmp_path, "user_folder") + mock_get_user_folder.return_value = user_folder + os.makedirs(user_folder, exist_ok=True) + + client = Mock() + client.download_media = AsyncMock() + + message = Mock() + message.document = Mock() + message.document.file_name = "test_document.pdf" + message.photo = None + message.video = None + message.animation = None + message.reply_text = AsyncMock() + + await handle_media_message_contents(self.tmp_path, client, message) + + client.download_media.assert_awaited_once_with( + message, os.path.join(user_folder, "test_document.pdf") + ) + message.reply_text.assert_awaited_once_with(f"Document saved to {user_folder}") + + @patch("telegram_downloader_bot.utils.get_user_folder") + async def test_photo(self, mock_get_user_folder): + user_folder = os.path.join(self.tmp_path, "user_folder") + mock_get_user_folder.return_value = user_folder + os.makedirs(user_folder, exist_ok=True) + + client = Mock() + client.download_media = AsyncMock() + + message = Mock() + message.document = None + message.photo = Mock() + message.photo.file_id = "1234567890" + message.video = None + message.animation = None + message.reply_text = AsyncMock() + + await handle_media_message_contents(self.tmp_path, client, message) + + expected_file = os.path.join(user_folder, f"photo_{message.photo.file_id}.jpg") + client.download_media.assert_awaited_once_with(message.photo, expected_file) + message.reply_text.assert_awaited_once_with(f"Photo saved to {user_folder}") + + @patch("telegram_downloader_bot.utils.get_user_folder") + async def test_unknown_media(self, mock_get_user_folder): + user_folder = os.path.join(self.tmp_path, "user_folder") + mock_get_user_folder.return_value = user_folder + os.makedirs(user_folder, exist_ok=True) + + client = Mock() + client.download_media = AsyncMock() + + message = Mock() + message.document = None + message.photo = None + message.video = None + message.animation = None + message.reply_text = AsyncMock() + + await handle_media_message_contents(self.tmp_path, client, message) + + client.download_media.assert_not_awaited() + message.reply_text.assert_awaited_once_with("Unknown media type!") + + +class TestDownloadTTVideo(unittest.TestCase): + def setUp(self): + # Create a temporary directory for each test + self.tmp_path = tempfile.mkdtemp() + + def tearDown(self): + # Remove the directory after the test + shutil.rmtree(self.tmp_path) + + @patch("telegram_downloader_bot.utils.snaptik") + @patch("telegram_downloader_bot.utils.integv.verify") + @patch("telegram_downloader_bot.utils.datetime") + def test_success(self, mock_datetime, mock_verify, mock_snaptik): + mock_video = Mock() + mock_video.download.return_value.getbuffer.return_value = b"video_content" + mock_snaptik.return_value = [mock_video] + mock_verify.return_value = True + + mock_now = datetime(2023, 1, 1, 12, 0, 0) + mock_datetime.now.return_value = mock_now + + result = download_tt_video(self.tmp_path, "http://tiktok.com/video123") + self.assertTrue(result) + + video_filename = mock_now.strftime("video-tiktok-%Y-%m-%d_%H-%M-%S.mp4") + video_filepath = os.path.join(self.tmp_path, "tiktok", video_filename) + self.assertTrue(os.path.exists(video_filepath)) + + @patch("telegram_downloader_bot.utils.snaptik") + @patch("telegram_downloader_bot.utils.integv.verify") + @patch("telegram_downloader_bot.utils.datetime") + def test_failure(self, mock_datetime, mock_verify, mock_snaptik): + mock_video = Mock() + mock_video.download.return_value.getbuffer.return_value = b"video_content" + mock_snaptik.return_value = [mock_video] + mock_verify.return_value = False + + mock_now = datetime(2023, 1, 1, 12, 0, 0) + mock_datetime.now.return_value = mock_now + + result = download_tt_video(self.tmp_path, "http://tiktok.com/video123") + self.assertFalse(result) + + video_filename = mock_now.strftime("video-tiktok-%Y-%m-%d_%H-%M-%S.mp4") + video_filepath = os.path.join(self.tmp_path, "tiktok", video_filename) + self.assertFalse(os.path.exists(video_filepath)) + + +class TestMakeFS(unittest.TestCase): + def setUp(self): + # Create a temporary directory for each test + self.tmp_path = tempfile.mkdtemp() + + def tearDown(self): + # Remove the directory after the test + shutil.rmtree(self.tmp_path) + + def test_make_fs(self): + make_fs(self.tmp_path) + self.assertTrue(os.path.exists(os.path.join(self.tmp_path, "tiktok"))) + self.assertTrue(os.path.exists(os.path.join(self.tmp_path, "telegram"))) + + +class TestExtractURLs(unittest.TestCase): + def test_no_urls(self): + result = extract_urls("This is some text without any URLs.") + self.assertEqual(result, []) + + def test_one_url(self): + result = extract_urls("Check out this link: http://example.com") + self.assertEqual(result, ["http://example.com"]) + + def test_multiple_urls(self): + result = extract_urls( + "Here are some links: http://example.com and https://test.com/page" + ) + self.assertEqual(result, ["http://example.com", "https://test.com/page"]) + + def test_malformed_url(self): + result = extract_urls("This is not a URL: htt://badurl.com") + self.assertEqual(result, []) + + def test_url_at_text_boundaries(self): + result = extract_urls("http://start.com text in the middle https://end.com") + self.assertEqual(result, ["http://start.com", "https://end.com"]) + + +class TestFilterTTURLs(unittest.TestCase): + def test_empty_list(self): + result = filter_tt_urls([]) + self.assertEqual(result, []) + + def test_no_tiktok_urls(self): + urls = ["http://example.com", "https://test.com/page"] + result = filter_tt_urls(urls) + self.assertEqual(result, []) + + def test_only_tiktok_urls(self): + urls = ["http://tiktok.com/video1", "https://www.tiktok.com/@user/video/123"] + result = filter_tt_urls(urls) + self.assertEqual(result, urls) + + def test_mixed_urls(self): + urls = ["http://example.com", "https://www.tiktok.com/@user/video/123"] + result = filter_tt_urls(urls) + self.assertEqual(result, ["https://www.tiktok.com/@user/video/123"]) + + def test_tiktok_in_query(self): + urls = ["http://example.com?param=tiktok", "https://www.other.com/path"] + result = filter_tt_urls(urls) + self.assertEqual(result, ["http://example.com?param=tiktok"]) \ No newline at end of file diff --git a/tox.ini b/tox.ini index 4b0c537..1456a84 100644 --- a/tox.ini +++ b/tox.ini @@ -1,9 +1,10 @@ [tox] -envlist = py311, flake8, bandit, codespell +envlist = py311, flake8, bandit, codespell, unit [testenv] basepython = python3.11 -deps = -r {toxinidir}/test-requirements.txt +deps = -r {toxinidir}/test-requirements.txt + -r {toxinidir}/requirements.txt [testenv:flake8] commands = flake8 telegram_downloader_bot/ @@ -12,4 +13,7 @@ commands = flake8 telegram_downloader_bot/ commands = bandit -r telegram_downloader_bot/ [testenv:codespell] -commands = codespell telegram_downloader_bot/ \ No newline at end of file +commands = codespell telegram_downloader_bot/ + +[testenv:unit] +commands = stestr run --test-path tests/ \ No newline at end of file