src/test/java/org/robolectric/shadows/ViewGroupTest.java

package org.robolectric.shadows;

import android.app.Application;
import android.view.MotionEvent;
import android.view.View;
import android.view.ViewGroup;
import android.view.ViewParent;
import android.view.animation.Animation;
import android.view.animation.Animation.AnimationListener;
import android.view.animation.LayoutAnimationController;
import android.widget.FrameLayout;
import android.widget.LinearLayout;
import android.widget.TextView;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.R;
import org.robolectric.Robolectric;
import org.robolectric.TestRunners;

import java.io.ByteArrayOutputStream;
import java.io.PrintStream;

import static org.fest.assertions.api.Assertions.assertThat;
import static org.junit.Assert.*;
import static org.robolectric.Robolectric.shadowOf;

@RunWith(TestRunners.WithDefaults.class)
public class ViewGroupTest {
    private String defaultLineSeparator;
    private ViewGroup root;
    private View child1;
    private View child2;
    private ViewGroup child3;
    private View child3a;
    private View child3b;
    private Application context;

    @Before
    public void setUp() throws Exception {
        context = Robolectric.application;

        root = new FrameLayout(context);

        child1 = new View(context);
        child2 = new View(context);
        child3 = new FrameLayout(context);
        child3a = new View(context);
        child3b = new View(context);

        root.addView(child1);
        root.addView(child2);
        root.addView(child3);

        child3.addView(child3a);
        child3.addView(child3b);

        defaultLineSeparator = System.getProperty("line.separator");
        System.setProperty("line.separator", "\n");
    }

    @After
    public void tearDown() throws Exception {
        System.setProperty("line.separator", defaultLineSeparator);
    }

    @Test
    public void removeNullView_doesNothing() {
        root.removeView(null);
    }

    @Test
    public void testLayoutAnimationListener() {
        assertThat(root.getLayoutAnimationListener()).isNull();

        AnimationListener animationListener = new AnimationListener() {
            @Override
            public void onAnimationEnd(Animation a) {
            }

            @Override
            public void onAnimationRepeat(Animation a) {
            }

            @Override
            public void onAnimationStart(Animation a) {
            }
        };
        root.setLayoutAnimationListener(animationListener);

        assertThat(root.getLayoutAnimationListener()).isSameAs(animationListener);
    }

    @Test
    public void testLayoutAnimation() {
        assertThat(root.getLayoutAnimation()).isNull();
        LayoutAnimationController layoutAnim = new LayoutAnimationController(context, null);
        root.setLayoutAnimation(layoutAnim);
        assertThat(root.getLayoutAnimation()).isSameAs(layoutAnim);
    }

    @Test
    public void testRemoveChildAt() throws Exception {
        root.removeViewAt(1);

        assertThat(root.getChildCount()).isEqualTo(2);
        assertThat(root.getChildAt(0)).isSameAs(child1);
        assertThat(root.getChildAt(1)).isSameAs((View) child3);

        assertThat(child2.getParent()).isNull();
    }

    @Test
    public void testAddViewAt() throws Exception {
        root.removeAllViews();
        root.addView(child1);
        root.addView(child2);
        root.addView(child3, 1);
        assertThat(root.getChildAt(0)).isSameAs(child1);
        assertThat(root.getChildAt(1)).isSameAs((View) child3);
        assertThat(root.getChildAt(2)).isSameAs(child2);
    }

    @Test
    public void shouldFindViewWithTag() {
        root.removeAllViews();
        child1.setTag("tag1");
        child2.setTag("tag2");
        child3.setTag("tag3");
        root.addView(child1);
        root.addView(child2);
        root.addView(child3, 1);
        assertThat(root.findViewWithTag("tag1")).isSameAs(child1);
        assertThat(root.findViewWithTag("tag2")).isSameAs((View) child2);
        assertThat((ViewGroup) root.findViewWithTag("tag3")).isSameAs(child3);
    }

    @Test
    public void shouldNotFindViewWithTagReturnNull() {
        root.removeAllViews();
        child1.setTag("tag1");
        child2.setTag("tag2");
        child3.setTag("tag3");
        root.addView(child1);
        root.addView(child2);
        root.addView(child3, 1);
        assertThat(root.findViewWithTag("tag21")).isEqualTo(null);
        assertThat((ViewGroup) root.findViewWithTag("tag23")).isEqualTo(null);
    }

    @Test
    public void shouldfindViewWithTagFromCorrectViewGroup() {
        root.removeAllViews();
        child1.setTag("tag1");
        child2.setTag("tag2");
        child3.setTag("tag3");
        root.addView(child1);
        root.addView(child2);
        root.addView(child3);

        child3a.setTag("tag1");
        child3b.setTag("tag2");

        //can find views by tag from root
        assertThat(root.findViewWithTag("tag1")).isSameAs(child1);
        assertThat(root.findViewWithTag("tag2")).isSameAs((View) child2);
        assertThat((ViewGroup) root.findViewWithTag("tag3")).isSameAs(child3);

        //can find views by tag from child3
        assertThat(child3.findViewWithTag("tag1")).isSameAs(child3a);
        assertThat(child3.findViewWithTag("tag2")).isSameAs(child3b);
    }

    @Test
    public void shouldFindViewWithTag_whenViewGroupOverridesGetTag() throws Exception {
        ViewGroup viewGroup = new LinearLayout(Robolectric.application) {
            @Override
            public Object getTag() {
                return "blarg";
            }
        };
        assertThat((ViewGroup) viewGroup.findViewWithTag("blarg")).isSameAs(viewGroup);
    }

    @Test
    public void hasFocus_shouldReturnTrueIfAnyChildHasFocus() throws Exception {
        assertFalse(root.hasFocus());

        child1.requestFocus();
        assertTrue(root.hasFocus());

        child1.clearFocus();
        assertFalse(root.hasFocus());

        child3b.requestFocus();
        assertTrue(root.hasFocus());

        child3b.clearFocus();
        assertFalse(root.hasFocus());

        root.requestFocus();
        assertTrue(root.hasFocus());
    }

    @Test
    public void clearFocus_shouldRecursivelyClearTheFocusOfAllChildren() throws Exception {
        child3a.requestFocus();

        root.clearFocus();

        assertFalse(child3a.hasFocus());
        assertFalse(child3.hasFocus());
        assertFalse(root.hasFocus());

        root.requestFocus();
        root.clearFocus();
        assertFalse(root.hasFocus());
    }

    @Test
    public void dump_shouldDumpStructure() throws Exception {
        child3.setId(R.id.snippet_text);
        child3b.setVisibility(View.GONE);
        TextView textView = new TextView(context);
        textView.setText("Here's some text!");
        textView.setVisibility(View.INVISIBLE);
        child3.addView(textView);

        ByteArrayOutputStream out = new ByteArrayOutputStream();
        shadowOf(root).dump(new PrintStream(out), 0);
        assertEquals("<FrameLayout>\n" +
                "  <View/>\n" +
                "  <View/>\n" +
                "  <FrameLayout id=\"org.robolectric:id/snippet_text\">\n" +
                "    <View/>\n" +
                "    <View visibility=\"GONE\"/>\n" +
                "    <TextView visibility=\"INVISIBLE\" text=\"Here&apos;s some text!\"/>\n" +
                "  </FrameLayout>\n" +
                "</FrameLayout>\n", out.toString());
    }

    @Test
    public void addViewWithLayoutParams_shouldStoreLayoutParams() throws Exception {
        FrameLayout.LayoutParams layoutParams1 = new FrameLayout.LayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT);
        FrameLayout.LayoutParams layoutParams2 = new FrameLayout.LayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT);
        View child1 = new View(Robolectric.application);
        View child2 = new View(Robolectric.application);
        root.addView(child1, layoutParams1);
        root.addView(child2, 1, layoutParams2);
        assertSame(layoutParams1, child1.getLayoutParams());
        assertSame(layoutParams2, child2.getLayoutParams());
    }

//    todo: re-enable this
//    @Test @Config(minSdk = FROYO)
//    public void getChildAt_shouldThrowIndexOutOfBoundsForInvalidIndices() { // 'cause that's what Android does
//        assertThat(root.getChildCount()).isEqualTo(3);
//        assertThrowsExceptionForBadIndex(13);
//        assertThrowsExceptionForBadIndex(3);
//        assertThrowsExceptionForBadIndex(-1);
//    }
//
//    private void assertThrowsExceptionForBadIndex(int index) {
//        try {
//            assertThat(root.getChildAt(index)).isNull();
//            fail("no exception");
//        } catch (IndexOutOfBoundsException ex) {
//            //noinspection UnnecessaryReturnStatement
//            return;
//        } catch (Exception ex) {
//            fail("wrong exception type");
//        }
//    }

    @Test
    public void layoutParams_shouldBeViewGroupLayoutParams() {
        assertThat(child1.getLayoutParams()).isInstanceOf(FrameLayout.LayoutParams.class);
        assertThat(child1.getLayoutParams()).isInstanceOf(ViewGroup.LayoutParams.class);
    }

    @Test
    public void removeView_removesView() throws Exception {
        assertThat(root.getChildCount()).isEqualTo(3);
        root.removeView(child1);
        assertThat(root.getChildCount()).isEqualTo(2);
        assertThat(root.getChildAt(0)).isSameAs(child2);
        assertThat(root.getChildAt(1)).isSameAs((View) child3);
        assertThat(child1.getParent()).isNull();
    }

    @Test
    public void removeView_resetsParentOnlyIfViewIsInViewGroup() throws Exception {
        assertThat(root.getChildCount()).isEqualTo(3);
        assertNotSame(child3a.getParent(), root);
        root.removeView(child3a);
        assertThat(root.getChildCount()).isEqualTo(3);
        assertThat(child3a.getParent()).isSameAs((ViewParent) child3);
    }

    @Test
    public void addView_whenChildAlreadyHasAParent_shouldThrow() throws Exception {
        ViewGroup newRoot = new FrameLayout(context);
        try {
            newRoot.addView(child1);
            fail("Expected IllegalStateException");
        } catch (IllegalStateException e) {
            // pass
        }
    }

    @Test
    public void shouldKnowWhenOnInterceptTouchEventWasCalled() throws Exception {
        ViewGroup viewGroup = new FrameLayout(context);

        MotionEvent touchEvent = MotionEvent.obtain(0, 0, MotionEvent.ACTION_DOWN, 0, 0, 0);
        viewGroup.onInterceptTouchEvent(touchEvent);

        assertThat(shadowOf(viewGroup).getInterceptedTouchEvent()).isEqualTo(touchEvent);
    }

    @Test
    public void removeView_shouldRequestLayout() throws Exception {
        View view = new View(context);
        ViewGroup viewGroup = new FrameLayout(context);
        viewGroup.addView(view);
        shadowOf(viewGroup).setDidRequestLayout(false);

        viewGroup.removeView(view);
        assertThat(shadowOf(viewGroup).didRequestLayout()).isTrue();
    }

    @Test
    public void removeViewAt_shouldRequestLayout() throws Exception {
        View view = new View(context);
        ViewGroup viewGroup = new FrameLayout(context);
        viewGroup.addView(view);
        shadowOf(viewGroup).setDidRequestLayout(false);

        viewGroup.removeViewAt(0);
        assertThat(shadowOf(viewGroup).didRequestLayout()).isTrue();
    }

    @Test
    public void removeAllViews_shouldRequestLayout() throws Exception {
        View view = new View(context);
        ViewGroup viewGroup = new FrameLayout(context);
        viewGroup.addView(view);
        shadowOf(viewGroup).setDidRequestLayout(false);

        viewGroup.removeAllViews();
        assertThat(shadowOf(viewGroup).didRequestLayout()).isTrue();
    }

    @Test
    public void addView_shouldRequestLayout() throws Exception {
        View view = new View(context);
        ViewGroup viewGroup = new FrameLayout(context);
        viewGroup.addView(view);

        assertThat(shadowOf(viewGroup).didRequestLayout()).isTrue();
    }

    @Test
    public void addView_withIndex_shouldRequestLayout() throws Exception {
        View view = new View(context);
        ViewGroup viewGroup = new FrameLayout(context);
        viewGroup.addView(view, 0);

        assertThat(shadowOf(viewGroup).didRequestLayout()).isTrue();
    }

    @Test
    public void removeAllViews_shouldCallOnChildViewRemovedWithEachChild() throws Exception {
        View view = new View(context);
        ViewGroup viewGroup = new FrameLayout(context);
        viewGroup.addView(view);

        TestOnHierarchyChangeListener testListener = new TestOnHierarchyChangeListener();

        viewGroup.setOnHierarchyChangeListener(testListener);
        viewGroup.removeAllViews();
        assertTrue(testListener.wasCalled());
    }

    class TestOnHierarchyChangeListener implements ViewGroup.OnHierarchyChangeListener {
        boolean wasCalled = false;

        @Override
        public void onChildViewAdded(View parent, View child) {
        }

        @Override
        public void onChildViewRemoved(View parent, View child) {
            wasCalled = true;
        }

        public boolean wasCalled() {
            return wasCalled;
        }
    }
}