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

Commit a3da6c88 authored by Cody Kesting's avatar Cody Kesting
Browse files

Change all 'safemode' references to use 'safe mode'.

Bug: 163433613
Test: atest FrameworksVcnTests
Change-Id: I5daced209e4e6d8d1b87385b3f64660322908fa0
parent f14145e3
Loading
Loading
Loading
Loading
+11 −11
Original line number Original line Diff line number Diff line
@@ -86,12 +86,12 @@ public class Vcn extends Handler {
    private static final int MSG_CMD_TEARDOWN = MSG_CMD_BASE;
    private static final int MSG_CMD_TEARDOWN = MSG_CMD_BASE;


    /**
    /**
     * Causes this VCN to immediately enter Safemode.
     * Causes this VCN to immediately enter safe mode.
     *
     *
     * <p>Upon entering Safemode, the VCN will unregister its RequestListener, tear down all of its
     * <p>Upon entering safe mode, the VCN will unregister its RequestListener, tear down all of its
     * VcnGatewayConnections, and notify VcnManagementService that it is in Safemode.
     * VcnGatewayConnections, and notify VcnManagementService that it is in safe mode.
     */
     */
    private static final int MSG_CMD_ENTER_SAFEMODE = MSG_CMD_BASE + 1;
    private static final int MSG_CMD_ENTER_SAFE_MODE = MSG_CMD_BASE + 1;


    @NonNull private final VcnContext mVcnContext;
    @NonNull private final VcnContext mVcnContext;
    @NonNull private final ParcelUuid mSubscriptionGroup;
    @NonNull private final ParcelUuid mSubscriptionGroup;
@@ -216,8 +216,8 @@ public class Vcn extends Handler {
            case MSG_CMD_TEARDOWN:
            case MSG_CMD_TEARDOWN:
                handleTeardown();
                handleTeardown();
                break;
                break;
            case MSG_CMD_ENTER_SAFEMODE:
            case MSG_CMD_ENTER_SAFE_MODE:
                handleEnterSafemode();
                handleEnterSafeMode();
                break;
                break;
            default:
            default:
                Slog.wtf(getLogTag(), "Unknown msg.what: " + msg.what);
                Slog.wtf(getLogTag(), "Unknown msg.what: " + msg.what);
@@ -243,7 +243,7 @@ public class Vcn extends Handler {
        mIsActive.set(false);
        mIsActive.set(false);
    }
    }


    private void handleEnterSafemode() {
    private void handleEnterSafeMode() {
        handleTeardown();
        handleTeardown();


        mVcnSafeModeCallback.onEnteredSafeMode();
        mVcnSafeModeCallback.onEnteredSafeMode();
@@ -335,14 +335,14 @@ public class Vcn extends Handler {
    /** Callback used for passing status signals from a VcnGatewayConnection to its managing Vcn. */
    /** Callback used for passing status signals from a VcnGatewayConnection to its managing Vcn. */
    @VisibleForTesting(visibility = Visibility.PACKAGE)
    @VisibleForTesting(visibility = Visibility.PACKAGE)
    public interface VcnGatewayStatusCallback {
    public interface VcnGatewayStatusCallback {
        /** Called by a VcnGatewayConnection to indicate that it has entered Safemode. */
        /** Called by a VcnGatewayConnection to indicate that it has entered safe mode. */
        void onEnteredSafemode();
        void onEnteredSafeMode();
    }
    }


    private class VcnGatewayStatusCallbackImpl implements VcnGatewayStatusCallback {
    private class VcnGatewayStatusCallbackImpl implements VcnGatewayStatusCallback {
        @Override
        @Override
        public void onEnteredSafemode() {
        public void onEnteredSafeMode() {
            sendMessage(obtainMessage(MSG_CMD_ENTER_SAFEMODE));
            sendMessage(obtainMessage(MSG_CMD_ENTER_SAFE_MODE));
        }
        }
    }
    }


+31 −31
Original line number Original line Diff line number Diff line
@@ -418,13 +418,13 @@ public class VcnGatewayConnection extends StateMachine {
    private static final int EVENT_SUBSCRIPTIONS_CHANGED = 9;
    private static final int EVENT_SUBSCRIPTIONS_CHANGED = 9;


    /**
    /**
     * Sent when this VcnGatewayConnection has entered Safemode.
     * Sent when this VcnGatewayConnection has entered safe mode.
     *
     *
     * <p>A VcnGatewayConnection enters Safemode when it takes over {@link
     * <p>A VcnGatewayConnection enters safe mode when it takes over {@link
     * #SAFEMODE_TIMEOUT_SECONDS} to enter {@link ConnectedState}.
     * #SAFEMODE_TIMEOUT_SECONDS} to enter {@link ConnectedState}.
     *
     *
     * <p>When a VcnGatewayConnection enters safe mode, it will fire {@link
     * <p>When a VcnGatewayConnection enters safe mode, it will fire {@link
     * VcnGatewayStatusCallback#onEnteredSafemode()} to notify its Vcn. The Vcn will then shut down
     * VcnGatewayStatusCallback#onEnteredSafeMode()} to notify its Vcn. The Vcn will then shut down
     * its VcnGatewayConnectin(s).
     * its VcnGatewayConnectin(s).
     *
     *
     * <p>Relevant in DisconnectingState, ConnectingState, ConnectedState (if the Vcn Network is not
     * <p>Relevant in DisconnectingState, ConnectingState, ConnectedState (if the Vcn Network is not
@@ -432,7 +432,7 @@ public class VcnGatewayConnection extends StateMachine {
     *
     *
     * @param arg1 The "all" token; this signal is always honored.
     * @param arg1 The "all" token; this signal is always honored.
     */
     */
    private static final int EVENT_SAFEMODE_TIMEOUT_EXCEEDED = 10;
    private static final int EVENT_SAFE_MODE_TIMEOUT_EXCEEDED = 10;


    @VisibleForTesting(visibility = Visibility.PRIVATE)
    @VisibleForTesting(visibility = Visibility.PRIVATE)
    @NonNull
    @NonNull
@@ -551,7 +551,7 @@ public class VcnGatewayConnection extends StateMachine {
    @Nullable private WakeupMessage mTeardownTimeoutAlarm;
    @Nullable private WakeupMessage mTeardownTimeoutAlarm;
    @Nullable private WakeupMessage mDisconnectRequestAlarm;
    @Nullable private WakeupMessage mDisconnectRequestAlarm;
    @Nullable private WakeupMessage mRetryTimeoutAlarm;
    @Nullable private WakeupMessage mRetryTimeoutAlarm;
    @Nullable private WakeupMessage mSafemodeTimeoutAlarm;
    @Nullable private WakeupMessage mSafeModeTimeoutAlarm;


    public VcnGatewayConnection(
    public VcnGatewayConnection(
            @NonNull VcnContext vcnContext,
            @NonNull VcnContext vcnContext,
@@ -638,7 +638,7 @@ public class VcnGatewayConnection extends StateMachine {
        cancelTeardownTimeoutAlarm();
        cancelTeardownTimeoutAlarm();
        cancelDisconnectRequestAlarm();
        cancelDisconnectRequestAlarm();
        cancelRetryTimeoutAlarm();
        cancelRetryTimeoutAlarm();
        cancelSafemodeAlarm();
        cancelSafeModeAlarm();


        mUnderlyingNetworkTracker.teardown();
        mUnderlyingNetworkTracker.teardown();
    }
    }
@@ -928,27 +928,27 @@ public class VcnGatewayConnection extends StateMachine {
    }
    }


    @VisibleForTesting(visibility = Visibility.PRIVATE)
    @VisibleForTesting(visibility = Visibility.PRIVATE)
    void setSafemodeAlarm() {
    void setSafeModeAlarm() {
        // Only schedule a NEW alarm if none is already set.
        // Only schedule a NEW alarm if none is already set.
        if (mSafemodeTimeoutAlarm != null) {
        if (mSafeModeTimeoutAlarm != null) {
            return;
            return;
        }
        }


        final Message delayedMessage = obtainMessage(EVENT_SAFEMODE_TIMEOUT_EXCEEDED, TOKEN_ALL);
        final Message delayedMessage = obtainMessage(EVENT_SAFE_MODE_TIMEOUT_EXCEEDED, TOKEN_ALL);
        mSafemodeTimeoutAlarm =
        mSafeModeTimeoutAlarm =
                createScheduledAlarm(
                createScheduledAlarm(
                        SAFEMODE_TIMEOUT_ALARM,
                        SAFEMODE_TIMEOUT_ALARM,
                        delayedMessage,
                        delayedMessage,
                        TimeUnit.SECONDS.toMillis(SAFEMODE_TIMEOUT_SECONDS));
                        TimeUnit.SECONDS.toMillis(SAFEMODE_TIMEOUT_SECONDS));
    }
    }


    private void cancelSafemodeAlarm() {
    private void cancelSafeModeAlarm() {
        if (mSafemodeTimeoutAlarm != null) {
        if (mSafeModeTimeoutAlarm != null) {
            mSafemodeTimeoutAlarm.cancel();
            mSafeModeTimeoutAlarm.cancel();
            mSafemodeTimeoutAlarm = null;
            mSafeModeTimeoutAlarm = null;
        }
        }


        removeEqualMessages(EVENT_SAFEMODE_TIMEOUT_EXCEEDED);
        removeEqualMessages(EVENT_SAFE_MODE_TIMEOUT_EXCEEDED);
    }
    }


    private void sessionLost(int token, @Nullable Exception exception) {
    private void sessionLost(int token, @Nullable Exception exception) {
@@ -1125,7 +1125,7 @@ public class VcnGatewayConnection extends StateMachine {
                Slog.wtf(TAG, "Active IKE Session or NetworkAgent in DisconnectedState");
                Slog.wtf(TAG, "Active IKE Session or NetworkAgent in DisconnectedState");
            }
            }


            cancelSafemodeAlarm();
            cancelSafeModeAlarm();
        }
        }


        @Override
        @Override
@@ -1153,7 +1153,7 @@ public class VcnGatewayConnection extends StateMachine {
        @Override
        @Override
        protected void exitState() {
        protected void exitState() {
            // Safe to blindly set up, as it is cancelled and cleared on entering this state
            // Safe to blindly set up, as it is cancelled and cleared on entering this state
            setSafemodeAlarm();
            setSafeModeAlarm();
        }
        }
    }
    }


@@ -1245,9 +1245,9 @@ public class VcnGatewayConnection extends StateMachine {
                        transitionTo(mDisconnectedState);
                        transitionTo(mDisconnectedState);
                    }
                    }
                    break;
                    break;
                case EVENT_SAFEMODE_TIMEOUT_EXCEEDED:
                case EVENT_SAFE_MODE_TIMEOUT_EXCEEDED:
                    mGatewayStatusCallback.onEnteredSafemode();
                    mGatewayStatusCallback.onEnteredSafeMode();
                    mSafemodeTimeoutAlarm = null;
                    mSafeModeTimeoutAlarm = null;
                    break;
                    break;
                default:
                default:
                    logUnhandledMessage(msg);
                    logUnhandledMessage(msg);
@@ -1331,9 +1331,9 @@ public class VcnGatewayConnection extends StateMachine {
                case EVENT_DISCONNECT_REQUESTED:
                case EVENT_DISCONNECT_REQUESTED:
                    handleDisconnectRequested(((EventDisconnectRequestedInfo) msg.obj).reason);
                    handleDisconnectRequested(((EventDisconnectRequestedInfo) msg.obj).reason);
                    break;
                    break;
                case EVENT_SAFEMODE_TIMEOUT_EXCEEDED:
                case EVENT_SAFE_MODE_TIMEOUT_EXCEEDED:
                    mGatewayStatusCallback.onEnteredSafemode();
                    mGatewayStatusCallback.onEnteredSafeMode();
                    mSafemodeTimeoutAlarm = null;
                    mSafeModeTimeoutAlarm = null;
                    break;
                    break;
                default:
                default:
                    logUnhandledMessage(msg);
                    logUnhandledMessage(msg);
@@ -1399,7 +1399,7 @@ public class VcnGatewayConnection extends StateMachine {


            // Validated connection, clear failed attempt counter
            // Validated connection, clear failed attempt counter
            mFailedAttempts = 0;
            mFailedAttempts = 0;
            cancelSafemodeAlarm();
            cancelSafeModeAlarm();
        }
        }


        protected void applyTransform(
        protected void applyTransform(
@@ -1517,9 +1517,9 @@ public class VcnGatewayConnection extends StateMachine {
                case EVENT_DISCONNECT_REQUESTED:
                case EVENT_DISCONNECT_REQUESTED:
                    handleDisconnectRequested(((EventDisconnectRequestedInfo) msg.obj).reason);
                    handleDisconnectRequested(((EventDisconnectRequestedInfo) msg.obj).reason);
                    break;
                    break;
                case EVENT_SAFEMODE_TIMEOUT_EXCEEDED:
                case EVENT_SAFE_MODE_TIMEOUT_EXCEEDED:
                    mGatewayStatusCallback.onEnteredSafemode();
                    mGatewayStatusCallback.onEnteredSafeMode();
                    mSafemodeTimeoutAlarm = null;
                    mSafeModeTimeoutAlarm = null;
                    break;
                    break;
                default:
                default:
                    logUnhandledMessage(msg);
                    logUnhandledMessage(msg);
@@ -1574,7 +1574,7 @@ public class VcnGatewayConnection extends StateMachine {
        protected void exitState() {
        protected void exitState() {
            // Attempt to set the safe mode alarm - this requires the Vcn Network being validated
            // Attempt to set the safe mode alarm - this requires the Vcn Network being validated
            // while in ConnectedState (which cancels the previous alarm)
            // while in ConnectedState (which cancels the previous alarm)
            setSafemodeAlarm();
            setSafeModeAlarm();
        }
        }
    }
    }


@@ -1622,9 +1622,9 @@ public class VcnGatewayConnection extends StateMachine {
                case EVENT_DISCONNECT_REQUESTED:
                case EVENT_DISCONNECT_REQUESTED:
                    handleDisconnectRequested(((EventDisconnectRequestedInfo) msg.obj).reason);
                    handleDisconnectRequested(((EventDisconnectRequestedInfo) msg.obj).reason);
                    break;
                    break;
                case EVENT_SAFEMODE_TIMEOUT_EXCEEDED:
                case EVENT_SAFE_MODE_TIMEOUT_EXCEEDED:
                    mGatewayStatusCallback.onEnteredSafemode();
                    mGatewayStatusCallback.onEnteredSafeMode();
                    mSafemodeTimeoutAlarm = null;
                    mSafeModeTimeoutAlarm = null;
                    break;
                    break;
                default:
                default:
                    logUnhandledMessage(msg);
                    logUnhandledMessage(msg);
+11 −11
Original line number Original line Diff line number Diff line
@@ -75,8 +75,8 @@ public class VcnGatewayConnectionConnectedStateTest extends VcnGatewayConnection
    }
    }


    @Test
    @Test
    public void testEnterStateDoesNotCancelSafemodeAlarm() {
    public void testEnterStateDoesNotCancelSafeModeAlarm() {
        verifySafemodeTimeoutAlarmAndGetCallback(false /* expectCanceled */);
        verifySafeModeTimeoutAlarmAndGetCallback(false /* expectCanceled */);
    }
    }


    @Test
    @Test
@@ -130,7 +130,7 @@ public class VcnGatewayConnectionConnectedStateTest extends VcnGatewayConnection
    @Test
    @Test
    public void testChildOpenedRegistersNetwork() throws Exception {
    public void testChildOpenedRegistersNetwork() throws Exception {
        // Verify scheduled but not canceled when entering ConnectedState
        // Verify scheduled but not canceled when entering ConnectedState
        verifySafemodeTimeoutAlarmAndGetCallback(false /* expectCanceled */);
        verifySafeModeTimeoutAlarmAndGetCallback(false /* expectCanceled */);


        final VcnChildSessionConfiguration mMockChildSessionConfig =
        final VcnChildSessionConfiguration mMockChildSessionConfig =
                mock(VcnChildSessionConfiguration.class);
                mock(VcnChildSessionConfiguration.class);
@@ -174,17 +174,17 @@ public class VcnGatewayConnectionConnectedStateTest extends VcnGatewayConnection
            assertTrue(nc.hasCapability(cap));
            assertTrue(nc.hasCapability(cap));
        }
        }


        // Now that Vcn Network is up, notify it as validated and verify the Safemode alarm is
        // Now that Vcn Network is up, notify it as validated and verify the SafeMode alarm is
        // canceled
        // canceled
        mGatewayConnection.mNetworkAgent.onValidationStatus(
        mGatewayConnection.mNetworkAgent.onValidationStatus(
                NetworkAgent.VALIDATION_STATUS_VALID, null /* redirectUri */);
                NetworkAgent.VALIDATION_STATUS_VALID, null /* redirectUri */);
        verify(mSafemodeTimeoutAlarm).cancel();
        verify(mSafeModeTimeoutAlarm).cancel();
    }
    }


    @Test
    @Test
    public void testChildSessionClosedTriggersDisconnect() throws Exception {
    public void testChildSessionClosedTriggersDisconnect() throws Exception {
        // Verify scheduled but not canceled when entering ConnectedState
        // Verify scheduled but not canceled when entering ConnectedState
        verifySafemodeTimeoutAlarmAndGetCallback(false /* expectCanceled */);
        verifySafeModeTimeoutAlarmAndGetCallback(false /* expectCanceled */);


        getChildSessionCallback().onClosed();
        getChildSessionCallback().onClosed();
        mTestLooper.dispatchAll();
        mTestLooper.dispatchAll();
@@ -192,14 +192,14 @@ public class VcnGatewayConnectionConnectedStateTest extends VcnGatewayConnection
        assertEquals(mGatewayConnection.mDisconnectingState, mGatewayConnection.getCurrentState());
        assertEquals(mGatewayConnection.mDisconnectingState, mGatewayConnection.getCurrentState());
        verifyTeardownTimeoutAlarmAndGetCallback(false /* expectCanceled */);
        verifyTeardownTimeoutAlarmAndGetCallback(false /* expectCanceled */);


        // Since network never validated, verify mSafemodeTimeoutAlarm not canceled
        // Since network never validated, verify mSafeModeTimeoutAlarm not canceled
        verifyNoMoreInteractions(mSafemodeTimeoutAlarm);
        verifyNoMoreInteractions(mSafeModeTimeoutAlarm);
    }
    }


    @Test
    @Test
    public void testIkeSessionClosedTriggersDisconnect() throws Exception {
    public void testIkeSessionClosedTriggersDisconnect() throws Exception {
        // Verify scheduled but not canceled when entering ConnectedState
        // Verify scheduled but not canceled when entering ConnectedState
        verifySafemodeTimeoutAlarmAndGetCallback(false /* expectCanceled */);
        verifySafeModeTimeoutAlarmAndGetCallback(false /* expectCanceled */);


        getIkeSessionCallback().onClosed();
        getIkeSessionCallback().onClosed();
        mTestLooper.dispatchAll();
        mTestLooper.dispatchAll();
@@ -207,7 +207,7 @@ public class VcnGatewayConnectionConnectedStateTest extends VcnGatewayConnection
        assertEquals(mGatewayConnection.mRetryTimeoutState, mGatewayConnection.getCurrentState());
        assertEquals(mGatewayConnection.mRetryTimeoutState, mGatewayConnection.getCurrentState());
        verify(mIkeSession).close();
        verify(mIkeSession).close();


        // Since network never validated, verify mSafemodeTimeoutAlarm not canceled
        // Since network never validated, verify mSafeModeTimeoutAlarm not canceled
        verifyNoMoreInteractions(mSafemodeTimeoutAlarm);
        verifyNoMoreInteractions(mSafeModeTimeoutAlarm);
    }
    }
}
}
+2 −2
Original line number Original line Diff line number Diff line
@@ -108,7 +108,7 @@ public class VcnGatewayConnectionConnectingStateTest extends VcnGatewayConnectio
    }
    }


    @Test
    @Test
    public void testSafemodeTimeoutNotifiesCallback() {
    public void testSafeModeTimeoutNotifiesCallback() {
        verifySafemodeTimeoutNotifiesCallback(mGatewayConnection.mConnectingState);
        verifySafeModeTimeoutNotifiesCallback(mGatewayConnection.mConnectingState);
    }
    }
}
}
+2 −2
Original line number Original line Diff line number Diff line
@@ -79,7 +79,7 @@ public class VcnGatewayConnectionDisconnectedStateTest extends VcnGatewayConnect
        mTestLooper.dispatchAll();
        mTestLooper.dispatchAll();


        assertEquals(mGatewayConnection.mConnectingState, mGatewayConnection.getCurrentState());
        assertEquals(mGatewayConnection.mConnectingState, mGatewayConnection.getCurrentState());
        verifySafemodeTimeoutAlarmAndGetCallback(false /* expectCanceled */);
        verifySafeModeTimeoutAlarmAndGetCallback(false /* expectCanceled */);
    }
    }


    @Test
    @Test
@@ -100,6 +100,6 @@ public class VcnGatewayConnectionDisconnectedStateTest extends VcnGatewayConnect


        assertNull(mGatewayConnection.getCurrentState());
        assertNull(mGatewayConnection.getCurrentState());
        verify(mIpSecSvc).deleteTunnelInterface(eq(TEST_IPSEC_TUNNEL_RESOURCE_ID), any());
        verify(mIpSecSvc).deleteTunnelInterface(eq(TEST_IPSEC_TUNNEL_RESOURCE_ID), any());
        verifySafemodeTimeoutAlarmAndGetCallback(true /* expectCanceled */);
        verifySafeModeTimeoutAlarmAndGetCallback(true /* expectCanceled */);
    }
    }
}
}
Loading