commit 5f6a50cf15a69fc55159c6f4e574cb5dd499534d
author Patrick Rohr <prohr@google.com> Tue Aug 23 16:13:52 2022 -0700
committer Patrick Rohr <prohr@google.com> Fri Oct 07 09:01:12 2022 -0700
tree ba85717f4cecba3773ee610de39a23a687789f8f
parent ae3ace443379046b2fefaeb477fbf51bdd162ce1

ethernet: cleanup ethernet state listener interaction

Add a addEthernetStateListener() function that works just like
addInterfaceStateListener(). Make sure ethernet state listeners are
added to addedListeners, and addedListeners are removed from both
ethernet and interface state listeners on tearDown. This is safe even if
a given listener was not registered as one or the other.

Test: atest EthernetManagerTest
Change-Id: I74d9d0747b94b7d34a2fe7630e840acd34f1a500

tests/cts/net/src/android/net/cts/EthernetManagerTest.kt

diff --git a/tests/cts/net/src/android/net/cts/EthernetManagerTest.kt b/tests/cts/net/src/android/net/cts/EthernetManagerTest.kt
index 1e44440..122eb15 100644
--- a/tests/cts/net/src/android/net/cts/EthernetManagerTest.kt
+++ b/tests/cts/net/src/android/net/cts/EthernetManagerTest.kt
@@ -381,7 +381,10 @@
         setIncludeTestInterfaces(false)
 
         for (listener in addedListeners) {
+            // Even if a given listener was not registered as both an interface and ethernet state
+            // listener, calling remove is safe.
             em.removeInterfaceStateListener(listener)
+            em.removeEthernetStateListener(listener)
         }
         registeredCallbacks.forEach { cm.unregisterNetworkCallback(it) }
         releaseTetheredInterface()
@@ -409,6 +412,11 @@
         addedListeners.add(listener)
     }
 
+    private fun addEthernetStateListener(listener: EthernetStateListener) {
+        em.addEthernetStateListener(handler::post, listener)
+        addedListeners.add(listener)
+    }
+
     // WARNING: setting hasCarrier to false requires kernel support. Call
     // assumeChangingCarrierSupported() at the top of your test.
     private fun createInterface(hasCarrier: Boolean = true): EthernetTestInterface {
@@ -503,13 +511,8 @@
         runAsShell(NETWORK_SETTINGS) { em.setEthernetEnabled(enabled) }
 
         val listener = EthernetStateListener()
-        em.addEthernetStateListener(handler::post, listener)
-        try {
-            listener.eventuallyExpect(
-                    if (enabled) ETHERNET_STATE_ENABLED else ETHERNET_STATE_DISABLED)
-        } finally {
-            em.removeEthernetStateListener(listener)
-        }
+        addEthernetStateListener(listener)
+        listener.eventuallyExpect(if (enabled) ETHERNET_STATE_ENABLED else ETHERNET_STATE_DISABLED)
     }
 
     // NetworkRequest.Builder does not create a copy of the passed NetworkRequest, so in order to