add tests for gui tool

tests/interactive_tools/test_create_los_tool.py

@@ -0,0 +1,259 @@
+# pylint: disable=protected-access
+import pytest
+from qgis.core import QgsProject, QgsRasterLayer
+from qgis.gui import QgisInterface, QgsMapCanvas
+from qgis.PyQt.QtCore import QEvent, Qt
+from qgis.PyQt.QtWidgets import QWidget
+
+from los_tools.gui.create_los_tool.create_los_tool import CreateLoSMapTool
+from los_tools.gui.dialog_los_settings import LoSSettings
+from los_tools.gui.dialog_raster_validations import RasterValidations
+from tests.utils import create_mouse_event
+
+
+def test_local_los(
+    qgis_parent: QWidget,
+    qgis_iface: QgisInterface,
+    raster_small: QgsRasterLayer,
+    raster_large: QgsRasterLayer,
+    qgis_canvas: QgsMapCanvas,
+):
+
+    project = QgsProject.instance()
+    project.addMapLayer(raster_small)
+    project.addMapLayer(raster_large)
+
+    center_point = raster_small.extent().center()
+    left_point = center_point.project(75, 90)
+
+    raster_validation_dialog = RasterValidations(qgis_iface)
+
+    los_settings = LoSSettings(qgis_parent)
+
+    map_tool = CreateLoSMapTool(qgis_iface, raster_validation_dialog, los_settings)
+
+    map_tool.activate()
+
+    assert map_tool._start_point is None
+    assert map_tool._last_towards_point is None
+    assert map_tool._los_rubber_band.size() == 0
+
+    # set observer point
+    map_tool.canvasReleaseEvent(create_mouse_event(qgis_canvas, center_point))
+
+    assert map_tool._start_point is not None
+    assert map_tool._start_point.isEmpty() is False
+    assert map_tool._last_towards_point is None
+    assert map_tool._los_rubber_band.size() == 0
+
+    # move mouse - start creating LoS
+    map_tool.canvasMoveEvent(create_mouse_event(qgis_canvas, left_point, event=QEvent.Type.MouseMove))
+
+    assert map_tool._start_point is not None
+    assert map_tool._last_towards_point is not None
+    assert map_tool._last_towards_point.isEmpty() is False
+    assert map_tool._los_rubber_band.size() == 1
+    assert map_tool._los_rubber_band.asGeometry().length() == 75
+
+    # set second point create local LoS
+    map_tool.canvasReleaseEvent(create_mouse_event(qgis_canvas, left_point))
+
+    assert map_tool._start_point is None
+    assert map_tool._last_towards_point is not None
+    assert map_tool._last_towards_point.isEmpty() is False
+    assert map_tool._los_rubber_band.size() == 1
+
+    assert map_tool._los_rubber_band.asGeometry().length() == 75
+    assert map_tool._los_rubber_band.asGeometry().asWkt(0) == "LineString (-336420 -1189120, -336345 -1189120)"
+
+    map_tool.deactivate()
+
+
+def test_global_los(
+    qgis_parent: QWidget,
+    qgis_iface: QgisInterface,
+    raster_small: QgsRasterLayer,
+    raster_large: QgsRasterLayer,
+    qgis_canvas: QgsMapCanvas,
+):
+
+    project = QgsProject.instance()
+    project.addMapLayer(raster_small)
+    project.addMapLayer(raster_large)
+
+    center_point = raster_small.extent().center()
+    left_point = center_point.project(75, 90)
+
+    raster_validation_dialog = RasterValidations(qgis_iface)
+
+    los_settings = LoSSettings(qgis_parent)
+
+    map_tool = CreateLoSMapTool(qgis_iface, raster_validation_dialog, los_settings)
+
+    map_tool.activate()
+
+    assert map_tool._start_point is None
+    assert map_tool._last_towards_point is None
+    assert map_tool._los_rubber_band.size() == 0
+
+    # set observer point
+    map_tool.canvasReleaseEvent(create_mouse_event(qgis_canvas, center_point))
+
+    assert map_tool._start_point is not None
+    assert map_tool._start_point.isEmpty() is False
+    assert map_tool._last_towards_point is None
+    assert map_tool._los_rubber_band.size() == 0
+    assert map_tool._widget._add_los_to_layer.isEnabled() is False
+
+    # set global LoS
+    map_tool._widget._los_type.setCurrentIndex(1)
+
+    # move mouse - start creating LoS
+    map_tool.canvasMoveEvent(create_mouse_event(qgis_canvas, left_point, event=QEvent.Type.MouseMove))
+
+    assert map_tool._start_point is not None
+    assert map_tool._last_towards_point is not None
+    assert map_tool._last_towards_point.isEmpty() is False
+    assert map_tool._los_rubber_band.size() == 1
+    assert map_tool._los_rubber_band.asGeometry().length() == pytest.approx(1822.1, rel=0.1)
+    assert map_tool._widget._add_los_to_layer.isEnabled() is False
+
+    # create global LoS
+    map_tool.canvasReleaseEvent(create_mouse_event(qgis_canvas, left_point))
+
+    assert map_tool._start_point is None
+    assert map_tool._last_towards_point is not None
+    assert map_tool._last_towards_point.isEmpty() is False
+    assert map_tool._los_rubber_band.size() == 1
+
+    assert map_tool._los_rubber_band.asGeometry().length() == pytest.approx(1822.1, rel=0.1)
+    assert (
+        map_tool._los_rubber_band.asGeometry().asWkt(0)
+        == "LineString (-336420 -1189120, -336345 -1189120, -334598 -1189120)"
+    )
+    assert map_tool._widget._add_los_to_layer.isEnabled()
+
+    map_tool.deactivate()
+
+
+def test_no_target_los(
+    qgis_parent: QWidget,
+    qgis_iface: QgisInterface,
+    raster_small: QgsRasterLayer,
+    raster_large: QgsRasterLayer,
+    qgis_canvas: QgsMapCanvas,
+):
+
+    project = QgsProject.instance()
+    project.addMapLayer(raster_small)
+    project.addMapLayer(raster_large)
+
+    center_point = raster_small.extent().center()
+    left_point = center_point.project(75, 90)
+
+    raster_validation_dialog = RasterValidations(qgis_iface)
+
+    los_settings = LoSSettings(qgis_parent)
+
+    map_tool = CreateLoSMapTool(qgis_iface, raster_validation_dialog, los_settings)
+
+    map_tool.activate()
+
+    assert map_tool._start_point is None
+    assert map_tool._last_towards_point is None
+    assert map_tool._los_rubber_band.size() == 0
+
+    # set observer point
+    map_tool.canvasReleaseEvent(create_mouse_event(qgis_canvas, center_point))
+
+    assert map_tool._start_point is not None
+    assert map_tool._start_point.isEmpty() is False
+    assert map_tool._last_towards_point is None
+    assert map_tool._los_rubber_band.size() == 0
+
+    # prior to setting no target LoS these should be disabled
+    assert map_tool._widget._angle_difference.isEnabled() is False
+    assert map_tool._widget._angle_step.isEnabled() is False
+
+    # set notarget LoS
+    map_tool._widget._los_type.setCurrentIndex(2)
+    assert map_tool._widget._angle_difference.isEnabled()
+    assert map_tool._widget._angle_step.isEnabled()
+    angle_diff = 20
+    angle_step = 1
+    map_tool._widget._angle_difference.setValue(angle_diff)
+    map_tool._widget._angle_step.setValue(angle_step)
+
+    # move mouse - start creating LoS
+    map_tool.canvasMoveEvent(create_mouse_event(qgis_canvas, left_point, event=QEvent.Type.MouseMove))
+
+    assert map_tool._start_point is not None
+    assert map_tool._last_towards_point is not None
+    assert map_tool._last_towards_point.isEmpty() is False
+    assert map_tool._los_rubber_band.size() == ((2 * angle_diff) / angle_step) + 1
+    geom = map_tool._los_rubber_band.asGeometry()
+    assert geom.get().parts().next().length() == pytest.approx(1939.0, rel=0.1)
+
+    # create global LoS
+    map_tool.canvasReleaseEvent(create_mouse_event(qgis_canvas, left_point))
+
+    assert map_tool._start_point is None
+    assert map_tool._last_towards_point is not None
+    assert map_tool._last_towards_point.isEmpty() is False
+    assert map_tool._los_rubber_band.size() == ((2 * angle_diff) / angle_step) + 1
+    geom = map_tool._los_rubber_band.asGeometry()
+    assert geom.get().parts().next().length() == pytest.approx(1939.0, rel=0.1)
+
+    map_tool.deactivate()
+
+
+def test_right_click_when_creating(
+    qgis_parent: QWidget,
+    qgis_iface: QgisInterface,
+    raster_small: QgsRasterLayer,
+    raster_large: QgsRasterLayer,
+    qgis_canvas: QgsMapCanvas,
+):
+
+    project = QgsProject.instance()
+    project.addMapLayer(raster_small)
+    project.addMapLayer(raster_large)
+
+    center_point = raster_small.extent().center()
+    left_point = center_point.project(75, 90)
+
+    raster_validation_dialog = RasterValidations(qgis_iface)
+
+    los_settings = LoSSettings(qgis_parent)
+
+    map_tool = CreateLoSMapTool(qgis_iface, raster_validation_dialog, los_settings)
+
+    map_tool.activate()
+
+    assert map_tool._start_point is None
+    assert map_tool._last_towards_point is None
+    assert map_tool._los_rubber_band.size() == 0
+
+    # set observer point
+    map_tool.canvasReleaseEvent(create_mouse_event(qgis_canvas, center_point))
+
+    assert map_tool._start_point is not None
+    assert map_tool._start_point.isEmpty() is False
+    assert map_tool._last_towards_point is None
+    assert map_tool._los_rubber_band.size() == 0
+
+    # move mouse - start creating LoS
+    map_tool.canvasMoveEvent(create_mouse_event(qgis_canvas, left_point, event=QEvent.Type.MouseMove))
+
+    assert map_tool._start_point is not None
+    assert map_tool._last_towards_point is not None
+    assert map_tool._last_towards_point.isEmpty() is False
+    assert map_tool._los_rubber_band.size() == 1
+    assert map_tool._los_rubber_band.asGeometry().length() == 75
+
+    # mouse right click
+    map_tool.canvasReleaseEvent(create_mouse_event(qgis_canvas, left_point, mouse_button=Qt.MouseButton.RightButton))
+
+    assert map_tool._start_point is None
+    assert map_tool._last_towards_point is None
+    assert map_tool._los_rubber_band.size() == 0

tests/utils.py

@@ -1,5 +1,10 @@
 from pathlib import Path
 
+from qgis.core import QgsPointXY
+from qgis.gui import QgsMapCanvas, QgsMapMouseEvent
+from qgis.PyQt.QtCore import QEvent, Qt
+from qgis.PyQt.QtGui import QMouseEvent
+
 
 def data_path() -> Path:
     """Path to folder with test data."""
@@ -32,3 +37,28 @@ def result_filename(filename: str) -> str:
     """File path to file in test results data folder."""
     path = data_result_path() / filename
     return path.as_posix()
+
+
+def create_mouse_event(
+    qgis_canvas: QgsMapCanvas,
+    point_in_canvas_crs_coordinates: QgsPointXY,
+    event: QEvent.Type = QEvent.Type.MouseButtonRelease,
+    mouse_button: Qt.MouseButton = Qt.MouseButton.LeftButton,
+    key_modifier: Qt.KeyboardModifier = Qt.KeyboardModifier.NoModifier,
+):
+    point_in_canvas_coords = qgis_canvas.getCoordinateTransform().toMapCoordinatesF(
+        point_in_canvas_crs_coordinates.x(), point_in_canvas_crs_coordinates.y()
+    )
+
+    event = QMouseEvent(
+        event,
+        point_in_canvas_coords.toQPointF(),
+        mouse_button,
+        mouse_button,
+        key_modifier,
+    )
+
+    return QgsMapMouseEvent(
+        qgis_canvas,
+        event,
+    )