test: Ruff formatting for test code

Author: RogerSelwyn

pyproject.toml

@@ -505,7 +505,7 @@ split-on-trailing-comma = false
 "script/*" = ["T20"]
 
 # Allow relative imports within auth and within components
-"tests/components/*/*/*" = ["TID252"]
+"tests/*" = ["TID252"]
 "custom_components/*/*/*"  = ["TID252"]
 
 # Temporary

tests/conftest.py

@@ -33,14 +33,14 @@
 
 @pytest.fixture(autouse=True)
 def folder_setup(tmp_path):
-    """Setup the testing session."""
+    """Folder setup for testing session."""
     directory = tmp_path / TOKEN_LOCATION
     directory.mkdir(parents=True, exist_ok=True)
 
 
 @pytest.fixture(autouse=True)
 def token_storage_path_setup(tmp_path):
-    """Setup the storage paths."""
+    """Storage paths setup."""
     tk_path = tmp_path / TOKEN_LOCATION
 
     with patch.object(
@@ -126,7 +126,7 @@ def v1_config_entry(request, hass: HomeAssistant) -> MS365MockConfigEntry:
 
 @pytest.fixture
 def base_token(request, tmp_path):
-    """Setup a basic token."""
+    """Create the Base token."""
     perms = BASE_TOKEN_PERMS
     if hasattr(request, "param"):
         perms = request.param
@@ -135,7 +135,7 @@ def base_token(request, tmp_path):
 
 @pytest.fixture
 def legacy_token(tmp_path):
-    """Setup a legacy token."""
+    """Create a legacy token."""
     token = LEGACY_TOKEN
     filename = tmp_path / TOKEN_LOCATION / f"{DOMAIN}_{ENTITY_NAME}.token"
     with open(filename, "w", encoding="UTF8") as f:

tests/const.py

@@ -15,8 +15,7 @@
     "https://login.microsoftonline.com/common/oauth2/v2.0/" + "authorize?client_id="
 )
 TOKEN_URL_CN21V_ASSERT = (
-    "https://login.partner.microsoftonline.cn/common/oauth2/v2.0/"
-    + "authorize?client_id="
+    "https://login.partner.microsoftonline.cn/common/oauth2/v2.0/authorize?client_id="
 )
 STORAGE_LOCATION = "storage"
 TOKEN_LOCATION = "storage/tokens"

tests/helpers/utils.py

@@ -40,7 +40,7 @@ def mock_cn21v_token(requests_mock, scope):
     )
 
 def _build_file_token(scope):
-    """Build a token"""
+    """Build a token."""
     perms = f"{scope} User.Read email openid profile"
     expire = int(time.time() + TOKEN_TIME)
     return {
@@ -101,7 +101,7 @@ def _build_file_token(scope):
 
 
 def build_retrieved_token(scope):
-    """Build a token"""
+    """Build a token."""
     return {
         "token_type": "Bearer",
         "scope": f"{scope} User.Read profile openid email",
@@ -113,7 +113,7 @@ def build_retrieved_token(scope):
 
 
 def build_token_url(result, token_url):
-    """Build the correct token url"""
+    """Build the correct token url."""
     state = re.search("state=(.*?)&", result["description_placeholders"]["auth_url"])[1]
 
     return f"{token_url}?{TOKEN_PARAMS.format(state)}"
@@ -137,7 +137,7 @@ def mock_call(
     method="get",
     tenant_id=None,
 ):
-    """Mock a call"""
+    """Mock a call."""
     data = load_json(f"O365/{datafile}.json")
     if start:
         data = data.replace("2020-01-01", start).replace("2020-01-02", end)
@@ -174,17 +174,17 @@ def check_entity_state(
 ):
     """Check entity state."""
     state = hass.states.get(entity_name)
-    print("*************************** State")
-    print(state)
-    print("--- State Attributes")
-    print(state.attributes)
+    # print("*************************** State")
+    # print(state)
+    # print("--- State Attributes")
+    # print(state.attributes)
     assert state.state == entity_state
     if entity_attributes:
         if "data" in state.attributes:
-            print("--- Data Attributes")
-            print(state.attributes["data"])
-            print("--- Match Attributes")
-            print(entity_attributes)
+            # print("--- Data Attributes")
+            # print(state.attributes["data"])
+            # print("--- Match Attributes")
+            # print(entity_attributes)
             assert state.attributes["data"] == entity_attributes
         else:
             assert state.attributes == entity_attributes
@@ -202,7 +202,7 @@ def utcnow():
 
 
 def token_setup(tmp_path, infile):
-    """Setup a token file"""
+    """Create a token file."""
     fromfile = TEST_DATA_LOCATION / f"token/{infile}.token"
     tofile = tmp_path / TOKEN_LOCATION / f"{DOMAIN}_test.token"
     shutil.copy(fromfile, tofile)

tests/integration/const_integration.py

@@ -81,7 +81,7 @@
 
 
 class URL(Enum):
-    """List of URLs"""
+    """List of URLs."""
 
     OPENID = (
         "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration"
@@ -95,7 +95,7 @@ class URL(Enum):
 
 
 class CN21VURL(Enum):
-    """List of URLs"""
+    """List of URLs."""
 
     DISCOVERY = "https://login.microsoftonline.com/common/discovery/instance"
     OPENID = "https://login.partner.microsoftonline.cn/common/v2.0/.well-known/openid-configuration"

tests/integration/fixtures.py

@@ -23,7 +23,7 @@
 
 @pytest.fixture(autouse=True)
 def yaml_storage_path_setup(tmp_path):
-    """Setup the storage paths."""
+    """Create the storage paths."""
     yml_path = tmp_path / STORAGE_LOCATION / f"{DOMAIN}s_test.yaml"
 
     with patch.object(

tests/integration/helpers_integration/mocks.py

@@ -9,7 +9,7 @@ class MS365Mocks:
     """Standard mocks."""
 
     def standard_mocks(self, requests_mock):
-        """Setup the standard mocks."""
+        """Create the standard mocks."""
         mock_call(requests_mock, URL.OPENID, "openid")
         mock_call(requests_mock, URL.ME, "me")
         mock_call(requests_mock, URL.CALENDARS, "calendars")
@@ -42,7 +42,7 @@ def standard_mocks(self, requests_mock):
         )
 
     def cn21v_mocks(self, requests_mock, tenant_id="common"):
-        """Setup the standard mocks."""
+        """Create the standard mocks."""
         mock_call(requests_mock, CN21VURL.DISCOVERY, "discovery")
         # Mock the /common/ openid config with CN21V-specific URLs.
         # MSAL fetches this via the discovery response's tenant_discovery_endpoint.
@@ -59,7 +59,7 @@ def cn21v_mocks(self, requests_mock, tenant_id="common"):
         mock_call(requests_mock, CN21VURL.CALENDARS, "calendar3", "calendar3")
 
     def shared_mocks(self, requests_mock):
-        """Setup the standard mocks."""
+        """Create the standard mocks."""
         mock_call(requests_mock, URL.OPENID, "openid")
         mock_call(requests_mock, URL.ME, "me")
         mock_call(requests_mock, URL.SHARED_CALENDARS, "calendars")
@@ -90,7 +90,7 @@ def shared_mocks(self, requests_mock):
         )
 
     def no_events_mocks(self, requests_mock):
-        """Setup the standard mocks."""
+        """Create the standard mocks."""
         _generic_mocks(requests_mock)
         mock_call(
             requests_mock,
@@ -102,7 +102,7 @@ def no_events_mocks(self, requests_mock):
         )
 
     def all_day_event_mocks(self, requests_mock):
-        """Setup the standard mocks."""
+        """Create the standard mocks."""
         _generic_mocks(requests_mock)
         mock_call(
             requests_mock,
@@ -114,7 +114,7 @@ def all_day_event_mocks(self, requests_mock):
         )
 
     def started_event_mocks(self, requests_mock):
-        """Setup the standard mocks."""
+        """Create the standard mocks."""
         _generic_mocks(requests_mock)
         mock_call(
             requests_mock,
@@ -126,7 +126,7 @@ def started_event_mocks(self, requests_mock):
         )
 
     def not_started_event_mocks(self, requests_mock):
-        """Setup the standard mocks."""
+        """Create the standard mocks."""
         _generic_mocks(requests_mock)
         mock_call(
             requests_mock,

tests/integration/helpers_integration/utils_integration.py

@@ -27,7 +27,7 @@
 
 
 def yaml_setup(tmp_path, infile):
-    """Setup a yaml file"""
+    """Create a yaml file."""
     fromfile = TEST_DATA_INTEGRATION_LOCATION / f"yaml/{infile}.yaml"
     tofile = tmp_path / STORAGE_LOCATION / f"{DOMAIN}s_test.yaml"
     shutil.copy(fromfile, tofile)
@@ -37,7 +37,7 @@ async def update_options(
     hass: HomeAssistant,
     base_config_entry: MS365MockConfigEntry,
 ) -> None:
-    """Test the options flow"""
+    """Test the options flow."""
 
     result = await hass.config_entries.options.async_init(base_config_entry.entry_id)
     result = await hass.config_entries.options.async_configure(

tests/integration/test_config_flow.py

@@ -45,7 +45,7 @@ async def test_options_flow(
     setup_base_integration,
     base_config_entry: MS365MockConfigEntry,
 ) -> None:
-    """Test the options flow"""
+    """Test the options flow."""
 
     result = await hass.config_entries.options.async_init(base_config_entry.entry_id)
     await hass.async_block_till_done()

tests/integration/test_filemgmt.py

@@ -80,4 +80,4 @@ async def test_deleted_file(
 
     check_yaml_file_contents(tmp_path, "ms365_calendars_base")
 
-    assert "Calendar deleted from" in caplog.text
+    assert "Calendar deleted from" in caplog.text