/*
 * Copyright (C) 2019 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.apf;

import static com.android.testutils.ParcelUtils.assertParcelingIsLossless;

import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

import android.content.Context;
import android.os.Build;

import androidx.test.InstrumentationRegistry;
import androidx.test.filters.SmallTest;
import androidx.test.runner.AndroidJUnit4;

import com.android.testutils.DevSdkIgnoreRule;
import com.android.testutils.DevSdkIgnoreRule.IgnoreAfter;
import com.android.testutils.DevSdkIgnoreRule.IgnoreUpTo;

import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;

import java.util.Arrays;

@RunWith(AndroidJUnit4.class)
@SmallTest
public class ApfCapabilitiesTest {
    @Rule
    public final DevSdkIgnoreRule mIgnoreRule = new DevSdkIgnoreRule();

    private Context mContext;

    @Before
    public void setUp() {
        mContext = InstrumentationRegistry.getContext();
    }

    @Test
    public void testConstructAndParcel() {
        final ApfCapabilities caps = new ApfCapabilities(123, 456, 789);
        assertEquals(123, caps.apfVersionSupported);
        assertEquals(456, caps.maximumApfProgramSize);
        assertEquals(789, caps.apfPacketFormat);

        assertParcelingIsLossless(caps);
    }

    @Test
    public void testEquals() {
        assertEquals(new ApfCapabilities(1, 2, 3), new ApfCapabilities(1, 2, 3));
        assertNotEquals(new ApfCapabilities(2, 2, 3), new ApfCapabilities(1, 2, 3));
        assertNotEquals(new ApfCapabilities(1, 3, 3), new ApfCapabilities(1, 2, 3));
        assertNotEquals(new ApfCapabilities(1, 2, 4), new ApfCapabilities(1, 2, 3));
    }

    @Test
    public void testHasDataAccess() {
        //hasDataAccess is only supported starting at apf version 4.
        ApfCapabilities caps = new ApfCapabilities(1 /* apfVersionSupported */, 2, 3);
        assertFalse(caps.hasDataAccess());

        caps = new ApfCapabilities(4 /* apfVersionSupported */, 5, 6);
        assertTrue(caps.hasDataAccess());
    }

    // the property is deleted in U, on S & T getApfDrop8023Frames() is mainline and
    // hardcoded to return true, so this simply verifies the unused property is also true,
    // as modifying it would not take effect.  For S+ change NetworkStack's
    // config_apfDrop802_3Frames instead.
    @Test @IgnoreAfter(Build.VERSION_CODES.TIRAMISU)
    public void testGetApfDrop8023Frames() {
        // Get com.android.internal.R.bool.config_apfDrop802_3Frames. The test cannot directly
        // use R.bool.config_apfDrop802_3Frames because that is not a stable resource ID.
        final int resId = mContext.getResources().getIdentifier("config_apfDrop802_3Frames",
                "bool", "android");
        final boolean shouldDrop8023Frames = mContext.getResources().getBoolean(resId);
        final boolean actual = ApfCapabilities.getApfDrop8023Frames();
        assertEquals(shouldDrop8023Frames, actual);
    }

    @Test @IgnoreUpTo(Build.VERSION_CODES.R)
    public void testGetApfDrop8023Frames_S() {
        // IpClient does not call getApfDrop8023Frames() since S, so any customization of the return
        // value on S+ is a configuration error as it will not be used by IpClient.
        assertTrue("android.R.bool.config_apfDrop802_3Frames has been modified to false, but "
                + "starting from S its value is not used by IpClient. If the modification is "
                + "intentional, use a runtime resource overlay for the NetworkStack package to "
                + "overlay com.android.networkstack.R.bool.config_apfDrop802_3Frames instead.",
                ApfCapabilities.getApfDrop8023Frames());
    }

    // the property is deleted in U, on S & T getApfEtherTypeBlackList() is mainline and
    // hardcoded to return a specific default set of ethertypes, so this simply verifies
    // that the unused property hasn't been changed away from the default, as it would
    // not take effect.  For S+ change NetworkStack's config_apfEthTypeDenyList instead.
    @Test @IgnoreAfter(Build.VERSION_CODES.TIRAMISU)
    public void testGetApfEtherTypeBlackList() {
        // Get com.android.internal.R.array.config_apfEthTypeBlackList. The test cannot directly
        // use R.array.config_apfEthTypeBlackList because that is not a stable resource ID.
        final int resId = mContext.getResources().getIdentifier("config_apfEthTypeBlackList",
                "array", "android");
        final int[] blacklistedEtherTypeArray = mContext.getResources().getIntArray(resId);
        final int[] actual = ApfCapabilities.getApfEtherTypeBlackList();
        assertNotNull(actual);
        assertTrue(Arrays.equals(blacklistedEtherTypeArray, actual));
    }

    @Test @IgnoreUpTo(Build.VERSION_CODES.R)
    public void testGetApfEtherTypeBlackList_S() {
        // IpClient does not call getApfEtherTypeBlackList() since S, so any customization of the
        // return value on S+ is a configuration error as it will not be used by IpClient.
        assertArrayEquals("android.R.array.config_apfEthTypeBlackList has been modified, but "
                        + "starting from S its value is not used by IpClient. If the modification "
                        + "is intentional, use a runtime resource overlay for the NetworkStack "
                        + "package to overlay "
                        + "com.android.networkstack.R.array.config_apfEthTypeDenyList instead.",
                new int[] { 0x88a2, 0x88a4, 0x88b8, 0x88cd, 0x88e3 },
                ApfCapabilities.getApfEtherTypeBlackList());
    }
}