SharePoint API: support for site design & unit tests

vgrem · vgrem · commit 90d15aad16a7 · 2022-06-05T10:37:32.000+03:00
diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml
@@ -24,7 +24,7 @@ jobs:
         office365_python_sdk_securevars: '${{ secrets.OFFICE365_PYTHON_SDK_SECUREVARS }}'
       run: |
         echo "OFFICE365_PYTHON_SDK_SECUREVARS:${{secrets.OFFICE365_PYTHON_SDK_SECUREVARS}}"
-        echo "OFFICE365_PYTHON_SDK_SECUREVARS:${{env.OFFICE365_PYTHON_SDK_SECUREVARS}}"
+        echo "OFFICE365_PYTHON_SDK_SECUREVARS:${{env.office365_python_sdk_securevars}}"
     - name: Set up Python 3.10
       uses: actions/setup-python@v3
       with:
diff --git a/examples/sharepoint/sitedesigns/__init__.py b/examples/sharepoint/sitedesigns/__init__.py
diff --git a/office365/directory/applications/application.py b/office365/directory/applications/application.py
@@ -8,7 +8,7 @@
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 from office365.runtime.paths.resource_path import ResourcePath
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 
 
 class Application(DirectoryObject):
diff --git a/office365/directory/applications/application_template.py b/office365/directory/applications/application_template.py
@@ -1,5 +1,5 @@
 from office365.entity import Entity
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 
 
 class ApplicationTemplate(Entity):
diff --git a/office365/directory/directory_object.py b/office365/directory/directory_object.py
@@ -1,7 +1,7 @@
 from office365.entity import Entity
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 
 
 class DirectoryObject(Entity):
diff --git a/office365/directory/extensions/extension_property.py b/office365/directory/extensions/extension_property.py
@@ -1,6 +1,6 @@
 # coding=utf-8
 from office365.directory.directory_object import DirectoryObject
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 
 
 class ExtensionProperty(DirectoryObject):
diff --git a/office365/directory/users/user.py b/office365/directory/users/user.py
@@ -29,7 +29,7 @@
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 from office365.runtime.paths.resource_path import ResourcePath
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 from office365.teams.team_collection import TeamCollection
 from office365.teams.user_teamwork import UserTeamwork
 
diff --git a/office365/onedrive/columns/choice.py b/office365/onedrive/columns/choice.py
@@ -1,5 +1,5 @@
 from office365.runtime.client_value import ClientValue
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 
 
 class ChoiceColumn(ClientValue):
diff --git a/office365/onedrive/contenttypes/content_type.py b/office365/onedrive/contenttypes/content_type.py
@@ -6,7 +6,7 @@
 from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 
 
 class ContentType(BaseItem):
diff --git a/office365/onedrive/permissions/permission.py b/office365/onedrive/permissions/permission.py
@@ -8,7 +8,7 @@
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 from office365.runtime.paths.resource_path import ResourcePath
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 
 
 class Permission(Entity):
diff --git a/office365/onedrive/termstore/store.py b/office365/onedrive/termstore/store.py
@@ -3,7 +3,7 @@
 from office365.onedrive.termstore.group import Group, GroupCollection
 from office365.onedrive.termstore.set import Set, SetCollection
 from office365.runtime.paths.resource_path import ResourcePath
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 
 
 class Store(Entity):
diff --git a/office365/onenote/pages/page.py b/office365/onenote/pages/page.py
@@ -8,7 +8,7 @@
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 from office365.runtime.paths.resource_path import ResourcePath
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 
 
 class OnenotePageCollection(EntityCollection):
diff --git a/office365/runtime/client_value.py b/office365/runtime/client_value.py
@@ -31,22 +31,21 @@ def to_json(self, json_format=None):
         :type json_format: office365.runtime.odata.odata_json_format.ODataJsonFormat or None
         """
 
-        def include(val):
+        def _is_valid_value(val):
             from office365.runtime.client_value_collection import ClientValueCollection
             if val is None:
                 return False
             elif isinstance(val, ClientValueCollection) and len(val) == 0:
                 return False
             return True
 
-        json = {k: v for k, v in self if include(v)}
+        json = {k: v for k, v in self if _is_valid_value(v)}
         for n, v in json.items():
             if isinstance(v, ClientValue):
                 json[n] = v.to_json(json_format)
         if isinstance(json_format, JsonLightFormat) and json_format.include_control_information() \
            and self.entity_type_name is not None:
             json[json_format.metadata_type_tag_name] = {'type': self.entity_type_name}
-
         return json
 
     @property
diff --git a/office365/runtime/client_value_collection.py b/office365/runtime/client_value_collection.py
@@ -1,3 +1,5 @@
+import uuid
+
 from office365.runtime.client_value import ClientValue
 from office365.runtime.odata.odata_type import ODataType
 from office365.runtime.odata.v3.json_light_format import JsonLightFormat
@@ -7,7 +9,7 @@ class ClientValueCollection(ClientValue):
 
     def __init__(self, item_type, initial_values=None):
         """
-        :type item_type: type[ClientValue] or type[int] or type[str]
+        :type item_type: type[ClientValue or int or str or bool or uuid]
         :type initial_values: list or dict or None
         """
         super(ClientValueCollection, self).__init__()
@@ -42,32 +44,38 @@ def to_json(self, json_format=None):
         for i, v in enumerate(json):
             if isinstance(v, ClientValue):
                 json[i] = v.to_json(json_format)
+            elif isinstance(v, uuid.UUID):
+                json[i] = str(v)
         if isinstance(json_format, JsonLightFormat) and json_format.include_control_information():
             json = {json_format.collection_tag_name: json,
                     json_format.metadata_type_tag_name: {'type': self.entity_type_name}}
         return json
 
-    def set_property(self, index, value, persist_changes=False):
-        child_value = self._item_type()
-        if isinstance(child_value, ClientValue):
-            for k, v in value.items():
-                child_value.set_property(k, v, False)
+    def _create_value(self, initial_value=None):
+        """
+        :type initial_value: int or bool or str or ClientValue or dict or None
+        """
+        if initial_value is None:
+            return uuid.uuid4() if self._item_type == uuid.UUID else self._item_type()
+
+        if self._item_type == uuid.UUID:
+            return uuid.UUID(initial_value)
+        elif issubclass(self._item_type, ClientValue):
+            value = self._item_type()
+            [value.set_property(k, v, False) for k, v in initial_value.items()]
+            return value
         else:
-            child_value = value
+            return initial_value
+
+    def set_property(self, index, value, persist_changes=False):
+        child_value = self._create_value(value)
         self.add(child_value)
         return self
 
     @property
-    def entity_type_name(self):
-        item_type_name = None
-
-        is_primitive = ODataType.primitive_types.get(self._item_type, None) is not None
-        if is_primitive:
-            item_type_name = ODataType.primitive_types[self._item_type]
-        elif issubclass(self._item_type, ClientValue):
-            item_type_name = self._item_type.entity_type_name.fget(self)
+    def item_type_name(self):
+        return ODataType.resolve_type(self._create_value())
 
-        if item_type_name is not None:
-            return "Collection({0})".format(item_type_name)
-        else:
-            return None
+    @property
+    def entity_type_name(self):
+        return ODataType.resolve_type(self)
diff --git a/office365/runtime/odata/odata_type.py b/office365/runtime/odata/odata_type.py
@@ -1,11 +1,15 @@
+import uuid
+
+
 class ODataType(object):
 
-    primitive_types = {
+    standard_types = {
         bool: "Edm.Boolean",
         int: "Edm.Int32",
         str: "Edm.String",
+        uuid.UUID: "Edm.Guid"
     }
-    """Primitive server types"""
+    """Primitive OData data type mapping"""
 
     def __init__(self):
         self.name = None
@@ -14,6 +18,34 @@ def __init__(self):
         self.properties = {}
         self.methods = {}
 
+    @staticmethod
+    def resolve_type(client_type):
+        """
+        Resolve OData type name
+
+        :param str or int or bool or uuid or ClientValue or list[str or int or bool or uuid] client_type: Client value
+        """
+        from office365.runtime.client_value import ClientValue
+        from office365.runtime.client_value_collection import ClientValueCollection
+
+        collection = False
+        if isinstance(client_type, list):
+            collection = True
+            resolved_name = ODataType.standard_types.get(type(client_type[0]), None)
+        elif isinstance(client_type, ClientValue):
+            if isinstance(client_type, ClientValueCollection):
+                collection = True
+                resolved_name = client_type.item_type_name
+            else:
+                resolved_name = client_type.entity_type_name
+        else:
+            resolved_name = ODataType.standard_types.get(type(client_type), None)
+
+        if resolved_name:
+            return "Collection({0})".format(resolved_name) if collection else resolved_name
+        else:
+            return None
+
     def add_property(self, prop_schema):
         """
         :type prop_schema:  office365.runtime.odata.odata_property.ODataProperty
diff --git a/office365/runtime/types/collections.py b/office365/runtime/types/collections.py
@@ -0,0 +1,21 @@
+import uuid
+
+from office365.runtime.client_value_collection import ClientValueCollection
+
+
+class StringCollection(ClientValueCollection):
+
+    def __init__(self, initial_values=None):
+        """
+        :type initial_values: list[str] or None
+        """
+        super(StringCollection, self).__init__(str, initial_values)
+
+
+class GuidCollection(ClientValueCollection):
+
+    def __init__(self, initial_values=None):
+        """
+        :type initial_values list[uuid] or None
+        """
+        super(GuidCollection, self).__init__(uuid.UUID, initial_values)
diff --git a/office365/runtime/types/string_collection.py b/office365/runtime/types/string_collection.py
diff --git a/office365/sharepoint/search/query/suggestion_results.py b/office365/sharepoint/search/query/suggestion_results.py
@@ -1,6 +1,6 @@
 from office365.runtime.client_value import ClientValue
 from office365.runtime.client_value_collection import ClientValueCollection
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 
 
 class PersonalResultSuggestion(ClientValue):
diff --git a/office365/sharepoint/search/search_request.py b/office365/sharepoint/search/search_request.py
@@ -1,6 +1,6 @@
 from office365.runtime.client_value import ClientValue
 from office365.runtime.client_value_collection import ClientValueCollection
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.search.query.sort import Sort
 
 
diff --git a/office365/sharepoint/server_settings.py b/office365/sharepoint/server_settings.py
@@ -1,7 +1,7 @@
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 from office365.runtime.paths.resource_path import ResourcePath
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.base_entity import BaseEntity
 from office365.sharepoint.sites.language_collection import LanguageCollection
 
diff --git a/office365/sharepoint/sitedesigns/creation_info.py b/office365/sharepoint/sitedesigns/creation_info.py
@@ -1,5 +1,30 @@
+import uuid
+
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
 
 
 class SiteDesignCreationInfo(ClientValue):
-    pass
+
+    def __init__(self, _id=None, title=None, description=None, web_template=None, site_script_ids=None,
+                 design_package_id=None):
+        """
+        :param str or None _id: The ID of the site design to apply.
+        :param str or None title: The display name of the site design.
+        :param str or None description: The display description of site design.
+        :param str or None web_template: Identifies which base template to add the design to. Use the value 64 for the
+            Team site template, and the value 68 for the Communication site template.
+        :param list[UUID] or None site_script_ids: A list of one or more site scripts. Each is identified by an ID.
+            The scripts will run in the order listed.
+        :param str or None design_package_id:
+        """
+        self.Id = _id
+        self.Title = title
+        self.Description = description
+        self.WebTemplate = web_template
+        self.SiteScriptIds = ClientValueCollection(uuid.UUID, site_script_ids)
+        self.DesignPackageId = design_package_id
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteDesignCreationInfo"
diff --git a/office365/sharepoint/sitedesigns/metadata.py b/office365/sharepoint/sitedesigns/metadata.py
@@ -2,4 +2,12 @@
 
 
 class SiteDesignMetadata(SiteDesignCreationInfo):
-    pass
+
+    def __init__(self, order=None, version=None):
+        super().__init__()
+        self.Order = order
+        self.Version = version
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteDesignMetadata"
diff --git a/office365/sharepoint/sitescripts/types.py b/office365/sharepoint/sitescripts/types.py
@@ -1,5 +1,5 @@
 from office365.runtime.client_value import ClientValue
-from office365.runtime.types.string_collection import StringCollection
+from office365.runtime.types.collections import StringCollection
 
 
 class SiteScriptCreationInfo(ClientValue):
diff --git a/office365/sharepoint/sitescripts/utility.py b/office365/sharepoint/sitescripts/utility.py
diff --git a/office365/sharepoint/tenant/administration/secondary_administrators_fields_data.py b/office365/sharepoint/tenant/administration/secondary_administrators_fields_data.py
diff --git a/office365/sharepoint/userprofiles/person_properties.py b/office365/sharepoint/userprofiles/person_properties.py
diff --git a/office365/teams/channels/conversation_member.py b/office365/teams/channels/conversation_member.py
diff --git a/tests/sharepoint/test_client.py b/tests/sharepoint/test_client.py
diff --git a/tests/sharepoint/test_site_design.py b/tests/sharepoint/test_site_design.py
