Merge branch 'release/3.5.0'

.github/workflows/codeql-analysis.yml

@@ -42,7 +42,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -53,7 +53,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -67,4 +67,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

README.md

@@ -31,6 +31,7 @@ This open source plugin can be used to analyze the ESQL-sourcecode of IBM App Co
 
 ## History
 
+- 3.5.0 - Parsing of COMMIT and ROLLBACK statements and rules for them
 - 3.4.0 - New coverage format, bugfixes, Sonar 9.4
 - 3.3.0 - Upgrade to SonarQube 8.9
 - 3.0.0 - Bugfixes, upgrade to sonar SonarQube 7.9

esql-checks/src/main/java/com/exxeta/iss/sonar/esql/check/CheckList.java

@@ -53,6 +53,7 @@ public static List<Class<?>> getChecks() {
             CommentRegularExpressionCheck.class,
             CommentedCodeCheck.class,
             CommentsCheck.class,
+            CommitCheck.class,
             ConditionParenthesisCheck.class,
             CyclomaticComplexityCheck.class,
             DeclareCombineCheck.class,
@@ -91,6 +92,7 @@ public static List<Class<?>> getChecks() {
             PropagateConsistencyCheck.class,
             PropagateToLabelCheck.class,
             RecursionCheck.class,
+            RollbackCheck.class,
             RoutineCommentsCheck.class,
             RoutineWithExcessiveReturnsCheck.class,
             SelectAllCheck.class,

esql-checks/src/main/java/com/exxeta/iss/sonar/esql/check/CommitCheck.java

@@ -0,0 +1,33 @@
+/*
+ * Sonar ESQL Plugin
+ * Copyright (C) 2013-2023 Thomas Pohl and EXXETA AG
+ * http://www.exxeta.com
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.exxeta.iss.sonar.esql.check;
+
+import com.exxeta.iss.sonar.esql.api.visitors.DoubleDispatchVisitorCheck;
+import com.exxeta.iss.sonar.esql.tree.impl.statement.CommitStatementTreeImpl;
+import org.sonar.check.Rule;
+
+@Rule(key="Commit")
+public class CommitCheck extends DoubleDispatchVisitorCheck {
+
+	public static final String MESSAGE = "COMMIT should not be called explicitly. Otherwise the messageflow can't handle the transaction.";
+	@Override
+	public void visitCommitStatement(CommitStatementTreeImpl tree) {
+		addIssue(tree.commitKeyword(), MESSAGE);
+		super.visitCommitStatement(tree);
+	}
+}

esql-checks/src/main/java/com/exxeta/iss/sonar/esql/check/RollbackCheck.java

@@ -0,0 +1,33 @@
+/*
+ * Sonar ESQL Plugin
+ * Copyright (C) 2013-2023 Thomas Pohl and EXXETA AG
+ * http://www.exxeta.com
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.exxeta.iss.sonar.esql.check;
+
+import com.exxeta.iss.sonar.esql.api.visitors.DoubleDispatchVisitorCheck;
+import com.exxeta.iss.sonar.esql.tree.impl.statement.RollbackStatementTreeImpl;
+import org.sonar.check.Rule;
+
+@Rule(key="Rollback")
+public class RollbackCheck extends DoubleDispatchVisitorCheck {
+
+	public static final String MESSAGE = "ROLLBACK should not be called explicitly. Otherwise the messageflow can't handle the transaction.";
+	@Override
+	public void visitRollbackStatement(RollbackStatementTreeImpl tree) {
+		addIssue(tree.rollbackKeyword(), MESSAGE);
+		super.visitRollbackStatement(tree);
+	}
+}

esql-checks/src/main/resources/org/sonar/l10n/esql/rules/esql/Commit.html

@@ -0,0 +1,6 @@
+<p>Avoid using the COMMIT statement in ESQL code, as it can undermine the transaction
+    handling mechanism of the message flow.  Instead, consider restructuring the flow
+    to handle smaller transactions or committing all changes at once. This approach
+    helps ensure that the transaction handling mechanism operates correctly and reliably,
+    without risking unexpected behavior or data loss. By avoiding the use of COMMIT statements,
+    you can help maintain the integrity and consistency of the message flow's data.</p>

esql-checks/src/main/resources/org/sonar/l10n/esql/rules/esql/Commit.json

@@ -0,0 +1,13 @@
+{
+  "title": "COMMIT should not be used.",
+  "type": "CODE_SMELL",
+  "status": "ready",
+  "remediation": {
+    "func": "Constant\/Issue",
+    "constantCost": "20min"
+  },
+  "tags": [
+    "bad-practice"
+  ],
+  "defaultSeverity": "Major"
+}

esql-checks/src/main/resources/org/sonar/l10n/esql/rules/esql/Rollback.html

@@ -0,0 +1,5 @@
+<p>Avoid using the ROLLBACK statement in ESQL code, as it can undermine the transaction
+    handling mechanism of the message flow. Instead, consider using the THROW statement to
+    raise an exception and trigger a rollback of the entire message flow. This approach helps
+    ensure that the transaction handling mechanism operates correctly and reliably, without
+    risking unexpected behavior or data loss.</p>

esql-checks/src/main/resources/org/sonar/l10n/esql/rules/esql/Rollback.json

@@ -0,0 +1,13 @@
+{
+  "title": "ROLLBACK should not be used.",
+  "type": "CODE_SMELL",
+  "status": "ready",
+  "remediation": {
+    "func": "Constant\/Issue",
+    "constantCost": "20min"
+  },
+  "tags": [
+    "bad-practice"
+  ],
+  "defaultSeverity": "Major"
+}

esql-checks/src/main/resources/org/sonar/l10n/esql/rules/esql/Sonar_way_profile.json

@@ -10,6 +10,7 @@
     "CaseWithoutElse",
     "CommentedCode",
     "Comments",
+    "Commit",
     "CyclomaticComplexity",
     "DeleteFromWithoutWhere",
     "DeprecatedMethod",
@@ -40,6 +41,7 @@
     "OneStatementPerLine",
     "ParameterWithDirection",
     "PassThruStatement",
+    "Rollback",
     "PropagateConsistency",
     "PropagateToLabel",
     "RoutineWithExcessiveReturns",

esql-checks/src/test/java/com/exxeta/iss/sonar/esql/check/CommitCheckTest.java

@@ -0,0 +1,16 @@
+package com.exxeta.iss.sonar.esql.check;
+
+import com.exxeta.iss.sonar.esql.checks.verifier.EsqlCheckVerifier;
+import java.io.File;
+import org.junit.jupiter.api.Test;
+
+class CommitCheckTest {
+
+    @Test
+    void test() {
+
+        EsqlCheckVerifier.issues(new RollbackCheck(), new File("src/test/resources/commitRollback.esql"))
+            .next().atLine(5).withMessage("ROLLBACK should not be called explicitly. Otherwise the messageflow can't handle the transaction.")
+            .noMore();
+    }
+}

esql-checks/src/test/java/com/exxeta/iss/sonar/esql/check/RollbackCheckTest.java

@@ -0,0 +1,16 @@
+package com.exxeta.iss.sonar.esql.check;
+
+import com.exxeta.iss.sonar.esql.checks.verifier.EsqlCheckVerifier;
+import java.io.File;
+import org.junit.jupiter.api.Test;
+
+class RollbackCheckTest {
+
+    @Test
+    void test() {
+
+        EsqlCheckVerifier.issues(new CommitCheck(), new File("src/test/resources/commitRollback.esql"))
+            .next().atLine(6).withMessage("COMMIT should not be called explicitly. Otherwise the messageflow can't handle the transaction.")
+            .noMore();
+    }
+}

esql-checks/src/test/resources/commitRollback.esql

@@ -0,0 +1,9 @@
+CREATE COMPUTE MODULE CommitRollback
+
+	CREATE FUNCTION Main() RETURNS BOOLEAN
+	BEGIN
+		ROLLBACK;
+		COMMIT;
+	END;
+
+END MODULE;

esql-frontend/src/main/java/com/exxeta/iss/sonar/esql/api/EsqlNonReservedKeyword.java

@@ -43,6 +43,7 @@ public enum EsqlNonReservedKeyword implements TokenType, GrammarRuleKey {
 	CHAR("CHAR"),
 	CHARACTER("CHARACTER"),
 	CLR("CLR"),
+	COMMIT("COMMIT"),
 	COMPUTE("COMPUTE"),
 	CONDITION("CONDITION"),
 	CONSTANT("CONSTANT"),
@@ -170,6 +171,7 @@ public enum EsqlNonReservedKeyword implements TokenType, GrammarRuleKey {
 	RESULT("RESULT"),
 	RETURN("RETURN"),
 	RETURNS("RETURNS"),
+	ROLLBACK("ROLLBACK"),
 	ROW("ROW"),
 	SAMEFIELD("SAMEFIELD"),
 	SCHEMA("SCHEMA"),

esql-frontend/src/main/java/com/exxeta/iss/sonar/esql/api/tree/Tree.java

@@ -17,6 +17,8 @@
  */
 package com.exxeta.iss.sonar.esql.api.tree;
 
+import com.exxeta.iss.sonar.esql.tree.impl.statement.CommitStatementTreeImpl;
+import com.exxeta.iss.sonar.esql.tree.impl.statement.RollbackStatementTreeImpl;
 import java.util.stream.Stream;
 
 import com.exxeta.iss.sonar.esql.api.tree.statement.JavaClassloaderServiceTree;
@@ -266,7 +268,9 @@ public enum Kind implements GrammarRuleKey, Kinds {
 		VARIABLE_REFERENCE(VariableReferenceTree.class), 
 		LIST_CONSTRUCTOR_FUNCTION(ListConstructorFunctionTree.class),
 		NULLABLE(NullableTree.class),
-		JAVA_CLASSLOADER_SERVICE(JavaClassloaderServiceTree.class);
+		JAVA_CLASSLOADER_SERVICE(JavaClassloaderServiceTree.class),
+		ROLLBACK_STATEMENT(RollbackStatementTreeImpl.class),
+		COMMIT_STATEMENT(CommitStatementTreeImpl.class);
 
 		final Class<? extends Tree> associatedInterface;
 

esql-frontend/src/main/java/com/exxeta/iss/sonar/esql/api/tree/statement/CommitStatementTree.java

@@ -0,0 +1,28 @@
+/*
+ * Sonar ESQL Plugin
+ * Copyright (C) 2013-2023 Thomas Pohl and EXXETA AG
+ * http://www.exxeta.com
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.exxeta.iss.sonar.esql.api.tree.statement;
+
+import com.exxeta.iss.sonar.esql.api.tree.FieldReferenceTree;
+import com.exxeta.iss.sonar.esql.api.tree.lexical.SyntaxToken;
+
+public interface CommitStatementTree extends StatementTree{
+
+	SyntaxToken commitKeyword();
+	FieldReferenceTree databaseReference();
+	SyntaxToken semi();
+}

esql-frontend/src/main/java/com/exxeta/iss/sonar/esql/api/tree/statement/RollbackStatementTree.java

@@ -0,0 +1,28 @@
+/*
+ * Sonar ESQL Plugin
+ * Copyright (C) 2013-2023 Thomas Pohl and EXXETA AG
+ * http://www.exxeta.com
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.exxeta.iss.sonar.esql.api.tree.statement;
+
+import com.exxeta.iss.sonar.esql.api.tree.FieldReferenceTree;
+import com.exxeta.iss.sonar.esql.api.tree.lexical.SyntaxToken;
+
+public interface RollbackStatementTree extends StatementTree{
+
+	SyntaxToken rollbackKeyword();
+	FieldReferenceTree databaseReference();
+	SyntaxToken semi();
+}

esql-frontend/src/main/java/com/exxeta/iss/sonar/esql/api/visitors/DoubleDispatchVisitor.java

@@ -17,6 +17,8 @@
  */
 package com.exxeta.iss.sonar.esql.api.visitors;
 
+import com.exxeta.iss.sonar.esql.tree.impl.statement.CommitStatementTreeImpl;
+import com.exxeta.iss.sonar.esql.tree.impl.statement.RollbackStatementTreeImpl;
 import java.util.Iterator;
 import java.util.List;
 
@@ -606,4 +608,10 @@ public void javaClassloaderService(JavaClassloaderServiceTree tree){
 		scanChildren(tree);
 	}
 
+	public void visitRollbackStatement(RollbackStatementTreeImpl tree) {
+		scanChildren(tree);
+	}
+	public void visitCommitStatement(CommitStatementTreeImpl tree) {
+		scanChildren(tree);
+	}
 }

esql-frontend/src/main/java/com/exxeta/iss/sonar/esql/parser/EsqlGrammar.java

@@ -93,6 +93,7 @@
 import com.exxeta.iss.sonar.esql.tree.impl.statement.BeginEndStatementTreeImpl;
 import com.exxeta.iss.sonar.esql.tree.impl.statement.CallStatementTreeImpl;
 import com.exxeta.iss.sonar.esql.tree.impl.statement.CaseStatementTreeImpl;
+import com.exxeta.iss.sonar.esql.tree.impl.statement.CommitStatementTreeImpl;
 import com.exxeta.iss.sonar.esql.tree.impl.statement.ControlsTreeImpl;
 import com.exxeta.iss.sonar.esql.tree.impl.statement.CreateFunctionStatementTreeImpl;
 import com.exxeta.iss.sonar.esql.tree.impl.statement.CreateModuleStatementTreeImpl;
@@ -131,6 +132,7 @@
 import com.exxeta.iss.sonar.esql.tree.impl.statement.ResultSetTreeImpl;
 import com.exxeta.iss.sonar.esql.tree.impl.statement.ReturnStatementTreeImpl;
 import com.exxeta.iss.sonar.esql.tree.impl.statement.ReturnTypeTreeImpl;
+import com.exxeta.iss.sonar.esql.tree.impl.statement.RollbackStatementTreeImpl;
 import com.exxeta.iss.sonar.esql.tree.impl.statement.RoutineBodyTreeImpl;
 import com.exxeta.iss.sonar.esql.tree.impl.statement.SetColumnTreeImpl;
 import com.exxeta.iss.sonar.esql.tree.impl.statement.SetStatementTreeImpl;
@@ -453,7 +455,7 @@ private StatementTree OTHER_STATEMENT() {
 	}
 
 	private StatementTree DATABASE_UPDATE_STATEMENT() {
-		return b.firstOf(DELETE_FROM_STATEMENT(), INSERT_STATEMENT(), PASSTHRU_STATEMENT(), UPDATE_STATEMENT());
+		return b.firstOf(COMMIT_STATEMENT(), DELETE_FROM_STATEMENT(), INSERT_STATEMENT(), PASSTHRU_STATEMENT(), ROLLBACK_STATEMENT(), UPDATE_STATEMENT());
 	}
 
 	private StatementTree NODE_INTERACTION_STATEMENT() {
@@ -1097,7 +1099,15 @@ public NameClausesTreeImpl NAME_CLAUSES(){
 				)
 		));
 	}
-
+
+	public CommitStatementTreeImpl COMMIT_STATEMENT(){
+		return b.<CommitStatementTreeImpl>nonterminal(Kind.COMMIT_STATEMENT).is (f.commitStatement(
+			b.token(EsqlNonReservedKeyword.COMMIT),b.optional(FIELD_REFERENCE()),
+			b.token(EsqlLegacyGrammar.EOS)
+		));
+	}
+
+
 	public DeleteFromStatementTreeImpl DELETE_FROM_STATEMENT(){
 		return b.<DeleteFromStatementTreeImpl>nonterminal(Kind.DELETE_FROM_STATEMENT).is (f.deleteFromStatement(
 				b.token(EsqlNonReservedKeyword.DELETE),b.token(EsqlReservedKeyword.FROM),FIELD_REFERENCE(),
@@ -1125,7 +1135,13 @@ public PassthruStatementTreeImpl PASSTHRU_STATEMENT(){
 				)), b.token(EsqlLegacyGrammar.EOS)
 		));
 	}
-
+
+	public RollbackStatementTreeImpl ROLLBACK_STATEMENT(){
+		return b.<RollbackStatementTreeImpl>nonterminal(Kind.ROLLBACK_STATEMENT).is (f.rollbackStatement(
+			b.token(EsqlNonReservedKeyword.ROLLBACK),b.optional(FIELD_REFERENCE()),
+			b.token(EsqlLegacyGrammar.EOS)
+		));
+	}
 	public UpdateStatementTreeImpl UPDATE_STATEMENT(){
 		return b.<UpdateStatementTreeImpl>nonterminal(Kind.UPDATE_STATEMENT).is(f.updateStatement(
 				b.token(EsqlNonReservedKeyword.UPDATE),