OneDrive: support for web parts, #866 fixes

vgrem · vgrem · commit 6334eb3e12e2 · 2024-05-26T13:11:35.000+03:00
diff --git a/examples/onedrive/lists/get_props.py b/examples/onedrive/lists/get_props.py
diff --git a/examples/onedrive/lists/list_in_site.py b/examples/onedrive/lists/list_in_site.py
diff --git a/generator/import_metadata.py b/generator/import_metadata.py
@@ -26,13 +26,13 @@ def export_to_file(path, content):
     "--endpoint",
     dest="endpoint",
     help="Import metadata endpoint",
-    default="sharepoint",
+    default="microsoftgraph",
 )
 parser.add_argument(
     "-p",
     "--path",
     dest="path",
-    default="./metadata/SharePoint.xml",
+    default="./metadata/MicrosoftGraph.xml",
     help="Import metadata endpoint",
 )
 
diff --git a/generator/metadata/MicrosoftGraph.xml b/generator/metadata/MicrosoftGraph.xml
diff --git a/office365/onedrive/internal/paths/url.py b/office365/onedrive/internal/paths/url.py
@@ -1,11 +1,19 @@
+from typing import TYPE_CHECKING
+
+from typing_extensions import Self
+
 from office365.onedrive.internal.paths.root import RootPath
 from office365.runtime.paths.v4.entity import EntityPath
 
+if TYPE_CHECKING:
+    from office365.runtime.paths.resource_path import ResourcePath
+
 
 class UrlPath(EntityPath):
     """Resource path for OneDrive entity path-based addressing"""
 
     def __init__(self, url, parent, collection=None):
+        # type: (str, ResourcePath, ResourcePath) -> None
         """
         :param str url: File or Folder server relative url
         :type parent: office365.runtime.paths.resource_path.ResourcePath
@@ -16,8 +24,14 @@ def __init__(self, url, parent, collection=None):
             parent = parent.parent
         elif isinstance(parent, RootPath):
             collection = parent.collection
+        elif isinstance(parent, EntityPath):
+            collection = parent.collection
         super(UrlPath, self).__init__(url, parent, collection)
 
+    def patch(self, key):
+        # type: (str) -> Self
+        return super(UrlPath, self).patch(key)
+
     @property
     def segment(self):
         return ":/{0}:/".format(self._key)
diff --git a/office365/onedrive/sitepages/horizontal_section_column.py b/office365/onedrive/sitepages/horizontal_section_column.py
@@ -1,6 +1,6 @@
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
-from office365.onedrive.sitepages.web_part import WebPart
+from office365.onedrive.sitepages.webparts.web_part import WebPart
 from office365.runtime.paths.resource_path import ResourcePath
 
 
diff --git a/office365/onedrive/sitepages/site_page.py b/office365/onedrive/sitepages/site_page.py
@@ -4,7 +4,7 @@
 from office365.onedrive.sitepages.base import BaseSitePage
 from office365.onedrive.sitepages.canvas_layout import CanvasLayout
 from office365.onedrive.sitepages.title_area import TitleArea
-from office365.onedrive.sitepages.web_part import WebPart
+from office365.onedrive.sitepages.webparts.web_part import WebPart
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
diff --git a/office365/onedrive/sitepages/vertical_section.py b/office365/onedrive/sitepages/vertical_section.py
@@ -1,6 +1,6 @@
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
-from office365.onedrive.sitepages.web_part import WebPart
+from office365.onedrive.sitepages.webparts.web_part import WebPart
 from office365.runtime.paths.resource_path import ResourcePath
 
 
diff --git a/office365/onedrive/sitepages/webparts/__init__.py b/office365/onedrive/sitepages/webparts/__init__.py
diff --git a/office365/onedrive/sitepages/webparts/standard.py b/office365/onedrive/sitepages/webparts/standard.py
@@ -0,0 +1,5 @@
+from office365.onedrive.sitepages.webparts.web_part import WebPart
+
+
+class StandardWebPart(WebPart):
+    """Represents a standard web part instance on a SharePoint page."""
diff --git a/office365/onedrive/sitepages/webparts/text.py b/office365/onedrive/sitepages/webparts/text.py
@@ -0,0 +1,5 @@
+from office365.onedrive.sitepages.webparts.web_part import WebPart
+
+
+class TextWebPart(WebPart):
+    """Represents a text web part instance on a SharePoint page."""
diff --git a/office365/onedrive/sitepages/webparts/web_part.py b/office365/onedrive/sitepages/webparts/web_part.py
diff --git a/office365/runtime/paths/resource_path.py b/office365/runtime/paths/resource_path.py
@@ -27,6 +27,9 @@ def __repr__(self):
     def __str__(self):
         return self.to_url()
 
+    def __eq__(self, other):
+        return self.to_url() == other.to_url()
+
     def to_url(self):
         # type: () -> str
         """Builds url"""
diff --git a/tests/onedrive/test_file.py b/tests/onedrive/test_file.py
@@ -8,7 +8,7 @@
 from tests.graph_case import GraphTestCase
 
 
-class TestDriveItem(GraphTestCase):
+class TestFile(GraphTestCase):
     """OneDrive specific test case base class"""
 
     target_drive = None  # type: Drive
@@ -17,7 +17,7 @@ class TestDriveItem(GraphTestCase):
 
     @classmethod
     def setUpClass(cls):
-        super(TestDriveItem, cls).setUpClass()
+        super(TestFile, cls).setUpClass()
         lib_name = create_unique_name("Lib")
         lib = cls.client.sites.root.lists.add(
             lib_name, "documentLibrary"
diff --git a/tests/onedrive/test_folder.py b/tests/onedrive/test_folder.py
@@ -0,0 +1,65 @@
+import uuid
+
+from office365.onedrive.driveitems.driveItem import DriveItem
+from office365.onedrive.drives.drive import Drive
+from office365.runtime.paths.v4.entity import EntityPath
+from tests import create_unique_name
+from tests.graph_case import GraphTestCase
+
+
+class TestFolder(GraphTestCase):
+    """OneDrive test case for a Folder"""
+
+    target_drive = None  # type: Drive
+    target_folder = None  # type: DriveItem
+    target_folder_name = "Archive_" + uuid.uuid4().hex
+
+    @classmethod
+    def setUpClass(cls):
+        super(TestFolder, cls).setUpClass()
+        lib_name = create_unique_name("Lib")
+        lib = cls.client.sites.root.lists.add(
+            lib_name, "documentLibrary"
+        ).execute_query()
+        cls.target_drive = lib.drive
+
+    @classmethod
+    def tearDownClass(cls):
+        cls.target_drive.list.delete_object().execute_query()
+
+    def test1_create_root_folder(self):
+        folder = self.target_drive.root.create_folder(
+            self.target_folder_name
+        ).execute_query()
+        self.assertEqual(folder.name, self.target_folder_name)
+        self.__class__.target_folder = folder
+
+    def test2_create_child_folder(self):
+        target_folder_name = "2018"
+        folder = self.__class__.target_folder.create_folder(
+            target_folder_name
+        ).execute_query()
+        self.assertEqual(folder.name, target_folder_name)
+
+    def test3_get_folder_by_path(self):
+        root_folder = (
+            self.target_drive.root.get_by_path(self.target_folder_name)
+            .get()
+            .execute_query()
+        )
+        folder = root_folder.get_by_path("2018").get().execute_query()
+        self.assertEqual(
+            folder.resource_path,
+            EntityPath(folder.id, self.target_drive.items.resource_path),
+        )
+
+    def test4_get_folder_permissions(self):
+        folder_perms = self.__class__.target_folder.permissions.get().execute_query()
+        self.assertIsNotNone(folder_perms.resource_path)
+
+    def test5_get_analytics(self):
+        result = self.__class__.target_folder.analytics.get().execute_query()
+        self.assertIsNotNone(result.resource_path)
+
+    def test6_delete_folder(self):
+        self.__class__.target_folder.delete_object().execute_query()
diff --git a/tests/test_graph_client.py b/tests/test_graph_client.py
@@ -57,23 +57,23 @@ def test7_build_drive_children_path(self):
         path = self.client.sites.root.drive.items[item_id].children.resource_path
         self.assertEqual(f"/sites/root/drive/items/{item_id}/children", str(path))
 
-    def test8_resolve_site_url_path(self):
+    def test9_resolve_site_url_path(self):
         site = self.client.sites.get_by_url(test_team_site_url).execute_query()
         self.assertEqual(
             f"{str(self.client.sites.resource_path)}/{site.id}", str(site.resource_path)
         )
 
-    def test9_resolve_drive_root_path(self):
+    def test_10_resolve_drive_root_path(self):
         path = self.client.me.drive.root.resource_path
         item_id = uuid.uuid4().hex
         path.patch(item_id)
         self.assertEqual(f"/me/drive/items/{item_id}", str(path))
 
-    def test_10_build_site_root_path(self):
+    def test_11_build_site_root_path(self):
         site = self.client.sites.root.get().execute_query()
         self.assertEqual(f"/sites/{site.id}", str(site.resource_path))
 
-    def test_11_resolve_term_children_path(self):
+    def test_12_resolve_term_children_path(self):
         group_id = uuid.uuid4().hex
         set_id = uuid.uuid4().hex
         term_id = uuid.uuid4().hex
