Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 038f3cd0 authored by Lorenzo Colitti's avatar Lorenzo Colitti
Browse files

Add a ClearingIpAddressesState. 

This simplifies StartedState a bit, and should have no impact on
behaviour.

Test: atest IpClientIntegrationTest
Change-Id: Ie897307925a9af571a622c823d4c641956e607f3
parent 1e868b32

src/android/net/ip/IpClient.java

+53 −31
Original line number Original line Diff line number Diff line
@@ -310,7 +310,7 @@ public class IpClient extends StateMachine { 
    // Internal commands to use instead of trying to call transitionTo() inside

    // Internal commands to use instead of trying to call transitionTo() inside

    // a given State's enter() method. Calling transitionTo() from enter/exit

    // a given State's enter() method. Calling transitionTo() from enter/exit

    // encounters a Log.wtf() that can cause trouble on eng builds.

    // encounters a Log.wtf() that can cause trouble on eng builds.

    private static final int CMD_JUMP_STARTED_TO_RUNNING          = 100;

    private static final int CMD_ADDRESSES_CLEARED                = 100;

    private static final int CMD_JUMP_RUNNING_TO_STOPPING         = 101;

    private static final int CMD_JUMP_RUNNING_TO_STOPPING         = 101;

    private static final int CMD_JUMP_STOPPING_TO_STOPPED         = 102;

    private static final int CMD_JUMP_STOPPING_TO_STOPPED         = 102;
@@ -342,6 +342,7 @@ public class IpClient extends StateMachine { 




    private final State mStoppedState = new StoppedState();

    private final State mStoppedState = new StoppedState();

    private final State mStoppingState = new StoppingState();

    private final State mStoppingState = new StoppingState();

    private final State mClearingIpAddressesState = new ClearingIpAddressesState();

    private final State mStartedState = new StartedState();

    private final State mStartedState = new StartedState();

    private final State mRunningState = new RunningState();

    private final State mRunningState = new RunningState();
@@ -621,6 +622,7 @@ public class IpClient extends StateMachine { 
        // CHECKSTYLE:OFF IndentationCheck

        // CHECKSTYLE:OFF IndentationCheck

        addState(mStoppedState);

        addState(mStoppedState);

        addState(mStartedState);

        addState(mStartedState);

            addState(mClearingIpAddressesState, mStartedState);

            addState(mRunningState, mStartedState);

            addState(mRunningState, mStartedState);

        addState(mStoppingState);

        addState(mStoppingState);

        // CHECKSTYLE:ON IndentationCheck

        // CHECKSTYLE:ON IndentationCheck
@@ -1355,7 +1357,7 @@ public class IpClient extends StateMachine { 




                case CMD_START:

                case CMD_START:

                    mConfiguration = (android.net.shared.ProvisioningConfiguration) msg.obj;

                    mConfiguration = (android.net.shared.ProvisioningConfiguration) msg.obj;

                    transitionTo(mStartedState);

                    transitionTo(mClearingIpAddressesState);

                    break;

                    break;





                case EVENT_NETLINK_LINKPROPERTIES_CHANGED:

                case EVENT_NETLINK_LINKPROPERTIES_CHANGED:
@@ -1437,18 +1439,11 @@ public class IpClient extends StateMachine { 
        }

        }

    }

    }





    class StartedState extends State {

    class ClearingIpAddressesState extends State {

        @Override

        @Override

        public void enter() {

        public void enter() {

            mStartTimeMillis = SystemClock.elapsedRealtime();

            if (mConfiguration.mProvisioningTimeoutMs > 0) {

                final long alarmTime = SystemClock.elapsedRealtime()

                        + mConfiguration.mProvisioningTimeoutMs;

                mProvisioningTimeoutAlarm.schedule(alarmTime);

            }



            if (readyToProceed()) {

            if (readyToProceed()) {

                deferMessage(obtainMessage(CMD_JUMP_STARTED_TO_RUNNING));

                deferMessage(obtainMessage(CMD_ADDRESSES_CLEARED));

            } else {

            } else {

                // Clear all IPv4 and IPv6 before proceeding to RunningState.

                // Clear all IPv4 and IPv6 before proceeding to RunningState.

                // Clean up any leftover state from an abnormal exit from

                // Clean up any leftover state from an abnormal exit from
@@ -1457,22 +1452,13 @@ public class IpClient extends StateMachine { 
            }

            }

        }

        }





        @Override

        public void exit() {

            mProvisioningTimeoutAlarm.cancel();

        }



        @Override

        @Override

        public boolean processMessage(Message msg) {

        public boolean processMessage(Message msg) {

            switch (msg.what) {

            switch (msg.what) {

                case CMD_JUMP_STARTED_TO_RUNNING:

                case CMD_ADDRESSES_CLEARED:

                    transitionTo(mRunningState);

                    transitionTo(mRunningState);

                    break;

                    break;





                case CMD_STOP:

                    transitionTo(mStoppingState);

                    break;



                case EVENT_NETLINK_LINKPROPERTIES_CHANGED:

                case EVENT_NETLINK_LINKPROPERTIES_CHANGED:

                    handleLinkPropertiesUpdate(NO_CALLBACKS);

                    handleLinkPropertiesUpdate(NO_CALLBACKS);

                    if (readyToProceed()) {

                    if (readyToProceed()) {
@@ -1480,6 +1466,50 @@ public class IpClient extends StateMachine { 
                    }

                    }

                    break;

                    break;





                case CMD_STOP:

                case EVENT_PROVISIONING_TIMEOUT:

                    // Fall through to StartedState.

                    return NOT_HANDLED;



                default:

                    // It's safe to process messages out of order because the

                    // only message that can both

                    //     a) be received at this time and

                    //     b) affect provisioning state

                    // is EVENT_NETLINK_LINKPROPERTIES_CHANGED (handled above).

                    deferMessage(msg);

            }

            return HANDLED;

        }



        private boolean readyToProceed() {

            return (!mLinkProperties.hasIpv4Address() && !mLinkProperties.hasGlobalIpv6Address());

        }

    }



    class StartedState extends State {

        @Override

        public void enter() {

            mStartTimeMillis = SystemClock.elapsedRealtime();

            if (mConfiguration.mProvisioningTimeoutMs > 0) {

                final long alarmTime = SystemClock.elapsedRealtime()

                        + mConfiguration.mProvisioningTimeoutMs;

                mProvisioningTimeoutAlarm.schedule(alarmTime);

            }

        }



        @Override

        public void exit() {

            mProvisioningTimeoutAlarm.cancel();

        }



        @Override

        public boolean processMessage(Message msg) {

            switch (msg.what) {

                case CMD_STOP:

                    transitionTo(mStoppingState);

                    break;



                case CMD_UPDATE_L2KEY_GROUPHINT: {

                case CMD_UPDATE_L2KEY_GROUPHINT: {

                    final Pair<String, String> args = (Pair<String, String>) msg.obj;

                    final Pair<String, String> args = (Pair<String, String>) msg.obj;

                    mL2Key = args.first;

                    mL2Key = args.first;
@@ -1497,22 +1527,14 @@ public class IpClient extends StateMachine { 
                case EVENT_PROVISIONING_TIMEOUT:

                case EVENT_PROVISIONING_TIMEOUT:

                    handleProvisioningFailure();

                    handleProvisioningFailure();

                    break;

                    break;



                default:

                default:

                    // It's safe to process messages out of order because the

                    return NOT_HANDLED;

                    // only message that can both

                    //     a) be received at this time and

                    //     b) affect provisioning state

                    // is EVENT_NETLINK_LINKPROPERTIES_CHANGED (handled above).

                    deferMessage(msg);

            }

            }





            mMsgStateLogger.handled(this, getCurrentState());

            mMsgStateLogger.handled(this, getCurrentState());

            return HANDLED;

            return HANDLED;

        }

        }



        private boolean readyToProceed() {

            return (!mLinkProperties.hasIpv4Address() && !mLinkProperties.hasGlobalIpv6Address());

        }

    }

    }





    class RunningState extends State {

    class RunningState extends State {

tests/integration/src/android/net/ip/IpClientIntegrationTest.java

+47 −1
Original line number Original line Diff line number Diff line
@@ -51,6 +51,7 @@ import static org.junit.Assert.assertEquals; 
import static org.junit.Assert.assertNotNull;

import static org.junit.Assert.assertNotNull;

import static org.junit.Assert.assertTrue;

import static org.junit.Assert.assertTrue;

import static org.mockito.Mockito.any;

import static org.mockito.Mockito.any;

import static org.mockito.Mockito.argThat;

import static org.mockito.Mockito.doAnswer;

import static org.mockito.Mockito.doAnswer;

import static org.mockito.Mockito.doThrow;

import static org.mockito.Mockito.doThrow;

import static org.mockito.Mockito.eq;

import static org.mockito.Mockito.eq;
@@ -919,4 +920,49 @@ public class IpClientIntegrationTest { 




        verify(mCb, timeout(TEST_TIMEOUT_MS)).onProvisioningFailure(captor.capture());

        verify(mCb, timeout(TEST_TIMEOUT_MS)).onProvisioningFailure(captor.capture());

        lp = captor.getValue();

        lp = captor.getValue();

    }}
 
        assertNotNull(lp);

        assertEquals(0, lp.getDnsServers().size());

        reset(mCb);

    }



    @Test

    public void testIpClientClearingIpAddressState() throws Exception {

        final long currentTime = System.currentTimeMillis();

        performDhcpHandshake(true /* isSuccessLease */, TEST_LEASE_DURATION_S,

                true /* isDhcpLeaseCacheEnabled */, false /* isDhcpRapidCommitEnabled */,

                TEST_DEFAULT_MTU);

        assertIpMemoryStoreNetworkAttributes(TEST_LEASE_DURATION_S, currentTime, TEST_DEFAULT_MTU);



        ArgumentCaptor<LinkProperties> captor = ArgumentCaptor.forClass(LinkProperties.class);

        verify(mCb, timeout(TEST_TIMEOUT_MS)).onProvisioningSuccess(captor.capture());

        LinkProperties lp = captor.getValue();

        assertNotNull(lp);

        assertEquals(1, lp.getAddresses().size());

        assertTrue(lp.getAddresses().contains(InetAddress.getByName(CLIENT_ADDR.getHostAddress())));



        // Stop IpClient and expect a final LinkProperties callback with an empty LP.

        mIpc.stop();

        verify(mCb, timeout(TEST_TIMEOUT_MS)).onLinkPropertiesChange(argThat(

                x -> x.getAddresses().size() == 0

                        && x.getRoutes().size() == 0

                        && x.getDnsServers().size() == 0));

        reset(mCb);



        // Pretend that something else (e.g., Tethering) used the interface and left an IP address

        // configured on it. When IpClient starts, it must clear this address before proceeding.

        // TODO: test IPv6 instead, since the DHCP client will remove this address by replacing it

        // with the new address.

        mNetd.interfaceAddAddress(mIfaceName, "192.0.2.99", 26);



        // start IpClient again and should enter Clearing State and wait for the message from kernel

        performDhcpHandshake(true /* isSuccessLease */, TEST_LEASE_DURATION_S,

                true /* isDhcpLeaseCacheEnabled */, false /* isDhcpRapidCommitEnabled */,

                TEST_DEFAULT_MTU);



        verify(mCb, timeout(TEST_TIMEOUT_MS)).onProvisioningSuccess(captor.capture());

        lp = captor.getValue();

        assertNotNull(lp);

        assertEquals(1, lp.getAddresses().size());

        assertTrue(lp.getAddresses().contains(InetAddress.getByName(CLIENT_ADDR.getHostAddress())));

    }

}