tests/tests/bluetooth/bluetoothTestUtilLib/src/android/bluetooth/cts/BTAdapterUtils.java

/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * 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.
 */

package android.bluetooth.cts;

import android.app.UiAutomation;
import android.bluetooth.BluetoothAdapter;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.util.Log;

import androidx.test.InstrumentationRegistry;

import java.util.HashSet;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.Condition;
import java.util.concurrent.locks.ReentrantLock;

/**
 * Utility for controlling the Bluetooth adapter from CTS test.
 */
public class BTAdapterUtils {
    private static final String TAG = "BTAdapterUtils";

    // ADAPTER_ENABLE_TIMEOUT_MS = AdapterState.BLE_START_TIMEOUT_DELAY +
    //                              AdapterState.BREDR_START_TIMEOUT_DELAY
    private static final int ADAPTER_ENABLE_TIMEOUT_MS = 8000;
    // ADAPTER_DISABLE_TIMEOUT_MS = AdapterState.BLE_STOP_TIMEOUT_DELAY +
    //                                  AdapterState.BREDR_STOP_TIMEOUT_DELAY
    private static final int ADAPTER_DISABLE_TIMEOUT_MS = 5000;

    private static BroadcastReceiver mAdapterIntentReceiver;

    private static Condition mConditionAdapterIsEnabled;
    private static ReentrantLock mAdapterStateEnablinglock;

    private static Condition mConditionAdapterIsDisabled;
    private static ReentrantLock mAdapterStateDisablinglock;
    private static boolean mAdapterVarsInitialized;

    private static class AdapterIntentReceiver extends BroadcastReceiver {
        @Override
        public void onReceive(Context context, Intent intent) {
            if (BluetoothAdapter.ACTION_STATE_CHANGED.equals(intent.getAction())) {
                int previousState = intent.getIntExtra(BluetoothAdapter.EXTRA_PREVIOUS_STATE, -1);
                int newState = intent.getIntExtra(BluetoothAdapter.EXTRA_STATE, -1);
                Log.d(TAG, "Previous state: " + previousState + " New state: " + newState);

                if (newState == BluetoothAdapter.STATE_ON) {
                    mAdapterStateEnablinglock.lock();
                    try {
                        Log.d(TAG, "Signaling to mConditionAdapterIsEnabled");
                        mConditionAdapterIsEnabled.signal();
                    } finally {
                        mAdapterStateEnablinglock.unlock();
                    }
                } else if (newState == BluetoothAdapter.STATE_OFF) {
                    mAdapterStateDisablinglock.lock();
                    try {
                        Log.d(TAG, "Signaling to mConditionAdapterIsDisabled");
                        mConditionAdapterIsDisabled.signal();
                    } finally {
                        mAdapterStateDisablinglock.unlock();
                    }
                }
            }
        }
    }

    /** Enables the Bluetooth Adapter. Return true if it is already enabled or is enabled. */
    public static boolean enableAdapter(BluetoothAdapter bluetoothAdapter, Context context) {
        if (!mAdapterVarsInitialized) {
            initAdapterStateVariables(context);
        }

        if (bluetoothAdapter.isEnabled()) return true;

        Log.d(TAG, "Enabling bluetooth adapter");
        UiAutomation auto = InstrumentationRegistry.getInstrumentation().getUiAutomation();
        Set<String> permissions = new HashSet(auto.getAdoptedShellPermissions());
        Set<String> savedPermissions = Set.copyOf(permissions);
        permissions.add(android.Manifest.permission.NETWORK_SETTINGS);
        auto.adoptShellPermissionIdentity(permissions.toArray(new String[permissions.size()]));
        bluetoothAdapter.enable();
        mAdapterStateEnablinglock.lock();
        try {
            // Wait for the Adapter to be enabled
            while (!bluetoothAdapter.isEnabled()) {
                if (!mConditionAdapterIsEnabled.await(
                        ADAPTER_ENABLE_TIMEOUT_MS, TimeUnit.MILLISECONDS)) {
                    // Timeout
                    Log.e(TAG, "Timeout while waiting for the Bluetooth Adapter enable");
                    break;
                } // else spurious wakeups
            }
        } catch(InterruptedException e) {
            Log.e(TAG, "enableAdapter: interrrupted");
        } finally {
            auto.adoptShellPermissionIdentity(savedPermissions.toArray(
                    new String[savedPermissions.size()]));
            mAdapterStateEnablinglock.unlock();
        }

        return bluetoothAdapter.isEnabled();
    }

    /** Disable the Bluetooth Adapter. Return true if it is already disabled or is disabled. */
    public static boolean disableAdapter(BluetoothAdapter bluetoothAdapter, Context context) {
        if (!mAdapterVarsInitialized) {
            initAdapterStateVariables(context);
        }

        if (bluetoothAdapter.getState() == BluetoothAdapter.STATE_OFF) return true;

        Log.d(TAG, "Disabling bluetooth adapter");
        UiAutomation auto = InstrumentationRegistry.getInstrumentation().getUiAutomation();
        Set<String> permissions = new HashSet(auto.getAdoptedShellPermissions());
        Set<String> savedPermissions = Set.copyOf(permissions);
        permissions.add(android.Manifest.permission.NETWORK_SETTINGS);
        auto.adoptShellPermissionIdentity(permissions.toArray(new String[permissions.size()]));
        bluetoothAdapter.disable();
        mAdapterStateDisablinglock.lock();
        try {
            // Wait for the Adapter to be disabled
            while (bluetoothAdapter.getState() != BluetoothAdapter.STATE_OFF) {
                if (!mConditionAdapterIsDisabled.await(
                        ADAPTER_DISABLE_TIMEOUT_MS, TimeUnit.MILLISECONDS)) {
                    // Timeout
                    Log.e(TAG, "Timeout while waiting for the Bluetooth Adapter disable");
                    break;
                } // else spurious wakeups
            }
        } catch(InterruptedException e) {
            Log.e(TAG, "enableAdapter: interrrupted");
        } finally {
            auto.adoptShellPermissionIdentity(savedPermissions.toArray(
                    new String[savedPermissions.size()]));
            mAdapterStateDisablinglock.unlock();
        }
        return bluetoothAdapter.getState() == BluetoothAdapter.STATE_OFF;
    }

    // Initialize variables required for TestUtils#enableAdapter and TestUtils#disableAdapter
    private static void initAdapterStateVariables(Context context) {
        Log.d(TAG, "Initializing adapter state variables");
        mAdapterIntentReceiver = new AdapterIntentReceiver();
        IntentFilter filter = new IntentFilter(BluetoothAdapter.ACTION_STATE_CHANGED);
        context.registerReceiver(mAdapterIntentReceiver, filter);

        mAdapterStateEnablinglock = new ReentrantLock();
        mConditionAdapterIsEnabled = mAdapterStateEnablinglock.newCondition();
        mAdapterStateDisablinglock = new ReentrantLock();
        mConditionAdapterIsDisabled = mAdapterStateDisablinglock.newCondition();

        mAdapterVarsInitialized = true;
    }
}