tests/wifitests/src/com/android/server/wifi/SupplicantStateTrackerTest.java

/*
 * Copyright (C) 2016 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 com.android.server.wifi;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.*;

import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.net.wifi.SupplicantState;
import android.net.wifi.WifiManager;
import android.net.wifi.WifiSsid;
import android.os.BatteryStatsManager;
import android.os.Handler;
import android.os.Message;
import android.os.test.TestLooper;

import androidx.test.filters.SmallTest;

import org.junit.Before;
import org.junit.Test;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

/**
 * Unit tests for {@link SupplicantStateTracker}.
 */
@SmallTest
public class SupplicantStateTrackerTest extends WifiBaseTest {

    private static final String TAG = "SupplicantStateTrackerTest";
    private static final String   sSSID = "\"GoogleGuest\"";
    private static final WifiSsid sWifiSsid = WifiSsid.createFromAsciiEncoded(sSSID);
    private static final String   sBSSID = "01:02:03:04:05:06";

    private @Mock WifiConfigManager mWcm;
    private @Mock Context mContext;
    private @Mock BatteryStatsManager mBatteryStats;
    private Handler mHandler;
    private SupplicantStateTracker mSupplicantStateTracker;
    private TestLooper mLooper;

    private Message getSupplicantStateChangeMessage(int networkId, WifiSsid wifiSsid,
            String bssid, SupplicantState newSupplicantState) {
        return Message.obtain(null, WifiMonitor.SUPPLICANT_STATE_CHANGE_EVENT, 0, 0,
                new StateChangeResult(networkId, wifiSsid, bssid, newSupplicantState));

    }

    @Before
    public void setUp() {
        mLooper = new TestLooper();
        mHandler = new Handler(mLooper.getLooper());
        MockitoAnnotations.initMocks(this);
        mSupplicantStateTracker = new SupplicantStateTracker(mContext, mWcm, mBatteryStats,
                mHandler);
    }

    /**
     * This test verifies that the SupplicantStateTracker sends a broadcast intent upon receiving
     * a message when supplicant state changes
     */
    @Test
    public void testSupplicantStateChangeIntent() {
        BroadcastReceiver wifiBroadcastReceiver = new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                String action = intent.getAction();
                assertTrue(action.equals(WifiManager.SUPPLICANT_STATE_CHANGED_ACTION));
                SupplicantState recvdState =
                        (SupplicantState) intent.getExtra(WifiManager.EXTRA_NEW_STATE, -1);
                assertEquals(SupplicantState.SCANNING, recvdState);
            }
        };
        IntentFilter mIntentFilter = new IntentFilter();
        mIntentFilter.addAction(WifiManager.SUPPLICANT_STATE_CHANGED_ACTION);
        mContext.registerReceiver(wifiBroadcastReceiver, mIntentFilter);
        mSupplicantStateTracker.sendMessage(getSupplicantStateChangeMessage(0, sWifiSsid,
                sBSSID, SupplicantState.SCANNING));
    }

    /**
     * This test verifies that the current auth status is sent in the Broadcast intent
     */
    @Test
    public void testAuthPassInSupplicantStateChangeIntent() {
        BroadcastReceiver wifiBroadcastReceiver = new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                String action = intent.getAction();
                assertTrue(action.equals(WifiManager.SUPPLICANT_STATE_CHANGED_ACTION));
                SupplicantState recvdState =
                        (SupplicantState) intent.getExtra(WifiManager.EXTRA_NEW_STATE, -1);
                assertEquals(SupplicantState.AUTHENTICATING, recvdState);
                boolean authStatus =
                        (boolean) intent.getExtra(WifiManager.EXTRA_SUPPLICANT_ERROR, -1);
                assertEquals(authStatus, true);
            }
        };
        IntentFilter mIntentFilter = new IntentFilter();
        mIntentFilter.addAction(WifiManager.SUPPLICANT_STATE_CHANGED_ACTION);
        mContext.registerReceiver(wifiBroadcastReceiver, mIntentFilter);
        mSupplicantStateTracker.sendMessage(getSupplicantStateChangeMessage(0, sWifiSsid,
                sBSSID, SupplicantState.AUTHENTICATING));
        mSupplicantStateTracker.sendMessage(WifiMonitor.AUTHENTICATION_FAILURE_EVENT);
    }

    /**
     * This test verifies that the current auth status is sent in the Broadcast intent
     */
    @Test
    public void testAuthFailedInSupplicantStateChangeIntent() {
        BroadcastReceiver wifiBroadcastReceiver = new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                String action = intent.getAction();
                assertTrue(action.equals(WifiManager.SUPPLICANT_STATE_CHANGED_ACTION));
                SupplicantState recvdState =
                        (SupplicantState) intent.getExtra(WifiManager.EXTRA_NEW_STATE, -1);
                assertEquals(SupplicantState.AUTHENTICATING, recvdState);
                boolean authStatus =
                        (boolean) intent.getExtra(WifiManager.EXTRA_SUPPLICANT_ERROR, -1);
                assertEquals(authStatus, false);
            }
        };
        IntentFilter mIntentFilter = new IntentFilter();
        mIntentFilter.addAction(WifiManager.SUPPLICANT_STATE_CHANGED_ACTION);
        mContext.registerReceiver(wifiBroadcastReceiver, mIntentFilter);
        mSupplicantStateTracker.sendMessage(WifiMonitor.AUTHENTICATION_FAILURE_EVENT);
        mSupplicantStateTracker.sendMessage(getSupplicantStateChangeMessage(0, sWifiSsid,
                sBSSID, SupplicantState.AUTHENTICATING));
    }

    /**
     * This test verifies the correct reasonCode for auth failure is sent in Broadcast
     * intent.
     */
    @Test
    public void testReasonCodeInSupplicantStateChangeIntent() {
        BroadcastReceiver wifiBroadcastReceiver = new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                String action = intent.getAction();
                assertTrue(action.equals(WifiManager.SUPPLICANT_STATE_CHANGED_ACTION));
                SupplicantState recvdState =
                        (SupplicantState) intent.getExtra(WifiManager.EXTRA_NEW_STATE, -1);
                assertEquals(SupplicantState.AUTHENTICATING, recvdState);
                boolean authStatus =
                        (boolean) intent.getExtra(WifiManager.EXTRA_SUPPLICANT_ERROR, -1);
                assertEquals(authStatus, false);
                int reasonCode = (int)
                        intent.getExtra(WifiManager.EXTRA_SUPPLICANT_ERROR_REASON, -1);
                assertEquals(reasonCode, WifiManager.ERROR_AUTH_FAILURE_WRONG_PSWD);
            }
        };
        IntentFilter mIntentFilter = new IntentFilter();
        mIntentFilter.addAction(WifiManager.SUPPLICANT_STATE_CHANGED_ACTION);
        mContext.registerReceiver(wifiBroadcastReceiver, mIntentFilter);
        mSupplicantStateTracker.sendMessage(WifiMonitor.AUTHENTICATION_FAILURE_EVENT,
                WifiManager.ERROR_AUTH_FAILURE_WRONG_PSWD, -1);
        mSupplicantStateTracker.sendMessage(getSupplicantStateChangeMessage(0, sWifiSsid,
                sBSSID, SupplicantState.AUTHENTICATING));
    }
}