7.8.22: CoCo for AcceptAction in Event-Transitions

Author: mathias-pfeiffer

gradle.properties

@@ -25,4 +25,4 @@ assertj_version    = 3.21.0
 junit_version      = 5.8.2
 
 # Version of published artifacts
-version            = 7.8.21
+version            = 7.8.22

language/src/main/java/de/monticore/lang/sysmlv2/SysMLv2Tool.java

@@ -24,6 +24,7 @@
 import de.monticore.lang.sysmlv2._symboltable.SysMLv2Symbols2Json;
 import de.monticore.lang.sysmlv2._visitor.SysMLv2Traverser;
 import de.monticore.lang.sysmlv2.cocos.AssignActionTypeCheck3;
+import de.monticore.lang.sysmlv2.cocos.EventTransitionRequiresAccept;
 import de.monticore.lang.sysmlv2.cocos.FlowCheckCoCo;
 import de.monticore.lang.sysmlv2.cocos.NameCompatible4Isabelle;
 import de.monticore.lang.sysmlv2.cocos.OneCardinality;
@@ -167,6 +168,7 @@ public void runAdditionalCoCos(
     checker.addCoCo(new FlowCheckCoCo());
     checker.addCoCo(new PortDefinitionExistsCoCo());
     checker.addCoCo(new PartBehaviorCoCo());
+    checker.addCoCo(new EventTransitionRequiresAccept());
 
     checker.checkAll(ast);
   }

language/src/main/java/de/monticore/lang/sysmlv2/cocos/EventTransitionRequiresAccept.java

@@ -0,0 +1,38 @@
+package de.monticore.lang.sysmlv2.cocos;
+
+import de.monticore.lang.componentconnector._symboltable.EventAutomatonSymbol;
+import de.monticore.lang.sysmlstates._ast.ASTSysMLTransition;
+import de.monticore.lang.sysmlstates._cocos.SysMLStatesASTSysMLTransitionCoCo;
+import de.se_rwth.commons.logging.Log;
+
+/**
+ * All transitions in an Event-Automaton need AcceptActions
+ */
+public class EventTransitionRequiresAccept implements
+    SysMLStatesASTSysMLTransitionCoCo {
+
+  @Override
+  public void check(ASTSysMLTransition node) {
+    if (!isInEventAutomaton(node)) return;
+
+    if (!node.isPresentInlineAcceptActionUsage()) {
+      Log.error("EventAutomaton transition must contain an AcceptAction.",
+          node.get_SourcePositionStart(),
+          node.get_SourcePositionEnd());
+    }
+  }
+
+  private boolean isInEventAutomaton(ASTSysMLTransition node) {
+    var scope = node.getEnclosingScope();
+
+    while (scope != null) {
+      if (scope.isPresentSpanningSymbol()) {
+        var sym = scope.getSpanningSymbol();
+        if (sym instanceof EventAutomatonSymbol) return true;
+      }
+      scope = scope.getEnclosingScope();
+    }
+    return false;
+  }
+
+}

language/src/test/java/cocos/EventTransitionRequiresAcceptTest.java

@@ -0,0 +1,108 @@
+package cocos;
+
+import de.monticore.lang.sysmlv2.SysMLv2Mill;
+import de.monticore.lang.sysmlv2.SysMLv2Tool;
+import de.monticore.lang.sysmlv2._ast.ASTSysMLModel;
+import de.monticore.lang.sysmlv2._cocos.SysMLv2CoCoChecker;
+import de.monticore.lang.sysmlv2.cocos.EventTransitionRequiresAccept;
+import de.se_rwth.commons.logging.Log;
+import de.se_rwth.commons.logging.LogStub;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.util.stream.Collectors;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.fail;
+
+public class EventTransitionRequiresAcceptTest {
+
+  @BeforeAll
+  public static void init() {
+    LogStub.init();
+  }
+
+  @BeforeEach
+  public void clear() {
+    Log.clearFindings();
+  }
+
+  @Test
+  void eventAutomaton_withAccept_mustNotLogError() {
+    parseAndCheck(valid);
+    var errors = Log.getFindings().stream()
+        .filter(s -> s.isError())
+        .collect(Collectors.toList());
+    assertTrue(errors.isEmpty(),
+        "Expected no errors, but got:\n" + errors);
+  }
+
+  @Test
+  void eventAutomaton_withoutAccept_mustLogError() {
+    parseAndCheck(invalid);
+    assertFalse(Log.getFindings().isEmpty());
+  }
+
+  void parseAndCheck(String model) {
+    var tool = new SysMLv2Tool();
+    tool.init();
+    ASTSysMLModel ast = null;
+    try {
+      ast = SysMLv2Mill.parser().parse_String(model).get();
+    }
+    catch (Exception e) {
+      fail("Model was not parsable");
+    }
+
+    tool.createSymbolTable(ast);
+    tool.completeSymbolTable(ast);
+    tool.finalizeSymbolTable(ast);
+
+    var checker = new SysMLv2CoCoChecker();
+    checker.addCoCo(new EventTransitionRequiresAccept());
+    checker.checkAll(ast);
+  }
+
+  String valid = "part def TestWithAccept {\n"
+      + "  port input: Booleans;\n"
+      + "  port output: ~Booleans;\n"
+      + "\n"
+      + "  exhibit state behavior {\n"
+      + "    entry;\n"
+      + "      then S;\n"
+      + "\n"
+      + "    state S;\n"
+      + "\n"
+      + "    transition\n"
+      + "      first S\n"
+      + "      accept input.val\n"
+      + "      if input.val == true\n"
+      + "      do action {\n"
+      + "        send false to output.val;\n"
+      + "      }\n"
+      + "      then S;\n"
+      + "  }\n"
+      + "}";
+
+  String invalid = "part def TestWithoutAccept {\n"
+        + "  port input: Booleans;\n"
+        + "\n"
+        + "  exhibit state behavior {\n"
+        + "    entry; then S;\n"
+        + "\n"
+        + "    state S;\n"
+        + "\n"
+        + "    transition ok\n"
+        + "      first S\n"
+        + "      accept input.val\n"
+        + "      then S;\n"
+        + "\n"
+        + "    transition bad\n"
+        + "      first S\n"
+        + "      then S;\n"
+        + "  }\n"
+        + "}";
+
+}