ara-cli 0.1.9.69__py3-none-any.whl → 0.1.10.8__py3-none-any.whl

tests/test_artefact_link_updater.py

@@ -25,7 +25,7 @@ def test_update_links_in_related_artefacts(mock_isfile, mock_listdir):
     mock_file_handles = {filename: mock_open(read_data=content).return_value
                          for filename, content in file_contents.items()}
     mock_open_function = mock_open()
-    mock_open_function.side_effect = lambda file_path, mode='r': mock_file_handles[os.path.basename(file_path)]
+    mock_open_function.side_effect = lambda file_path, mode='r', encoding='utf-8': mock_file_handles[os.path.basename(file_path)]
 
     with patch("builtins.open", mock_open_function):
         # Instantiate the ArtefactLinkUpdater with the mocked file system
@@ -38,8 +38,8 @@ def test_update_links_in_related_artefacts(mock_isfile, mock_listdir):
         # Verify that the open function was called correctly for each file
         for filename in file_contents.keys():
             expected_file_path = os.path.join(dir_path, filename)
-            mock_open_function.assert_any_call(expected_file_path, 'r')
-            mock_open_function.assert_any_call(expected_file_path, 'w')
+            mock_open_function.assert_any_call(expected_file_path, 'r', encoding='utf-8')
+            mock_open_function.assert_any_call(expected_file_path, 'w', encoding='utf-8')
 
         # Verify the content of the files was updated correctly
         for filename, content in file_contents.items():

tests/test_artefact_lister.py

@@ -2,6 +2,11 @@ import pytest
 from unittest.mock import MagicMock, patch
 from ara_cli.artefact_lister import ArtefactLister
 from ara_cli.list_filter import ListFilter
+from ara_cli.artefact_models.artefact_data_retrieval import (
+    artefact_content_retrieval,
+    artefact_path_retrieval,
+    artefact_tags_retrieval,
+)
 
 
 @pytest.fixture
@@ -9,66 +14,6 @@ def artefact_lister():
     return ArtefactLister()
 
 
-@pytest.mark.parametrize(
-    "users, status, tags, expected_tags",
-    [
-        # Normal case with all fields populated
-        (
-            ["john", "alice"],
-            "in-progress",
-            ["important", "urgent"],
-            ["user_john", "user_alice", "in-progress", "important", "urgent"]
-        ),
-        # Case with empty users
-        (
-            [],
-            "to-do",
-            ["feature", "backend"],
-            ["to-do", "feature", "backend"]
-        ),
-        # Case with empty tags
-        (
-            ["bob"],
-            "done",
-            [],
-            ["user_bob", "done"]
-        ),
-        # Case with all empty fields
-        (
-            [],
-            "",
-            [],
-            [""]
-        ),
-        # Case with None values for tags (should handle gracefully)
-        (
-            ["admin"],
-            "closed",
-            None,
-            ["user_admin", "closed"]
-        ),
-    ]
-)
-def test_artefact_tags_retrieval(users, status, tags, expected_tags):
-    # Create a mock artefact with the specified attributes
-    artefact_mock = MagicMock()
-    artefact_mock.users = users
-    artefact_mock.status = status
-    artefact_mock.tags = tags if tags is not None else []
-
-    # Call the method under test
-    result = ArtefactLister.artefact_tags_retrieval(artefact_mock)
-
-    # Verify the result
-    assert result == expected_tags
-
-
-def test_artefact_tags_retrieval_with_none():
-    # Test with None artefact
-    result = ArtefactLister.artefact_tags_retrieval(None)
-    assert result == []
-
-
 @pytest.mark.parametrize(
     "classified_files, list_filter, filter_result",
     [
@@ -76,39 +21,36 @@ def test_artefact_tags_retrieval_with_none():
         (
             {"type1": [MagicMock(), MagicMock()]},
             None,
-            {"type1": [MagicMock(), MagicMock()]}
+            {"type1": [MagicMock(), MagicMock()]},
         ),
         # Case 2: Filter with include tags
         (
             {"type1": [MagicMock(), MagicMock()]},
             ListFilter(include_tags=["tag1"]),
-            {"type1": [MagicMock()]}
+            {"type1": [MagicMock()]},
         ),
         # Case 3: Filter with exclude tags
         (
             {"type1": [MagicMock(), MagicMock()], "type2": [MagicMock()]},
             ListFilter(exclude_tags=["tag2"]),
-            {"type1": [MagicMock()], "type2": []}
+            {"type1": [MagicMock()], "type2": []},
         ),
         # Case 4: Empty result after filtering
         (
             {"type1": [MagicMock(), MagicMock()]},
             ListFilter(include_tags=["nonexistent"]),
-            {"type1": []}
+            {"type1": []},
         ),
         # Case 5: Multiple artefact types
         (
             {"type1": [MagicMock()], "type2": [MagicMock(), MagicMock()]},
             ListFilter(exclude_extension=[".txt"]),
-            {"type1": [], "type2": [MagicMock()]}
+            {"type1": [], "type2": [MagicMock()]},
         ),
     ],
 )
 def test_filter_artefacts(
-    artefact_lister,
-    classified_files,
-    list_filter,
-    filter_result
+    artefact_lister, classified_files, list_filter, filter_result
 ):
     # Mock the filter_list function
     with patch("ara_cli.artefact_lister.filter_list") as mock_filter_list:
@@ -121,9 +63,9 @@ def test_filter_artefacts(
         mock_filter_list.assert_called_once_with(
             list_to_filter=classified_files,
             list_filter=list_filter,
-            content_retrieval_strategy=ArtefactLister.artefact_content_retrieval,
-            file_path_retrieval=ArtefactLister.artefact_path_retrieval,
-            tag_retrieval=ArtefactLister.artefact_tags_retrieval
+            content_retrieval_strategy=artefact_content_retrieval,
+            file_path_retrieval=artefact_path_retrieval,
+            tag_retrieval=artefact_tags_retrieval,
         )
 
         # Verify the structure matches (don't compare the actual MagicMock objects)
@@ -132,30 +74,6 @@ def test_filter_artefacts(
             assert len(result[key]) == len(filter_result[key])
 
 
-@pytest.mark.parametrize("artefact_content", ["content1", "content2", "content3"])
-def test_artefact_content_retrieval(artefact_content):
-    artefact_mock = MagicMock()
-    artefact_mock.serialize.return_value = artefact_content  # Mock serialize()
-
-    content = ArtefactLister.artefact_content_retrieval(artefact_mock)
-    assert content == artefact_content
-
-
-@pytest.mark.parametrize(
-    "file_path",
-    [
-        ("./ara/userstories/test.userstory"),
-        ("./ara/epics/test.epic"),
-    ],
-)
-def test_artefact_path_retrieval(file_path):
-    artefact_mock = MagicMock()
-    artefact_mock.file_path = file_path
-
-    path = ArtefactLister.artefact_path_retrieval(artefact_mock)
-    assert path == file_path
-
-
 @pytest.mark.parametrize(
     "tags, navigate_to_target, list_filter, mock_artefacts, filtered_artefacts, expected_filtered",
     [
@@ -476,20 +394,21 @@ def test_list_data_artefact_found_data_exists(artefact_lister):
     classified_artefacts = {
         "epic": [
             {"title": "Epic1", "file_path": "path/to/Epic1.epic"},
-            {"title": "Epic2", "file_path": "path/to/Epic2.epic"}
+            {"title": "Epic2", "file_path": "path/to/Epic2.epic"},
         ]
     }
-    
-    with patch("ara_cli.artefact_lister.FileClassifier") as mock_file_classifier, \
-         patch("ara_cli.artefact_lister.suggest_close_name_matches") as mock_suggest, \
-         patch("ara_cli.artefact_lister.os") as mock_os, \
-         patch("ara_cli.artefact_lister.list_files_in_directory") as mock_list_files:
+
+    with patch("ara_cli.artefact_lister.FileClassifier") as mock_file_classifier, patch(
+        "ara_cli.artefact_lister.suggest_close_name_matches"
+    ) as mock_suggest, patch("ara_cli.artefact_lister.os") as mock_os, patch(
+        "ara_cli.artefact_lister.list_files_in_directory"
+    ) as mock_list_files:
 
         # Configure mocks
         mock_classifier_instance = MagicMock()
         mock_file_classifier.return_value = mock_classifier_instance
         mock_classifier_instance.classify_files.return_value = classified_artefacts
-        
+
         mock_os.path.splitext.return_value = ("path/to/Epic1", ".epic")
         mock_os.path.exists.return_value = True
 
@@ -510,20 +429,21 @@ def test_list_data_artefact_found_data_not_exists(artefact_lister):
     classified_artefacts = {
         "epic": [
             {"title": "Epic1", "file_path": "path/to/Epic1.epic"},
-            {"title": "Epic2", "file_path": "path/to/Epic2.epic"}
+            {"title": "Epic2", "file_path": "path/to/Epic2.epic"},
         ]
     }
-    
-    with patch("ara_cli.artefact_lister.FileClassifier") as mock_file_classifier, \
-         patch("ara_cli.artefact_lister.suggest_close_name_matches") as mock_suggest, \
-         patch("ara_cli.artefact_lister.os") as mock_os, \
-         patch("ara_cli.artefact_lister.list_files_in_directory") as mock_list_files:
+
+    with patch("ara_cli.artefact_lister.FileClassifier") as mock_file_classifier, patch(
+        "ara_cli.artefact_lister.suggest_close_name_matches"
+    ) as mock_suggest, patch("ara_cli.artefact_lister.os") as mock_os, patch(
+        "ara_cli.artefact_lister.list_files_in_directory"
+    ) as mock_list_files:
 
         # Configure mocks
         mock_classifier_instance = MagicMock()
         mock_file_classifier.return_value = mock_classifier_instance
         mock_classifier_instance.classify_files.return_value = classified_artefacts
-        
+
         mock_os.path.splitext.return_value = ("path/to/Epic1", ".epic")
         mock_os.path.exists.return_value = False
 
@@ -544,14 +464,15 @@ def test_list_data_artefact_not_found(artefact_lister):
     classified_artefacts = {
         "epic": [
             {"title": "Epic1", "file_path": "path/to/Epic1.epic"},
-            {"title": "Epic2", "file_path": "path/to/Epic2.epic"}
+            {"title": "Epic2", "file_path": "path/to/Epic2.epic"},
         ]
     }
-    
-    with patch("ara_cli.artefact_lister.FileClassifier") as mock_file_classifier, \
-         patch("ara_cli.artefact_lister.suggest_close_name_matches") as mock_suggest, \
-         patch("ara_cli.artefact_lister.os") as mock_os, \
-         patch("ara_cli.artefact_lister.list_files_in_directory") as mock_list_files:
+
+    with patch("ara_cli.artefact_lister.FileClassifier") as mock_file_classifier, patch(
+        "ara_cli.artefact_lister.suggest_close_name_matches"
+    ) as mock_suggest, patch("ara_cli.artefact_lister.os") as mock_os, patch(
+        "ara_cli.artefact_lister.list_files_in_directory"
+    ) as mock_list_files:
 
         # Configure mocks
         mock_classifier_instance = MagicMock()
@@ -562,10 +483,7 @@ def test_list_data_artefact_not_found(artefact_lister):
         artefact_lister.list_data(classifier, artefact_name, list_filter)
 
         # Verify interactions
-        mock_suggest.assert_called_once_with(
-            artefact_name,
-            ["Epic1", "Epic2"]
-        )
+        mock_suggest.assert_called_once_with(artefact_name, ["Epic1", "Epic2"])
         mock_os.path.splitext.assert_not_called()
         mock_os.path.exists.assert_not_called()
         mock_list_files.assert_not_called()
@@ -578,20 +496,21 @@ def test_list_data_with_filter(artefact_lister):
     classified_artefacts = {
         "userstory": [
             {"title": "Story1", "file_path": "path/to/Story1.userstory"},
-            {"title": "Story2", "file_path": "path/to/Story2.userstory"}
+            {"title": "Story2", "file_path": "path/to/Story2.userstory"},
         ]
     }
-    
-    with patch("ara_cli.artefact_lister.FileClassifier") as mock_file_classifier, \
-         patch("ara_cli.artefact_lister.suggest_close_name_matches") as mock_suggest, \
-         patch("ara_cli.artefact_lister.os") as mock_os, \
-         patch("ara_cli.artefact_lister.list_files_in_directory") as mock_list_files:
+
+    with patch("ara_cli.artefact_lister.FileClassifier") as mock_file_classifier, patch(
+        "ara_cli.artefact_lister.suggest_close_name_matches"
+    ) as mock_suggest, patch("ara_cli.artefact_lister.os") as mock_os, patch(
+        "ara_cli.artefact_lister.list_files_in_directory"
+    ) as mock_list_files:
 
         # Configure mocks
         mock_classifier_instance = MagicMock()
         mock_file_classifier.return_value = mock_classifier_instance
         mock_classifier_instance.classify_files.return_value = classified_artefacts
-        
+
         mock_os.path.splitext.return_value = ("path/to/Story1", ".userstory")
         mock_os.path.exists.return_value = True
 
@@ -610,11 +529,12 @@ def test_list_data_empty_artefact_list(artefact_lister):
     artefact_name = "Epic1"
     list_filter = None
     classified_artefacts = {"epic": []}
-    
-    with patch("ara_cli.artefact_lister.FileClassifier") as mock_file_classifier, \
-         patch("ara_cli.artefact_lister.suggest_close_name_matches") as mock_suggest, \
-         patch("ara_cli.artefact_lister.os") as mock_os, \
-         patch("ara_cli.artefact_lister.list_files_in_directory") as mock_list_files:
+
+    with patch("ara_cli.artefact_lister.FileClassifier") as mock_file_classifier, patch(
+        "ara_cli.artefact_lister.suggest_close_name_matches"
+    ) as mock_suggest, patch("ara_cli.artefact_lister.os") as mock_os, patch(
+        "ara_cli.artefact_lister.list_files_in_directory"
+    ) as mock_list_files:
 
         # Configure mocks
         mock_classifier_instance = MagicMock()

tests/test_artefact_renamer.py

@@ -53,9 +53,9 @@ def test_update_title_in_artefact(mock_file, classifier, artefact_name, read_dat
         ar._update_title_in_artefact(artefact_path, new_title, classifier)
 
     # Check that the file was opened for reading
-    mock_file.assert_any_call(artefact_path, 'r')
+    mock_file.assert_any_call(artefact_path, 'r', encoding='utf-8')
     # Check that the file was opened for writing
-    mock_file.assert_any_call(artefact_path, 'w')
+    mock_file.assert_any_call(artefact_path, 'w', encoding='utf-8')
     # Check that the file write was called with the correct new content
     expected_content = read_data.replace(f"{read_data_prefix}{old_title}", f"{read_data_prefix}{new_title}")
     mock_file().write.assert_called_with(expected_content)