refactor test suites

Author: danlu1

tests/integration/synapseclient/models/async/test_wiki_async.py

@@ -1,5 +1,6 @@
 """Integration tests for the synapseclient.models.wiki module."""
 
+import asyncio
 import gzip
 import os
 import tempfile
@@ -34,7 +35,6 @@ async def wiki_page_fixture(
         markdown=wiki_markdown,
     )
     root_wiki = await wiki_page.store_async(synapse_client=syn)
-    schedule_for_cleanup(root_wiki.id)
     return root_wiki
 
 
@@ -240,7 +240,7 @@ async def test_get_attachment_preview_url(
         # GIVEN a wiki page with an attachment
         wiki_page, attachment_name = wiki_page_with_attachment
         # Sleep for 0.5 minutes to ensure the attachment preview is created
-        time.sleep(0.5 * 60)
+        await asyncio.sleep(0.5 * 60)
         # WHEN getting attachment preview URL
         preview_url = await wiki_page.get_attachment_preview_async(
             file_name=attachment_name, download_file=False, synapse_client=self.syn
@@ -649,9 +649,11 @@ async def test_wiki_page_history(
         # GIVEN a wiki page with multiple versions
         sub_wiki = wiki_page_with_multiple_versions
         # WHEN getting wiki history
-        history = await WikiHistorySnapshot.get_async(
+        history = []
+        async for item in WikiHistorySnapshot.get_async(
             owner_id=project_model.id, id=sub_wiki.id, synapse_client=self.syn
-        )
+        ):
+            history.append(item)
         # THEN history should be returned
         assert len(history) == 3
         schedule_for_cleanup(history)
@@ -690,9 +692,11 @@ async def test_get_wiki_header_tree(
         self, project_model: Project, schedule_for_cleanup: Callable[..., None]
     ) -> None:
         # WHEN getting the wiki header tree
-        headers = await WikiHeader.get_async(
+        headers = []
+        async for header in WikiHeader.get_async(
             owner_id=project_model.id, synapse_client=self.syn
-        )
+        ):
+            headers.append(header)
 
         # THEN headers should be returned
         assert len(headers) == 8
@@ -727,9 +731,11 @@ async def test_store_wiki_order_hint(
         self, project_model: Project, schedule_for_cleanup: Callable[..., None]
     ) -> None:
         # Get headers
-        headers = await WikiHeader.get_async(
+        headers = []
+        async for header in WikiHeader.get_async(
             owner_id=project_model.id, synapse_client=self.syn
-        )
+        ):
+            headers.append(header)
         # Get the ids of the headers
         header_ids = [header.id for header in headers]
         # Get initial order hint
@@ -749,3 +755,9 @@ async def test_store_wiki_order_hint(
         schedule_for_cleanup(retrieved_order_hint)
         assert retrieved_order_hint.id_list == header_ids
         assert len(retrieved_order_hint.id_list) == 8
+
+    # clean up the wiki pages for other tests in the same session
+    async def test_cleanup_wiki_pages(self, wiki_page_fixture: WikiPage):
+        root_wiki = wiki_page_fixture
+        await root_wiki.delete_async(synapse_client=self.syn)
+        assert True

tests/integration/synapseclient/models/synchronous/test_wiki.py

@@ -644,9 +644,11 @@ def test_wiki_page_history(
         # GIVEN a wiki page with multiple versions
         sub_wiki = wiki_page_with_multiple_versions
         # WHEN getting wiki history
-        history = WikiHistorySnapshot.get(
+        history = []
+        for item in WikiHistorySnapshot.get(
             owner_id=project_model.id, id=sub_wiki.id, synapse_client=self.syn
-        )
+        ):
+            history.append(item)
         # THEN history should be returned
         assert len(history) == 3
         schedule_for_cleanup(history)
@@ -688,7 +690,11 @@ def test_get_wiki_header_tree(
         schedule_for_cleanup: Callable[..., None],
     ) -> None:
         # WHEN getting the wiki header tree
-        headers = WikiHeader.get(owner_id=project_model.id, synapse_client=self.syn)
+        headers = []
+        for header in WikiHeader.get(
+            owner_id=project_model.id, synapse_client=self.syn
+        ):
+            headers.append(header)
 
         # THEN headers should be returned
         assert len(headers) == 8
@@ -743,3 +749,9 @@ def test_store_wiki_order_hint(
         schedule_for_cleanup(retrieved_order_hint)
         assert retrieved_order_hint.id_list == header_ids
         assert len(retrieved_order_hint.id_list) == 8
+
+    # clean up the wiki pages for other tests in the same session
+    def test_cleanup_wiki_pages(self, wiki_page_fixture: WikiPage):
+        root_wiki = wiki_page_fixture
+        root_wiki.delete(synapse_client=self.syn)
+        assert True

tests/unit/synapseclient/models/async/unit_test_wiki_async.py

@@ -199,13 +199,15 @@ async def mock_async_generator(
             "synapseclient.models.wiki.get_wiki_history",
             return_value=mock_async_generator(mock_responses),
         ) as mocked_get:
-            results = await WikiHistorySnapshot.get_async(
+            results = []
+            async for item in WikiHistorySnapshot.get_async(
                 owner_id="syn123",
                 id="wiki1",
                 offset=0,
                 limit=20,
                 synapse_client=self.syn,
-            )
+            ):
+                results.append(item)
             # THEN the API should be called with correct parameters
             mocked_get.assert_called_once_with(
                 owner_id="syn123",
@@ -242,11 +244,12 @@ async def test_get_async_missing_owner_id(self) -> None:
         ) as mocked_get, pytest.raises(
             ValueError, match="Must provide owner_id to get wiki history."
         ):
-            await WikiHistorySnapshot.get_async(
+            async for _ in WikiHistorySnapshot.get_async(
                 owner_id=None,
                 id="wiki1",
                 synapse_client=self.syn,
-            )
+            ):
+                pass
             # THEN the API should not be called
             mocked_get.assert_not_called()
 
@@ -257,11 +260,12 @@ async def test_get_async_missing_id(self) -> None:
         ) as mocked_get, pytest.raises(
             ValueError, match="Must provide id to get wiki history."
         ):
-            await WikiHistorySnapshot.get_async(
+            async for _ in WikiHistorySnapshot.get_async(
                 owner_id="syn123",
                 id=None,
                 synapse_client=self.syn,
-            )
+            ):
+                pass
             # THEN the API should not be called
             mocked_get.assert_not_called()
 
@@ -319,13 +323,14 @@ async def mock_async_generator(
             "synapseclient.models.wiki.get_wiki_header_tree",
             return_value=mock_async_generator(mock_responses),
         ) as mocked_get:
-            results = await WikiHeader.get_async(
+            results = []
+            async for item in WikiHeader.get_async(
                 owner_id="syn123",
                 synapse_client=self.syn,
                 offset=0,
                 limit=20,
-            )
-
+            ):
+                results.append(item)
             # THEN the API should be called with correct parameters
             mocked_get.assert_called_once_with(
                 owner_id="syn123",
@@ -349,7 +354,8 @@ async def test_get_async_missing_owner_id(self) -> None:
         ) as mocked_get, pytest.raises(
             ValueError, match="Must provide owner_id to get wiki header tree."
         ):
-            await WikiHeader.get_async(owner_id=None, synapse_client=self.syn)
+            async for _ in WikiHeader.get_async(owner_id=None, synapse_client=self.syn):
+                pass
             # THEN the API should not be called
             mocked_get.assert_not_called()
 
@@ -603,6 +609,28 @@ def test_reformat_attachment_file_name(self, file_name: str, expected: str) -> N
         # THEN the result should be the reformatted file name
         assert result == expected
 
+    @pytest.mark.parametrize(
+        "file_name,expected",
+        [
+            ("test.png", False),
+            ("test.jpg", False),
+            ("test.jpeg", False),
+            ("test.txt.gz", False),
+            ("test.txt", True),
+        ],
+    )
+    def test_should_gzip_file(self, file_name: str, expected: bool) -> None:
+        # WHEN I call `_should_gzip_file` with a file name
+        result = WikiPage._should_gzip_file(file_name)
+        # THEN the result should match the expected value
+        assert result == expected
+
+    def test_should_gzip_file_with_invalid_content(self) -> None:
+        # WHEN I call `_should_gzip_file` with invalid content (non-string)
+        # THEN it should raise an AttributeError
+        with pytest.raises(AttributeError):
+            WikiPage._should_gzip_file(123)
+
     async def test_get_markdown_file_handle_success_with_markdown(self) -> WikiPage:
         with patch(
             "synapseclient.models.wiki.WikiPage._to_gzip_file",
@@ -931,9 +959,12 @@ async def test_determine_wiki_action_create_root(self) -> None:
             )
 
     async def test_determine_wiki_action_create_sub(self) -> None:
+        async def mock_get_async(*args, **kwargs) -> AsyncGenerator[WikiHeader, None]:
+            yield WikiHeader(id="wiki1", title="Test Wiki Page")
+
         with patch(
             "synapseclient.models.wiki.WikiHeader.get_async",
-            side_effect=SynapseHTTPError(response=Mock(status_code=404)),
+            side_effect=mock_get_async,
         ) as mock_get_header:
             # GIVEN a WikiPage with a parent_id
             wiki_page = WikiPage(
@@ -950,9 +981,12 @@ async def test_determine_wiki_action_create_sub(self) -> None:
             mock_get_header.assert_not_called()
 
     async def test_determine_wiki_action_update_existing_root(self) -> None:
+        async def mock_get_async(*args, **kwargs) -> AsyncGenerator[WikiHeader, None]:
+            yield WikiHeader(id="wiki1", title="Test Wiki Page")
+
         with patch(
             "synapseclient.models.wiki.WikiHeader.get_async",
-            return_value=WikiHeader(id="wiki1", title="Test Wiki Page"),
+            side_effect=mock_get_async,
         ) as mock_get_header:
             # GIVEN a WikiPage with an id
             wiki_page = WikiPage(
@@ -974,9 +1008,12 @@ async def test_determine_wiki_action_update_existing_root(self) -> None:
     async def test_determine_wiki_action_update_existing_without_passing_id(
         self,
     ) -> None:
+        async def mock_get_async(*args, **kwargs) -> AsyncGenerator[WikiHeader, None]:
+            yield WikiHeader(id="wiki1", title="Test Wiki Page")
+
         with patch(
             "synapseclient.models.wiki.WikiHeader.get_async",
-            return_value=WikiHeader(id="wiki1", title="Test Wiki Page"),
+            side_effect=mock_get_async,
         ) as mock_get_header:
             # GIVEN a WikiPage with an id and parent_id
             wiki_page = WikiPage(