WIP more tests for parsing the sentences

Author: jkittner

tests/adafruit_gps_test.py

@@ -1,8 +1,10 @@
-# pylint: disable=missing-function-docstring,missing-module-docstring,invalid-name
+# pylint: disable=missing-function-docstring,missing-module-docstring,invalid-name,protected-access,no-self-use
 
 # SPDX-FileCopyrightText: 2021 Jonas Kittner
 #
 # SPDX-License-Identifier: MIT
+import time
+from unittest import mock
 import pytest
 
 from adafruit_gps import _parse_degrees
@@ -11,6 +13,7 @@
 from adafruit_gps import _read_degrees
 from adafruit_gps import _parse_talker
 from adafruit_gps import _parse_data
+from adafruit_gps import GPS
 
 
 @pytest.mark.parametrize(
@@ -164,3 +167,201 @@ def test_param_types_does_not_match_data_items():
 )
 def test_parse_data(st, data, exp_data):
     assert pytest.approx(_parse_data(sentence_type=st, data=data)) == exp_data
+
+
+def test_parse_data_unexpected_parameter_type():
+    with mock.patch("adafruit_gps._SENTENCE_PARAMS", ("xyz",)):
+        with pytest.raises(TypeError) as exc_info:
+            _parse_data(sentence_type=0, data=["x", "y", "z"])
+
+    assert exc_info.value.args[0] == "GPS: Unexpected parameter type 'x'"
+
+
+class UartMock:
+    """mocking the UART connection an its methods"""
+
+    def write(self, bytestr):
+        print(bytestr, end="")
+
+    @property
+    def in_waiting(self):
+        return 100
+
+
+def test_read_sentence_too_few_in_waiting():
+    with mock.patch.object(GPS, "readline", return_value="x"):
+
+        class UartMockWaiting(UartMock):
+            """overwrite the in_waiting property to perform the test"""
+
+            @property
+            def in_waiting(self):
+                return 3
+
+        gps = GPS(uart=UartMockWaiting())
+        assert not gps.update()
+
+
+def test_GPS_update_timestamp_UTC_date_None():
+    gps = GPS(uart=UartMock())
+    exp_struct = time.struct_time((0, 0, 0, 22, 14, 11, 0, 0, -1))
+    gps._update_timestamp_utc(time_utc=221411)
+    assert gps.timestamp_utc == exp_struct
+
+
+def test_GPS_update_timestamp_UTC_date_not_None():
+    gps = GPS(uart=UartMock())
+    exp_struct = time.struct_time((2021, 10, 2, 22, 14, 11, 0, 0, -1))
+    gps._update_timestamp_utc(time_utc=221411, date=21021)
+    assert gps.timestamp_utc == exp_struct
+
+
+def test_GPS_update_timestamp_timestamp_utc_was_not_none_new_date_none():
+    gps = GPS(uart=UartMock())
+    # set this to a value
+    gps.timestamp_utc = time.struct_time((2021, 10, 2, 22, 10, 11, 0, 0, -1))
+    exp_struct = time.struct_time((2021, 10, 2, 22, 14, 11, 0, 0, -1))
+    # update the timestamp
+    gps._update_timestamp_utc(time_utc=221411)
+    assert gps.timestamp_utc == exp_struct
+
+
+def test_GPS_update_rmc_no_magnetic_variation():
+    r = b"$GPRMC,215032.086,A,1234.5678,N,00123.12345,E,0.45,56.35,021021,,,A*6A\r\n"
+    with mock.patch.object(GPS, "readline", return_value=r):
+        gps = GPS(uart=UartMock())
+        assert gps.update()
+        exp_time = time.struct_time((2021, 10, 2, 21, 50, 32, 0, 0, -1))
+        assert gps.timestamp_utc == exp_time
+        assert gps.latitude == pytest.approx(12.57613)
+        assert gps.longitude == pytest.approx(1.385391)
+        assert gps.fix_quality == 1
+        assert gps.fix_quality_3d == 0
+        assert gps.speed_knots == 0.45
+        assert gps.track_angle_deg == 56.35
+        assert gps._magnetic_variation is None
+        assert gps._mode_indicator == "A"
+        assert gps.has_fix is True
+        assert gps.has_3d_fix is False
+        assert gps.datetime == exp_time
+        assert (
+            gps._raw_sentence
+            == "$GPRMC,215032.086,A,1234.5678,N,00123.12345,E,0.45,56.35,021021,,,A*6A"
+        )
+        assert (
+            gps.nmea_sentence
+            == "$GPRMC,215032.086,A,1234.5678,N,00123.12345,E,0.45,56.35,021021,,,A*6A"
+        )
+
+
+def test_GPS_update_rmc_fix_is_set():
+    r_valid = (
+        b"$GPRMC,215032.086,A,1234.5678,N,00123.12345,E,0.45,56.35,021021,,,A*6A\r\n"
+    )
+    r_invalid = (
+        b"$GPRMC,215032.086,V,1234.5678,N,00123.12345,E,0.45,56.35,021021,,,A*7D\r\n"
+    )
+    with mock.patch.object(GPS, "readline", return_value=r_valid):
+        gps = GPS(uart=UartMock())
+        assert gps.update()
+        assert gps.fix_quality == 1
+        assert gps.has_fix is True
+
+    with mock.patch.object(gps, "readline", return_value=r_invalid):
+        assert gps.update()
+        assert gps.fix_quality == 0
+        assert gps.has_fix is False
+
+
+def test_GPS_update_rmc_fix_is_set_new():
+    r_valid = (
+        b"$GPRMC,215032.086,A,1234.5678,N,00123.12345,E,0.45,56.35,021021,,,A*6A\r\n"
+    )
+    r_invalid = b"$GPRMC,215032.086,V,ABC,N,00123.12345,E,0.45,56.35,021021,,,A*1B\r\n"
+    with mock.patch.object(GPS, "readline", return_value=r_valid):
+        gps = GPS(uart=UartMock())
+        assert gps.update()
+        assert gps.fix_quality == 1
+        assert gps.has_fix is True
+    # now get an invalid response --> set fix_qualit to 0
+    with mock.patch.object(gps, "readline", return_value=r_invalid):
+        assert not gps.update()
+        assert gps.fix_quality == 0
+        assert gps.has_fix is False
+
+
+def test_GPS_update_rmc_invalid_checksum():
+    r = b"$GPRMC,215032.086,A,1234.5678,N,00123.12345,E,0.45,56.35,021021,,,A*5C\r\n"
+    with mock.patch.object(GPS, "readline", return_value=r):
+        gps = GPS(uart=UartMock())
+        assert not gps.update()
+
+
+def test_GPS_update_empty_sentence():
+    with mock.patch.object(GPS, "readline", return_value=b""):
+        gps = GPS(uart=UartMock())
+        assert not gps.update()
+
+
+@pytest.mark.parametrize(
+    ("r", "exp"),
+    (
+        pytest.param(
+            b"$GPRMC,215032.086,A,1234.5678,N,00123.12345,E,0.45,56.35,021021,1234.56,W,A*14\r\n",
+            -12.576,
+            id="W",
+        ),
+        pytest.param(
+            b"$GPRMC,215032.086,A,1234.5678,N,00123.12345,E,0.45,56.35,021021,1234.56,E,A*06\r\n",
+            12.576,
+            id="E",
+        ),
+    ),
+)
+def test_GPS_update_rmc_has_magnetic_variation(r, exp):
+    with mock.patch.object(GPS, "readline", return_value=r):
+        gps = GPS(uart=UartMock())
+        assert gps.update()
+        assert gps._magnetic_variation == pytest.approx(exp)
+
+
+def test_GPS_update_sentence_is_None():
+    with mock.patch.object(GPS, "_parse_sentence", return_value=None):
+        gps = GPS(uart=UartMock())
+        assert not gps.update()
+
+
+def test_GPS_update_rmc_debug_shows_sentence(capsys):
+    r = b"$GPRMC,215032.086,A,1234.5678,N,00123.12345,E,0.45,56.35,021021,,,A*6A\r\n"
+    with mock.patch.object(GPS, "readline", return_value=r):
+        gps = GPS(uart=UartMock(), debug=True)
+        assert gps.update()
+        out, err = capsys.readouterr()
+        assert err == ""
+        assert (
+            out
+            == "('GPRMC', '215032.086,A,1234.5678,N,00123.12345,E,0.45,56.35,021021,,,A')\n"
+        )
+
+
+def test_GPS_update_data_type_too_short():
+    r = ("GPRM", "x,y,z")
+    with mock.patch.object(GPS, "_parse_sentence", return_value=r):
+        gps = GPS(uart=UartMock(), debug=True)
+        assert not gps.update()
+
+
+def test_GPS_send_command_with_checksum(capsys):
+    gps = GPS(uart=UartMock())
+    gps.send_command(command=b"$PMTK001,314,3\r\n", add_checksum=True)
+    out, err = capsys.readouterr()
+    assert err == ""
+    assert out == ("b'$'" "b'$PMTK001,314,3\\r\\n'" "b'*'" "b'15'" "b'\\r\\n'")
+
+
+def test_GPS_send_command_without_checksum(capsys):
+    gps = GPS(uart=UartMock())
+    gps.send_command(command=b"$PMTK001,314,3\r\n", add_checksum=False)
+    out, err = capsys.readouterr()
+    assert err == ""
+    assert out == ("b'$'" "b'$PMTK001,314,3\\r\\n'" "b'\\r\\n'")