tests/integration/signature/android/net/ip/IpClientSignatureTest.kt

/*
 * 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.net.ip

import android.net.ipmemorystore.NetworkAttributes
import android.net.ipmemorystore.OnNetworkAttributesRetrievedListener
import android.net.ipmemorystore.Status
import android.net.ipmemorystore.Status.SUCCESS
import android.util.ArrayMap
import android.util.Pair
import org.mockito.ArgumentCaptor
import org.mockito.Mockito.any
import org.mockito.Mockito.doAnswer
import org.mockito.Mockito.eq
import org.mockito.Mockito.never
import org.mockito.Mockito.timeout
import org.mockito.Mockito.verify

/**
 * Tests for IpClient, run with signature permissions.
 */
class IpClientSignatureTest : IpClientIntegrationTestCommon() {
    companion object {
        private val TAG = IpClientSignatureTest::class.java.simpleName
    }

    private val DEFAULT_NUD_SOLICIT_NUM_POST_ROAM = 5
    private val DEFAULT_NUD_SOLICIT_NUM_STEADY_STATE = 10

    private val mDeviceConfigProperties = ArrayMap<String, String>()

    override fun makeIIpClient(ifaceName: String, cb: IIpClientCallbacks): IIpClient {
        return mIpc.makeConnector()
    }

    override fun useNetworkStackSignature() = true

    override fun isFeatureEnabled(name: String): Boolean {
        return FEATURE_ENABLED.equals(getDeviceConfigProperty(name))
    }

    override fun isFeatureNotChickenedOut(name: String): Boolean {
        return !FEATURE_DISABLED.equals(getDeviceConfigProperty(name))
    }

    override fun setDeviceConfigProperty(name: String, value: String) {
        mDeviceConfigProperties.put(name, value)
    }

    override fun getDeviceConfigProperty(name: String): String? {
        return mDeviceConfigProperties.get(name)
    }

    override fun getStoredNetworkAttributes(l2Key: String, timeout: Long): NetworkAttributes {
        val networkAttributesCaptor = ArgumentCaptor.forClass(NetworkAttributes::class.java)

        verify(mIpMemoryStore, timeout(timeout))
                .storeNetworkAttributes(eq(l2Key), networkAttributesCaptor.capture(), any())
        return networkAttributesCaptor.value
    }

    override fun getStoredNetworkEventCount(
            cluster: String,
            sinceTimes: LongArray,
            eventType: IntArray,
            timeout: Long
    ): IntArray {
        val counts = IntArray(sinceTimes.size)
        val eventTypesSet = eventType.toSet() // Convert eventType to Set for faster contains check

        sinceTimes.forEachIndexed { index, sinceTime ->
            var count = 0
            mNetworkEvents.forEach { event ->
                val key = event.first
                val value = event.second
                if (key == cluster && eventTypesSet.contains(value.second) &&
                        sinceTime <= value.first) {
                    count++
                }
            }
            counts[index] = count
        }
        return counts
    }

    override fun assertIpMemoryNeverStoreNetworkAttributes(l2Key: String, timeout: Long) {
        verify(mIpMemoryStore, never()).storeNetworkAttributes(eq(l2Key), any(), any())
    }

    override fun storeNetworkAttributes(l2Key: String, na: NetworkAttributes) {
        doAnswer { inv ->
            val listener = inv.getArgument<OnNetworkAttributesRetrievedListener>(1)
            listener.onNetworkAttributesRetrieved(Status(SUCCESS), l2Key, na)
            true
        }.`when`(mIpMemoryStore).retrieveNetworkAttributes(eq(l2Key), any())
    }

    override fun storeNetworkEvent(cluster: String, now: Long, expiry: Long, eventType: Int) {
        val event = Pair(cluster, Pair(now, eventType))
        mNetworkEvents.add(event)
    }

    override fun readNudSolicitNumInSteadyStateFromResource(): Int {
        return DEFAULT_NUD_SOLICIT_NUM_STEADY_STATE
    }

    override fun readNudSolicitNumPostRoamingFromResource(): Int {
        return DEFAULT_NUD_SOLICIT_NUM_POST_ROAM
    }
}