[Honeydew] New Affordance ABC with is_supported()

Updated some of the existing affordance ABCs to inherit from this newly
created "Affordance" class.

In subsequent CLs,
* Update rest of the affordnaces ABCs to inherit from this "Affordance"
  class.
* Introduce "Transport" ABC with is_supprted() and update transport ABCs
  to inherit from this

Bug: 377585143

Change-Id: Ice40d2a1e32ac64bedf4869890776ec0d8615bcc
Reviewed-on: https://fuchsia-review.googlesource.com/c/fuchsia/+/1151733
Reviewed-by: Sam Balana <[email protected]>
Reviewed-by: Kevin Cho <[email protected]>
Commit-Queue: Pavan Kumar Juturu <[email protected]>

Author: juturupavankumar

src/testing/end_to_end/honeydew/BUILD.gn

@@ -32,6 +32,7 @@ python_library("honeydew_no_testonly") {
   sources = [
     "__init__.py",
     "affordances/__init__.py",
+    "affordances/affordance.py",
     "affordances/connectivity/wlan/__init__.py",
     "affordances/connectivity/wlan/utils/errors.py",
     "affordances/connectivity/wlan/utils/types.py",

src/testing/end_to_end/honeydew/honeydew/affordances/affordance.py

@@ -0,0 +1,26 @@
+# Copyright 2024 The Fuchsia Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+"""Abstract base class for Honeydew affordance."""
+
+import abc
+
+
+class Affordance(abc.ABC):
+    """Abstract base class for Honeydew affordance.
+
+    Every Honeydew affordance contract should inherit from this class and thus required to implement
+    the methods defined in this class.
+    """
+
+    @abc.abstractmethod
+    def verify_supported(self) -> None:
+        """Verifies that affordance implementation is supported by the Fuchsia device.
+
+        This method should be called in every affordance implementation's `__init__()` so that if an
+        affordance is used on a Fuchsia device that does not support it, it will raise
+        NotSupportedError.
+
+        Raises:
+            NotSupportedError: If affordance is not supported.
+        """

src/testing/end_to_end/honeydew/honeydew/affordances/connectivity/wlan/wlan/tests/unit_tests/wlan_using_fc_test.py

@@ -207,7 +207,7 @@ def tearDown(self) -> None:
         super().tearDown()
 
     def test_verify_supported(self) -> None:
-        """Test if _verify_supported works."""
+        """Test if verify_supported() works."""
         self.ffx_transport_obj.run.return_value = ""
         with self.assertRaises(NotSupportedError):
             self.wlan_obj = wlan_using_fc.Wlan(

src/testing/end_to_end/honeydew/honeydew/affordances/connectivity/wlan/wlan/wlan.py

@@ -5,6 +5,7 @@
 
 import abc
 
+from honeydew.affordances import affordance
 from honeydew.affordances.connectivity.wlan.utils.types import (
     Authentication,
     BssDescription,
@@ -15,7 +16,7 @@
 )
 
 
-class Wlan(abc.ABC):
+class Wlan(affordance.Affordance):
     """Abstract base class for Wlan driver affordance."""
 
     # List all the public methods

src/testing/end_to_end/honeydew/honeydew/affordances/connectivity/wlan/wlan/wlan_using_fc.py

@@ -71,13 +71,16 @@ def __init__(
             reboot_affordance: Object that implements RebootCapableDevice.
             fuchsia_device_close: Object that implements FuchsiaDeviceClose.
         """
-        super().__init__()
-        self._verify_supported(device_name, ffx)
+        AsyncAdapter.__init__(self)
 
+        self._device_name: str = device_name
+        self._ffx: ffx_transport.FFX = ffx
         self._fc_transport = fuchsia_controller
         self._reboot_affordance = reboot_affordance
         self._fuchsia_device_close = fuchsia_device_close
 
+        self.verify_supported()
+
         self._connect_proxy()
         self._reboot_affordance.register_for_on_device_boot(self._connect_proxy)
 
@@ -94,29 +97,29 @@ def close(self) -> None:
             self.loop().run_forever()  # Handle pending tasks
             self.loop().close()
 
-    def _verify_supported(self, device: str, ffx: ffx_transport.FFX) -> None:
-        """Check if WLAN is supported on the DUT.
+    def verify_supported(self) -> None:
+        """Verifies that the WLAN affordance using FuchsiaController is supported by the Fuchsia
+        device.
 
-        Args:
-            device: Device name returned by `ffx target list`.
-            ffx: FFX transport
+        This method should be called in `__init__()` so that if this affordance was called on a
+        Fuchsia device that does not support it, it will raise NotSupportedError.
 
         Raises:
-            NotSupportedError: A required component capability is not available.
+            NotSupportedError: If affordance is not supported.
         """
         for capability in _REQUIRED_CAPABILITIES:
             # TODO(http://b/359342196): This is a maintenance burden; find a
             # better way to detect FIDL component capabilities.
-            if capability not in ffx.run(
+            if capability not in self._ffx.run(
                 ["component", "capability", capability]
             ):
                 _LOGGER.warning(
                     "All available WLAN component capabilities:\n%s",
-                    ffx.run(["component", "capability", "fuchsia.wlan"]),
+                    self._ffx.run(["component", "capability", "fuchsia.wlan"]),
                 )
                 raise errors.NotSupportedError(
                     f'Component capability "{capability}" not exposed by device '
-                    f"{device}; this build of Fuchsia does not support the "
+                    f"{self._device_name}; this build of Fuchsia does not support the "
                     "WLAN FC affordance."
                 )
 

src/testing/end_to_end/honeydew/honeydew/affordances/connectivity/wlan/wlan/wlan_using_sl4f.py

@@ -82,7 +82,21 @@ def __init__(self, device_name: str, sl4f: SL4F) -> None:
         self._name: str = device_name
         self._sl4f: SL4F = sl4f
 
+        self.verify_supported()
+
     # List all the public methods
+    def verify_supported(self) -> None:
+        """Verifies that the WLAN affordance using SL4F is supported by the Fuchsia device.
+
+        This method should be called in `__init__()` so that if this affordance was called on a
+        Fuchsia device that does not support it, it will raise NotSupportedError.
+
+        Raises:
+            NotSupportedError: If affordance is not supported.
+        """
+        # TODO(http://b/377585939): To Be Implemented
+        return
+
     def connect(
         self,
         ssid: str,

src/testing/end_to_end/honeydew/honeydew/affordances/connectivity/wlan/wlan_policy/tests/unit_tests/wlan_policy_using_fc_test.py

@@ -216,7 +216,7 @@ def get_listener(updates: Channel) -> None:
             yield client_listener_proxy
 
     def test_verify_supported(self) -> None:
-        """Test if _verify_supported works."""
+        """Test if verify_supported works."""
         self.ffx_transport_obj.run.return_value = ""
 
         with self.assertRaises(NotSupportedError):

src/testing/end_to_end/honeydew/honeydew/affordances/connectivity/wlan/wlan_policy/wlan_policy.py

@@ -5,6 +5,7 @@
 
 import abc
 
+from honeydew.affordances import affordance
 from honeydew.affordances.connectivity.wlan.utils.types import (
     ClientStateSummary,
     NetworkConfig,
@@ -13,7 +14,7 @@
 )
 
 
-class WlanPolicy(abc.ABC):
+class WlanPolicy(affordance.Affordance):
     """Abstract base class for WlanPolicy affordance."""
 
     # List all the public methods

src/testing/end_to_end/honeydew/honeydew/affordances/connectivity/wlan/wlan_policy/wlan_policy_using_fc.py

@@ -111,7 +111,7 @@ class ClientControllerState:
 
 
 class WlanPolicy(AsyncAdapter, wlan_policy.WlanPolicy):
-    """WLAN affordance implemented with Fuchsia Controller."""
+    """WlanPolicy affordance implemented with Fuchsia Controller."""
 
     def __init__(
         self,
@@ -121,7 +121,7 @@ def __init__(
         reboot_affordance: affordances_capable.RebootCapableDevice,
         fuchsia_device_close: affordances_capable.FuchsiaDeviceClose,
     ) -> None:
-        """Create a WLAN Policy Fuchsia Controller affordance.
+        """Create a WlanPolicy Fuchsia Controller affordance.
 
         Args:
             device_name: Device name returned by `ffx target list`.
@@ -131,13 +131,16 @@ def __init__(
             fuchsia_device_close: Object that implements FuchsiaDeviceClose.
         """
         super().__init__()
-        self._verify_supported(device_name, ffx)
 
+        self._device_name: str = device_name
+        self._ffx: ffx_transport.FFX = ffx
         self._fc_transport = fuchsia_controller
         self._reboot_affordance = reboot_affordance
         self._fuchsia_device_close = fuchsia_device_close
         self._client_controller: ClientControllerState | None = None
 
+        self.verify_supported()
+
         self._connect_proxy()
         self._reboot_affordance.register_for_on_device_boot(self._connect_proxy)
 
@@ -164,29 +167,29 @@ def _close(self) -> None:
             self.loop().run_forever()  # Handle pending tasks
             self.loop().close()
 
-    def _verify_supported(self, device: str, ffx: ffx_transport.FFX) -> None:
-        """Check if WLAN Policy is supported on the DUT.
+    def verify_supported(self) -> None:
+        """Verifies that the WlanPolicy affordance using FuchsiaController is supported by the
+        Fuchsia device.
 
-        Args:
-            device: Device name returned by `ffx target list`.
-            ffx: FFX transport
+        This method should be called in `__init__()` so that if this affordance was called on a
+        Fuchsia device that does not support it, it will raise NotSupportedError.
 
         Raises:
-            NotSupportedError: A required component capability is not available.
+            NotSupportedError: If affordance is not supported.
         """
         for capability in _REQUIRED_CAPABILITIES:
             # TODO(http://b/359342196): This is a maintenance burden; find a
             # better way to detect FIDL component capabilities.
-            if capability not in ffx.run(
+            if capability not in self._ffx.run(
                 ["component", "capability", capability]
             ):
                 _LOGGER.warning(
                     "All available WLAN component capabilities:\n%s",
-                    ffx.run(["component", "capability", "fuchsia.wlan"]),
+                    self._ffx.run(["component", "capability", "fuchsia.wlan"]),
                 )
                 raise errors.NotSupportedError(
                     f'Component capability "{capability}" not exposed by device '
-                    f"{device}; this build of Fuchsia does not support the "
+                    f"{self._device_name}; this build of Fuchsia does not support the "
                     "WLAN FC affordance."
                 )
 

src/testing/end_to_end/honeydew/honeydew/affordances/connectivity/wlan/wlan_policy/wlan_policy_using_sl4f.py

@@ -58,7 +58,21 @@ def __init__(self, device_name: str, sl4f: SL4F) -> None:
         self._name: str = device_name
         self._sl4f: SL4F = sl4f
 
+        self.verify_supported()
+
     # List all the public methods
+    def verify_supported(self) -> None:
+        """Verifies that the WlanPolicy affordance using SL4F is supported by the Fuchsia device.
+
+        This method should be called in `__init__()` so that if this affordance was called on a
+        Fuchsia device that does not support it, it will raise NotSupportedError.
+
+        Raises:
+            NotSupportedError: If affordance is not supported.
+        """
+        # TODO(http://b/377585939): To Be Implemented
+        return
+
     def connect(
         self, target_ssid: str, security_type: SecurityType
     ) -> RequestStatus: