Code coverage and pretty printing (#1283)

jacalata · LGraber · web-flow · commit 2f6a34322fea · 2023-09-25T16:17:47.000-07:00
* implement str and repr for a bunch more classes * also: versioning for JWT, user-impersonation (cherry picked from commit 4887a62) * fix code coverage action * use reflection to find all models for comprehensive testing. --------- Co-authored-by: Lee Graber <lgraber@tableau.com>
diff --git a/.github/workflows/code-coverage.yml b/.github/workflows/code-coverage.yml
@@ -30,7 +30,7 @@ jobs:
 
     #  https://github.com/marketplace/actions/pytest-coverage-comment
     - name: Generate coverage report
-      run: pytest --junitxml=pytest.xml --cov=tableauserverclient tests/ | tee pytest-coverage.txt
+      run: pytest --junitxml=pytest.xml --cov=tableauserverclient test/ | tee pytest-coverage.txt
 
     - name: Comment on pull request with coverage
       uses: MishaKav/pytest-coverage-comment@main
diff --git a/README.md b/README.md
@@ -19,4 +19,4 @@ For more information on installing and using TSC, see the documentation:
 
 
 ## License
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python?ref=badge_large)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python?ref=badge_large)
diff --git a/pyproject.toml b/pyproject.toml
@@ -31,7 +31,8 @@ classifiers = [
 repository = "https://github.com/tableau/server-client-python"
 
 [project.optional-dependencies]
-test = ["argparse", "black==23.7", "mock", "mypy==1.4", "pytest>=7.0", "pytest-subtests", "requests-mock>=1.0,<2.0"]
+test = ["argparse", "black==23.7", "mock", "mypy==1.4", "pytest>=7.0", "pytest-cov", "pytest-subtests",
+    "requests-mock>=1.0,<2.0"]
 
 [tool.black]
 line-length = 120
diff --git a/tableauserverclient/__init__.py b/tableauserverclient/__init__.py
@@ -1,6 +1,47 @@
 from ._version import get_versions
 from .namespace import NEW_NAMESPACE as DEFAULT_NAMESPACE
-from .models import *
+from .models import (
+    BackgroundJobItem,
+    ColumnItem,
+    ConnectionCredentials,
+    ConnectionItem,
+    CustomViewItem,
+    DQWItem,
+    DailyInterval,
+    DataAlertItem,
+    DatabaseItem,
+    DatasourceItem,
+    FavoriteItem,
+    FlowItem,
+    FlowRunItem,
+    FileuploadItem,
+    GroupItem,
+    HourlyInterval,
+    IntervalItem,
+    JobItem,
+    JWTAuth,
+    MetricItem,
+    MonthlyInterval,
+    PaginationItem,
+    Permission,
+    PermissionsRule,
+    PersonalAccessTokenAuth,
+    ProjectItem,
+    RevisionItem,
+    ScheduleItem,
+    SiteItem,
+    ServerInfoItem,
+    SubscriptionItem,
+    TableItem,
+    TableauAuth,
+    Target,
+    TaskItem,
+    UserItem,
+    ViewItem,
+    WebhookItem,
+    WeeklyInterval,
+    WorkbookItem,
+)
 from .server import (
     CSVRequestOptions,
     ExcelRequestOptions,
diff --git a/tableauserverclient/models/__init__.py b/tableauserverclient/models/__init__.py
@@ -31,7 +31,7 @@
 from .site_item import SiteItem
 from .subscription_item import SubscriptionItem
 from .table_item import TableItem
-from .tableau_auth import Credentials, TableauAuth, PersonalAccessTokenAuth
+from .tableau_auth import Credentials, TableauAuth, PersonalAccessTokenAuth, JWTAuth
 from .tableau_types import Resource, TableauItem, plural_type
 from .tag_item import TagItem
 from .target import Target
diff --git a/tableauserverclient/models/column_item.py b/tableauserverclient/models/column_item.py
@@ -9,6 +9,9 @@ def __init__(self, name, description=None):
         self.description = description
         self.name = name
 
+    def __repr__(self):
+        return f"<{self.__class__.__name__} {self._id} {self.name} {self.description}>"
+
     @property
     def id(self):
         return self._id
diff --git a/tableauserverclient/models/connection_credentials.py b/tableauserverclient/models/connection_credentials.py
@@ -15,6 +15,13 @@ def __init__(self, name, password, embed=True, oauth=False):
         self.embed = embed
         self.oauth = oauth
 
+    def __repr__(self):
+        if self.password:
+            print = "redacted"
+        else:
+            print = "None"
+        return f"<{self.__class__.__name__} name={self.name} password={print} embed={self.embed} oauth={self.oauth} >"
+
     @property
     def embed(self):
         return self._embed
diff --git a/tableauserverclient/models/data_acceleration_report_item.py b/tableauserverclient/models/data_acceleration_report_item.py
@@ -46,6 +46,9 @@ def avg_non_accelerated_plt(self):
     def __init__(self, comparison_records):
         self._comparison_records = comparison_records
 
+    def __repr__(self):
+        return f"<(deprecated)DataAccelerationReportItem site={self.site} sheet={sheet_uri}>"
+
     @property
     def comparison_records(self):
         return self._comparison_records
diff --git a/tableauserverclient/models/group_item.py b/tableauserverclient/models/group_item.py
@@ -26,11 +26,9 @@ def __init__(self, name=None, domain_name=None) -> None:
         self.name: Optional[str] = name
         self.domain_name: Optional[str] = domain_name
 
-    def __str__(self):
+    def __repr__(self):
         return "{}({!r})".format(self.__class__.__name__, self.__dict__)
 
-    __repr__ = __str__
-
     @property
     def domain_name(self) -> Optional[str]:
         return self._domain_name
@@ -48,7 +46,6 @@ def name(self) -> Optional[str]:
         return self._name
 
     @name.setter
-    @property_not_empty
     def name(self, value: str) -> None:
         self._name = value
 
diff --git a/tableauserverclient/models/interval_item.py b/tableauserverclient/models/interval_item.py
@@ -31,6 +31,9 @@ def __init__(self, start_time, end_time, interval_value):
         self.end_time = end_time
         self.interval = interval_value
 
+    def __repr__(self):
+        return f"<{self.__class__.__name__} start={self.start_time} end={self.end_time} interval={self.interval}>"
+
     @property
     def _frequency(self):
         return IntervalItem.Frequency.Hourly
@@ -86,6 +89,9 @@ def __init__(self, start_time, *interval_values):
         self.start_time = start_time
         self.interval = interval_values
 
+    def __repr__(self):
+        return f"<{self.__class__.__name__} start={self.start_time} interval={self.interval}>"
+
     @property
     def _frequency(self):
         return IntervalItem.Frequency.Daily
@@ -114,6 +120,9 @@ def __init__(self, start_time, *interval_values):
         self.start_time = start_time
         self.interval = interval_values
 
+    def __repr__(self):
+        return f"<{self.__class__.__name__} start={self.start_time} interval={self.interval}>"
+
     @property
     def _frequency(self):
         return IntervalItem.Frequency.Weekly
@@ -148,6 +157,9 @@ def __init__(self, start_time, interval_value):
         self.start_time = start_time
         self.interval = str(interval_value)
 
+    def __repr__(self):
+        return f"<{self.__class__.__name__} start={self.start_time} interval={self.interval}>"
+
     @property
     def _frequency(self):
         return IntervalItem.Frequency.Monthly
diff --git a/tableauserverclient/models/job_item.py b/tableauserverclient/models/job_item.py
@@ -117,12 +117,15 @@ def flow_run(self, value):
     def updated_at(self) -> Optional[datetime.datetime]:
         return self._updated_at
 
-    def __repr__(self):
+    def __str__(self):
         return (
             "<Job#{_id} {_type} created_at({_created_at}) started_at({_started_at}) updated_at({_updated_at}) completed_at({_completed_at})"
             " progress ({_progress}) finish_code({_finish_code})>".format(**self.__dict__)
         )
 
+    def __repr__(self):
+        return self.__str__() + "  { " + ", ".join(" % s: % s" % item for item in vars(self).items()) + "}"
+
     @classmethod
     def from_response(cls, xml, ns) -> List["JobItem"]:
         parsed_response = fromstring(xml)
@@ -202,6 +205,12 @@ def __init__(
         self._title = title
         self._subtitle = subtitle
 
+    def __str__(self):
+        return f"<{self.__class__.name} {self._id} {self._type}>"
+
+    def __repr__(self):
+        return self.__str__() + "  { " + ", ".join(" % s: % s" % item for item in vars(self).items()) + "}"
+
     @property
     def id(self) -> str:
         return self._id
diff --git a/tableauserverclient/models/metric_item.py b/tableauserverclient/models/metric_item.py
@@ -115,9 +115,12 @@ def view_id(self, value: Optional[str]) -> None:
     def _set_permissions(self, permissions):
         self._permissions = permissions
 
-    def __repr__(self):
+    def __str__(self):
         return "<MetricItem# name={_name} id={_id} owner_id={_owner_id}>".format(**vars(self))
 
+    def __repr__(self):
+        return self.__str__() + "  { " + ", ".join(" % s: % s" % item for item in vars(self).items()) + "}"
+
     @classmethod
     def from_response(
         cls,
diff --git a/tableauserverclient/models/pagination_item.py b/tableauserverclient/models/pagination_item.py
@@ -7,6 +7,9 @@ def __init__(self):
         self._page_size = None
         self._total_available = None
 
+    def __repr__(self):
+        return f"<PaginationItem page_number={self._page_number} page_size={self._page_size} total={self._total_available}>"
+
     @property
     def page_number(self) -> int:
         return self._page_number
diff --git a/tableauserverclient/models/permissions_item.py b/tableauserverclient/models/permissions_item.py
@@ -1,4 +1,3 @@
-import logging
 import xml.etree.ElementTree as ET
 from typing import Dict, List, Optional
 
@@ -17,6 +16,9 @@ class Mode:
         Allow = "Allow"
         Deny = "Deny"
 
+        def __repr__(self):
+            return "<Enum Mode: Allow | Deny>"
+
     class Capability:
         AddComment = "AddComment"
         ChangeHierarchy = "ChangeHierarchy"
@@ -39,17 +41,18 @@ class Capability:
         CreateRefreshMetrics = "CreateRefreshMetrics"
         SaveAs = "SaveAs"
 
+        def __repr__(self):
+            return "<Enum Capability: AddComment | ChangeHierarchy | ChangePermission ... (17 more) >"
+
 
 class PermissionsRule(object):
     def __init__(self, grantee: ResourceReference, capabilities: Dict[str, str]) -> None:
         self.grantee = grantee
         self.capabilities = capabilities
 
-    def __str__(self):
+    def __repr__(self):
         return "<PermissionsRule grantee={}, capabilities={}>".format(self.grantee, self.capabilities)
 
-    __repr__ = __str__
-
     @classmethod
     def from_response(cls, resp, ns=None) -> List["PermissionsRule"]:
         parsed_response = fromstring(resp)
diff --git a/tableauserverclient/models/schedule_item.py b/tableauserverclient/models/schedule_item.py
@@ -48,9 +48,12 @@ def __init__(self, name: str, priority: int, schedule_type: str, execution_order
         self.priority: int = priority
         self.schedule_type: str = schedule_type
 
-    def __repr__(self):
+    def __str__(self):
         return '<Schedule#{_id} "{_name}" {interval_item}>'.format(**vars(self))
 
+    def __repr__(self):
+        return self.__str__() + "  { " + ", ".join(" % s: % s" % item for item in vars(self).items()) + "}"
+
     @property
     def created_at(self) -> Optional[datetime]:
         return self._created_at
diff --git a/tableauserverclient/models/server_info_item.py b/tableauserverclient/models/server_info_item.py
@@ -12,7 +12,7 @@ def __init__(self, product_version, build_number, rest_api_version):
         self._build_number = build_number
         self._rest_api_version = rest_api_version
 
-    def __str__(self):
+    def __repr__(self):
         return (
             "ServerInfoItem: [product version: "
             + self._product_version
diff --git a/tableauserverclient/models/site_item.py b/tableauserverclient/models/site_item.py
@@ -39,6 +39,9 @@ def __str__(self):
             + ">"
         )
 
+    def __repr__(self):
+        return self.__str__() + "  { " + ", ".join(" % s: % s" % item for item in vars(self).items()) + "}"
+
     class AdminMode:
         ContentAndUsers: str = "ContentAndUsers"
         ContentOnly: str = "ContentOnly"
diff --git a/tableauserverclient/models/table_item.py b/tableauserverclient/models/table_item.py
@@ -19,6 +19,12 @@ def __init__(self, name, description=None):
         self._columns = None
         self._data_quality_warnings = None
 
+    def __str__(self):
+        return f"<{self.__class__.__name__} {self._id} {self._name} >"
+
+    def __repr__(self):
+        return self.__str__() + "  { " + ", ".join(" % s: % s" % item for item in vars(self).items()) + "}"
+
     @property
     def permissions(self):
         if self._permissions is None:
diff --git a/tableauserverclient/models/tableau_auth.py b/tableauserverclient/models/tableau_auth.py
@@ -43,7 +43,11 @@ def credentials(self):
         return {"name": self.username, "password": self.password}
 
     def __repr__(self):
-        return "<Credentials username={} password={}>".format(self.username, "<redacted>")
+        if self.user_id_to_impersonate:
+            uid = f", user_id_to_impersonate=f{self.user_id_to_impersonate}"
+        else:
+            uid = ""
+        return f"<Credentials username={self.username} password=redacted (site={self.site_id}{uid})>"
 
     @property
     def site(self):
@@ -56,6 +60,7 @@ def site(self, value):
         self.site_id = value
 
 
+# A Tableau-generated Personal Access Token
 class PersonalAccessTokenAuth(Credentials):
     def __init__(self, token_name, personal_access_token, site_id=None, user_id_to_impersonate=None):
         if personal_access_token is None or token_name is None:
@@ -72,13 +77,19 @@ def credentials(self):
         }
 
     def __repr__(self):
-        return "<PersonalAccessToken name={} token={}>(site={})".format(
-            self.token_name, self.personal_access_token[:2] + "...", self.site_id
+        if self.user_id_to_impersonate:
+            uid = f", user_id_to_impersonate=f{self.user_id_to_impersonate}"
+        else:
+            uid = ""
+        return (
+            f"<PersonalAccessToken name={self.token_name} token={self.personal_access_token[:2]}..."
+            f"(site={self.site_id}{uid} >"
         )
 
 
+# A standard JWT generated specifically for Tableau
 class JWTAuth(Credentials):
-    def __init__(self, jwt=None, site_id=None, user_id_to_impersonate=None):
+    def __init__(self, jwt: str, site_id=None, user_id_to_impersonate=None):
         if jwt is None:
             raise TabError("Must provide a JWT token when using JWT authentication")
         super().__init__(site_id, user_id_to_impersonate)
@@ -93,4 +104,4 @@ def __repr__(self):
             uid = f", user_id_to_impersonate=f{self.user_id_to_impersonate}"
         else:
             uid = ""
-        return f"<{self.__class__.__qualname__}(jwt={self.jwt[:5]}..., site_id={self.site_id}{uid})>"
+        return f"<{self.__class__.__qualname__} jwt={self.jwt[:5]}... (site={self.site_id}{uid})>"
diff --git a/tableauserverclient/models/user_item.py b/tableauserverclient/models/user_item.py
@@ -67,10 +67,13 @@ def __init__(
 
         return None
 
-    def __repr__(self) -> str:
+    def __str__(self) -> str:
         str_site_role = self.site_role or "None"
         return "<User {} name={} role={}>".format(self.id, self.name, str_site_role)
 
+    def __repr__(self):
+        return self.__str__() + "  { " + ", ".join(" % s: % s" % item for item in vars(self).items()) + "}"
+
     @property
     def auth_setting(self) -> Optional[str]:
         return self._auth_setting
diff --git a/tableauserverclient/models/view_item.py b/tableauserverclient/models/view_item.py
@@ -32,11 +32,14 @@ def __init__(self) -> None:
         self._permissions: Optional[Callable[[], List[PermissionsRule]]] = None
         self.tags: Set[str] = set()
 
-    def __repr__(self):
+    def __str__(self):
         return "<ViewItem {0} '{1}' contentUrl='{2}' project={3}>".format(
             self._id, self.name, self.content_url, self.project_id
         )
 
+    def __repr__(self):
+        return self.__str__() + "  { " + ", ".join(" % s: % s" % item for item in vars(self).items()) + "}"
+
     def _set_preview_image(self, preview_image):
         self._preview_image = preview_image
 
diff --git a/tableauserverclient/models/workbook_item.py b/tableauserverclient/models/workbook_item.py
diff --git a/tableauserverclient/server/endpoint/auth_endpoint.py b/tableauserverclient/server/endpoint/auth_endpoint.py
diff --git a/test/models/_models.py b/test/models/_models.py
diff --git a/test/models/test_repr.py b/test/models/test_repr.py
diff --git a/test/test_group_model.py b/test/test_group_model.py

Original file line number	Diff line number	Diff line change
`@@ -19,4 +19,4 @@ For more information on installing and using TSC, see the documentation:`
`19`	`19`
`20`	`20`
`21`	`21`	`## License`
`22`		`-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python?ref=badge_large)`
	`22`	`+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python?ref=badge_large)`