| #!/usr/bin/env python3 |
| # |
| # Copyright 2022 The Fuchsia Authors |
| # |
| # Licensed under the Apache License, Version 2.0 (the "License"); |
| # you may not use this file except in compliance with the License. |
| # You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| |
| import logging |
| import time |
| from typing import Any |
| |
| from mobly import signals, test_runner |
| |
| from antlion.controllers.access_point import setup_ap |
| from antlion.controllers.ap_lib import hostapd_constants, hostapd_security |
| from antlion.controllers.fuchsia_device import FuchsiaDevice |
| from antlion.test_utils.wifi import base_test |
| from antlion.utils import rand_ascii_str |
| |
| DISCONNECTED = "Disconnected" |
| CONNECTION_STOPPED = "ConnectionStopped" |
| CONNECTIONS_ENABLED = "ConnectionsEnabled" |
| CONNECTIONS_DISABLED = "ConnectionsDisabled" |
| UPDATE_TIMEOUT_SEC = 5 |
| |
| |
| class StartStopClientConnectionsTest(base_test.WifiBaseTest): |
| """Tests that we see the expected behavior with enabling and disabling |
| client connections |
| |
| Test Bed Requirement: |
| * One or more Fuchsia devices |
| * One Access Point |
| """ |
| |
| def setup_class(self): |
| super().setup_class() |
| self.log = logging.getLogger() |
| # Start an AP with a hidden network |
| self.ssid = rand_ascii_str(hostapd_constants.AP_SSID_LENGTH_2G) |
| self.access_point = self.access_points[0] |
| self.password = rand_ascii_str(hostapd_constants.AP_PASSPHRASE_LENGTH_2G) |
| self.security_type = hostapd_security.SecurityMode.WPA2.fuchsia_security_type() |
| security = hostapd_security.Security( |
| security_mode=hostapd_security.SecurityMode.WPA2, password=self.password |
| ) |
| |
| self.access_point.stop_all_aps() |
| # TODO(63719) use varying values for AP that shouldn't affect the test. |
| setup_ap( |
| self.access_point, |
| "whirlwind", |
| hostapd_constants.AP_DEFAULT_CHANNEL_5G, |
| self.ssid, |
| security=security, |
| ) |
| |
| if len(self.fuchsia_devices) < 1: |
| raise EnvironmentError("No Fuchsia devices found.") |
| for fd in self.fuchsia_devices: |
| fd.configure_wlan( |
| association_mechanism="policy", preserve_saved_networks=True |
| ) |
| |
| def setup_test(self): |
| for fd in self.fuchsia_devices: |
| if not fd.wlan_policy_controller.remove_all_networks(): |
| raise EnvironmentError("Failed to remove all networks in setup") |
| |
| def teardown_class(self): |
| self.access_point.stop_all_aps() |
| |
| def connect_and_validate(self, fd, ssid, security_type, expected_response): |
| """Sends a connect request to the device and verifies we get a response |
| without error. This does not validate that a connection will be |
| attempted. This will fail the test if there is an error sending the |
| connect request, or if we don't get the expected connect response.""" |
| result_connect = fd.sl4f.wlan_policy_lib.connect(ssid, security_type) |
| if result_connect.get("error") != None: |
| self.log.error( |
| f"Error occurred requesting a connection: {result_connect.get('error')}" |
| ) |
| raise EnvironmentError("Failed to send connect request") |
| response = result_connect.get("result") |
| if response != expected_response: |
| self.log.error( |
| 'Incorrect connect request response. Expected: "%s", Actual: %s' |
| % (expected_response, response) |
| ) |
| raise signals.TestFailure("Failed to get expected connect response") |
| |
| def await_state_update( |
| self, fd: FuchsiaDevice, desired_state: Any, timeout_sec: int |
| ): |
| """This function polls the policy client state until it converges to |
| the caller's desired state. |
| |
| Args: |
| fd: A FuchsiaDevice |
| desired_state: The expected client policy state. |
| timeout_sec: Duration to wait for the desired_state. |
| Returns: |
| None assuming the desired state has been reached. |
| Raises: |
| TestFailure if the desired state is not reached by the timeout. |
| """ |
| start_time = time.time() |
| curr_state = None |
| while time.time() < start_time + timeout_sec: |
| fd.sl4f.wlan_policy_lib.set_new_listener() |
| curr_state = fd.sl4f.wlan_policy_lib.get_update() |
| if curr_state.get("error"): |
| self.log.error( |
| f"Error occurred getting status update: {curr_state.get('error')}" |
| ) |
| raise EnvironmentError("Failed to get update") |
| |
| if curr_state.get("result") and curr_state.get("result") == desired_state: |
| return |
| |
| time.sleep(1) |
| |
| self.log.error( |
| f"Client state did not converge to the expected state in {timeout_sec}s. " |
| f"Expected update: {desired_state} Actual update: {curr_state}" |
| ) |
| raise signals.TestFailure("Client policy layer is in unexpected state") |
| |
| def test_stop_client_connections_update(self): |
| for fd in self.fuchsia_devices: |
| if not fd.wlan_policy_controller.stop_client_connections(): |
| raise EnvironmentError("Failed to stop client connecions") |
| |
| # Check that the most recent update says that the device is not |
| # connected to anything and client connections are disabled |
| expected_update = {"networks": [], "state": CONNECTIONS_DISABLED} |
| self.await_state_update(fd, expected_update, UPDATE_TIMEOUT_SEC) |
| |
| def test_start_client_connections_update(self): |
| for fd in self.fuchsia_devices: |
| if not fd.wlan_policy_controller.start_client_connections(): |
| raise EnvironmentError("Failed to start client connecions") |
| |
| # Check that the most recent update says that the device is not |
| # connected to anything and client connections are disabled |
| expected_update = {"networks": [], "state": CONNECTIONS_ENABLED} |
| self.await_state_update(fd, expected_update, UPDATE_TIMEOUT_SEC) |
| |
| def test_stop_client_connections_rejects_connections(self): |
| # Test that if we turn client connections off, our requests to connect |
| # are rejected. |
| for fd in self.fuchsia_devices: |
| if not fd.wlan_policy_controller.stop_client_connections(): |
| raise EnvironmentError("Failed to stop client connecions") |
| |
| # Save the network, otherwise connecting may fail because the |
| # network is not saved instead of client connections being off |
| if not fd.wlan_policy_controller.save_network( |
| self.ssid, self.security_type, password=self.password |
| ): |
| raise EnvironmentError("Failed to save network") |
| expected_response = "RejectedIncompatibleMode" |
| self.connect_and_validate( |
| fd, self.ssid, self.security_type, expected_response |
| ) |
| |
| def test_start_stop_client_connections(self): |
| # Test that if we turn client connections on the device will connect, |
| # and if we turn of client connections the device will disconnect. |
| for fd in self.fuchsia_devices: |
| # Start client connections and check that we can |
| if not fd.wlan_policy_controller.save_network( |
| self.ssid, self.security_type, password=self.password |
| ): |
| raise EnvironmentError("Failed to save network") |
| if not fd.wlan_policy_controller.start_client_connections(): |
| raise EnvironmentError("Failed to start client connections") |
| |
| expected_response = "Acknowledged" |
| self.connect_and_validate( |
| fd, self.ssid, self.security_type, expected_response |
| ) |
| |
| if not fd.wlan_policy_controller.wait_for_connect( |
| self.ssid, self.security_type |
| ): |
| raise signals.TestFailure( |
| "Failed to connect after starting client connections" |
| ) |
| |
| # Stop client connections again and check that we disconnect |
| if not fd.wlan_policy_controller.stop_client_connections(): |
| raise EnvironmentError("Failed to stop client connecions") |
| if not fd.wlan_policy_controller.wait_for_disconnect( |
| self.ssid, self.security_type, DISCONNECTED, CONNECTION_STOPPED |
| ): |
| raise signals.TestFailure( |
| "Failed to disconnect after client connections stopped" |
| ) |
| |
| |
| if __name__ == "__main__": |
| test_runner.main() |