tests/unit/src/android/net/shared/ProvisioningConfigurationTest.java

/*
 * 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.shared;

import static android.net.InetAddresses.parseNumericAddress;
import static android.net.shared.ProvisioningConfiguration.fromStableParcelable;

import static com.android.testutils.MiscAsserts.assertFieldCountEquals;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;

import android.net.LinkAddress;
import android.net.MacAddress;
import android.net.Network;
import android.net.ProvisioningConfigurationParcelable;
import android.net.StaticIpConfiguration;
import android.net.apf.ApfCapabilities;
import android.net.shared.ProvisioningConfiguration.ScanResultInfo;

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

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

import java.nio.ByteBuffer;
import java.util.Collections;
import java.util.function.Consumer;

/**
 * Tests for {@link ProvisioningConfiguration}.
 */
@RunWith(AndroidJUnit4.class)
@SmallTest
public class ProvisioningConfigurationTest {
    private ProvisioningConfiguration mConfig;

    private ScanResultInfo makeScanResultInfo(final String ssid) {
        final byte[] payload = new byte[] {
            (byte) 0x00, (byte) 0x17, (byte) 0xF2, (byte) 0x06, (byte) 0x01,
            (byte) 0x01, (byte) 0x03, (byte) 0x01, (byte) 0x00, (byte) 0x00,
        };
        final ScanResultInfo.InformationElement ie =
                new ScanResultInfo.InformationElement(0xdd /* vendor specific IE id */,
                        ByteBuffer.wrap(payload));
        return new ScanResultInfo(ssid, "01:02:03:04:05:06" /* bssid string */,
                Collections.singletonList(ie));
    }

    @Before
    public void setUp() {
        mConfig = new ProvisioningConfiguration();
        mConfig.mEnableIPv4 = true;
        mConfig.mEnableIPv6 = true;
        mConfig.mUsingMultinetworkPolicyTracker = true;
        mConfig.mUsingIpReachabilityMonitor = true;
        mConfig.mRequestedPreDhcpActionMs = 42;
        mConfig.mInitialConfig = new InitialConfiguration();
        mConfig.mInitialConfig.ipAddresses.add(
                new LinkAddress(parseNumericAddress("192.168.42.42"), 24));
        mConfig.mStaticIpConfig = new StaticIpConfiguration();
        mConfig.mStaticIpConfig.ipAddress =
                new LinkAddress(parseNumericAddress("2001:db8::42"), 90);
        // Not testing other InitialConfig or StaticIpConfig members: they have their own unit tests
        mConfig.mApfCapabilities = new ApfCapabilities(1, 2, 3);
        mConfig.mProvisioningTimeoutMs = 4200;
        mConfig.mIPv6AddrGenMode = 123;
        mConfig.mNetwork = new Network(321);
        mConfig.mDisplayName = "test_config";
        mConfig.mEnablePreconnection = false;
        mConfig.mScanResultInfo = makeScanResultInfo("ssid");
        mConfig.mLayer2Info = new Layer2Information("some l2key", "some cluster",
                MacAddress.fromString("00:01:02:03:04:05"));
        // Any added field must be included in equals() to be tested properly
        assertFieldCountEquals(15, ProvisioningConfiguration.class);
    }

    @Test
    public void testParcelUnparcel() {
        doParcelUnparcelTest();
    }

    @Test
    public void testParcelUnparcel_NullInitialConfiguration() {
        mConfig.mInitialConfig = null;
        doParcelUnparcelTest();
    }

    @Test
    public void testParcelUnparcel_NullStaticConfiguration() {
        mConfig.mStaticIpConfig = null;
        doParcelUnparcelTest();
    }

    @Test
    public void testParcelUnparcel_NullApfCapabilities() {
        mConfig.mApfCapabilities = null;
        doParcelUnparcelTest();
    }

    @Test
    public void testParcelUnparcel_NullNetwork() {
        mConfig.mNetwork = null;
        doParcelUnparcelTest();
    }

    @Test
    public void testParcelUnparcel_NullScanResultInfo() {
        mConfig.mScanResultInfo = null;
        doParcelUnparcelTest();
    }

    @Test
    public void testParcelUnparcel_WithPreDhcpConnection() {
        mConfig.mEnablePreconnection = true;
        doParcelUnparcelTest();
    }

    private void doParcelUnparcelTest() {
        final ProvisioningConfiguration unparceled =
                fromStableParcelable(mConfig.toStableParcelable());
        assertEquals(mConfig, unparceled);
    }

    @Test
    public void testEquals() {
        assertEquals(mConfig, new ProvisioningConfiguration(mConfig));

        assertNotEqualsAfterChange(c -> c.mEnableIPv4 = false);
        assertNotEqualsAfterChange(c -> c.mEnableIPv6 = false);
        assertNotEqualsAfterChange(c -> c.mUsingMultinetworkPolicyTracker = false);
        assertNotEqualsAfterChange(c -> c.mUsingIpReachabilityMonitor = false);
        assertNotEqualsAfterChange(c -> c.mRequestedPreDhcpActionMs++);
        assertNotEqualsAfterChange(c -> c.mInitialConfig.ipAddresses.add(
                new LinkAddress(parseNumericAddress("192.168.47.47"), 16)));
        assertNotEqualsAfterChange(c -> c.mInitialConfig = null);
        assertNotEqualsAfterChange(c -> c.mStaticIpConfig.ipAddress =
                new LinkAddress(parseNumericAddress("2001:db8::47"), 64));
        assertNotEqualsAfterChange(c -> c.mStaticIpConfig = null);
        assertNotEqualsAfterChange(c -> c.mApfCapabilities = new ApfCapabilities(4, 5, 6));
        assertNotEqualsAfterChange(c -> c.mApfCapabilities = null);
        assertNotEqualsAfterChange(c -> c.mProvisioningTimeoutMs++);
        assertNotEqualsAfterChange(c -> c.mIPv6AddrGenMode++);
        assertNotEqualsAfterChange(c -> c.mNetwork = new Network(123));
        assertNotEqualsAfterChange(c -> c.mNetwork = null);
        assertNotEqualsAfterChange(c -> c.mDisplayName = "other_test");
        assertNotEqualsAfterChange(c -> c.mDisplayName = null);
        assertNotEqualsAfterChange(c -> c.mEnablePreconnection = true);
        assertNotEqualsAfterChange(c -> c.mScanResultInfo = null);
        assertNotEqualsAfterChange(c -> c.mScanResultInfo = makeScanResultInfo("another ssid"));
        assertNotEqualsAfterChange(c -> c.mLayer2Info = new Layer2Information("another l2key",
                "some cluster", MacAddress.fromString("00:01:02:03:04:05")));
        assertNotEqualsAfterChange(c -> c.mLayer2Info = new Layer2Information("some l2key",
                "another cluster", MacAddress.fromString("00:01:02:03:04:05")));
        assertNotEqualsAfterChange(c -> c.mLayer2Info = new Layer2Information("some l2key",
                "some cluster", MacAddress.fromString("01:02:03:04:05:06")));
        assertNotEqualsAfterChange(c -> c.mLayer2Info = null);
        assertFieldCountEquals(15, ProvisioningConfiguration.class);
    }

    private void assertNotEqualsAfterChange(Consumer<ProvisioningConfiguration> mutator) {
        final ProvisioningConfiguration newConfig = new ProvisioningConfiguration(mConfig);
        mutator.accept(newConfig);
        assertNotEquals(mConfig, newConfig);
    }

    private static final String TEMPLATE = ""
            + "android.net.ProvisioningConfigurationParcelable{enableIPv4: true, enableIPv6: true,"
            + " usingMultinetworkPolicyTracker: true,"
            + " usingIpReachabilityMonitor: true, requestedPreDhcpActionMs: 42,"
            + " initialConfig: android.net.InitialConfigurationParcelable{ipAddresses:"
            + " [192.168.42.42/24], directlyConnectedRoutes: [], dnsServers: [], gateway: null},"
            + " staticIpConfig: IP address 2001:db8::42/90 Gateway  DNS servers: [ ] Domains ,"
            + " apfCapabilities: ApfCapabilities{version: 1, maxSize: 2, format: 3},"
            + " provisioningTimeoutMs: 4200, ipv6AddrGenMode: 123, network: 321,"
            + " displayName: test_config, enablePreconnection: false, scanResultInfo:"
            + " android.net.ScanResultInfoParcelable{ssid: ssid, bssid: 01:02:03:04:05:06,"
            + " informationElements: [android.net.InformationElementParcelable{id: 221,"
            + " payload: [0, 23, -14, 6, 1, 1, 3, 1, 0, 0]}]}, layer2Info:"
            + " android.net.Layer2InformationParcelable{l2Key: some l2key,"
            + " cluster: some cluster, bssid: %s}}";

    @Test
    public void testParcelableToString() {
        String expected = String.format(TEMPLATE, "00:01:02:03:04:05");
        assertEquals(expected, mConfig.toStableParcelable().toString());

        final ProvisioningConfigurationParcelable parcelWithNull = mConfig.toStableParcelable();
        parcelWithNull.layer2Info.bssid = null;
        expected = String.format(TEMPLATE, "null");
        assertEquals(expected, parcelWithNull.toString());
    }
}