Refactored self._lease_time to self._lease.

Author: BiffoBear

adafruit_wiznet5k/adafruit_wiznet5k_dhcp.py

@@ -160,10 +160,10 @@ def __init__(
         self.subnet_mask = _UNASSIGNED_IP_ADDR
         self.dns_server_ip = _UNASSIGNED_IP_ADDR
 
-        # Lease configuration
-        self._lease_time = 0
+        # Lease expiry times
         self._t1 = 0
         self._t2 = 0
+        self._lease = 0
 
         # Host name
         mac_string = "".join("{:02X}".format(o) for o in mac_address)
@@ -340,9 +340,9 @@ def _process_messaging_states(self, *, message_type: int):
                 self._dhcp_state = _STATE_INIT
             elif message_type == _DHCP_ACK:
                 debug_msg("Message is ACK, setting FSM state to BOUND.", self._debug)
-                self._t1 = self._start_time + self._lease_time // 2
-                self._t2 = self._start_time + self._lease_time - self._lease_time // 8
-                self._lease_time += self._start_time
+                self._t1 = self._start_time + self._lease // 2
+                self._t2 = self._start_time + self._lease - self._lease // 8
+                self._lease += self._start_time
                 self._increment_transaction_id()
                 if not self._renew:
                     self._eth.ifconfig = (
@@ -424,7 +424,7 @@ def _dhcp_state_machine(self, *, blocking: bool = False) -> None:
                     debug_msg("No timers have expired. Exiting FSM.", self._debug)
                     self._socket_release()
                     return
-                if now > self._lease_time:
+                if now > self._lease:
                     debug_msg(
                         "Lease has expired, switching state to INIT.", self._debug
                     )
@@ -646,7 +646,7 @@ def option_reader(pointer: int) -> Tuple[int, int, bytes]:
             elif data_type == _DHCP_SERVER_ID:
                 self.dhcp_server_ip = data
             elif data_type == _LEASE_TIME:
-                self._lease_time = int.from_bytes(data, "big")
+                self._lease = int.from_bytes(data, "big")
             elif data_type == _ROUTERS_ON_SUBNET:
                 self.gateway_ip = data[:4]
             elif data_type == _DNS_SERVERS:
@@ -669,7 +669,7 @@ def option_reader(pointer: int) -> Tuple[int, int, bytes]:
                 self.local_ip,
                 self._t1,
                 self._t2,
-                self._lease_time,
+                self._lease,
             ),
             self._debug,
         )

tests/test_dhcp_helper_functions.py

@@ -59,7 +59,7 @@ def test_dhcp_setup_default(self, mocker, mock_wiznet5k, mac_address):
         assert dhcp_client.gateway_ip == wiz_dhcp._UNASSIGNED_IP_ADDR
         assert dhcp_client.subnet_mask == wiz_dhcp._UNASSIGNED_IP_ADDR
         assert dhcp_client.dns_server_ip == wiz_dhcp._UNASSIGNED_IP_ADDR
-        assert dhcp_client._lease_time == 0
+        assert dhcp_client._lease == 0
         assert dhcp_client._t1 == 0
         assert dhcp_client._t2 == 0
         mac_string = "".join("{:02X}".format(o) for o in mac_address)
@@ -293,7 +293,7 @@ def test_parse_good_data(
         assert dhcp_client.dhcp_server_ip == dhcp_ip
         assert dhcp_client.gateway_ip == gate_ip
         assert dhcp_client.dns_server_ip == dns_ip
-        assert dhcp_client._lease_time == lease
+        assert dhcp_client._lease == lease
         assert dhcp_client._t1 == t1
         assert dhcp_client._t2 == t2
 
@@ -775,7 +775,7 @@ def test_called_from_requesting_with_ack(self, mock_dhcp, lease_time):
         # Setup with the required state.
         mock_dhcp._dhcp_state = wiz_dhcp._STATE_REQUESTING
         # Set the lease_time (zero forces a default to be used).
-        mock_dhcp._lease_time = lease_time
+        mock_dhcp._lease = lease_time
         # Set renew to "renew" to confirm that an ACK sets it to None.
         mock_dhcp._renew = "renew"
         # Set a start time.
@@ -785,7 +785,7 @@ def test_called_from_requesting_with_ack(self, mock_dhcp, lease_time):
         # Confirm timers are correctly set.
         assert mock_dhcp._t1 == time.monotonic() + lease_time // 2
         assert mock_dhcp._t2 == time.monotonic() + lease_time - lease_time // 8
-        assert mock_dhcp._lease_time == time.monotonic() + lease_time
+        assert mock_dhcp._lease == time.monotonic() + lease_time
         # Check that renew is forced to None
         assert mock_dhcp._renew is None
         # FSM state should be bound.