Skip to content

Home Information - Your home, your data, organized.

Python
14.3 KB
Raw Blame
import logging
from unittest.mock import Mock, patch

from hi.apps.console.transient_view_manager import TransientViewManager
from hi.testing.base_test_case import BaseTestCase

logging.disable(logging.CRITICAL)


class TestTransientViewManager(BaseTestCase):

    def setUp(self):
        super().setUp()
        # Reset singleton state for each test
        TransientViewManager._instance = None
        self.manager = TransientViewManager()
        
    def tearDown(self):
        # Clear any suggestions between tests
        self.manager.clear_suggestion()
        # Reset singleton for next test
        TransientViewManager._instance = None
        super().tearDown()

    def test_transient_view_manager_singleton_behavior(self):
        """Test TransientViewManager singleton pattern - critical for system consistency."""
        manager1 = TransientViewManager()
        manager2 = TransientViewManager()
        
        self.assertIs(manager1, manager2)
        return

    def test_priority_based_replacement_business_logic(self):
        """Test priority-based suggestion replacement - critical business logic for alert prioritization."""
        # Simulate realistic scenario: motion detection followed by critical alarm
        
        # Low priority motion detection from secondary camera
        self.manager.suggest_view_change(
            url='/console/sensor/backyard/video',
            duration_seconds=30,
            priority=10,  # Low priority
            trigger_reason='motion_detection_backyard'
        )
        
        initial_suggestion = self.manager.peek_current_suggestion()
        self.assertEqual(initial_suggestion.url, '/console/sensor/backyard/video')
        
        # High priority motion detection from front door (security concern)
        self.manager.suggest_view_change(
            url='/console/sensor/frontdoor/video',
            duration_seconds=45,
            priority=100,  # High priority security event
            trigger_reason='motion_detection_entrance'
        )
        
        # Should replace with higher priority
        current_suggestion = self.manager.peek_current_suggestion()
        self.assertEqual(current_suggestion.url, '/console/sensor/frontdoor/video')
        self.assertEqual(current_suggestion.priority, 100)
        
        # Lower priority subsequent event should be ignored
        self.manager.suggest_view_change(
            url='/console/sensor/garage/video',
            duration_seconds=30,
            priority=50,  # Medium priority, but lower than current
            trigger_reason='motion_detection_garage'
        )
        
        # Should still have high priority front door suggestion
        final_suggestion = self.manager.peek_current_suggestion()
        self.assertEqual(final_suggestion.url, '/console/sensor/frontdoor/video')
        self.assertEqual(final_suggestion.priority, 100)
        return

    def test_equal_priority_replacement_for_newer_events(self):
        """Test equal priority replacement - ensures newer events of same importance are shown."""
        # Realistic scenario: Multiple motion events of same priority
        # User should see the most recent one
        
        self.manager.suggest_view_change(
            url='/console/sensor/zone1/video',
            duration_seconds=30,
            priority=50,
            trigger_reason='motion_zone1'
        )
        
        # Same priority event from different zone
        self.manager.suggest_view_change(
            url='/console/sensor/zone2/video',
            duration_seconds=30,
            priority=50,  # Same priority
            trigger_reason='motion_zone2'
        )
        
        # Should have the newer suggestion
        suggestion = self.manager.peek_current_suggestion()
        self.assertEqual(suggestion.url, '/console/sensor/zone2/video')
        self.assertEqual(suggestion.trigger_reason, 'motion_zone2')
        return

    def test_get_and_clear_pattern_for_api_consumption(self):
        """Test get_current_suggestion consumption pattern - critical for API endpoint behavior."""
        # This simulates how the API status endpoint consumes suggestions
        
        self.manager.suggest_view_change(
            url='/console/sensor/123/video',
            duration_seconds=30,
            priority=75,
            trigger_reason='motion_alarm'
        )
        
        # First API call gets the suggestion
        suggestion = self.manager.get_current_suggestion()
        self.assertIsNotNone(suggestion)
        self.assertEqual(suggestion.url, '/console/sensor/123/video')
        
        # Subsequent API calls should get None (suggestion consumed)
        next_suggestion = self.manager.get_current_suggestion()
        self.assertIsNone(next_suggestion)
        
        # This prevents the same suggestion from being sent multiple times
        self.assertFalse(self.manager.has_suggestion())
        return

    def test_consider_alert_with_auto_view_enabled(self):
        """Test TransientViewManager considers alerts when auto-view enabled - core business logic."""
        from django.utils import timezone
        from hi.apps.alert.alert import Alert
        from hi.apps.alert.alarm import Alarm
        from hi.apps.alert.enums import AlarmLevel, AlarmSource
        from hi.apps.security.enums import SecurityLevel
        from hi.apps.entity.models import Entity, EntityState
        from hi.apps.sense.transient_models import SensorResponse
        from hi.integrations.transient_models import IntegrationKey
        from hi.apps.entity.enums import EntityStateType
        from hi.apps.sense.models import Sensor
        
        # Create test data - entity with both motion and video stream sensors
        entity = Entity.objects.create(
            integration_id='test.camera.front_door',
            integration_name='test_integration',
            name='Front Door Camera',
            entity_type_str='camera'
        )
        
        # Create motion sensor state
        motion_state = EntityState.objects.create(
            entity=entity,
            entity_state_type_str=str(EntityStateType.MOVEMENT),
            name='motion'
        )
        motion_sensor = Sensor.objects.create(
            entity_state=motion_state,
            integration_id='test.motion.front_door',
            integration_name='test_integration',
            name='Motion Sensor'
        )
        
        # Enable video stream capability for this entity
        entity.has_video_stream = True
        entity.save()
        
        # Create motion detection alert with motion sensor
        source_details = SensorResponse(
            integration_key=IntegrationKey("test", "test.sensor"),
            value="active",
            timestamp=timezone.now(),
            sensor=motion_sensor,  # Motion sensor that triggered the alarm
            detail_attrs={'location': 'Front Door'},
            has_event_video_clip=False
        )
        
        motion_alarm = Alarm(
            alarm_source=AlarmSource.EVENT,
            alarm_type='motion_detection',
            alarm_level=AlarmLevel.WARNING,
            title='Motion detected at Front Door',
            sensor_response_list=[source_details],
            security_level=SecurityLevel.OFF,
            alarm_lifetime_secs=300,
            timestamp=timezone.now()
        )
        
        alert = Alert(motion_alarm)
        
        # Mock settings to enable auto-view
        with patch('hi.apps.console.transient_view_manager.ConsoleSettingsHelper') as mock_helper_class:
            mock_helper = Mock()
            mock_helper.get_auto_view_enabled.return_value = True
            mock_helper.get_auto_view_duration.return_value = 30
            mock_helper_class.return_value = mock_helper
            
            # Mock URL generation at system boundary
            # Initially no suggestion
            self.assertFalse(self.manager.has_suggestion())
            
            # Consider alert for auto-view
            self.manager.consider_alert_for_auto_view(alert)
            
            # TransientViewManager should create suggestions for video-enabled entities
            self.assertTrue(self.manager.has_suggestion())
            
            # Verify suggestion content
            suggestion = self.manager.get_current_suggestion()
            self.assertIsNotNone(suggestion)
            self.assertIn('/console/entity/video/', suggestion.url)
            self.assertIn(str(entity.id), suggestion.url)
            self.assertEqual(suggestion.duration_seconds, 30)
            self.assertEqual(suggestion.priority, motion_alarm.alarm_level.priority)
            self.assertEqual(suggestion.trigger_reason, 'event_alert')
            
            # Verify suggestion is consumed (cleared after retrieval)
            self.assertFalse(self.manager.has_suggestion())

    def test_consider_alert_with_auto_view_disabled(self):
        """Test TransientViewManager ignores alerts when auto-view disabled - settings integration."""
        from django.utils import timezone
        from hi.apps.alert.alert import Alert
        from hi.apps.alert.alarm import Alarm
        from hi.apps.alert.enums import AlarmLevel, AlarmSource
        from hi.apps.security.enums import SecurityLevel
        from hi.apps.sense.transient_models import SensorResponse
        from hi.integrations.transient_models import IntegrationKey
        
        # Create motion detection alert
        source_details = SensorResponse(
            integration_key=IntegrationKey("test", "test.sensor"),
            value="active",
            timestamp=timezone.now(),
            sensor=None,  # TODO: fix sensor reference
            detail_attrs={},
            has_event_video_clip=False
        )
        
        motion_alarm = Alarm(
            alarm_source=AlarmSource.EVENT,
            alarm_type='motion_detection',
            alarm_level=AlarmLevel.WARNING,
            title='Motion detected',
            sensor_response_list=[source_details],
            security_level=SecurityLevel.OFF,
            alarm_lifetime_secs=300,
            timestamp=timezone.now()
        )
        
        alert = Alert(motion_alarm)
        
        # Mock settings to disable auto-view
        with patch('hi.apps.console.transient_view_manager.ConsoleSettingsHelper') as mock_helper_class:
            mock_helper = Mock()
            mock_helper.get_auto_view_enabled.return_value = False
            mock_helper_class.return_value = mock_helper
            
            # Consider alert for auto-view
            self.manager.consider_alert_for_auto_view(alert)
            
            # Should not create suggestion when disabled
            self.assertFalse(self.manager.has_suggestion())

    def test_consider_non_motion_alert_ignored(self):
        """Test TransientViewManager handles alerts without camera view URLs - integration test."""
        from django.utils import timezone
        from hi.apps.alert.alert import Alert
        from hi.apps.alert.alarm import Alarm
        from hi.apps.alert.enums import AlarmLevel, AlarmSource
        from hi.apps.security.enums import SecurityLevel
        from hi.apps.sense.transient_models import SensorResponse
        from hi.integrations.transient_models import IntegrationKey
        
        # Create non-motion EVENT alarm
        source_details = SensorResponse(
            integration_key=IntegrationKey("test", "test.sensor"),
            value="active",
            timestamp=timezone.now(),
            sensor=None,  # TODO: fix sensor reference
            detail_attrs={},
            has_event_video_clip=False
        )
        
        status_alarm = Alarm(
            alarm_source=AlarmSource.EVENT,
            alarm_type='device_status',  # Not motion-related
            alarm_level=AlarmLevel.INFO,
            title='Device status update',
            sensor_response_list=[source_details],
            security_level=SecurityLevel.OFF,
            alarm_lifetime_secs=300,
            timestamp=timezone.now()
        )
        
        alert = Alert(status_alarm)
        
        # Mock settings to enable auto-view
        with patch('hi.apps.console.transient_view_manager.ConsoleSettingsHelper') as mock_helper_class:
            mock_helper = Mock()
            mock_helper.get_auto_view_enabled.return_value = True
            mock_helper_class.return_value = mock_helper
            
            # Consider alert for auto-view
            self.manager.consider_alert_for_auto_view(alert)
            
            # Should not create suggestion for non-motion events
            self.assertFalse(self.manager.has_suggestion())

    def test_consider_alert_without_view_url_ignored(self):
        """Test TransientViewManager ignores alerts without view URLs - integration with Alert model."""
        from django.utils import timezone
        from hi.apps.alert.alert import Alert
        from hi.apps.alert.alarm import Alarm
        from hi.apps.alert.enums import AlarmLevel, AlarmSource
        from hi.apps.security.enums import SecurityLevel
        from hi.apps.sense.transient_models import SensorResponse
        from hi.integrations.transient_models import IntegrationKey
        
        # Create motion alarm but without sensor_id (no view URL)
        source_details = SensorResponse(
            integration_key=IntegrationKey("test", "test.no_sensor"),
            value="active",
            timestamp=timezone.now(),
            sensor=None,
            detail_attrs={'location': 'Front Door'},
            has_event_video_clip=False
        )
        
        motion_alarm = Alarm(
            alarm_source=AlarmSource.EVENT,
            alarm_type='motion_detection',
            alarm_level=AlarmLevel.WARNING,
            title='Motion detected',
            sensor_response_list=[source_details],
            security_level=SecurityLevel.OFF,
            alarm_lifetime_secs=300,
            timestamp=timezone.now()
        )
        
        alert = Alert(motion_alarm)
        
        # Mock settings to enable auto-view
        with patch('hi.apps.console.transient_view_manager.ConsoleSettingsHelper') as mock_helper_class:
            mock_helper = Mock()
            mock_helper.get_auto_view_enabled.return_value = True
            mock_helper_class.return_value = mock_helper
            
            # Consider alert for auto-view
            self.manager.consider_alert_for_auto_view(alert)
            
            # Should not create suggestion when no view URL available
            self.assertFalse(self.manager.has_suggestion())