ExecutionTraces now return last event

README.md

@@ -44,6 +44,10 @@ a link to this page somewhere in the documentation/system about section.
 
 ## Change Log for the BPjs Library.
 
+### 2019-02-10
+* :arrow_up: `ExecutionTrace`s can now return the last event, in addition to returning the last state.
+* :arrow_up: More tests.
+
 ### 2019-02-10
 * :arrow_up: Updated the Tic-Tac-Toe code.
 * :put_litter_in_its_place: Removed dependencies from `pom.xml`

src/main/java/il/ac/bgu/cs/bp/bpjs/analysis/ArrayExecutionTrace.java

@@ -63,7 +63,12 @@ public int getStateCount() {
     public BProgramSyncSnapshot getLastState() {
         return stack.get(stack.size()-1).getState();
     }
-
+
+    @Override
+    public BEvent getLastEvent() {
+        return stack.get(stack.size()-(isCyclic()?1:2)).getEvent().get();
+    }
+
     @Override
     public List<Entry> getNodes() {
         return Collections.unmodifiableList(stack);

src/main/java/il/ac/bgu/cs/bp/bpjs/analysis/ExecutionTrace.java

@@ -123,6 +123,16 @@ public boolean equals(Object obj) {
      */
     BProgramSyncSnapshot getLastState();
 
+    /**
+     * Returns the last event in the node list. For non-cyclic traces, that would
+     * be the last event to happen before the current state. In cyclic traces, 
+     * this would be the event that causes the b-program to get back to a state
+     * already in the trace, thereby closing the cycle.
+     * 
+     * @return the last event to happen in the node list.
+     */
+    BEvent getLastEvent();
+
     /**
      * Ordered list of all nodes in the state. In case of cycles, the last node
      * in the list is the last before returning to a previously visited node.

src/test/java/il/ac/bgu/cs/bp/bpjs/analysis/ArrayExecutionTraceTest.java

@@ -0,0 +1,116 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2019 michael.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package il.ac.bgu.cs.bp.bpjs.analysis;
+
+import static il.ac.bgu.cs.bp.bpjs.TestUtils.makeBPSS;
+import il.ac.bgu.cs.bp.bpjs.mocks.MockBThreadSyncSnapshot;
+import il.ac.bgu.cs.bp.bpjs.model.BEvent;
+import il.ac.bgu.cs.bp.bpjs.model.BProgram;
+import il.ac.bgu.cs.bp.bpjs.model.BProgramSyncSnapshot;
+import il.ac.bgu.cs.bp.bpjs.model.StringBProgram;
+import il.ac.bgu.cs.bp.bpjs.model.SyncStatement;
+import java.util.List;
+import org.junit.After;
+import org.junit.AfterClass;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import static org.junit.Assert.*;
+
+/**
+ *
+ * @author michael
+ */
+public class ArrayExecutionTraceTest {
+
+    BEvent EVT_1 = new BEvent("EVT1");
+    BEvent EVT_2 = new BEvent("EVT2");
+    BEvent EVT_3 = new BEvent("EVT3");
+    BEvent EVT_4 = new BEvent("EVT4");
+
+    /**
+     * Test of getLastEvent method, of class ArrayExecutionTrace.
+     */
+    @Test
+    public void testGetLastEvent() {
+
+        ArrayExecutionTrace sut = new ArrayExecutionTrace(new StringBProgram(""));
+
+        sut.push(makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+        sut.advance(EVT_1, makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+        sut.advance(EVT_2, makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+        sut.advance(EVT_3, makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+        sut.advance(EVT_4, makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+
+        assertEquals(EVT_4, sut.getLastEvent() );
+
+        sut.cycleTo(EVT_3, 2);
+        assertEquals(EVT_3, sut.getLastEvent() );
+    }
+
+
+    /**
+     * Test of isCyclic method, of class ArrayExecutionTrace.
+     */
+    @Test
+    public void testgetFinalCycle() {
+
+        ArrayExecutionTrace sut = new ArrayExecutionTrace(new StringBProgram(""));
+
+        sut.push(makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+        sut.advance(EVT_1, makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+        sut.advance(EVT_2, makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+        sut.advance(EVT_3, makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+        sut.advance(EVT_4, makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+
+        assertTrue(sut.getFinalCycle().isEmpty());
+
+        sut.cycleTo(EVT_3, 2);
+        assertEquals(3, sut.getFinalCycle().size());
+
+    }
+
+    /**
+     * Test of clear method, of class ArrayExecutionTrace.
+     */
+    @Test
+    public void testClear() {
+
+        ArrayExecutionTrace sut = new ArrayExecutionTrace(new StringBProgram(""));
+
+        sut.push(makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+        sut.advance(EVT_1, makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+        sut.advance(EVT_2, makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+        sut.advance(EVT_3, makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+        sut.advance(EVT_4, makeBPSS(new MockBThreadSyncSnapshot(SyncStatement.make())));
+
+        assertEquals( 5, sut.getStateCount() );
+
+        sut.clear();
+
+        assertEquals( 0, sut.getStateCount() );
+
+    }
+
+}