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

Commit 82e81af8 authored by Sunny Shao's avatar Sunny Shao
Browse files

Clean FooterPreferenceMixin and FooterPreferenceMixinCompat 

Fixes: 124129485
Test: make RunSettingsLibRoboTests
Change-Id: Id0940329bd0c20e32f2cec3b0b05cc4e98357944
parent 2292c5d7

packages/SettingsLib/src/com/android/settingslib/widget/FooterPreferenceMixin.java

deleted100644 → 0
+0 −78
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2016 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.settingslib.widget;



import android.content.Context;



import androidx.preference.PreferenceFragment;

import androidx.preference.PreferenceScreen;



import com.android.settingslib.core.lifecycle.Lifecycle;

import com.android.settingslib.core.lifecycle.LifecycleObserver;

import com.android.settingslib.core.lifecycle.events.SetPreferenceScreen;



/**

 * Framework mixin is deprecated, use the compat version instead.

 *

 * @deprecated

 */

@Deprecated

public class FooterPreferenceMixin implements LifecycleObserver, SetPreferenceScreen {



    private final PreferenceFragment mFragment;

    private FooterPreference mFooterPreference;



    public FooterPreferenceMixin(PreferenceFragment fragment, Lifecycle lifecycle) {

        mFragment = fragment;

        lifecycle.addObserver(this);

    }



    @Override

    public void setPreferenceScreen(PreferenceScreen preferenceScreen) {

        if (mFooterPreference != null) {

            preferenceScreen.addPreference(mFooterPreference);

        }

    }



    /**

     * Creates a new {@link FooterPreference}.

     */

    public FooterPreference createFooterPreference() {

        final PreferenceScreen screen = mFragment.getPreferenceScreen();

        if (mFooterPreference != null && screen != null) {

            screen.removePreference(mFooterPreference);

        }

        mFooterPreference = new FooterPreference(getPrefContext());



        if (screen != null) {

            screen.addPreference(mFooterPreference);

        }

        return mFooterPreference;

    }



    /**

     * Returns an UI context with theme properly set for new Preference objects.

     */

    private Context getPrefContext() {

        return mFragment.getPreferenceManager().getContext();

    }



    public boolean hasFooter() {

        return mFooterPreference != null;

    }

}

packages/SettingsLib/src/com/android/settingslib/widget/FooterPreferenceMixinCompat.java

deleted100644 → 0
+0 −72
Original line number Diff line number Diff line 
/*

 * 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.settingslib.widget;



import android.content.Context;



import androidx.preference.PreferenceFragmentCompat;

import androidx.preference.PreferenceScreen;



import com.android.settingslib.core.lifecycle.Lifecycle;

import com.android.settingslib.core.lifecycle.LifecycleObserver;

import com.android.settingslib.core.lifecycle.events.SetPreferenceScreen;



public class FooterPreferenceMixinCompat implements LifecycleObserver, SetPreferenceScreen {



    private final PreferenceFragmentCompat mFragment;

    private FooterPreference mFooterPreference;



    public FooterPreferenceMixinCompat(PreferenceFragmentCompat fragment, Lifecycle lifecycle) {

        mFragment = fragment;

        lifecycle.addObserver(this);

    }



    @Override

    public void setPreferenceScreen(PreferenceScreen preferenceScreen) {

        if (mFooterPreference != null) {

            preferenceScreen.addPreference(mFooterPreference);

        }

    }



    /**

     * Creates a new {@link FooterPreference}.

     */

    public FooterPreference createFooterPreference() {

        final PreferenceScreen screen = mFragment.getPreferenceScreen();

        if (mFooterPreference != null && screen != null) {

            screen.removePreference(mFooterPreference);

        }

        mFooterPreference = new FooterPreference(getPrefContext());



        if (screen != null) {

            screen.addPreference(mFooterPreference);

        }

        return mFooterPreference;

    }



    /**

     * Returns an UI context with theme properly set for new Preference objects.

     */

    private Context getPrefContext() {

        return mFragment.getPreferenceManager().getContext();

    }



    public boolean hasFooter() {

        return mFooterPreference != null;

    }

}

packages/SettingsLib/tests/robotests/src/com/android/settingslib/widget/FooterPreferenceMixinCompatTest.java

deleted100644 → 0
+0 −100
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2016 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.settingslib.widget;



import static com.google.common.truth.Truth.assertThat;



import static org.mockito.ArgumentMatchers.any;

import static org.mockito.Mockito.mock;

import static org.mockito.Mockito.times;

import static org.mockito.Mockito.verify;

import static org.mockito.Mockito.when;



import androidx.lifecycle.LifecycleOwner;

import androidx.preference.PreferenceFragmentCompat;

import androidx.preference.PreferenceManager;

import androidx.preference.PreferenceScreen;



import com.android.settingslib.core.lifecycle.Lifecycle;



import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.mockito.Mock;

import org.mockito.MockitoAnnotations;

import org.robolectric.RobolectricTestRunner;

import org.robolectric.RuntimeEnvironment;



@RunWith(RobolectricTestRunner.class)

public class FooterPreferenceMixinCompatTest {



    @Mock

    private PreferenceFragmentCompat mFragment;

    @Mock

    private PreferenceScreen mScreen;



    private LifecycleOwner mLifecycleOwner;

    private Lifecycle mLifecycle;

    private FooterPreferenceMixinCompat mMixin;



    @Before

    public void setUp() {

        MockitoAnnotations.initMocks(this);

        mLifecycleOwner = () -> mLifecycle;

        mLifecycle = new Lifecycle(mLifecycleOwner);

        when(mFragment.getPreferenceManager()).thenReturn(mock(PreferenceManager.class));

        when(mFragment.getPreferenceManager().getContext())

                .thenReturn(RuntimeEnvironment.application);

        mMixin = new FooterPreferenceMixinCompat(mFragment, mLifecycle);

    }



    @Test

    public void createFooter_screenNotAvailable_noCrash() {

        assertThat(mMixin.createFooterPreference()).isNotNull();

    }



    @Test

    public void createFooter_screenAvailable_canAttachToScreen() {

        when(mFragment.getPreferenceScreen()).thenReturn(mScreen);



        final FooterPreference preference = mMixin.createFooterPreference();



        assertThat(preference).isNotNull();

        verify(mScreen).addPreference(preference);

    }



    @Test

    public void createFooter_screenAvailableDelayed_canAttachToScreen() {

        final FooterPreference preference = mMixin.createFooterPreference();



        mLifecycle.setPreferenceScreen(mScreen);



        assertThat(preference).isNotNull();

        verify(mScreen).addPreference(preference);

    }



    @Test

    public void createFooterTwice_screenAvailable_replaceOldFooter() {

        when(mFragment.getPreferenceScreen()).thenReturn(mScreen);



        mMixin.createFooterPreference();

        mMixin.createFooterPreference();



        verify(mScreen).removePreference(any(FooterPreference.class));

        verify(mScreen, times(2)).addPreference(any(FooterPreference.class));

    }

}

packages/SettingsLib/tests/robotests/src/com/android/settingslib/widget/FooterPreferenceMixinTest.java

deleted100644 → 0
+0 −101
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2016 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.settingslib.widget;



import static com.google.common.truth.Truth.assertThat;



import static org.mockito.ArgumentMatchers.any;

import static org.mockito.Mockito.mock;

import static org.mockito.Mockito.times;

import static org.mockito.Mockito.verify;

import static org.mockito.Mockito.when;



import androidx.lifecycle.LifecycleOwner;

import androidx.preference.PreferenceFragment;

import androidx.preference.PreferenceManager;

import androidx.preference.PreferenceScreen;



import com.android.settingslib.core.lifecycle.Lifecycle;



import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.mockito.Mock;

import org.mockito.MockitoAnnotations;

import org.robolectric.RobolectricTestRunner;

import org.robolectric.RuntimeEnvironment;



@RunWith(RobolectricTestRunner.class)

public class FooterPreferenceMixinTest {



    @Mock

    private PreferenceFragment mFragment;

    @Mock

    private PreferenceScreen mScreen;



    private LifecycleOwner mLifecycleOwner;

    private Lifecycle mLifecycle;

    private FooterPreferenceMixin mMixin;



    @Before

    public void setUp() {

        MockitoAnnotations.initMocks(this);

        mLifecycleOwner = () -> mLifecycle;

        mLifecycle = new Lifecycle(mLifecycleOwner);

        when(mFragment.getPreferenceManager()).thenReturn(mock(PreferenceManager.class));

        when(mFragment.getPreferenceManager().getContext())

                .thenReturn(RuntimeEnvironment.application);

        mMixin = new FooterPreferenceMixin(mFragment, mLifecycle);

    }



    @Test

    public void createFooter_screenNotAvailable_noCrash() {

        assertThat(mMixin.createFooterPreference()).isNotNull();

    }



    @Test

    public void createFooter_screenAvailable_canAttachToScreen() {

        when(mFragment.getPreferenceScreen()).thenReturn(mScreen);



        final FooterPreference preference = mMixin.createFooterPreference();



        assertThat(preference).isNotNull();

        verify(mScreen).addPreference(preference);

    }



    @Test

    public void createFooter_screenAvailableDelayed_canAttachToScreen() {

        final FooterPreference preference = mMixin.createFooterPreference();



        mLifecycle.setPreferenceScreen(mScreen);



        assertThat(preference).isNotNull();

        verify(mScreen).addPreference(preference);

    }



    @Test

    public void createFooterTwice_screenAvailable_replaceOldFooter() {

        when(mFragment.getPreferenceScreen()).thenReturn(mScreen);



        mMixin.createFooterPreference();

        mMixin.createFooterPreference();



        verify(mScreen).removePreference(any(FooterPreference.class));

        verify(mScreen, times(2)).addPreference(any(FooterPreference.class));

    }



}