Tests + debug

Author: AjroudRami

pom.xml

@@ -6,6 +6,14 @@
     <groupId>rams</groupId>
     <artifactId>scxml-to-fsm</artifactId>
     <version>1.0-SNAPSHOT</version>
+    <dependencies>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.12</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
 
 
 </project>

scxmltofsm.iml

@@ -11,5 +11,7 @@
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="TEST" name="Maven: junit:junit:4.12" level="project" />
+    <orderEntry type="library" scope="TEST" name="Maven: org.hamcrest:hamcrest-core:1.3" level="project" />
   </component>
 </module>

src/main/java/stateMachine/AbstractStateMachine.java

@@ -13,18 +13,41 @@ public abstract class AbstractStateMachine implements Serializable {
     protected List<State> stateList;
     protected State initState;
     protected State currentState;
+    protected EventHandler eventHandler;
 
     public AbstractStateMachine(){
+        this.eventHandler = new EventHandler(this);
         this.stateList = new ArrayList<State>();
     }
 
+    public List<State> getStateList(){
+        return this.stateList;
+    }
+
+    public State getInitState(){
+        return this.initState;
+    }
+
+    public State getCurrentState(){
+        return this.currentState;
+    }
+
     protected void init(){
         if(initState == null && stateList.size() != 0) {
             initState = stateList.get(0);
         }
         this.currentState = initState;
     }
 
+    public void start(){
+        Thread t = new Thread(eventHandler);
+        t.start();
+    }
+
+    public void stop(){
+        eventHandler.stop();
+    }
+
     public void notifyEvent(String event){
         this.currentState = this.currentState.notifyEvent(event);
     }
@@ -56,6 +79,7 @@ public void connectToEvent(String eventName, Callable callable){
     public void linkStates(){
         for(State state: this.stateList){
             for(Transition transition : state.getTransitions()){
+                transition.setFrom(state);
                 for(State state1 : this.stateList){
                     if(transition.to().getId().equals(state1.getId())){
                         transition.setTo(state1);

src/main/java/stateMachine/Event.java

@@ -10,6 +10,9 @@
 public class Event implements Serializable {
     private String name;
     private List<Callable> callables;
+    private Type type;
+
+    public enum Type {SEND, RAISE}
 
     public Event(String name){
         this.name = name;
@@ -38,4 +41,8 @@ public int getDelay(){
         }
         return delay;
     }
+
+    public Type getType(){
+        return this.type;
+    }
 }

src/main/java/stateMachine/EventHandler.java

@@ -0,0 +1,53 @@
+package stateMachine;
+
+import java.util.ArrayList;
+
+/**
+ * Created by Rami on 08/04/2017.
+ */
+public class EventHandler implements Runnable {
+
+    private ArrayList<Event> eventsStack;
+    private AbstractStateMachine stateMachine;
+    private boolean run;
+
+    public EventHandler(AbstractStateMachine stateMachine){
+        this.eventsStack = new ArrayList<Event>();
+        this.stateMachine = stateMachine;
+        this.run = false;
+    }
+
+
+    public void run() {
+        start();
+        while(run){
+            Event e = getNextEvent();
+            if(e != null){
+                e.trigger();
+            }
+        }
+    }
+
+    public void stop(){
+        this.run = false;
+    }
+
+    public void start(){
+        this.run = true;
+    }
+
+    private Event getNextEvent(){
+        Event e = null;
+        for(int i = 0; i<eventsStack.size(); i++){
+            if(eventsStack.get(i).getType().equals(Event.Type.SEND)){
+                return eventsStack.remove(i);
+            }
+        }
+        for(int i = 0; i<eventsStack.size(); i++){
+            if(eventsStack.get(i).getType().equals(Event.Type.RAISE)){
+                return eventsStack.remove(i);
+            }
+        }
+        return null;
+    }
+}

src/main/java/stateMachine/SCXMLToJava.java

@@ -19,11 +19,11 @@ public class SCXMLToJava {
 
     private final String openInst = "{";
     private final String closeInst = "}";
-    private final String packageHeader="package stateMachine;\n";
+    private final String packageHeader="import stateMachine.*;\n";
     private final String messageHeader="/**\nGenerated By SCXMLToJava class\n**/\n";
     private final String classNameHeader="public class GStateMachine extends AbstractStateMachine" + openInst + "\n";
     private final String constructorHeader="public GStateMachine()" + openInst + "\n";
-
+    private final String fileName = "GStateMachine.java";
     private String javaCode;
 
     private Document doc;
@@ -38,7 +38,7 @@ public SCXMLToJava(File scxmlDocument) throws ParserConfigurationException, IOEx
     public void generateJavaCode() throws IOException {
         String constructorBody = parseScxml(this.doc);
         this.javaCode = packageHeader + messageHeader + classNameHeader + constructorHeader + constructorBody + closeInst + closeInst;
-        Writer writer = new BufferedWriter(new OutputStreamWriter(new FileOutputStream("GStateMachine.java"), "utf-8"));
+        Writer writer = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(this.fileName), "utf-8"));
         writer.write(this.javaCode);
         writer.flush();
         writer.close();
@@ -52,6 +52,7 @@ private String parseScxml(Document doc){
                 result += parseState(init.getChildNodes().item(i));
             }
         }
+        result += "super.linkStates();\n";
         result += "super.init();\n";
         return result;
     }
@@ -157,4 +158,8 @@ private String parseTransitionEventsTrigger(Element e){
         }
         return result;
     }
+
+    public File getJavaCodeFile(){
+        return new File(this.fileName);
+    }
 }

src/main/java/stateMachine/State.java

@@ -15,7 +15,7 @@ public class State implements Serializable {
     private List<Event> onEntry;
     private List<Event> onExit;
 
-    State(){
+    public State(){
         this.id = "";
         this.isInit = false;
         this.transitions = new ArrayList<Transition>();

src/main/resources/integrationTests/test1.scxml

@@ -0,0 +1,8 @@
+<scxml version="1.0" xmlns="http://www.w3.org/2005/07/scxml">
+	<state id="State1">
+		<transition event="event1" target="State2" type="external"/>
+	</state>
+	<state id="State2">
+		<transition event="event2" target="State1" type="external"/>
+	</state>
+</scxml>

src/test/java/integration/SimpleStateMachineTest.java

@@ -0,0 +1,106 @@
+package integration;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.xml.sax.SAXException;
+import stateMachine.AbstractStateMachine;
+import stateMachine.GStateMachine;
+import stateMachine.SCXMLToJava;
+import stateMachine.State;
+
+import javax.tools.JavaCompiler;
+import javax.tools.ToolProvider;
+import javax.xml.parsers.ParserConfigurationException;
+import java.io.File;
+import java.io.IOException;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.junit.Assert.assertEquals;
+
+/**
+ * Created by Rami on 08/04/2017.
+ */
+public class SimpleStateMachineTest {
+
+    static String ressourceDir = "src\\main\\resources\\";
+    static String integrationTestDir = "integrationTests\\";
+    static AbstractStateMachine stateMachine;
+
+    @BeforeClass
+    public static void prepareEnv(){
+        File scxml = new File(ressourceDir + integrationTestDir +"test1.scxml");
+        try {
+            SCXMLToJava builder = new SCXMLToJava(scxml);
+            builder.generateJavaCode();
+            File javaCode = builder.getJavaCodeFile();
+            File root = javaCode.getAbsoluteFile().getParentFile();
+            System.out.println(root);
+            JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
+            compiler.run(null, System.out, System.err, javaCode.getPath());
+            URLClassLoader classLoader = URLClassLoader.newInstance(new URL[]{root.toURI().toURL()});
+            Class<?> cls = Class.forName("GStateMachine", true, classLoader);
+            stateMachine = (AbstractStateMachine) cls.newInstance();
+        } catch (ParserConfigurationException e) {
+            e.printStackTrace();
+        } catch (IOException e) {
+            e.printStackTrace();
+        } catch (SAXException e) {
+            e.printStackTrace();
+        } catch (IllegalAccessException e) {
+            e.printStackTrace();
+        } catch (InstantiationException e) {
+            e.printStackTrace();
+        } catch (ClassNotFoundException e) {
+            e.printStackTrace();
+        }
+    }
+
+
+    @Test
+    public void testInitState(){
+        //Test if the proper state has been set to initial (State1 without prior indication)
+        assertEquals(this.stateMachine.getInitState().getId(), "State1");
+
+        //Test if initial state is current state if we do not start the machine
+        assertEquals(this.stateMachine.getInitState(), this.stateMachine.getCurrentState());
+    }
+
+    @Test
+    public void testNbOfStates(){
+        assertEquals(this.stateMachine.getStateList().size(), 2);
+    }
+
+    @Test
+    public void testStatesNames(){
+        List<State> states =  this.stateMachine.getStateList();
+        List<State> expected = new ArrayList<State>();
+        expected.add(new State("State1"));
+        expected.add(new State("State2"));
+        for(int i = 0; i < states.size(); i++){
+            assertEquals(states.get(i).getId(), expected.get(i).getId());
+        }
+    }
+
+    @Test
+    public void testNBOfTransitions(){
+        List<State> states =  this.stateMachine.getStateList();
+        for(State state: states){
+            assertEquals(state.getTransitions().size(), 1);
+        }
+    }
+
+    @Test
+    public void testTransition(){
+        List<State> states =  this.stateMachine.getStateList();
+        System.out.println(states.get(0).getTransitions().get(0));
+        assertEquals(states.get(0).getTransitions().get(0).from(), states.get(0));
+        assertEquals(states.get(0).getTransitions().get(0).to(), states.get(1));
+
+        assertEquals(states.get(1).getTransitions().get(0).from(), states.get(1));
+        assertEquals(states.get(1).getTransitions().get(0).to(), states.get(0));
+
+    }
+}