Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 4702085f authored by Jack He's avatar Jack He Committed by Automerger Merge Worker
Browse files

Merge "Update bluetooth-test-util-lib to modern standard" into main am: a03c2e3e 

Original change: https://android-review.googlesource.com/c/platform/packages/modules/Bluetooth/+/2813242



Change-Id: I6aece521fba2b7053e465ab092c8e8ba0cd5d0bd
Signed-off-by: default avatarAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
parents c60972fe a03c2e3e

framework/tests/util/Android.bp

+1 −0
Original line number Diff line number Diff line
@@ -21,6 +21,7 @@ java_library { 
    defaults: ["cts_defaults"],

    static_libs: [

        "PlatformProperties",

        "androidx.test.ext.truth",

        "compatibility-device-util-axt",

        "junit",

    ],

framework/tests/util/src/android/bluetooth/cts/BTAdapterUtils.java

+50 −43
Original line number Diff line number Diff line
@@ -25,8 +25,9 @@ import android.content.Context; 
import android.content.Intent;

import android.content.IntentFilter;

import android.util.Log;

import android.util.SparseIntArray;



import java.time.Duration;

import java.util.HashMap;

import java.util.Set;

import java.util.concurrent.TimeUnit;

import java.util.concurrent.locks.Condition;
@@ -34,34 +35,36 @@ import java.util.concurrent.locks.ReentrantLock; 


/** Utility for controlling the Bluetooth adapter from CTS test. */

public class BTAdapterUtils {

    private static final String TAG = "BTAdapterUtils";

    private static final String TAG = BTAdapterUtils.class.getSimpleName();



    // ADAPTER_ENABLE_TIMEOUT_MS = AdapterState.BLE_START_TIMEOUT_DELAY +

    //                             AdapterState.BREDR_START_TIMEOUT_DELAY +

    //                             (10 seconds of additional delay)

    private static final int ADAPTER_ENABLE_TIMEOUT_MS = 18000;

    // ADAPTER_DISABLE_TIMEOUT_MS = AdapterState.BLE_STOP_TIMEOUT_DELAY +

    //                                  AdapterState.BREDR_STOP_TIMEOUT_DELAY

    private static final int ADAPTER_DISABLE_TIMEOUT_MS = 5000;

    /**

     * ADAPTER_ENABLE_TIMEOUT_MS = AdapterState.BLE_START_TIMEOUT_DELAY +

     * AdapterState.BREDR_START_TIMEOUT_DELAY + (10 seconds of additional delay)

     */

    private static final Duration ADAPTER_ENABLE_TIMEOUT = Duration.ofSeconds(18);

    /**

     * ADAPTER_DISABLE_TIMEOUT_MS = AdapterState.BLE_STOP_TIMEOUT_DELAY +

     * AdapterState.BREDR_STOP_TIMEOUT_DELAY

     */

    private static final Duration ADAPTER_DISABLE_TIMEOUT = Duration.ofSeconds(5);



    /** Redefined from {@link BluetoothAdapter} because of hidden APIs */

    public static final int STATE_BLE_TURNING_ON = 14;

    public static final int STATE_BLE_ON = 15;



    public static final int STATE_BLE_TURNING_OFF = 16;



    private static final SparseIntArray sStateTimeouts = new SparseIntArray();

    private static final HashMap<Integer, Duration> sStateTimeouts = new HashMap<>();



    static {

        sStateTimeouts.put(BluetoothAdapter.STATE_OFF, ADAPTER_DISABLE_TIMEOUT_MS);

        sStateTimeouts.put(BluetoothAdapter.STATE_TURNING_ON, ADAPTER_ENABLE_TIMEOUT_MS);

        sStateTimeouts.put(BluetoothAdapter.STATE_ON, ADAPTER_ENABLE_TIMEOUT_MS);

        sStateTimeouts.put(BluetoothAdapter.STATE_TURNING_OFF, ADAPTER_DISABLE_TIMEOUT_MS);

        sStateTimeouts.put(STATE_BLE_TURNING_ON, ADAPTER_ENABLE_TIMEOUT_MS);

        sStateTimeouts.put(STATE_BLE_ON, ADAPTER_ENABLE_TIMEOUT_MS);

        sStateTimeouts.put(STATE_BLE_TURNING_OFF, ADAPTER_DISABLE_TIMEOUT_MS);

        sStateTimeouts.put(BluetoothAdapter.STATE_OFF, ADAPTER_DISABLE_TIMEOUT);

        sStateTimeouts.put(BluetoothAdapter.STATE_TURNING_ON, ADAPTER_ENABLE_TIMEOUT);

        sStateTimeouts.put(BluetoothAdapter.STATE_ON, ADAPTER_ENABLE_TIMEOUT);

        sStateTimeouts.put(BluetoothAdapter.STATE_TURNING_OFF, ADAPTER_DISABLE_TIMEOUT);

        sStateTimeouts.put(STATE_BLE_TURNING_ON, ADAPTER_ENABLE_TIMEOUT);

        sStateTimeouts.put(BluetoothAdapter.STATE_BLE_ON, ADAPTER_ENABLE_TIMEOUT);

        sStateTimeouts.put(STATE_BLE_TURNING_OFF, ADAPTER_DISABLE_TIMEOUT);

    }



    private static BluetoothAdapterReceiver sAdapterReceiver;



    private static boolean sAdapterVarsInitialized;

    private static ReentrantLock sBluetoothAdapterLock;

    private static Condition sConditionAdapterStateReached;
@@ -95,7 +98,7 @@ public class BTAdapterUtils { 
    /** Initialize all static state variables */

    private static void initAdapterStateVariables(Context context) {

        Log.d(TAG, "Initializing adapter state variables");

        sAdapterReceiver = new BluetoothAdapterReceiver();

        BluetoothAdapterReceiver sAdapterReceiver = new BluetoothAdapterReceiver();

        sBluetoothAdapterLock = new ReentrantLock();

        sConditionAdapterStateReached = sBluetoothAdapterLock.newCondition();

        sDesiredState = -1;
@@ -106,31 +109,37 @@ public class BTAdapterUtils { 
    }



    /**

     * Wait for the bluetooth adapter to be in a given state

     * Helper method to wait for the bluetooth adapter to be in a given state

     *

     * <p>Assumes all state variables are initialized. Assumes it's being run with

     * sBluetoothAdapterLock in the locked state.

     */

    private static boolean waitForAdapterStateLocked(int desiredState, BluetoothAdapter adapter)

            throws InterruptedException {

        int timeout = sStateTimeouts.get(desiredState, ADAPTER_ENABLE_TIMEOUT_MS);

        Duration timeout = sStateTimeouts.getOrDefault(desiredState, ADAPTER_ENABLE_TIMEOUT);



        Log.d(TAG, "Waiting for adapter state " + desiredState);

        sDesiredState = desiredState;



        // Wait until we have reached the desired state

        // Handle spurious wakeup

        while (desiredState != sAdapterState) {

            if (!sConditionAdapterStateReached.await(timeout, TimeUnit.MILLISECONDS)) {

                // Handle situation where state change occurs, but we don't receive the broadcast

            if (sConditionAdapterStateReached.await(timeout.toMillis(), TimeUnit.MILLISECONDS)) {

                // Handle spurious wakeup

                continue;

            }

            // Handle timeout cases

            // Case 1: situation where state change occurs, but we don't receive the broadcast

            if (desiredState >= BluetoothAdapter.STATE_OFF

                    && desiredState <= BluetoothAdapter.STATE_TURNING_OFF) {

                int currentState = adapter.getState();

                Log.d(TAG, "desiredState: " + desiredState + ", currentState: " + currentState);

                return desiredState == currentState;

                } else if (desiredState == STATE_BLE_ON) {

            } else if (desiredState == BluetoothAdapter.STATE_BLE_ON) {

                Log.d(TAG, "adapter isLeEnabled: " + adapter.isLeEnabled());

                return adapter.isLeEnabled();

            }

            // Case 2: Actual timeout

            Log.e(

                    TAG,

                    "Timeout while waiting for Bluetooth adapter state "
@@ -139,10 +148,8 @@ public class BTAdapterUtils { 
                            + sAdapterState);

            break;

        }

        }



        Log.d(TAG, "Final state while waiting: " + sAdapterState);



        return sAdapterState == desiredState;

    }
@@ -176,7 +183,7 @@ public class BTAdapterUtils { 
                Log.e(TAG, "Unable to enable Bluetooth low energy only mode");

                return false;

            }

            return waitForAdapterStateLocked(STATE_BLE_ON, bluetoothAdapter);

            return waitForAdapterStateLocked(BluetoothAdapter.STATE_BLE_ON, bluetoothAdapter);

        } catch (InterruptedException e) {

            Log.w(TAG, "enableBLE(): interrupted", e);

        } finally {

framework/tests/util/src/android/bluetooth/cts/EnableBluetoothRule.java

+32 −17
Original line number Diff line number Diff line
@@ -18,13 +18,13 @@ package android.bluetooth.cts; 


import static com.android.compatibility.common.util.SystemUtil.runShellCommandOrThrow;



import static org.junit.Assert.assertTrue;

import static com.google.common.truth.Truth.assertThat;



import static org.junit.Assume.assumeTrue;



import android.bluetooth.BluetoothAdapter;

import android.bluetooth.BluetoothManager;

import android.content.Context;

import android.content.pm.PackageManager;



import androidx.test.platform.app.InstrumentationRegistry;
@@ -41,35 +41,47 @@ import org.junit.runners.model.Statement; 
 */

public class EnableBluetoothRule extends BeforeAfterRule {

    private final Context mContext = InstrumentationRegistry.getInstrumentation().getContext();

    private final BluetoothManager mBluetoothManager =

            mContext.getSystemService(BluetoothManager.class);

    private final BluetoothAdapter mBluetoothAdapter = mBluetoothManager.getAdapter();

    private final BluetoothAdapter mBluetoothAdapter =

            mContext.getSystemService(BluetoothManager.class).getAdapter();

    private final boolean mEnableTestMode;

    private final boolean mToggleBluetooth;



    private boolean mWasBluetoothAdapterEnabled = true;



    /** Empty constructor */

    public EnableBluetoothRule() {

        mEnableTestMode = false;

        mToggleBluetooth = false;

    }



    public EnableBluetoothRule(boolean enableTestMode) {

    /**

     * Constructor that allows test mode

     *

     * @param enableTestMode whether test mode is enabled

     * @param toggleBluetooth whether to toggle Bluetooth at the beginning of the test if it is

     *     already enabled

     */

    public EnableBluetoothRule(boolean enableTestMode, boolean toggleBluetooth) {

        mEnableTestMode = enableTestMode;

        mToggleBluetooth = toggleBluetooth;

    }



    private boolean supportsBluetooth() {

        return mContext.getPackageManager().hasSystemFeature(PackageManager.FEATURE_BLUETOOTH);

    }



    private boolean isBluetoothEnabled() {

        return mBluetoothAdapter.isEnabled();

    /**

     * Constructor that allows test mode

     *

     * @param enableTestMode whether test mode is enabled

     */

    public EnableBluetoothRule(boolean enableTestMode) {

        mEnableTestMode = enableTestMode;

        mToggleBluetooth = false;

    }



    private void enableBluetoothAdapter() {

        assertTrue(BTAdapterUtils.enableAdapter(mBluetoothAdapter, mContext));

        assertThat(BTAdapterUtils.enableAdapter(mBluetoothAdapter, mContext)).isTrue();

    }



    private void disableBluetoothAdapter() {

        assertTrue(BTAdapterUtils.disableAdapter(mBluetoothAdapter, mContext));

        assertThat(BTAdapterUtils.disableAdapter(mBluetoothAdapter, mContext)).isTrue();

    }



    private void enableBluetoothTestMode() {
@@ -86,10 +98,13 @@ public class EnableBluetoothRule extends BeforeAfterRule { 


    @Override

    protected void onBefore(Statement base, Description description) {

        assumeTrue(supportsBluetooth());

        mWasBluetoothAdapterEnabled = isBluetoothEnabled();

        assumeTrue(TestUtils.hasBluetooth());

        mWasBluetoothAdapterEnabled = mBluetoothAdapter.isEnabled();

        if (!mWasBluetoothAdapterEnabled) {

            enableBluetoothAdapter();

        } else if (mToggleBluetooth) {

            disableBluetoothAdapter();

            enableBluetoothAdapter();

        }

        if (mEnableTestMode) {

            enableBluetoothTestMode();
@@ -98,7 +113,7 @@ public class EnableBluetoothRule extends BeforeAfterRule { 


    @Override

    protected void onAfter(Statement base, Description description) {

        assumeTrue(supportsBluetooth());

        assumeTrue(TestUtils.hasBluetooth());

        disableBluetoothTestMode();

        if (!mWasBluetoothAdapterEnabled) {

            disableBluetoothAdapter();

framework/tests/util/src/android/bluetooth/cts/TestUtils.java

+160 −55

File changed.

Preview size limit exceeded, changes collapsed.