| /* |
| * Copyright (C) 2018 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.connectivity.ipmemorystore; |
| |
| import static org.junit.Assert.assertEquals; |
| import static org.junit.Assert.assertFalse; |
| import static org.junit.Assert.assertNull; |
| import static org.junit.Assert.assertTrue; |
| import static org.junit.Assert.fail; |
| import static org.mockito.ArgumentMatchers.anyString; |
| import static org.mockito.Mockito.doReturn; |
| |
| import android.content.Context; |
| import android.net.ipmemorystore.Blob; |
| import android.net.ipmemorystore.IOnBlobRetrievedListener; |
| import android.net.ipmemorystore.IOnL2KeyResponseListener; |
| import android.net.ipmemorystore.IOnNetworkAttributesRetrieved; |
| import android.net.ipmemorystore.IOnSameNetworkResponseListener; |
| import android.net.ipmemorystore.IOnStatusListener; |
| import android.net.ipmemorystore.NetworkAttributes; |
| import android.net.ipmemorystore.NetworkAttributesParcelable; |
| import android.net.ipmemorystore.SameL3NetworkResponse; |
| import android.net.ipmemorystore.SameL3NetworkResponseParcelable; |
| import android.net.ipmemorystore.Status; |
| import android.net.ipmemorystore.StatusParcelable; |
| import android.os.IBinder; |
| import android.os.RemoteException; |
| |
| import androidx.test.InstrumentationRegistry; |
| import androidx.test.filters.SmallTest; |
| import androidx.test.runner.AndroidJUnit4; |
| |
| import org.junit.After; |
| import org.junit.Before; |
| import org.junit.Test; |
| import org.junit.runner.RunWith; |
| import org.mockito.Mock; |
| import org.mockito.MockitoAnnotations; |
| |
| import java.io.File; |
| import java.lang.reflect.Modifier; |
| import java.net.Inet4Address; |
| import java.net.Inet6Address; |
| import java.net.InetAddress; |
| import java.net.UnknownHostException; |
| import java.util.Arrays; |
| import java.util.concurrent.CountDownLatch; |
| import java.util.concurrent.TimeUnit; |
| import java.util.function.Consumer; |
| |
| /** Unit tests for {@link IpMemoryStoreService}. */ |
| @SmallTest |
| @RunWith(AndroidJUnit4.class) |
| public class IpMemoryStoreServiceTest { |
| private static final String TEST_CLIENT_ID = "testClientId"; |
| private static final String TEST_DATA_NAME = "testData"; |
| |
| private static final int FAKE_KEY_COUNT = 20; |
| private static final String[] FAKE_KEYS; |
| static { |
| FAKE_KEYS = new String[FAKE_KEY_COUNT]; |
| for (int i = 0; i < FAKE_KEYS.length; ++i) { |
| FAKE_KEYS[i] = "fakeKey" + i; |
| } |
| } |
| |
| @Mock |
| private Context mMockContext; |
| private File mDbFile; |
| |
| private IpMemoryStoreService mService; |
| |
| @Before |
| public void setUp() { |
| MockitoAnnotations.initMocks(this); |
| final Context context = InstrumentationRegistry.getContext(); |
| final File dir = context.getFilesDir(); |
| mDbFile = new File(dir, "test.db"); |
| doReturn(mDbFile).when(mMockContext).getDatabasePath(anyString()); |
| mService = new IpMemoryStoreService(mMockContext); |
| } |
| |
| @After |
| public void tearDown() { |
| mService.shutdown(); |
| mDbFile.delete(); |
| } |
| |
| /** Helper method to make a vanilla IOnStatusListener */ |
| private IOnStatusListener onStatus(Consumer<Status> functor) { |
| return new IOnStatusListener() { |
| @Override |
| public void onComplete(final StatusParcelable statusParcelable) throws RemoteException { |
| functor.accept(new Status(statusParcelable)); |
| } |
| |
| @Override |
| public IBinder asBinder() { |
| return null; |
| } |
| }; |
| } |
| |
| /** Helper method to make an IOnBlobRetrievedListener */ |
| private interface OnBlobRetrievedListener { |
| void onBlobRetrieved(Status status, String l2Key, String name, byte[] data); |
| } |
| private IOnBlobRetrievedListener onBlobRetrieved(final OnBlobRetrievedListener functor) { |
| return new IOnBlobRetrievedListener() { |
| @Override |
| public void onBlobRetrieved(final StatusParcelable statusParcelable, |
| final String l2Key, final String name, final Blob blob) throws RemoteException { |
| functor.onBlobRetrieved(new Status(statusParcelable), l2Key, name, |
| null == blob ? null : blob.data); |
| } |
| |
| @Override |
| public IBinder asBinder() { |
| return null; |
| } |
| }; |
| } |
| |
| /** Helper method to make an IOnNetworkAttributesRetrievedListener */ |
| private interface OnNetworkAttributesRetrievedListener { |
| void onNetworkAttributesRetrieved(Status status, String l2Key, NetworkAttributes attr); |
| } |
| private IOnNetworkAttributesRetrieved onNetworkAttributesRetrieved( |
| final OnNetworkAttributesRetrievedListener functor) { |
| return new IOnNetworkAttributesRetrieved() { |
| @Override |
| public void onNetworkAttributesRetrieved(final StatusParcelable status, |
| final String l2Key, final NetworkAttributesParcelable attributes) |
| throws RemoteException { |
| functor.onNetworkAttributesRetrieved(new Status(status), l2Key, |
| null == attributes ? null : new NetworkAttributes(attributes)); |
| } |
| |
| @Override |
| public IBinder asBinder() { |
| return null; |
| } |
| }; |
| } |
| |
| /** Helper method to make an IOnSameNetworkResponseListener */ |
| private interface OnSameNetworkResponseListener { |
| void onSameNetworkResponse(Status status, SameL3NetworkResponse answer); |
| } |
| private IOnSameNetworkResponseListener onSameResponse( |
| final OnSameNetworkResponseListener functor) { |
| return new IOnSameNetworkResponseListener() { |
| @Override |
| public void onSameNetworkResponse(final StatusParcelable status, |
| final SameL3NetworkResponseParcelable sameL3Network) |
| throws RemoteException { |
| functor.onSameNetworkResponse(new Status(status), |
| null == sameL3Network ? null : new SameL3NetworkResponse(sameL3Network)); |
| } |
| |
| @Override |
| public IBinder asBinder() { |
| return null; |
| } |
| }; |
| } |
| |
| /** Helper method to make an IOnL2KeyResponseListener */ |
| private interface OnL2KeyResponseListener { |
| void onL2KeyResponse(Status status, String key); |
| } |
| private IOnL2KeyResponseListener onL2KeyResponse(final OnL2KeyResponseListener functor) { |
| return new IOnL2KeyResponseListener() { |
| @Override |
| public void onL2KeyResponse(final StatusParcelable status, final String key) |
| throws RemoteException { |
| functor.onL2KeyResponse(new Status(status), key); |
| } |
| |
| @Override |
| public IBinder asBinder() { |
| return null; |
| } |
| }; |
| } |
| |
| // Helper method to factorize some boilerplate |
| private void doLatched(final String timeoutMessage, final Consumer<CountDownLatch> functor) { |
| final CountDownLatch latch = new CountDownLatch(1); |
| functor.accept(latch); |
| try { |
| if (!latch.await(5000, TimeUnit.MILLISECONDS)) { |
| fail(timeoutMessage); |
| } |
| } catch (InterruptedException e) { |
| fail("Thread was interrupted"); |
| } |
| } |
| |
| // Helper methods to factorize more boilerplate |
| private void storeAttributes(final String l2Key, final NetworkAttributes na) { |
| storeAttributes("Did not complete storing attributes", l2Key, na); |
| } |
| private void storeAttributes(final String timeoutMessage, final String l2Key, |
| final NetworkAttributes na) { |
| doLatched(timeoutMessage, latch -> mService.storeNetworkAttributes(l2Key, na.toParcelable(), |
| onStatus(status -> { |
| assertTrue("Store not successful : " + status.resultCode, status.isSuccess()); |
| latch.countDown(); |
| }))); |
| } |
| |
| @Test |
| public void testNetworkAttributes() throws UnknownHostException { |
| final NetworkAttributes.Builder na = new NetworkAttributes.Builder(); |
| na.setAssignedV4Address((Inet4Address) Inet4Address.getByName("1.2.3.4")); |
| na.setGroupHint("hint1"); |
| na.setMtu(219); |
| final String l2Key = FAKE_KEYS[0]; |
| NetworkAttributes attributes = na.build(); |
| storeAttributes(l2Key, attributes); |
| |
| doLatched("Did not complete retrieving attributes", latch -> |
| mService.retrieveNetworkAttributes(l2Key, onNetworkAttributesRetrieved( |
| (status, key, attr) -> { |
| assertTrue("Retrieve network attributes not successful : " |
| + status.resultCode, status.isSuccess()); |
| assertEquals(l2Key, key); |
| assertEquals(attributes, attr); |
| latch.countDown(); |
| }))); |
| |
| final NetworkAttributes.Builder na2 = new NetworkAttributes.Builder(); |
| na.setDnsAddresses(Arrays.asList( |
| new InetAddress[] {Inet6Address.getByName("0A1C:2E40:480A::1CA6")})); |
| final NetworkAttributes attributes2 = na2.build(); |
| storeAttributes("Did not complete storing attributes 2", l2Key, attributes2); |
| |
| doLatched("Did not complete retrieving attributes 2", latch -> |
| mService.retrieveNetworkAttributes(l2Key, onNetworkAttributesRetrieved( |
| (status, key, attr) -> { |
| assertTrue("Retrieve network attributes not successful : " |
| + status.resultCode, status.isSuccess()); |
| assertEquals(l2Key, key); |
| assertEquals(attributes.assignedV4Address, attr.assignedV4Address); |
| assertEquals(attributes.groupHint, attr.groupHint); |
| assertEquals(attributes.mtu, attr.mtu); |
| assertEquals(attributes2.dnsAddresses, attr.dnsAddresses); |
| latch.countDown(); |
| }))); |
| |
| doLatched("Did not complete retrieving attributes 3", latch -> |
| mService.retrieveNetworkAttributes(l2Key + "nonexistent", |
| onNetworkAttributesRetrieved( |
| (status, key, attr) -> { |
| assertTrue("Retrieve network attributes not successful : " |
| + status.resultCode, status.isSuccess()); |
| assertEquals(l2Key + "nonexistent", key); |
| assertNull("Retrieved data not stored", attr); |
| latch.countDown(); |
| } |
| ))); |
| |
| // Verify that this test does not miss any new field added later. |
| // If any field is added to NetworkAttributes it must be tested here for storing |
| // and retrieving. |
| assertEquals(4, Arrays.stream(NetworkAttributes.class.getDeclaredFields()) |
| .filter(f -> !Modifier.isStatic(f.getModifiers())).count()); |
| } |
| |
| @Test |
| public void testInvalidAttributes() { |
| doLatched("Did not complete storing bad attributes", latch -> |
| mService.storeNetworkAttributes("key", null, onStatus(status -> { |
| assertFalse("Success storing on a null key", |
| status.isSuccess()); |
| assertEquals(Status.ERROR_ILLEGAL_ARGUMENT, status.resultCode); |
| latch.countDown(); |
| }))); |
| |
| final NetworkAttributes na = new NetworkAttributes.Builder().setMtu(2).build(); |
| doLatched("Did not complete storing bad attributes", latch -> |
| mService.storeNetworkAttributes(null, na.toParcelable(), onStatus(status -> { |
| assertFalse("Success storing null attributes on a null key", |
| status.isSuccess()); |
| assertEquals(Status.ERROR_ILLEGAL_ARGUMENT, status.resultCode); |
| latch.countDown(); |
| }))); |
| |
| doLatched("Did not complete storing bad attributes", latch -> |
| mService.storeNetworkAttributes(null, null, onStatus(status -> { |
| assertFalse("Success storing null attributes on a null key", |
| status.isSuccess()); |
| assertEquals(Status.ERROR_ILLEGAL_ARGUMENT, status.resultCode); |
| latch.countDown(); |
| }))); |
| |
| doLatched("Did not complete retrieving bad attributes", latch -> |
| mService.retrieveNetworkAttributes(null, onNetworkAttributesRetrieved( |
| (status, key, attr) -> { |
| assertFalse("Success retrieving attributes for a null key", |
| status.isSuccess()); |
| assertEquals(Status.ERROR_ILLEGAL_ARGUMENT, status.resultCode); |
| assertNull(key); |
| assertNull(attr); |
| latch.countDown(); |
| }))); |
| } |
| |
| @Test |
| public void testPrivateData() { |
| final Blob b = new Blob(); |
| b.data = new byte[] { -3, 6, 8, -9, 12, -128, 0, 89, 112, 91, -34 }; |
| final String l2Key = FAKE_KEYS[0]; |
| doLatched("Did not complete storing private data", latch -> |
| mService.storeBlob(l2Key, TEST_CLIENT_ID, TEST_DATA_NAME, b, |
| onStatus(status -> { |
| assertTrue("Store status not successful : " + status.resultCode, |
| status.isSuccess()); |
| latch.countDown(); |
| }))); |
| |
| doLatched("Did not complete retrieving private data", latch -> |
| mService.retrieveBlob(l2Key, TEST_CLIENT_ID, TEST_DATA_NAME, onBlobRetrieved( |
| (status, key, name, data) -> { |
| assertTrue("Retrieve blob status not successful : " + status.resultCode, |
| status.isSuccess()); |
| assertEquals(l2Key, key); |
| assertEquals(name, TEST_DATA_NAME); |
| Arrays.equals(b.data, data); |
| latch.countDown(); |
| }))); |
| |
| // Most puzzling error message ever |
| doLatched("Did not complete retrieving nothing", latch -> |
| mService.retrieveBlob(l2Key, TEST_CLIENT_ID, TEST_DATA_NAME + "2", onBlobRetrieved( |
| (status, key, name, data) -> { |
| assertTrue("Retrieve blob status not successful : " + status.resultCode, |
| status.isSuccess()); |
| assertEquals(l2Key, key); |
| assertEquals(name, TEST_DATA_NAME + "2"); |
| assertNull(data); |
| latch.countDown(); |
| }))); |
| } |
| |
| @Test |
| public void testFindL2Key() throws UnknownHostException { |
| final NetworkAttributes.Builder na = new NetworkAttributes.Builder(); |
| na.setGroupHint("hint0"); |
| storeAttributes(FAKE_KEYS[0], na.build()); |
| |
| na.setDnsAddresses(Arrays.asList( |
| new InetAddress[] {Inet6Address.getByName("8D56:9AF1::08EE:20F1")})); |
| na.setMtu(219); |
| storeAttributes(FAKE_KEYS[1], na.build()); |
| na.setMtu(null); |
| na.setAssignedV4Address((Inet4Address) Inet4Address.getByName("1.2.3.4")); |
| na.setDnsAddresses(Arrays.asList( |
| new InetAddress[] {Inet6Address.getByName("0A1C:2E40:480A::1CA6")})); |
| na.setGroupHint("hint1"); |
| storeAttributes(FAKE_KEYS[2], na.build()); |
| na.setMtu(219); |
| storeAttributes(FAKE_KEYS[3], na.build()); |
| na.setMtu(240); |
| storeAttributes(FAKE_KEYS[4], na.build()); |
| na.setAssignedV4Address((Inet4Address) Inet4Address.getByName("5.6.7.8")); |
| storeAttributes(FAKE_KEYS[5], na.build()); |
| |
| // Matches key 5 exactly |
| doLatched("Did not finish finding L2Key", latch -> |
| mService.findL2Key(na.build().toParcelable(), onL2KeyResponse((status, key) -> { |
| assertTrue("Retrieve network sameness not successful : " + status.resultCode, |
| status.isSuccess()); |
| assertEquals(FAKE_KEYS[5], key); |
| latch.countDown(); |
| }))); |
| |
| // MTU matches key 4 but v4 address matches key 5. The latter is stronger. |
| na.setMtu(240); |
| doLatched("Did not finish finding L2Key", latch -> |
| mService.findL2Key(na.build().toParcelable(), onL2KeyResponse((status, key) -> { |
| assertTrue("Retrieve network sameness not successful : " + status.resultCode, |
| status.isSuccess()); |
| assertEquals(FAKE_KEYS[5], key); |
| latch.countDown(); |
| }))); |
| |
| // Closest to key 3 (indeed, identical) |
| na.setAssignedV4Address((Inet4Address) Inet4Address.getByName("1.2.3.4")); |
| na.setMtu(219); |
| doLatched("Did not finish finding L2Key", latch -> |
| mService.findL2Key(na.build().toParcelable(), onL2KeyResponse((status, key) -> { |
| assertTrue("Retrieve network sameness not successful : " + status.resultCode, |
| status.isSuccess()); |
| assertEquals(FAKE_KEYS[3], key); |
| latch.countDown(); |
| }))); |
| |
| // Group hint alone must not be strong enough to override the rest |
| na.setGroupHint("hint0"); |
| doLatched("Did not finish finding L2Key", latch -> |
| mService.findL2Key(na.build().toParcelable(), onL2KeyResponse((status, key) -> { |
| assertTrue("Retrieve network sameness not successful : " + status.resultCode, |
| status.isSuccess()); |
| assertEquals(FAKE_KEYS[3], key); |
| latch.countDown(); |
| }))); |
| |
| // Still closest to key 3, though confidence is lower |
| na.setGroupHint("hint1"); |
| na.setDnsAddresses(null); |
| doLatched("Did not finish finding L2Key", latch -> |
| mService.findL2Key(na.build().toParcelable(), onL2KeyResponse((status, key) -> { |
| assertTrue("Retrieve network sameness not successful : " + status.resultCode, |
| status.isSuccess()); |
| assertEquals(FAKE_KEYS[3], key); |
| latch.countDown(); |
| }))); |
| |
| // But changing the MTU makes this closer to key 4 |
| na.setMtu(240); |
| doLatched("Did not finish finding L2Key", latch -> |
| mService.findL2Key(na.build().toParcelable(), onL2KeyResponse((status, key) -> { |
| assertTrue("Retrieve network sameness not successful : " + status.resultCode, |
| status.isSuccess()); |
| assertEquals(FAKE_KEYS[4], key); |
| latch.countDown(); |
| }))); |
| |
| // MTU alone not strong enough to make this group-close |
| na.setGroupHint(null); |
| na.setDnsAddresses(null); |
| na.setAssignedV4Address(null); |
| doLatched("Did not finish finding L2Key", latch -> |
| mService.findL2Key(na.build().toParcelable(), onL2KeyResponse((status, key) -> { |
| assertTrue("Retrieve network sameness not successful : " + status.resultCode, |
| status.isSuccess()); |
| assertNull(key); |
| latch.countDown(); |
| }))); |
| } |
| |
| private void assertNetworksSameness(final String key1, final String key2, final int sameness) { |
| doLatched("Did not finish evaluating sameness", latch -> |
| mService.isSameNetwork(key1, key2, onSameResponse((status, answer) -> { |
| assertTrue("Retrieve network sameness not successful : " + status.resultCode, |
| status.isSuccess()); |
| assertEquals(sameness, answer.getNetworkSameness()); |
| latch.countDown(); |
| }))); |
| } |
| |
| @Test |
| public void testIsSameNetwork() throws UnknownHostException { |
| final NetworkAttributes.Builder na = new NetworkAttributes.Builder(); |
| na.setAssignedV4Address((Inet4Address) Inet4Address.getByName("1.2.3.4")); |
| na.setGroupHint("hint1"); |
| na.setMtu(219); |
| na.setDnsAddresses(Arrays.asList(Inet6Address.getByName("0A1C:2E40:480A::1CA6"))); |
| |
| storeAttributes(FAKE_KEYS[0], na.build()); |
| // 0 and 1 have identical attributes |
| storeAttributes(FAKE_KEYS[1], na.build()); |
| |
| // Hopefully only the MTU being different still means it's the same network |
| na.setMtu(200); |
| storeAttributes(FAKE_KEYS[2], na.build()); |
| |
| // Hopefully different MTU, assigned V4 address and grouphint make a different network, |
| // even with identical DNS addresses |
| na.setAssignedV4Address(null); |
| na.setGroupHint("hint2"); |
| storeAttributes(FAKE_KEYS[3], na.build()); |
| |
| assertNetworksSameness(FAKE_KEYS[0], FAKE_KEYS[1], SameL3NetworkResponse.NETWORK_SAME); |
| assertNetworksSameness(FAKE_KEYS[0], FAKE_KEYS[2], SameL3NetworkResponse.NETWORK_SAME); |
| assertNetworksSameness(FAKE_KEYS[1], FAKE_KEYS[2], SameL3NetworkResponse.NETWORK_SAME); |
| assertNetworksSameness(FAKE_KEYS[0], FAKE_KEYS[3], SameL3NetworkResponse.NETWORK_DIFFERENT); |
| assertNetworksSameness(FAKE_KEYS[0], "neverInsertedKey", |
| SameL3NetworkResponse.NETWORK_NEVER_CONNECTED); |
| |
| doLatched("Did not finish evaluating sameness", latch -> |
| mService.isSameNetwork(null, null, onSameResponse((status, answer) -> { |
| assertFalse("Retrieve network sameness suspiciously successful : " |
| + status.resultCode, status.isSuccess()); |
| assertEquals(Status.ERROR_ILLEGAL_ARGUMENT, status.resultCode); |
| assertNull(answer); |
| latch.countDown(); |
| }))); |
| } |
| } |