Merge "[FUI08] Create NeworkStateSnapshot"

/**

 * Copyright (c) 2021, 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;

parcelable NetworkStateSnapshot;

/*

 * Copyright (C) 2021 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;

import android.annotation.NonNull;

import android.annotation.Nullable;

import android.os.Parcel;

import android.os.Parcelable;

import java.util.Objects;

/**

 * Snapshot of network state.

 *

 * @hide

 */

public final class NetworkStateSnapshot implements Parcelable {

    @NonNull

    public final LinkProperties linkProperties;

    @NonNull

    public final NetworkCapabilities networkCapabilities;

    @NonNull

    public final Network network;

    @Nullable

    public final String subscriberId;

    public final int legacyType;

    public NetworkStateSnapshot(@NonNull LinkProperties linkProperties,

            @NonNull NetworkCapabilities networkCapabilities, @NonNull Network network,

            @Nullable String subscriberId, int legacyType) {

        this.linkProperties = Objects.requireNonNull(linkProperties);

        this.networkCapabilities = Objects.requireNonNull(networkCapabilities);

        this.network = Objects.requireNonNull(network);

        this.subscriberId = subscriberId;

        this.legacyType = legacyType;

    }

    public NetworkStateSnapshot(@NonNull Parcel in) {

        linkProperties = in.readParcelable(null);

        networkCapabilities = in.readParcelable(null);

        network = in.readParcelable(null);

        subscriberId = in.readString();

        legacyType = in.readInt();

    }

    @Override

    public int describeContents() {

        return 0;

    }

    @Override

    public void writeToParcel(@NonNull Parcel out, int flags) {

        out.writeParcelable(linkProperties, flags);

        out.writeParcelable(networkCapabilities, flags);

        out.writeParcelable(network, flags);

        out.writeString(subscriberId);

        out.writeInt(legacyType);

    }

    @NonNull

    public static final Creator<NetworkStateSnapshot> CREATOR =

            new Creator<NetworkStateSnapshot>() {

        @NonNull

        @Override

        public NetworkStateSnapshot createFromParcel(@NonNull Parcel in) {

            return new NetworkStateSnapshot(in);

        }

        @NonNull

        @Override

        public NetworkStateSnapshot[] newArray(int size) {

            return new NetworkStateSnapshot[size];

        }

    };

    @Override

    public boolean equals(Object o) {

        if (this == o) return true;

        if (!(o instanceof NetworkStateSnapshot)) return false;

        NetworkStateSnapshot that = (NetworkStateSnapshot) o;

        return legacyType == that.legacyType

                && Objects.equals(linkProperties, that.linkProperties)

                && Objects.equals(networkCapabilities, that.networkCapabilities)

                && Objects.equals(network, that.network)

                && Objects.equals(subscriberId, that.subscriberId);

    }

    @Override

    public int hashCode() {

        return Objects.hash(linkProperties, networkCapabilities, network, subscriberId, legacyType);

    }

}

/*

 * Copyright (C) 2021 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

import android.net.ConnectivityManager.TYPE_NONE

import android.net.ConnectivityManager.TYPE_WIFI

import android.net.InetAddresses.parseNumericAddress

import android.net.NetworkCapabilities.TRANSPORT_WIFI

import android.os.Build

import androidx.test.filters.SmallTest

import com.android.testutils.DevSdkIgnoreRule

import com.android.testutils.DevSdkIgnoreRunner

import com.android.testutils.assertParcelSane

import org.junit.Test

import org.junit.runner.RunWith

import java.net.Inet4Address

import java.net.Inet6Address

private const val TEST_IMSI = "imsi1"

private const val TEST_SSID = "SSID1"

private const val TEST_NETID = 123

private val TEST_IPV4_GATEWAY = parseNumericAddress("192.168.222.3") as Inet4Address

private val TEST_IPV6_GATEWAY = parseNumericAddress("2001:db8::1") as Inet6Address

private val TEST_IPV4_LINKADDR = LinkAddress("192.168.222.123/24")

private val TEST_IPV6_LINKADDR = LinkAddress("2001:db8::123/64")

private val TEST_IFACE = "fake0"

private val TEST_LINK_PROPERTIES = LinkProperties().apply {

    interfaceName = TEST_IFACE

    addLinkAddress(TEST_IPV4_LINKADDR)

    addLinkAddress(TEST_IPV6_LINKADDR)

    // Add default routes

    addRoute(RouteInfo(IpPrefix(parseNumericAddress("0.0.0.0"), 0), TEST_IPV4_GATEWAY))

    addRoute(RouteInfo(IpPrefix(parseNumericAddress("::"), 0), TEST_IPV6_GATEWAY))

}

private val TEST_CAPABILITIES = NetworkCapabilities().apply {

    addTransportType(TRANSPORT_WIFI)

    setCapability(NetworkCapabilities.NET_CAPABILITY_NOT_METERED, false)

    setCapability(NetworkCapabilities.NET_CAPABILITY_NOT_ROAMING, true)

    setSSID(TEST_SSID)

}

@SmallTest

@RunWith(DevSdkIgnoreRunner::class)

@DevSdkIgnoreRule.IgnoreUpTo(Build.VERSION_CODES.R)

class NetworkStateSnapshotTest {

    @Test

    fun testParcelUnparcel() {

        val emptySnapshot = NetworkStateSnapshot(LinkProperties(), NetworkCapabilities(),

                Network(TEST_NETID), null, TYPE_NONE)

        val snapshot = NetworkStateSnapshot(

                TEST_LINK_PROPERTIES, TEST_CAPABILITIES, Network(TEST_NETID), TEST_IMSI, TYPE_WIFI)

        assertParcelSane(emptySnapshot, 5)

        assertParcelSane(snapshot, 5)

    }

}