Files
JIMRI/java/test/jmri/jmrit/display/logixng/ActionPositionableTest.java
T
2026-06-17 14:00:51 +02:00

575 lines
26 KiB
Java

package jmri.jmrit.display.logixng;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import jmri.jmrit.logixng.actions.*;
import java.util.ArrayList;
import jmri.*;
import jmri.jmrit.display.*;
import jmri.jmrit.logixng.*;
import jmri.jmrit.logixng.implementation.DefaultConditionalNGScaffold;
import jmri.util.JUnitUtil;
import jmri.util.ThreadingUtil;
import jmri.util.junit.annotations.DisabledIfHeadless;
import org.junit.jupiter.api.*;
/**
* Test ActionPositionable
*
* @author Daniel Bergqvist 2018
*/
@DisabledIfHeadless
public class ActionPositionableTest extends AbstractDigitalActionTestBase {
private LogixNG logixNG;
private ConditionalNG conditionalNG;
private ActionPositionable actionPositionable;
private Turnout turnout;
private Editor editor;
private Positionable positionable1;
private Positionable positionable2;
private Positionable positionable3;
@Override
public ConditionalNG getConditionalNG() {
return conditionalNG;
}
@Override
public LogixNG getLogixNG() {
return logixNG;
}
@Override
public MaleSocket getConnectableChild() {
return null;
}
@Override
public String getExpectedPrintedTree() {
return String.format("Set icon/label \"Some other id\" on panel \"A panel editor\" to \"Disable\" ::: Use default%n");
}
@Override
public String getExpectedPrintedTreeFromRoot() {
return String.format(
"LogixNG: A logixNG%n" +
" ConditionalNG: A conditionalNG%n" +
" ! A%n" +
" Set icon/label \"Some other id\" on panel \"A panel editor\" to \"Disable\" ::: Use default%n");
}
@Override
public NamedBean createNewBean(String systemName) {
return new ActionPositionable(systemName, null);
}
@Override
public boolean addNewSocket() {
return false;
}
@Test
public void testCtor() throws JmriException {
assertNotNull( _base, "object exists");
ActionPositionable action2;
assertNotNull( turnout, "turnout is not null");
turnout.setState(Turnout.ON);
action2 = new ActionPositionable("IQDA321", null);
assertNotNull( action2, "object exists");
assertNull( action2.getUserName(), "Username matches");
assertEquals( "Set icon/label \"''\" on panel \"''\" to \"Enable\"",
action2.getLongDescription(), "String matches");
action2 = new ActionPositionable("IQDA321", "My turnout");
assertNotNull( action2, "object exists");
assertEquals( "My turnout", action2.getUserName(), "Username matches");
assertEquals( "Set icon/label \"''\" on panel \"''\" to \"Enable\"",
action2.getLongDescription(), "String matches");
/*
action2 = new ActionPositionable("IQDA321", null);
action2.setTurnout(turnout);
Assert.assertTrue("turnout is correct", turnout == action2.getTurnout().getBean());
Assert.assertNotNull("object exists", action2);
Assert.assertNull("Username matches", action2.getUserName());
Assert.assertEquals("String matches", "Set turnout IT1 to state Thrown", action2.getLongDescription());
Turnout l = InstanceManager.getDefault(TurnoutManager.class).provide("IT1");
action2 = new ActionPositionable("IQDA321", "My turnout");
action2.setTurnout(l);
Assert.assertTrue("turnout is correct", l == action2.getTurnout().getBean());
Assert.assertNotNull("object exists", action2);
Assert.assertEquals("Username matches", "My turnout", action2.getUserName());
Assert.assertEquals("String matches", "Set turnout IT1 to state Thrown", action2.getLongDescription());
*/
IllegalArgumentException ex = assertThrows(IllegalArgumentException.class,
() -> {
var ac = new ActionPositionable("IQA55:12:XY11", null);
assertNull(ac); // should not reach here, avoids new instance ignored compiler warning
}, "Illegal system name Expected exception thrown");
assertNotNull(ex);
ex = assertThrows(IllegalArgumentException.class,
() -> {
var ac = new ActionPositionable("IQA55:12:XY11", "A name");
assertNull(ac); // should not reach here, avoids new instance ignored compiler warning
}, "Illegal system name Expected exception thrown 2");
assertNotNull(ex);
// Test setup(). This method doesn't do anything, but execute it for coverage.
_base.setup();
}
@Test
public void testGetChild() {
assertEquals( 0, actionPositionable.getChildCount(), "getChildCount() returns 0");
UnsupportedOperationException ex = assertThrows( UnsupportedOperationException.class,
() -> actionPositionable.getChild(0), "Exception is thrown");
assertEquals( "Not supported.", ex.getMessage(), "Error message is correct");
}
@Test
public void testTurnoutState() {
assertEquals( "Disable", ActionPositionable.Operation.Disable.toString(), "String matches");
assertEquals( "Enable", ActionPositionable.Operation.Enable.toString(), "String matches 2");
}
/*
@Test
public void testSetTurnout() {
Turnout turnout11 = InstanceManager.getDefault(TurnoutManager.class).provide("IL11");
Turnout turnout12 = InstanceManager.getDefault(TurnoutManager.class).provide("IL12");
NamedBeanHandle<Turnout> turnoutHandle12 = InstanceManager.getDefault(NamedBeanHandleManager.class).getNamedBeanHandle(turnout12.getDisplayName(), turnout12);
Turnout turnout13 = InstanceManager.getDefault(TurnoutManager.class).provide("IL13");
Turnout turnout14 = InstanceManager.getDefault(TurnoutManager.class).provide("IL14");
turnout14.setUserName("Some user name");
actionEnableDisable.removeTurnout();
Assert.assertNull("turnout handle is null", actionEnableDisable.getTurnout());
actionEnableDisable.setTurnout(turnout11);
Assert.assertTrue("turnout is correct", turnout11 == actionEnableDisable.getTurnout().getBean());
actionEnableDisable.removeTurnout();
Assert.assertNull("turnout handle is null", actionEnableDisable.getTurnout());
actionEnableDisable.setTurnout(turnoutHandle12);
Assert.assertTrue("turnout handle is correct", turnoutHandle12 == actionEnableDisable.getTurnout());
actionEnableDisable.setTurnout("A non existent turnout");
Assert.assertNull("turnout handle is null", actionEnableDisable.getTurnout());
JUnitAppender.assertErrorMessage("turnout \"A non existent turnout\" is not found");
actionEnableDisable.setTurnout(turnout13.getSystemName());
Assert.assertTrue("turnout is correct", turnout13 == actionEnableDisable.getTurnout().getBean());
actionEnableDisable.setTurnout(turnout14.getUserName());
Assert.assertTrue("turnout is correct", turnout14 == actionEnableDisable.getTurnout().getBean());
}
@Test
public void testAction() throws SocketAlreadyConnectedException, JmriException {
// Set the light
turnout.setCommandedState(Turnout.CLOSED);
// The turnout should be closed
Assert.assertTrue("turnout is closed",turnout.getCommandedState() == Turnout.CLOSED);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the turnout should be thrown
Assert.assertTrue("turnout is thrown",turnout.getCommandedState() == Turnout.THROWN);
// Test to set turnout to closed
actionEnableDisable.setBeanState(ActionPositionable.TurnoutState.Closed);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the turnout should be thrown
Assert.assertTrue("turnout is thrown",turnout.getCommandedState() == Turnout.CLOSED);
// Test to set turnout to toggle
actionEnableDisable.setBeanState(ActionPositionable.TurnoutState.Toggle);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the turnout should be thrown
Assert.assertTrue("turnout is thrown",turnout.getCommandedState() == Turnout.THROWN);
// Test to set turnout to toggle
actionEnableDisable.setBeanState(ActionPositionable.TurnoutState.Toggle);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the turnout should be thrown
Assert.assertTrue("turnout is thrown",turnout.getCommandedState() == Turnout.CLOSED);
}
@Test
public void testIndirectAddressing() throws JmriException {
Memory m1 = InstanceManager.getDefault(MemoryManager.class).provide("IM1");
m1.setValue("IT102");
Assert.assertTrue(conditionalNG.isActive());
Turnout t1 = InstanceManager.getDefault(TurnoutManager.class).provide("IT101");
Turnout t2 = InstanceManager.getDefault(TurnoutManager.class).provide("IT102");
Turnout t3 = InstanceManager.getDefault(TurnoutManager.class).provide("IT103");
Turnout t4 = InstanceManager.getDefault(TurnoutManager.class).provide("IT104");
Turnout t5 = InstanceManager.getDefault(TurnoutManager.class).provide("IT105");
actionEnableDisable.setBeanState(ActionPositionable.TurnoutState.Thrown);
actionEnableDisable.setTurnout(t1.getSystemName());
actionEnableDisable.setReference("{IM1}"); // Points to "IT102"
actionEnableDisable.setLocalVariable("myTurnout");
actionEnableDisable.setFormula("\"IT10\" + str(index)");
_baseMaleSocket.addLocalVariable("refTurnout", SymbolTable.InitialValueType.String, "IT103");
_baseMaleSocket.addLocalVariable("myTurnout", SymbolTable.InitialValueType.String, "IT104");
_baseMaleSocket.addLocalVariable("index", SymbolTable.InitialValueType.Integer, "5");
// Test direct addressing
actionEnableDisable.setAddressing(NamedBeanAddressing.Direct);
t1.setState(Turnout.CLOSED);
t2.setState(Turnout.CLOSED);
t3.setState(Turnout.CLOSED);
t4.setState(Turnout.CLOSED);
t5.setState(Turnout.CLOSED);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.THROWN, t1.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t2.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t3.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t4.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t5.getCommandedState());
// Test reference by memory addressing
actionEnableDisable.setAddressing(NamedBeanAddressing.Reference);
t1.setState(Turnout.CLOSED);
t2.setState(Turnout.CLOSED);
t3.setState(Turnout.CLOSED);
t4.setState(Turnout.CLOSED);
t5.setState(Turnout.CLOSED);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.CLOSED, t1.getCommandedState());
Assert.assertEquals(Turnout.THROWN, t2.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t3.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t4.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t5.getCommandedState());
// Test reference by local variable addressing
actionEnableDisable.setReference("{refTurnout}"); // Points to "IT103"
actionEnableDisable.setAddressing(NamedBeanAddressing.Reference);
t1.setState(Turnout.CLOSED);
t2.setState(Turnout.CLOSED);
t3.setState(Turnout.CLOSED);
t4.setState(Turnout.CLOSED);
t5.setState(Turnout.CLOSED);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.CLOSED, t1.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t2.getCommandedState());
Assert.assertEquals(Turnout.THROWN, t3.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t4.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t5.getCommandedState());
// Test local variable addressing
actionEnableDisable.setAddressing(NamedBeanAddressing.LocalVariable);
t1.setState(Turnout.CLOSED);
t2.setState(Turnout.CLOSED);
t3.setState(Turnout.CLOSED);
t4.setState(Turnout.CLOSED);
t5.setState(Turnout.CLOSED);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.CLOSED, t1.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t2.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t3.getCommandedState());
Assert.assertEquals(Turnout.THROWN, t4.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t5.getCommandedState());
// Test formula addressing
actionEnableDisable.setAddressing(NamedBeanAddressing.Formula);
t1.setState(Turnout.CLOSED);
t2.setState(Turnout.CLOSED);
t3.setState(Turnout.CLOSED);
t4.setState(Turnout.CLOSED);
t5.setState(Turnout.CLOSED);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.CLOSED, t1.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t2.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t3.getCommandedState());
Assert.assertEquals(Turnout.CLOSED, t4.getCommandedState());
Assert.assertEquals(Turnout.THROWN, t5.getCommandedState());
}
@Test
public void testIndirectStateAddressing() throws JmriException {
Memory m1 = InstanceManager.getDefault(MemoryManager.class).provide("IM1");
m1.setValue("IT102");
Assert.assertTrue(conditionalNG.isActive());
// Test direct addressing
actionEnableDisable.setStateAddressing(NamedBeanAddressing.Direct);
// Test Closed
turnout.setState(Turnout.THROWN);
actionEnableDisable.setBeanState(ActionPositionable.TurnoutState.Closed);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.CLOSED, turnout.getCommandedState());
// Test Thrown
turnout.setState(Turnout.CLOSED);
actionEnableDisable.setBeanState(ActionPositionable.TurnoutState.Thrown);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.THROWN, turnout.getCommandedState());
// Test reference by memory addressing
actionEnableDisable.setStateAddressing(NamedBeanAddressing.Reference);
actionEnableDisable.setStateReference("{IM1}");
// Test Closed
m1.setValue("Closed");
turnout.setState(Turnout.THROWN);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.CLOSED, turnout.getCommandedState());
// Test Thrown
m1.setValue("Thrown");
turnout.setState(Turnout.CLOSED);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.THROWN, turnout.getCommandedState());
// Test reference by local variable addressing
actionEnableDisable.setStateAddressing(NamedBeanAddressing.Reference);
actionEnableDisable.setStateReference("{refVariable}");
// Test Closed
_baseMaleSocket.clearLocalVariables();
_baseMaleSocket.addLocalVariable("refVariable", SymbolTable.InitialValueType.String, "Closed");
turnout.setState(Turnout.THROWN);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.CLOSED, turnout.getCommandedState());
// Test Thrown
_baseMaleSocket.clearLocalVariables();
_baseMaleSocket.addLocalVariable("refVariable", SymbolTable.InitialValueType.String, "Thrown");
turnout.setState(Turnout.CLOSED);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.THROWN, turnout.getCommandedState());
// Test local variable addressing
actionEnableDisable.setStateAddressing(NamedBeanAddressing.Reference);
actionEnableDisable.setStateLocalVariable("myVariable");
// Test Closed
_baseMaleSocket.clearLocalVariables();
_baseMaleSocket.addLocalVariable("refVariable", SymbolTable.InitialValueType.String, "Closed");
turnout.setState(Turnout.THROWN);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.CLOSED, turnout.getCommandedState());
// Test Thrown
_baseMaleSocket.clearLocalVariables();
_baseMaleSocket.addLocalVariable("refVariable", SymbolTable.InitialValueType.String, "Thrown");
turnout.setState(Turnout.CLOSED);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.THROWN, turnout.getCommandedState());
// Test formula addressing
actionEnableDisable.setStateAddressing(NamedBeanAddressing.Formula);
actionEnableDisable.setStateFormula("refVariable + myVariable");
// Test Closed
_baseMaleSocket.clearLocalVariables();
_baseMaleSocket.addLocalVariable("refVariable", SymbolTable.InitialValueType.String, "Clo");
_baseMaleSocket.addLocalVariable("myVariable", SymbolTable.InitialValueType.String, "sed");
turnout.setState(Turnout.THROWN);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.CLOSED, turnout.getCommandedState());
// Test Thrown
_baseMaleSocket.clearLocalVariables();
_baseMaleSocket.addLocalVariable("refVariable", SymbolTable.InitialValueType.String, "Thro");
_baseMaleSocket.addLocalVariable("myVariable", SymbolTable.InitialValueType.String, "wn");
turnout.setState(Turnout.CLOSED);
// Execute the conditional
conditionalNG.execute();
// The action should now be executed so the correct turnout should be thrown
Assert.assertEquals(Turnout.THROWN, turnout.getCommandedState());
}
@Test
public void testVetoableChange() throws PropertyVetoException {
// Get the action and set the turnout
Turnout turnout = InstanceManager.getDefault(TurnoutManager.class).provide("IT1");
Assert.assertNotNull("Turnout is not null", turnout);
ActionPositionable action = new ActionPositionable(InstanceManager.getDefault(DigitalActionManager.class).getAutoSystemName(), null);
action.setTurnout(turnout);
// Get some other turnout for later use
Turnout otherTurnout = InstanceManager.getDefault(TurnoutManager.class).provide("IM99");
Assert.assertNotNull("Turnout is not null", otherTurnout);
Assert.assertNotEquals("Turnout is not equal", turnout, otherTurnout);
// Test vetoableChange() for some other propery
action.vetoableChange(new PropertyChangeEvent(this, "CanSomething", "test", null));
Assert.assertEquals("Turnout matches", turnout, action.getTurnout().getBean());
// Test vetoableChange() for a string
action.vetoableChange(new PropertyChangeEvent(this, "CanDelete", "test", null));
Assert.assertEquals("Turnout matches", turnout, action.getTurnout().getBean());
action.vetoableChange(new PropertyChangeEvent(this, "DoDelete", "test", null));
Assert.assertEquals("Turnout matches", turnout, action.getTurnout().getBean());
// Test vetoableChange() for another turnout
action.vetoableChange(new PropertyChangeEvent(this, "CanDelete", otherTurnout, null));
Assert.assertEquals("Turnout matches", turnout, action.getTurnout().getBean());
action.vetoableChange(new PropertyChangeEvent(this, "DoDelete", otherTurnout, null));
Assert.assertEquals("Turnout matches", turnout, action.getTurnout().getBean());
// Test vetoableChange() for its own turnout
boolean thrown = false;
try {
action.vetoableChange(new PropertyChangeEvent(this, "CanDelete", turnout, null));
} catch (PropertyVetoException ex) {
thrown = true;
}
Assert.assertTrue("Expected exception thrown", thrown);
Assert.assertEquals("Turnout matches", turnout, action.getTurnout().getBean());
action.vetoableChange(new PropertyChangeEvent(this, "DoDelete", turnout, null));
Assert.assertNull("Turnout is null", action.getTurnout());
}
*/
@Test
public void testCategory() {
assertSame( CategoryDisplay.DISPLAY, _base.getCategory(), "Category matches");
}
@Test
public void testShortDescription() {
assertEquals( "Icon/Label on panel", _base.getShortDescription(), "String matches");
}
@Test
public void testLongDescription() {
assertEquals( "Set icon/label \"Some other id\" on panel \"A panel editor\" to \"Disable\"",
_base.getLongDescription(), "String matches");
}
@Test
public void testChild() {
assertEquals( 0, _base.getChildCount(), "Num children is zero");
UnsupportedOperationException ex = assertThrows( UnsupportedOperationException.class,
() -> _base.getChild(0), "Exception is thrown");
assertEquals( "Not supported.", ex.getMessage(), "Error message is correct");
}
@BeforeEach
public void setUp() throws SocketAlreadyConnectedException, Positionable.DuplicateIdException {
JUnitUtil.setUp();
JUnitUtil.resetInstanceManager();
JUnitUtil.resetProfileManager();
JUnitUtil.initConfigureManager();
JUnitUtil.initInternalSensorManager();
JUnitUtil.initInternalTurnoutManager();
JUnitUtil.initLogixNGManager();
_category = LogixNG_Category.ITEM;
_isExternal = true;
EditorManager editorManager = InstanceManager.getDefault(EditorManager.class);
editor = new jmri.jmrit.display.panelEditor.PanelEditor("Some panel");
editor.setName("A panel editor");
editorManager.add(editor);
positionable1 = new jmri.jmrit.display.MemoryIcon("Memory", editor);
editor.putItem(positionable1);
positionable1.setId("Some id");
positionable2 = new jmri.jmrit.display.MemoryIcon("Memory", editor);
editor.putItem(positionable2);
positionable2.setId("Some other id");
positionable3 = new jmri.jmrit.display.MemoryIcon("Memory", editor);
editor.putItem(positionable3);
turnout = InstanceManager.getDefault(TurnoutManager.class).provide("IT1");
turnout.setCommandedState(Turnout.CLOSED);
logixNG = InstanceManager.getDefault(LogixNG_Manager.class).createLogixNG("A logixNG");
conditionalNG = new DefaultConditionalNGScaffold("IQC1", "A conditionalNG"); // NOI18N;
InstanceManager.getDefault(ConditionalNG_Manager.class).register(conditionalNG);
logixNG.addConditionalNG(conditionalNG);
conditionalNG.setRunDelayed(false);
conditionalNG.setEnabled(true);
actionPositionable = new ActionPositionable(InstanceManager.getDefault(DigitalActionManager.class).getAutoSystemName(), null);
actionPositionable.setEditor(editor.getName());
actionPositionable.setPositionable(positionable2.getId());
actionPositionable.setOperation(ActionPositionable.Operation.Disable);
MaleSocket socket = InstanceManager.getDefault(DigitalActionManager.class).registerAction(actionPositionable);
conditionalNG.getChild(0).connect(socket);
_base = actionPositionable;
_baseMaleSocket = socket;
assertTrue ( logixNG.setParentForAllChildren(new ArrayList<>()));
logixNG.activate();
logixNG.setEnabled(true);
// At this stage Panel is visible but not Editor.
// Make visible so both can be closed by Operator in tearDown
ThreadingUtil.runOnGUI( () -> {
editor.pack();
editor.setVisible(true);
});
}
@AfterEach
public void tearDown() {
if ( editor != null ) {
EditorFrameOperator efo = new EditorFrameOperator(editor);
efo.deleteViaFileMenuWithConfirmations();
EditorFrameOperator.clearEditorFrameOperatorThreads();
}
editor = null;
logixNG = null;
positionable1 = null;
positionable2 = null;
positionable3 = null;
jmri.jmrit.logixng.util.LogixNG_Thread.stopAllLogixNGThreads();
JUnitUtil.deregisterBlockManagerShutdownTask();
JUnitUtil.tearDown();
}
}