/* $Id: TestModelEventPump.java 18978 2011-01-24 18:25:30Z linus $
*****************************************************************************
* Copyright (c) 2009 Contributors - see below
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* euluis
*****************************************************************************
*
* Some portions of this file was previously release using the BSD License:
*/
// Copyright (c) 2004-2007 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies. This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason. IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
package org.argouml.model;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import junit.framework.TestCase;
import org.argouml.kernel.Project;
import org.argouml.kernel.ProjectManager;
import org.argouml.profile.ProfileFacade;
import org.argouml.profile.init.InitProfileSubsystem;
/**
* Test delivery of Model events.
*
* TODO: We have not documented exactly what events arrive and when.
*
* @author Linus Tolke
*/
public class TestModelEventPump extends TestCase {
private Object elem;
private Object model;
private boolean eventcalled;
private TestListener listener;
/**
* A mock listener used for the tests.
*/
private class TestListener implements PropertyChangeListener {
/*
* @see PropertyChangeListener#propertyChange(PropertyChangeEvent)
*/
public void propertyChange(PropertyChangeEvent e) {
// TODO: This log entry tells us what events actually arrive
// to the listener. I (Linus) suggest we let it in there until
// all event types and contents are fully documented.
// System.out.println("Received event " + e.getSource()
// + "[" + e.getSource().getClass() + "], "
// + e.getPropertyName() + ", "
// + e.getOldValue() + ", "
// + e.getNewValue());
eventcalled = true;
}
}
/**
* Constructor for TestUmlModelEventPump.
*
* @param arg0 is the name of the test case.
*/
public TestModelEventPump(String arg0) {
super(arg0);
InitializeModel.initializeDefault();
}
/*
* @see junit.framework.TestCase#setUp()
*/
protected void setUp() throws Exception {
super.setUp();
elem = Model.getCoreFactory().createClass();
new InitProfileSubsystem().init();
model = Model.getModelManagementFactory().createModel();
Model.getCoreHelper().addOwnedElement(model, elem);
eventcalled = false;
listener = new TestListener();
Model.getPump().flushModelEvents();
}
/*
* @see junit.framework.TestCase#tearDown()
*/
@Override
protected void tearDown() throws Exception {
ProfileFacade.reset();
if (elem != null) {
Model.getUmlFactory().delete(elem);
elem = null;
Model.getUmlFactory().delete(model);
model = null;
}
listener = null;
super.tearDown();
}
/**
* Tests if a listener that registered for a PropertySet event on
* the class level really receive the event.
*/
public void testPropertySetClass() {
Model.getPump().addClassModelEventListener(listener,
elem.getClass(),
new String[] {
"isAbstract",
});
Model.getCoreHelper().setAbstract(elem, true);
Model.getPump().flushModelEvents();
assertTrue(eventcalled);
}
/**
* Tests whether a listener that is registered for a remove event on the
* class level receives the event.
*/
public void testRemovedClass() {
Model.getPump().addClassModelEventListener(listener,
elem.getClass(),
new String[] {
"remove",
});
Model.getUmlFactory().delete(elem);
Model.getPump().flushModelEvents();
assertTrue(eventcalled);
}
/**
* Tests whether a listener that is registered for a generalization event on
* the class level receives the event when a new generalization is created.
*/
public void testRoleAddedSetClass() {
Model.getPump().addClassModelEventListener(listener,
elem.getClass(),
new String[] {
"generalization",
});
Model.getCoreFactory().buildGeneralization(
elem,
Model.getCoreFactory().createClass());
Model.getPump().flushModelEvents();
assertTrue(eventcalled);
}
/**
* Tests if a listener that registered for a RoleRemoved event on
* the class level really receive the event.
*/
public void testRoleRemovedSetClass() {
Object gen = Model.getCoreFactory().buildGeneralization(
elem, Model.getCoreFactory().createClass());
Model.getPump().addClassModelEventListener(
listener, elem.getClass(), new String[] {"generalization", });
Model.getUmlFactory().delete(gen);
Model.getPump().flushModelEvents();
assertTrue(eventcalled);
}
/**
* Tests if a non registered listener does not receive any events.
*/
public void testFireNonregisteredListener() {
Model.getCoreFactory().createClass();
Model.getCoreFactory().buildGeneralization(
elem,
Model.getCoreFactory().createClass());
Model.getPump().flushModelEvents();
assertTrue(!eventcalled);
}
/**
* Tests if a listener that registered for a PropertySet event really
* receive the event.
*/
public void testPropertySet() {
Model.getPump().addModelEventListener(listener,
elem,
new String[] {
"isAbstract",
});
Model.getCoreHelper().setAbstract(elem, true);
Model.getPump().flushModelEvents();
assertTrue(eventcalled);
}
/**
* Tests if a listener that registered for a Removed event really
* receive the event.
*/
public void testRemoved() {
Model.getPump().addModelEventListener(listener,
elem,
new String[] {
"remove",
});
Model.getUmlFactory().delete(elem);
Model.getPump().flushModelEvents();
assertTrue(eventcalled);
}
/**
* Tests if a listener that registered for a RoleAddedSet event really
* receive the event.
*/
public void testRoleAddedSet() {
Model.getPump().addModelEventListener(listener,
elem,
new String[] {
"generalization",
});
Model.getCoreFactory().buildGeneralization(
elem,
Model.getCoreFactory().createClass());
Model.getPump().flushModelEvents();
assertTrue(eventcalled);
}
/**
* Tests if a listener that registered for a RoleRemovedSet event really
* receive the event.
*/
public void testRoleRemovedSet() {
Object gen = Model.getCoreFactory().buildGeneralization(
elem, Model.getCoreFactory().createClass());
Model.getPump().addModelEventListener(listener,
elem,
new String[] {
"generalization",
});
Model.getUmlFactory().delete(gen);
Model.getPump().flushModelEvents();
assertTrue(eventcalled);
}
/**
* Tests if a listener to a class that is legally added and then
* removed, really is removed.
*/
public void testRemoveLegalClassListener() {
Model.getPump().addClassModelEventListener(listener,
elem.getClass(),
new String[] {
"isAbstract",
});
Model.getCoreHelper().setAbstract(elem, true);
Model.getPump().flushModelEvents();
assertTrue(eventcalled);
eventcalled = false;
Model.getPump().removeClassModelEventListener(listener,
elem.getClass(),
new String[] {
"isAbstract",
});
Model.getCoreHelper().setAbstract(elem, false);
Model.getPump().flushModelEvents();
assertFalse(eventcalled);
}
/**
* Tests if a listener that is legally added and then removed,
* really is removed.
*/
public void testRemoveLegalListener() {
String[] map = new String[] {
"isAbstract",
};
Model.getPump().addModelEventListener(listener, elem, map);
Model.getCoreHelper().setAbstract(elem, true);
Model.getPump().flushModelEvents();
assertTrue(eventcalled);
eventcalled = false;
Model.getPump().removeModelEventListener(listener, elem, map);
Model.getCoreHelper().setAbstract(elem, false);
Model.getPump().flushModelEvents();
assertFalse(eventcalled);
}
}