openwebrx-clone/test/owrx/property/test_property_stack.py

from unittest import TestCase
from unittest.mock import Mock
from owrx.property import PropertyLayer, PropertyStack, PropertyDeleted


class PropertyStackTest(TestCase):
    def testLayer(self):
        om = PropertyStack()
        pm = PropertyLayer()
        pm["testkey"] = "testvalue"
        om.addLayer(1, pm)
        self.assertEqual(om["testkey"], "testvalue")

    def testHighPriority(self):
        om = PropertyStack()
        low_pm = PropertyLayer()
        high_pm = PropertyLayer()
        low_pm["testkey"] = "low value"
        high_pm["testkey"] = "high value"
        om.addLayer(1, low_pm)
        om.addLayer(0, high_pm)
        self.assertEqual(om["testkey"], "high value")

    def testPriorityFallback(self):
        om = PropertyStack()
        low_pm = PropertyLayer()
        high_pm = PropertyLayer()
        low_pm["testkey"] = "low value"
        om.addLayer(1, low_pm)
        om.addLayer(0, high_pm)
        self.assertEqual(om["testkey"], "low value")

    def testLayerRemoval(self):
        om = PropertyStack()
        low_pm = PropertyLayer()
        high_pm = PropertyLayer()
        low_pm["testkey"] = "low value"
        high_pm["testkey"] = "high value"
        om.addLayer(1, low_pm)
        om.addLayer(0, high_pm)
        self.assertEqual(om["testkey"], "high value")
        om.removeLayer(high_pm)
        self.assertEqual(om["testkey"], "low value")

    def testLayerRemovalByPriority(self):
        om = PropertyStack()
        low_pm = PropertyLayer()
        high_pm = PropertyLayer()
        low_pm["testkey"] = "low value"
        high_pm["testkey"] = "high value"
        om.addLayer(1, low_pm)
        om.addLayer(0, high_pm)
        self.assertEqual(om["testkey"], "high value")
        om.removeLayerByPriority(0)
        self.assertEqual(om["testkey"], "low value")

    def testPropertyChange(self):
        layer = PropertyLayer()
        stack = PropertyStack()
        stack.addLayer(0, layer)
        mock = Mock()
        stack.wire(mock.method)
        layer["testkey"] = "testvalue"
        mock.method.assert_called_once_with({"testkey": "testvalue"})

    def testPropertyChangeEventPriority(self):
        low_layer = PropertyLayer()
        high_layer = PropertyLayer()
        low_layer["testkey"] = "initial low value"
        high_layer["testkey"] = "initial high value"
        stack = PropertyStack()
        stack.addLayer(1, low_layer)
        stack.addLayer(0, high_layer)
        mock = Mock()
        stack.wire(mock.method)
        low_layer["testkey"] = "modified low value"
        mock.method.assert_not_called()
        high_layer["testkey"] = "modified high value"
        mock.method.assert_called_once_with({"testkey": "modified high value"})

    def testPropertyEventOnLayerAdd(self):
        low_layer = PropertyLayer()
        low_layer["testkey"] = "low value"
        stack = PropertyStack()
        stack.addLayer(1, low_layer)
        mock = Mock()
        stack.wireProperty("testkey", mock.method)
        mock.reset_mock()
        high_layer = PropertyLayer()
        high_layer["testkey"] = "high value"
        stack.addLayer(0, high_layer)
        mock.method.assert_called_once_with("high value")

    def testNoEventOnExistingValue(self):
        low_layer = PropertyLayer()
        low_layer["testkey"] = "same value"
        stack = PropertyStack()
        stack.addLayer(1, low_layer)
        mock = Mock()
        stack.wireProperty("testkey", mock.method)
        mock.reset_mock()
        high_layer = PropertyLayer()
        high_layer["testkey"] = "same value"
        stack.addLayer(0, high_layer)
        mock.method.assert_not_called()

    def testEventOnLayerWithNewProperty(self):
        low_layer = PropertyLayer()
        low_layer["existingkey"] = "existing value"
        stack = PropertyStack()
        stack.addLayer(1, low_layer)
        mock = Mock()
        stack.wireProperty("newkey", mock.method)
        high_layer = PropertyLayer()
        high_layer["newkey"] = "new value"
        stack.addLayer(0, high_layer)
        mock.method.assert_called_once_with("new value")

    def testEventOnLayerRemoval(self):
        low_layer = PropertyLayer()
        high_layer = PropertyLayer()
        stack = PropertyStack()
        stack.addLayer(1, low_layer)
        stack.addLayer(0, high_layer)
        low_layer["testkey"] = "low value"
        high_layer["testkey"] = "high value"

        mock = Mock()
        stack.wireProperty("testkey", mock.method)
        mock.method.assert_called_once_with("high value")
        mock.reset_mock()
        stack.removeLayer(high_layer)
        mock.method.assert_called_once_with("low value")

    def testNoneOnKeyRemoval(self):
        low_layer = PropertyLayer()
        high_layer = PropertyLayer()
        stack = PropertyStack()
        stack.addLayer(1, low_layer)
        stack.addLayer(0, high_layer)
        low_layer["testkey"] = "low value"
        high_layer["testkey"] = "high value"
        high_layer["unique key"] = "unique value"

        mock = Mock()
        stack.wireProperty("unique key", mock.method)
        mock.method.assert_called_once_with("unique value")
        mock.reset_mock()
        stack.removeLayer(high_layer)
        mock.method.assert_called_once_with(PropertyDeleted)

    def testReplaceLayer(self):
        first_layer = PropertyLayer()
        first_layer["testkey"] = "old value"
        second_layer = PropertyLayer()
        second_layer["testkey"] = "new value"

        stack = PropertyStack()
        stack.addLayer(0, first_layer)

        mock = Mock()
        stack.wireProperty("testkey", mock.method)
        mock.method.assert_called_once_with("old value")
        mock.reset_mock()

        stack.replaceLayer(0, second_layer)
        mock.method.assert_called_once_with("new value")

    def testUnwiresEventsOnRemoval(self):
        layer = PropertyLayer()
        layer["testkey"] = "before"
        stack = PropertyStack()
        stack.addLayer(0, layer)
        mock = Mock()
        stack.wire(mock.method)
        stack.removeLayer(layer)
        mock.method.assert_called_once_with({"testkey": PropertyDeleted})
        mock.reset_mock()

        layer["testkey"] = "after"
        mock.method.assert_not_called()

    def testReplaceLayerNoEventWhenValueUnchanged(self):
        fixed = PropertyLayer()
        fixed["testkey"] = "fixed value"
        first_layer = PropertyLayer()
        first_layer["testkey"] = "same value"
        second_layer = PropertyLayer()
        second_layer["testkey"] = "same value"

        stack = PropertyStack()
        stack.addLayer(1, fixed)
        stack.addLayer(0, first_layer)
        mock = Mock()
        stack.wire(mock.method)
        mock.method.assert_not_called()

        stack.replaceLayer(0, second_layer)
        mock.method.assert_not_called()

    def testWritesToExpectedLayer(self):
        om = PropertyStack()
        low_pm = PropertyLayer()
        high_pm = PropertyLayer()
        low_pm["testkey"] = "low value"
        om.addLayer(1, low_pm)
        om.addLayer(0, high_pm)
        om["testkey"] = "new value"
        self.assertEqual(low_pm["testkey"], "new value")

    def testDeletionEvent(self):
        ps = PropertyStack()
        pm = PropertyLayer(testkey="testvalue")
        ps.addLayer(0, pm)
        mock = Mock()
        ps.wire(mock.method)
        del ps["testkey"]
        mock.method.assert_called_once_with({"testkey": PropertyDeleted})

    def testDeletionWithSecondLayer(self):
        ps = PropertyStack()
        low_pm = PropertyLayer(testkey="testvalue")
        high_pm = PropertyLayer()
        ps.addLayer(0, high_pm)
        ps.addLayer(1, low_pm)
        mock = Mock()
        ps.wire(mock.method)
        del low_pm["testkey"]
        mock.method.assert_called_once_with({"testkey": PropertyDeleted})

    def testChangeEventWhenKeyDeleted(self):
        ps = PropertyStack()
        low_pm = PropertyLayer(testkey="lowvalue")
        high_pm = PropertyLayer(testkey="highvalue")
        ps.addLayer(0, high_pm)
        ps.addLayer(1, low_pm)
        mock = Mock()
        ps.wire(mock.method)
        del high_pm["testkey"]
        mock.method.assert_called_once_with({"testkey": "lowvalue"})