Merge branch 'feature/video-livechat' into feature/video-transcription

Author: aninhasalesp

tests/commands/test_base.py

@@ -19,11 +19,17 @@ def execute(cls, **kwargs):
 
 @pytest.fixture
 def subparsers():
+    """Fixture to create subparsers for argument parsing."""
     parser = argparse.ArgumentParser()
     return parser.add_subparsers()
 
 
 def test_generate_parser(subparsers):
+    """Test to verify the parser generation.
+
+    This test checks if the `generate_parser` method correctly generates a parser
+    for the command and sets the appropriate properties
+    """
     parser = TestCommand.generate_parser(subparsers)
 
     assert parser is not None, "Parser should not be None"
@@ -32,6 +38,11 @@ def test_generate_parser(subparsers):
 
 
 def test_parse_arguments(subparsers):
+    """Test to verify argument parsing.
+
+    This test checks if the `parse_arguments` method correctly adds the command's
+    arguments to the parser and sets the default function to the command's execute method.
+    """
     subparsers_mock = MagicMock(spec=subparsers)
 
     TestCommand.parse_arguments(subparsers_mock)
@@ -43,6 +54,11 @@ def test_parse_arguments(subparsers):
 
 
 def test_command():
+    """Test to verify that the `execute` method is implemented.
+
+    This test ensures that if a command does not implement the `execute` method,
+    a `NotImplementedError` is raised.
+    """
     class MyCommand(Command):
         pass
 
@@ -52,6 +68,7 @@ class MyCommand(Command):
 
 @pytest.fixture
 def mock_csv_file():
+    """Fixture to provide mock CSV content for tests."""
 
     csv_content = """URL
     http://example.com
@@ -60,6 +77,14 @@ def mock_csv_file():
     return csv_content
 
 def test_data_from_csv_valid(mock_csv_file):
+    """Test to verify reading data from a valid CSV file.
+
+    This test checks if the `data_from_csv` method correctly reads data from a valid CSV file
+    and returns the expected list of URLs.
+
+    Args:
+        mock_csv_file (str): The mock CSV file content.
+    """
     with patch('pathlib.Path.is_file', return_value=True):
         with patch('builtins.open', mock_open(read_data=mock_csv_file)):
             data_column_name = "URL"
@@ -70,6 +95,11 @@ def test_data_from_csv_valid(mock_csv_file):
             assert result[1] == "http://example2.com"
 
 def test_data_from_csv_file_not_found():
+    """Test to verify behavior when the specified column is not found in the CSV file.
+
+    This test checks if the `data_from_csv` method raises an exception when the specified
+    column does not exist in the CSV file.
+    """
     with patch('pathlib.Path.is_file', return_value=False):
         file_path = Path("/fake/path/not_found.csv")
         with pytest.raises(FileNotFoundError):
@@ -86,12 +116,18 @@ def test_data_from_csv_column_not_found(mock_csv_file):
 
 @pytest.fixture
 def sample_data():
+    """Fixture to provide sample data for tests."""
     return [
         {"id": "123", "name": "Channel One"},
         {"id": "456", "name": "Channel Two"}
     ]
 
 def test_data_to_csv_with_output_file_path(tmp_path, sample_data):
+    """Test to verify writing data to a CSV file with an output file path specified.
+
+    This test checks if the `data_to_csv` method correctly writes the sample data to
+    a CSV file when an output file path is provided.
+    """
     output_file_path = tmp_path / "output.csv"
 
     result_path = Command.data_to_csv(sample_data, str(output_file_path))
@@ -105,13 +141,24 @@ def test_data_to_csv_with_output_file_path(tmp_path, sample_data):
         assert rows[0]["id"] == "123" and rows[1]["id"] == "456"
 
 def test_data_to_csv_without_output_file_path(sample_data):
+    """Test to verify writing data to a CSV format without an output file path specified.
+
+    This test checks if the `data_to_csv` method correctly returns the CSV content
+    as a string when no output file path is provided.
+    """
     csv_content = Command.data_to_csv(sample_data)
 
     assert "id,name" in csv_content
     assert "123,Channel One" in csv_content
     assert "456,Channel Two" in csv_content
 
 def test_data_to_csv_output(tmp_path):
+    """
+    Test to verify the content of the output CSV file.
+
+    This test checks if the `data_to_csv` method writes the expected content
+    to the output CSV file.
+    """
     output_file_path = tmp_path / "output.csv"
 
     data = [

tests/commands/test_channel_id.py

@@ -8,18 +8,30 @@
 
 @pytest.fixture
 def csv_file(tmp_path):
+    """Fixture to create a temporary CSV file with a single YouTube channel URL."""
+
     csv_content = "channel_url\nhttps://www.youtube.com/@Turicas/featured\n"
     csv_file = tmp_path / "urls.csv"
     csv_file.write_text(csv_content)
     return csv_file
 
 @pytest.fixture
 def youtube_api_mock():
+    """Fixture to mock the YouTube API.
+
+    This fixture mocks the `YouTube` class and its `channel_id_from_url` method
+    to return a channel ID based on the URL.
+    """
     with patch("youtool.commands.channel_id.YouTube") as mock:
         mock.return_value.channel_id_from_url.side_effect = lambda url: f"channel-{url}"
         yield mock
 
 def test_channels_ids_csv_preparation(youtube_api_mock):
+    """Fixture to mock the YouTube API.
+
+    This fixture mocks the `YouTube` class and its `channel_id_from_url` method
+    to return a channel ID based on the URL.
+    """
     urls = ["https://www.youtube.com/@Turicas/featured", "https://www.youtube.com/c/PythonicCaf%C3%A9"]
     api_key = "test_api_key"
     id_column_name = "custom_id_column"
@@ -40,16 +52,29 @@ def test_channels_ids_csv_preparation(youtube_api_mock):
 
 
 def test_resolve_urls_with_direct_urls():
-    # Tests whether the function returns the directly given list of URLs.
+    """Test to verify resolving URLs when provided directly.
+
+    This test checks if the `resolve_urls` method of the `ChannelId` class correctly
+    returns the given list of URLs when provided directly.
+    """
     urls = ["https://www.youtube.com/@Turicas/featured"]
     result = ChannelId.resolve_urls(urls, None, None)
     assert result == urls
 
 def test_resolve_urls_with_file_path(csv_file):
+    """Test to verify resolving URLs from a CSV file.
+
+    This test checks if the `resolve_urls` method of the `ChannelId` class correctly
+    reads URLs from a given CSV file.
+    """
     result = ChannelId.resolve_urls(None, csv_file, "channel_url")
     assert result == ["https://www.youtube.com/@Turicas/featured"]
 
 def test_resolve_urls_raises_exception():
-    # Tests whether the function throws an exception when neither urls nor urls_file_path are provided.
+    """Test to verify exception raising when no URLs are provided.
+
+    This test checks if the `resolve_urls` method of the `ChannelId` class raises an exception
+    when neither direct URLs nor a file path are provided.
+    """
     with pytest.raises(Exception, match="Either 'username' or 'url' must be provided for the channel-id command"):
         ChannelId.resolve_urls(None, None, None)

tests/commands/test_channel_info.py

@@ -1,11 +1,14 @@
-import pytest
+from unittest.mock import Mock, call
 
-from unittest.mock import patch, Mock, call
-
-from youtool.commands.channel_info import ChannelInfo, YouTube
+from youtool.commands.channel_info import ChannelInfo
 
 
 def test_filter_fields():
+    """Test to verify the filtering of channel information fields.
+
+    This test checks if the `filter_fields` method of the `ChannelInfo` class correctly
+    filters out unwanted fields from the channel information dictionary based on the provided columns.
+    """
     channel_info = {
         'channel_id': '123456',
         'channel_name': 'Test Channel',
@@ -26,7 +29,15 @@ def test_filter_fields():
     assert filtered_info == expected_result, f"Expected {expected_result}, but got {filtered_info}"
 
 
-def test_channel_ids_from_urls_and_usernames(mocker, channels_urls, usernames):
+def test_channel_ids_from_urls_and_usernames(mocker):
+    """Test to verify fetching channel IDs from both URLs and usernames.
+
+    This test checks if the `execute` method of the `ChannelInfo` class correctly fetches channel IDs
+    from a list of URLs and usernames, and then calls the `channels_infos` method with these IDs.
+    """
+    urls = ["https://www.youtube.com/@Turicas/featured", "https://www.youtube.com/c/PythonicCaf%C3%A9"]
+    usernames = ["Turicas", "PythonicCafe"]
+
     ids_from_urls_mock = "id_from_url"
     ids_from_usernames_mock = "id_from_username"
     youtube_mock = mocker.patch("youtool.commands.channel_info.YouTube")

tests/commands/test_video_comments.py

@@ -8,6 +8,11 @@
 
 
 def test_video_comments(mocker):
+    """Test case for fetching video comments and verifying the output.
+
+    This test mocks the YouTube API to simulate fetching comments for a video,
+    then compares the generated CSV output with expected comments.
+    """
     youtube_mock = mocker.patch("youtool.commands.video_comments.YouTube")
     video_id = "video_id_mock"
 
@@ -30,6 +35,11 @@ def test_video_comments(mocker):
 
 
 def test_video_comments_with_file_output(mocker, tmp_path):
+    """Test case for fetching video comments and saving them to a CSV file.
+
+    This test mocks the YouTube API to simulate fetching comments for a video,
+    then saves the comments to a temporary CSV file.
+    """
     youtube_mock = mocker.patch("youtool.commands.video_comments.YouTube")
     video_id = "video_id_mock"
 

tests/commands/test_video_info.py

@@ -8,19 +8,26 @@
 
 @pytest.fixture
 def youtube_mock(mocker, mock_video_info):
+    """Fixture to mock the YouTube instance and its videos_infos method."""
     mock = mocker.patch("youtool.commands.video_info.YouTube")
     mock_instance = mock.return_value
     mock_instance.videos_infos = Mock(return_value=mock_video_info)
     return mock_instance
 
 @pytest.fixture
 def mock_video_info():
+    """Fixture to return mock video information."""
     return [
         {"id": "tmrhPou85HQ", "title": "Title 1", "description": "Description 1", "published_at": "2021-01-01", "view_count": 100, "like_count": 10, "comment_count": 5},
         {"id": "qoI_x9fylaw", "title": "Title 2", "description": "Description 2", "published_at": "2021-02-01", "view_count": 200, "like_count": 20, "comment_count": 10} 
     ]
 
 def test_execute_with_ids_and_urls(youtube_mock, mocker, tmp_path, mock_video_info):
+    """Test the execute method with provided video IDs and URLs.
+
+    This test verifies that the execute method can handle both video IDs and URLs, 
+    and correctly writes the video information to the output CSV file.
+    """
     ids = ["tmrhPou85HQ", "qoI_x9fylaw"]
     urls = ["https://www.youtube.com/watch?v=tmrhPou85HQ&ab_channel=Turicas", "https://www.youtube.com/watch?v=qoI_x9fylaw&ab_channel=PythonicCaf%C3%A9"]
     output_file_path = tmp_path / "output.csv"
@@ -36,12 +43,25 @@ def test_execute_with_ids_and_urls(youtube_mock, mocker, tmp_path, mock_video_in
     assert csv_data[1]["id"] == "qoI_x9fylaw"
 
 def test_execute_missing_arguments():
+    """Test the execute method raises an exception when missing required arguments.
+
+    This test verifies that the execute method raises an exception if neither 
+    video IDs nor URLs are provided.
+
+    Raises:
+        Exception: If neither 'ids' nor 'urls' is provided.
+    """
     with pytest.raises(Exception) as exc_info:
         VideoInfo.execute(api_key="test_api_key")
 
     assert str(exc_info.value) == "Either 'ids' or 'urls' must be provided for the video-info command"
 
 def test_execute_with_input_file_path(youtube_mock, mocker, tmp_path, mock_video_info):
+    """Test the execute method with an input CSV file containing video URLs and IDs.
+
+    This test verifies that the execute method can read video URLs and IDs from 
+    an input CSV file and correctly writes the video information to the output CSV file.
+    """
     input_csv_content = """video_id,video_url
     tmrhPou85HQ,https://www.youtube.com/watch?v=tmrhPou85HQ&ab_channel=Turicas
     qoI_x9fylaw,https://www.youtube.com/watch?v=qoI_x9fylaw&ab_channel=PythonicCaf%C3%A9
@@ -64,6 +84,12 @@ def test_execute_with_input_file_path(youtube_mock, mocker, tmp_path, mock_video
 
 
 def test_execute_with_info_columns(youtube_mock, mocker, tmp_path, mock_video_info):
+    """Test the execute method with specified info columns.
+
+    This test verifies that the execute method can filter the video information 
+    based on specified columns and correctly writes the filtered information 
+    to the output CSV file.
+    """
     ids = ["tmrhPou85HQ", "qoI_x9fylaw"]
     output_file_path = tmp_path / "output.csv"
 

tests/commands/test_video_livechat.py

@@ -8,6 +8,10 @@
 
 
 def test_video_livechat(mocker):
+    """Test case for fetching live chat messages from a YouTube video.
+
+    Mocks the YouTube API to return expected live chat messages and verifies if the execute method correctly formats and returns the data.
+    """
     youtube_mock = mocker.patch("youtool.commands.video_livechat.YouTube")
     video_id = "video_id_mock"
 
@@ -30,6 +34,10 @@ def test_video_livechat(mocker):
 
 
 def test_video_livechat_with_file_output(mocker, tmp_path):
+    """Test case for fetching live chat messages from a YouTube video and saving them to a CSV file.
+
+    Mocks the YouTube API to return expected live chat messages and verifies if the execute method correctly saves the data to a CSV file.
+    """
     youtube_mock = mocker.patch("youtool.commands.video_livechat.YouTube")
     video_id = "video_id_mock"
 

tests/commands/test_video_search.py

@@ -2,13 +2,18 @@
 import pytest
 
 from io import StringIO
-from unittest.mock import Mock, call
+from unittest.mock import Mock
 from datetime import datetime
 
 from youtool.commands.video_search import VideoSearch
 
 
 def test_video_search_string_output(mocker, videos_ids, videos_urls):
+    """Test the execution of the video-search command and verify the output as string.
+
+    This test simulates the execution of the `VideoSearch.execute` command with a list of video IDs and URLs,
+    and checks if the output is correctly formatted as a CSV string.
+    """
     youtube_mock = mocker.patch("youtool.commands.video_search.YouTube")
     expected_videos_infos = [
         {
@@ -31,6 +36,11 @@ def test_video_search_string_output(mocker, videos_ids, videos_urls):
 
 
 def test_video_search_file_output(mocker, videos_ids, videos_urls, tmp_path):
+    """Test the execution of the video-search command and verify the output to a file.
+
+    This test simulates the execution of the `VideoSearch.execute` command with a list of video IDs and URLs,
+    and checks if the output is correctly written to a CSV file.
+    """
     youtube_mock = mocker.patch("youtool.commands.video_search.YouTube")
     expected_videos_infos = [
         {
@@ -62,5 +72,13 @@ def test_video_search_file_output(mocker, videos_ids, videos_urls, tmp_path):
 
 
 def test_video_search_no_id_and_url_error():
+    """Test if the video-search command raises an exception when neither IDs nor URLs are provided.
+
+    This test checks if executing the `VideoSearch.execute` command without providing IDs or URLs
+    raises the expected exception.
+
+    Assertions:
+        - Assert that the raised exception matches the expected error message.
+    """
     with pytest.raises(Exception, match="Either 'ids' or 'urls' must be provided"):
         VideoSearch.execute(ids=None, urls=None)

tests/test_cli.py

@@ -12,6 +12,11 @@
     "command", COMMANDS
 )
 def test_missing_api_key(monkeypatch: pytest.MonkeyPatch, command: Command):
+    """Test to verify behavior when the YouTube API key is missing.
+    
+    This test ensures that when the YouTube API key is not set, running any command
+    from the youtool CLI results in an appropriate error message and exit code.
+    """
     monkeypatch.delenv('YOUTUBE_API_KEY', raising=False)
     cli_path = Path("youtool") / "cli.py"
     command_string = ["python", cli_path, command.name]