update tenant namespace method and types

Author: vgrem

examples/sharepoint/migration/list_scanner.py renamed to examples/sharepoint/migration/scanner.py

@@ -1,6 +1,7 @@
 import logging
 
-from office365.migration.assessment.list_scanner import ListScanner
+from office365.migration.assessment.scanners.list import ListScanner
+from office365.migration.assessment.scanners.site import SiteScanner
 from office365.sharepoint.client_context import ClientContext
 from tests import test_team_site_url, test_user_credentials
 
@@ -10,10 +11,13 @@
 
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_user_credentials)
-lib = ctx.web.default_document_library()
-scanner = ListScanner(lib)
+# lib = ctx.web.default_document_library()
+# scanner = ListScanner(lib)
+
+scanner = SiteScanner(ctx.site)
 scan_info = scanner.scan()
+
 logging.info(
-    "List_Usage %s",
-    scan_info,
+    "Site_Usage %s",
+    scan_info.properties,
 )

generator/import_metadata.py

@@ -26,13 +26,13 @@ def export_to_file(path, content):
     "--endpoint",
     dest="endpoint",
     help="Import metadata endpoint",
-    default="graph",
+    default="sharepoint",
 )
 parser.add_argument(
     "-p",
     "--path",
     dest="path",
-    default="./metadata/Graph.xml",
+    default="./metadata/SharePoint.xml",
     help="Import metadata endpoint",
 )
 

generator/metadata/SharePoint.xml

@@ -0,0 +1,65 @@
+from abc import ABC, abstractmethod
+from functools import wraps
+from typing import Any, Dict, Generic
+
+from typing_extensions import Self
+
+from office365.runtime.client_object import T
+
+
+def mapped_property(name):
+    # type: (str) -> callable
+    """
+    Decorator that maps a property to a specific key in _properties
+
+    Args:
+        name: The key to use when storing in _properties dictionary
+    """
+
+    def decorator(func):
+        # type: (callable) -> property
+        @wraps(func)
+        def wrapper(self):
+            # type: (Any) -> Any
+            value = func(self)
+            if hasattr(self, "_properties"):
+                self._properties[name] = value
+            return value
+
+        wrapper._serialized = True
+        return property(wrapper)
+
+    return decorator
+
+
+class BaseScanner(ABC, Generic[T]):
+
+    def __init__(self, source):
+        # type: (T) -> None
+        self.source = source
+        self._properties = {}  # type: Dict[str, Any]
+
+    @abstractmethod
+    def build_query(self):
+        # type: () -> Self
+        pass
+
+    def scan(self):
+        # type: () -> Self
+        self.build_query()
+        self.source.execute_query()
+        self.process()
+        return self
+
+    def process(self):
+        # type: () -> None
+        for name, attr in self.__class__.__dict__.items():
+            if isinstance(attr, property) and hasattr(attr.fget, "_serialized"):
+                getattr(self, name)
+
+    @property
+    def properties(self):
+        return self._properties
+
+    def __repr__(self):
+        return f"{self.__class__.__name__}({self._properties})"

office365/migration/assessment/base_scanner.py

@@ -1,12 +1,36 @@
-from typing import Dict, Self
+from typing import Self
 
-from office365.migration.assessment.base_scanner import BaseScanner
+from office365.migration.assessment.scanners.base import BaseScanner, mapped_property
 from office365.sharepoint.listitems.collection import ListItemCollection
 from office365.sharepoint.lists.list import List
 
 
 class ListScanner(BaseScanner[List]):
 
+    @property
+    def files_count(self):
+        return self._properties.get("FilesCount", None)
+
+    @property
+    def folders_count(self):
+        return self._properties.get("FoldersCount", None)
+
+    @mapped_property("ItemsCount")
+    def items_count(self):
+        return self.source.item_count
+
+    @mapped_property("FieldsCount")
+    def fields_count(self):
+        return len(self.source.fields)
+
+    @mapped_property("ContentTypesCount")
+    def content_types_count(self):
+        return len(self.source.content_types)
+
+    @property
+    def list_template(self):
+        return self.source.base_template
+
     def build_query(self):
         # type: () -> Self
         self._query_list_metadata()
@@ -15,28 +39,6 @@ def build_query(self):
 
         return self
 
-    def process(self):
-        # type: () -> Dict
-        return {
-            "ListTemplate": self.source.base_template,
-            "NumOfAllItems": self.source.item_count,
-            # "NumOfPages": -1,
-            # "NumOfCheckedOutFiles": -1,
-            # "NumOfItems_HasUniquePermission": -1,
-            "NumOfUniquePermissions": (
-                len(self.source.role_assignments)
-                if self.source.has_unique_role_assignments
-                else 0
-            ),
-            "NumOfContentTypes": len(self.source.content_types),
-            "NumOfFields": len(self.source.fields),
-            # "NumOfLookupFields": -1,
-            # "TotalFileVersions": -1,
-            # "Size": -1,
-            "NumOfFiles": self._result["NumOfFiles"],
-            "NumOfFolders": self._result["NumOfFolders"],
-        }
-
     def _query_list_metadata(self):
         self.source.select(
             [
@@ -60,10 +62,10 @@ def _query_list_items(self):
 
     def _process_item(self, items):
         # type: (ListItemCollection) -> None
-        self._result.setdefault("NumOfFiles", 0)
-        self._result.setdefault("NumOfFolders", 0)
+        self._properties.setdefault("FilesCount", 0)
+        self._properties.setdefault("FoldersCount", 0)
 
         file_count = sum(1 for item in items if item.properties.get("FSObjType") == 0)
         folder_count = sum(1 for item in items if item.properties.get("FSObjType") == 1)
-        self._result["NumOfFiles"] += file_count
-        self._result["NumOfFolders"] += folder_count
+        self._properties["FilesCount"] += file_count
+        self._properties["FoldersCount"] += folder_count

office365/migration/assessment/scanners/__init__.py

@@ -0,0 +1,25 @@
+from office365.migration.assessment.scanners.base import BaseScanner, mapped_property
+from office365.sharepoint.sites.site import Site
+
+
+class SiteScanner(BaseScanner[Site]):
+    """ """
+
+    @mapped_property("FeaturesCount")
+    def features_count(self):
+        return len(self.source.features)
+
+    @mapped_property("UsersCount")
+    def users_count(self):
+        return len(self.source.root_web.site_users)
+
+    @mapped_property("GroupsCount")
+    def groups_count(self):
+        return len(self.source.root_web.site_groups)
+
+    def build_query(self):
+        self.source.select(["UsageInfo", "Features/Name"]).expand(["Features"]).get()
+
+        self.source.root_web.site_users.get()
+        self.source.root_web.site_groups.get()
+        return self

office365/migration/assessment/scanners/base.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.entity import Entity
+
+
+class ArchiveFileSizeMetric(Entity):
+    """ """