/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.wicket;
import java.util.ArrayList;
import java.util.List;
import org.apache.wicket.application.IComponentInitializationListener;
import org.apache.wicket.markup.IMarkupResourceStreamProvider;
import org.apache.wicket.markup.html.WebComponent;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.WebPage;
import org.apache.wicket.util.resource.IResourceStream;
import org.apache.wicket.util.resource.StringResourceStream;
/**
* Tests {@link Component#onInitialize()} contract
*
* @author igor
*/
public class ComponentInitializationTest extends WicketTestCase
{
/**
* testPropagation()
*/
public void testPropagation()
{
TestPage page = new TestPage();
TestComponent t1 = new TestComponent("t1");
TestComponent t2 = new TestComponent("t2");
TestComponent t3 = new TestComponent("t3");
TestComponent t4 = new TestComponent("t4");
// component is not initialized until the page has been
page.add(t1);
assertEquals(0, page.getCount());
assertEquals(0, t1.getCount());
// initialize the page which will initialize t1 and make subsequent component
// initializations immediate on add
page.internalInitialize();
assertEquals(1, page.getCount());
assertEquals(1, t1.getCount());
// unless the page is available no initialization takes place
t2.add(t3);
assertEquals(0, t2.getCount());
assertEquals(0, t3.getCount());
// initialization cascades from initialized
t1.add(t2);
assertEquals(1, t1.getCount());
assertEquals(1, t2.getCount());
assertEquals(1, t3.getCount());
// test intialization when adding to removed components
page.remove(t1);
t3.add(t4);
assertEquals(0, t4.getCount());
// test initialization when readding a component with uninitialized children
page.add(t1);
assertEquals(1, t4.getCount());
}
/**
* testAtomicity()
*/
public void testAtomicity()
{
TestPage page = new TestPage();
TestComponent t1 = new TestComponent("t1");
TestComponent t2 = new TestComponent("t2");
TestComponent t3 = new TestComponent("t3");
t1.add(t2);
t2.add(t3);
page.internalInitialize();
page.add(t1);
assertEquals(1, t1.getCount());
assertEquals(1, t2.getCount());
assertEquals(1, t3.getCount());
// test moving
page.add(t3);
assertEquals(1, t3.getCount());
// test removal and readdition
page.remove(t1);
assertEquals(1, t1.getCount());
page.add(t1);
assertEquals(1, t1.getCount());
assertEquals(1, t2.getCount());
}
/**
* testOnInitializeSuperVerified()
*/
public void testOnInitializeSuperVerified()
{
TestPage page = new TestPage();
page.internalInitialize();
boolean illegalState = false;
try
{
page.add(new InvalidComponent("addedComponent"));
}
catch (IllegalStateException e)
{
illegalState = true;
}
assertTrue(illegalState);
}
/**
* testInitListeners()
*/
public void testInitListeners()
{
TestInitListener listener1 = new TestInitListener();
TestInitListener listener2 = new TestInitListener();
tester.getApplication().getComponentInitializationListeners().add(listener1);
tester.getApplication().getComponentInitializationListeners().add(listener2);
WebPage page = new WebPage()
{
private static final long serialVersionUID = 1L;
};
page.internalInitialize();
TestComponent t1 = new TestComponent("t1");
TestComponent t2 = new TestComponent("t2");
t1.add(t2);
page.add(t1);
assertTrue(listener1.getComponents().contains(page));
assertTrue(listener1.getComponents().contains(t1));
assertTrue(listener1.getComponents().contains(t2));
assertTrue(listener2.getComponents().contains(page));
assertTrue(listener2.getComponents().contains(t1));
assertTrue(listener2.getComponents().contains(t2));
}
/**
* testInitializationOrder()
*/
public void testInitializationOrder()
{
TestInitListener listener1 = new TestInitListener();
tester.getApplication().getComponentInitializationListeners().add(listener1);
WebPage page = new WebPage()
{
private static final long serialVersionUID = 1L;
};
page.internalInitialize();
TestComponent t1 = new TestComponent("t1");
TestComponent t2 = new TestComponent("t2");
TestComponent t3 = new TestComponent("t3");
TestComponent t4 = new TestComponent("t4");
t1.add(t2);
page.add(t1);
t1.add(t3);
t3.add(t4);
assertTrue(page == listener1.getComponents().get(0));
assertTrue(t1 == listener1.getComponents().get(1));
assertTrue(t2 == listener1.getComponents().get(2));
assertTrue(t3 == listener1.getComponents().get(3));
assertTrue(t4 == listener1.getComponents().get(4));
}
static class TestPage extends WebPage implements IMarkupResourceStreamProvider
{
private static final long serialVersionUID = 1L;
private int count;
public IResourceStream getMarkupResourceStream(MarkupContainer container,
Class<?> containerClass)
{
return new StringResourceStream("<html><body></body></html>");
}
@Override
protected void onInitialize()
{
super.onInitialize();
count++;
}
public int getCount()
{
return count;
}
}
private static class TestComponent extends WebMarkupContainer
{
private static final long serialVersionUID = 1L;
private int count = 0;
public TestComponent(String id)
{
super(id);
}
@Override
protected void onInitialize()
{
super.onInitialize();
count++;
}
public int getCount()
{
return count;
}
}
private static class InvalidComponent extends WebComponent
{
private static final long serialVersionUID = 1L;
private final boolean initialized = false;
public InvalidComponent(String id)
{
super(id);
}
@Override
protected void onInitialize()
{
// missing super call
}
}
private static class TestInitListener implements IComponentInitializationListener
{
private List<Component> components = new ArrayList<Component>();
public void onInitialize(Component component)
{
System.out.println(component);
components.add(component);
}
public List<Component> getComponents()
{
return components;
}
}
}