tests: optimized to use fixtures - used CoPilot

Author: santhoshramaraj

tests/core/test_minion_id.py

@@ -5,14 +5,28 @@
 from pathlib import Path
 from unittest import mock
 
+import pytest
 from nisystemlink.clients.core.helpers._minion_id import read_minion_id
 
 
-class TestReadMinionId:
-    """Test cases for read_minion_id function."""
+@pytest.fixture
+def mock_path_constants():
+    """Fixture to mock PathConstants."""
+    with mock.patch(
+        "nisystemlink.clients.core.helpers._minion_id.PathConstants"
+    ) as mock_constants:
+        yield mock_constants
+
+
+@pytest.fixture
+def mock_minion_id_path(mock_path_constants):
+    """Fixture to set up the mock path structure for minion_id file.
+
+    Returns a callable that accepts an exists parameter to configure
+    whether the path exists.
+    """
 
-    def _setup_mock_path(self, mock_path_constants, exists=True):
-        """Helper to set up the mock path structure."""
+    def _create_mock_path(exists=True):
         mock_minion_id_path = mock.Mock(spec=Path)
         mock_minion_id_path.exists.return_value = exists
 
@@ -27,12 +41,17 @@ def _setup_mock_path(self, mock_path_constants, exists=True):
 
         return mock_minion_id_path
 
-    @mock.patch("nisystemlink.clients.core.helpers._minion_id.PathConstants")
-    def test__minion_id_file_exists__returns_content(self, mock_path_constants):
+    return _create_mock_path
+
+
+class TestReadMinionId:
+    """Test cases for read_minion_id function."""
+
+    def test__minion_id_file_exists__returns_content(self, mock_minion_id_path):
         """Test that the minion ID is read correctly when the file exists."""
         # Arrange
         expected_minion_id = "test-minion-123"
-        mock_minion_id_path = self._setup_mock_path(mock_path_constants, exists=True)
+        minion_path = mock_minion_id_path(exists=True)
 
         # Mock the file open and read
         mock_open = mock.mock_open(read_data=f"{expected_minion_id}\n")
@@ -43,17 +62,16 @@ def test__minion_id_file_exists__returns_content(self, mock_path_constants):
 
         # Assert
         assert result == expected_minion_id
-        mock_minion_id_path.exists.assert_called_once()
-        mock_open.assert_called_once_with(mock_minion_id_path, "r", encoding="utf-8")
+        minion_path.exists.assert_called_once()
+        mock_open.assert_called_once_with(minion_path, "r", encoding="utf-8")
 
-    @mock.patch("nisystemlink.clients.core.helpers._minion_id.PathConstants")
     def test__minion_id_file_exists_with_whitespace__returns_stripped_content(
-        self, mock_path_constants
+        self, mock_minion_id_path
     ):
         """Test that the minion ID is stripped of leading/trailing whitespace."""
         # Arrange
         expected_minion_id = "test-minion-456"
-        mock_minion_id_path = self._setup_mock_path(mock_path_constants, exists=True)
+        minion_path = mock_minion_id_path(exists=True)
 
         # Mock the file open with extra whitespace
         mock_open = mock.mock_open(read_data=f"  {expected_minion_id}  \n\t")
@@ -64,26 +82,24 @@ def test__minion_id_file_exists_with_whitespace__returns_stripped_content(
 
         # Assert
         assert result == expected_minion_id
-        mock_minion_id_path.exists.assert_called_once()
+        minion_path.exists.assert_called_once()
 
-    @mock.patch("nisystemlink.clients.core.helpers._minion_id.PathConstants")
-    def test__minion_id_file_does_not_exist__returns_none(self, mock_path_constants):
+    def test__minion_id_file_does_not_exist__returns_none(self, mock_minion_id_path):
         """Test that None is returned when the minion_id file does not exist."""
         # Arrange
-        mock_minion_id_path = self._setup_mock_path(mock_path_constants, exists=False)
+        minion_path = mock_minion_id_path(exists=False)
 
         # Act
         result = read_minion_id()
 
         # Assert
         assert result is None
-        mock_minion_id_path.exists.assert_called_once()
+        minion_path.exists.assert_called_once()
 
-    @mock.patch("nisystemlink.clients.core.helpers._minion_id.PathConstants")
-    def test__minion_id_file_has_oserror__returns_none(self, mock_path_constants):
+    def test__minion_id_file_has_oserror__returns_none(self, mock_minion_id_path):
         """Test that None is returned when an OSError occurs reading the file."""
         # Arrange
-        mock_minion_id_path = self._setup_mock_path(mock_path_constants, exists=True)
+        minion_path = mock_minion_id_path(exists=True)
 
         # Mock the file open to raise OSError
         mock_open = mock.mock_open()
@@ -95,15 +111,14 @@ def test__minion_id_file_has_oserror__returns_none(self, mock_path_constants):
 
         # Assert
         assert result is None
-        mock_minion_id_path.exists.assert_called_once()
+        minion_path.exists.assert_called_once()
 
-    @mock.patch("nisystemlink.clients.core.helpers._minion_id.PathConstants")
     def test__minion_id_file_has_permission_error__returns_none(
-        self, mock_path_constants
+        self, mock_minion_id_path
     ):
         """Test that None is returned when a PermissionError occurs reading the file."""
         # Arrange
-        mock_minion_id_path = self._setup_mock_path(mock_path_constants, exists=True)
+        minion_path = mock_minion_id_path(exists=True)
 
         # Mock the file open to raise PermissionError
         mock_open = mock.mock_open()
@@ -115,13 +130,12 @@ def test__minion_id_file_has_permission_error__returns_none(
 
         # Assert
         assert result is None
-        mock_minion_id_path.exists.assert_called_once()
+        minion_path.exists.assert_called_once()
 
-    @mock.patch("nisystemlink.clients.core.helpers._minion_id.PathConstants")
-    def test__minion_id_file_is_empty__returns_empty_string(self, mock_path_constants):
+    def test__minion_id_file_is_empty__returns_empty_string(self, mock_minion_id_path):
         """Test that an empty string is returned when the file is empty."""
         # Arrange
-        mock_minion_id_path = self._setup_mock_path(mock_path_constants, exists=True)
+        minion_path = mock_minion_id_path(exists=True)
 
         # Mock the file open with empty content
         mock_open = mock.mock_open(read_data="")
@@ -132,15 +146,14 @@ def test__minion_id_file_is_empty__returns_empty_string(self, mock_path_constant
 
         # Assert
         assert result == ""
-        mock_minion_id_path.exists.assert_called_once()
+        minion_path.exists.assert_called_once()
 
-    @mock.patch("nisystemlink.clients.core.helpers._minion_id.PathConstants")
     def test__minion_id_file_only_whitespace__returns_empty_string(
-        self, mock_path_constants
+        self, mock_minion_id_path
     ):
         """Test that an empty string is returned when the file contains only whitespace."""
         # Arrange
-        mock_minion_id_path = self._setup_mock_path(mock_path_constants, exists=True)
+        minion_path = mock_minion_id_path(exists=True)
 
         # Mock the file open with only whitespace
         mock_open = mock.mock_open(read_data="   \n\t  \n")
@@ -151,4 +164,4 @@ def test__minion_id_file_only_whitespace__returns_empty_string(
 
         # Assert
         assert result == ""
-        mock_minion_id_path.exists.assert_called_once()
+        minion_path.exists.assert_called_once()