feat: CICS SOAPFAULT improvements (#2589)

mm-broadcom · web-flow · commit 1f308b23f8ce · 2025-01-16T16:55:33.000+01:00
diff --git a/server/engine/src/main/antlr4/org/eclipse/lsp/cobol/implicitDialects/cics/CICSParser.g4 b/server/engine/src/main/antlr4/org/eclipse/lsp/cobol/implicitDialects/cics/CICSParser.g4
@@ -783,17 +783,11 @@ cics_signon_token_body: ((KERBEROS | BIT | BASE64) | (TOKENLEN | GROUPID | LANGU
                     (TOKEN | LANGINUSE | NATLANGINUSE | ESMREASON | ESMRESP) cics_data_area | (TOKENTYPE | DATATYPE) cics_cvda | cics_handle_response)+;
 
 /** SOAPFAULT ADD / CREATE / DELETE */
-cics_soapfault: SOAPFAULT (cics_soapfault_add | cics_soapfault_create | DELETE);
-cics_soapfault_add: ADD (cics_soapfault_faultstring | cics_soapfault_subcodestr | FROMCCSID cics_data_value | cics_handle_response)+;
-cics_soapfault_faultstring: (FAULTSTRING cics_data_value | FAULTSTRLEN cics_data_value | NATLANG cics_data_value)+;
-cics_soapfault_subcodestr: (SUBCODESTR cics_data_value | SUBCODELEN cics_data_value)+;
-cics_soapfault_create: CREATE (FAULTCODE cics_cvda | CLIENT | SERVER | SENDER | RECEIVER | cics_soapfault_faultcodestr |
-                       cics_soapfault_faultstring | cics_soapfault_role | cics_soapfault_faultactor |
-                       cics_soapfault_detail | FROMCCSID cics_data_value | cics_handle_response)+;
-cics_soapfault_faultcodestr: (FAULTCODESTR cics_data_value | FAULTCODELEN cics_data_value)+;
-cics_soapfault_role: (ROLE cics_data_value | ROLELENGTH cics_data_value)+;
-cics_soapfault_faultactor: (FAULTACTOR cics_data_value | FAULTACTLEN cics_data_value)+;
-cics_soapfault_detail: (DETAIL cics_data_value | DETAILLENGTH cics_data_value)+;
+cics_soapfault: SOAPFAULT (cics_soapfault_add | cics_soapfault_create | cics_soapfault_delete);
+cics_soapfault_add: ADD ((FAULTSTRING | FAULTSTRLEN |NATLANG | SUBCODESTR | SUBCODELEN | FROMCCSID) cics_data_value | cics_handle_response)+;
+cics_soapfault_create: CREATE ((CLIENT | SERVER | SENDER | RECEIVER) | (FAULTCODESTR | FAULTCODELEN | FAULTSTRING | FAULTSTRLEN | NATLANG | ROLE | ROLELENGTH | FAULTACTOR | FAULTACTLEN | DETAIL | DETAILLENGTH | FROMCCSID) cics_data_value
+                        | (FAULTCODE) cics_cvda | cics_handle_response)+;
+cics_soapfault_delete: (DELETE | cics_handle_response)+;
 
 /** SPOOLCLOSE */
 cics_spoolclose: SPOOLCLOSE cics_spoolclose_options;
diff --git a/server/engine/src/main/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSOptionsCheckUtility.java b/server/engine/src/main/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSOptionsCheckUtility.java
@@ -276,6 +276,9 @@ public CICSOptionsCheckUtility(DialectProcessingContext context, List<SyntaxErro
     optionsMap.put(
         CICSPutContainerOptionsCheckUtility.RULE_INDEX,
         new CICSPutContainerOptionsCheckUtility(context, errors));
+    optionsMap.put(
+        CICSSoapfaultOptionsCheckUtility.RULE_INDEX,
+        new CICSSoapfaultOptionsCheckUtility(context, errors));
     spOptionsMap.put(
         CICSInquireSPOptionsCheckUtility.RULE_INDEX,
         new CICSInquireSPOptionsCheckUtility(context, errors));
diff --git a/server/engine/src/main/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSSoapfaultOptionsCheckUtility.java b/server/engine/src/main/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSSoapfaultOptionsCheckUtility.java
@@ -0,0 +1,117 @@
+/*
+ * Copyright (c) 2024 Broadcom.
+ * The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *    Broadcom, Inc. - initial API and implementation
+ *
+ */
+package org.eclipse.lsp.cobol.implicitDialects.cics.utility;
+
+import org.antlr.v4.runtime.ParserRuleContext;
+import org.eclipse.lsp.cobol.common.dialects.DialectProcessingContext;
+import org.eclipse.lsp.cobol.common.error.ErrorSeverity;
+import org.eclipse.lsp.cobol.common.error.SyntaxError;
+import org.eclipse.lsp.cobol.implicitDialects.cics.CICSLexer;
+import org.eclipse.lsp.cobol.implicitDialects.cics.CICSParser;
+
+import java.util.*;
+
+import static org.eclipse.lsp.cobol.implicitDialects.cics.CICSParser.*;
+
+/** Checks CICS SOAPFAULT rules for required and invalid options */
+public class CICSSoapfaultOptionsCheckUtility extends CICSOptionsCheckBaseUtility {
+
+    public static final int RULE_INDEX = RULE_cics_soapfault;
+
+    private static final Map<Integer, ErrorSeverity> DUPLICATE_CHECK_OPTIONS =
+            new HashMap<Integer, ErrorSeverity>() {
+                {
+                    put(CICSLexer.FAULTCODE, ErrorSeverity.ERROR);
+                    put(CICSLexer.CLIENT, ErrorSeverity.ERROR);
+                    put(CICSLexer.SERVER, ErrorSeverity.ERROR);
+                    put(CICSLexer.SENDER, ErrorSeverity.ERROR);
+                    put(CICSLexer.RECEIVER, ErrorSeverity.ERROR);
+                    put(CICSLexer.FAULTCODESTR, ErrorSeverity.ERROR);
+                    put(CICSLexer.FAULTCODELEN, ErrorSeverity.ERROR);
+                    put(CICSLexer.FAULTSTRING, ErrorSeverity.ERROR);
+                    put(CICSLexer.FAULTSTRLEN, ErrorSeverity.ERROR);
+                    put(CICSLexer.NATLANG, ErrorSeverity.ERROR);
+                    put(CICSLexer.ROLE, ErrorSeverity.ERROR);
+                    put(CICSLexer.ROLELENGTH, ErrorSeverity.ERROR);
+                    put(CICSLexer.FAULTACTOR, ErrorSeverity.ERROR);
+                    put(CICSLexer.FAULTACTLEN, ErrorSeverity.ERROR);
+                    put(CICSLexer.DETAIL, ErrorSeverity.ERROR);
+                    put(CICSLexer.DETAILLENGTH, ErrorSeverity.ERROR);
+                    put(CICSLexer.FROMCCSID, ErrorSeverity.ERROR);
+
+                    put(CICSLexer.DELETE, ErrorSeverity.WARNING);
+                    put(CICSLexer.CREATE, ErrorSeverity.WARNING);
+                    put(CICSLexer.ADD, ErrorSeverity.WARNING);
+                }
+            };
+
+    public CICSSoapfaultOptionsCheckUtility(DialectProcessingContext context, List<SyntaxError> errors) {
+        super(context, errors, DUPLICATE_CHECK_OPTIONS);
+    }
+
+    /**
+     * Entrypoint to check CICS SOAPFAULT CREATE rules for required and invalid options
+     * @param ctx ParserRuleContext subclass containing options
+     * @param <E> A subclass of ParserRuleContext
+     */
+    public <E extends ParserRuleContext> void checkOptions(E ctx) {
+        switch (ctx.getRuleIndex()) {
+            case RULE_cics_soapfault_create:
+                checkCreate((CICSParser.Cics_soapfault_createContext) ctx);
+                break;
+            case RULE_cics_soapfault_add:
+                checkAdd((CICSParser.Cics_soapfault_addContext) ctx);
+                break;
+            case RULE_cics_soapfault_delete:
+                checkDelete((CICSParser.Cics_soapfault_deleteContext) ctx);
+                break;
+            default:
+                break;
+        }
+
+        checkDuplicates(ctx);
+    }
+
+    private void checkCreate(CICSParser.Cics_soapfault_createContext ctx) {
+        checkHasExactlyOneOption("FAULTCODE, FAULTCODESTR, CLIENT, SERVER, SENDER or RECEIVER", ctx, ctx.FAULTCODE(), ctx.FAULTCODESTR(), ctx.CLIENT(), ctx.SERVER(), ctx.SENDER(), ctx.RECEIVER());
+
+        checkHasMandatoryOptions(ctx.FAULTSTRING(), ctx, "FAULTSTRING");
+
+        checkPrerequisiteIsMet(ctx.FAULTCODESTR(), ctx.FAULTCODELEN(), ctx, "FAULTCODELEN without FAULTCODESTR");
+
+        checkPrerequisiteIsMet(ctx.ROLE(), ctx.ROLELENGTH(), ctx, "ROLELENGTH without ROLE");
+
+        checkPrerequisiteIsMet(ctx.FAULTACTOR(), ctx.FAULTACTLEN(), ctx, "FAULTACTLEN without FAULTACTOR");
+
+        checkPrerequisiteIsMet(ctx.DETAIL(), ctx.DETAILLENGTH(), ctx, "DETAILLENGTH without DETAIL");
+
+        checkPrerequisiteIsMet(ctx.FAULTCODE(), ctx.FAULTCODELEN(), ctx, "FAULTCODELEN without FAULTCODE");
+
+        checkPrerequisiteIsMet(ctx.FAULTSTRING(), ctx.FAULTSTRLEN(), ctx, "FAULTSTRLEN without FAULTSTRING");
+    }
+
+    private void checkAdd(CICSParser.Cics_soapfault_addContext ctx) {
+        checkPrerequisiteIsMet(ctx.FAULTSTRING(), ctx.FAULTSTRLEN(), ctx, "FAULTSTRLEN without FAULTSTRING");
+
+        checkPrerequisiteIsMet(ctx.SUBCODESTR(), ctx.SUBCODELEN(), ctx, "SUBCODELEN without SUBCODESTR");
+
+        checkHasExactlyOneOption("FAULTSTRING or SUBCODESTR", ctx, ctx.FAULTSTRING(), ctx.SUBCODESTR());
+    }
+
+    private void checkDelete(CICSParser.Cics_soapfault_deleteContext ctx) {
+        checkHasMandatoryOptions(ctx.DELETE(), ctx, "DELETE");
+    }
+
+}
diff --git a/server/engine/src/test/java/org/eclipse/lsp/cobol/usecases/TestCICSSoapfaultStatement.java b/server/engine/src/test/java/org/eclipse/lsp/cobol/usecases/TestCICSSoapfaultStatement.java
@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) 2024 Broadcom.
+ * The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *    Broadcom, Inc. - initial API and implementation
+ *
+ */
+
+package org.eclipse.lsp.cobol.usecases;
+
+import org.eclipse.lsp.cobol.common.error.ErrorSource;
+import org.eclipse.lsp.cobol.usecases.common.CICSTestUtils;
+import org.eclipse.lsp4j.Diagnostic;
+import org.eclipse.lsp4j.DiagnosticSeverity;
+import org.eclipse.lsp4j.Range;
+import org.junit.jupiter.api.Test;
+
+import java.util.*;
+
+/**
+ * Test CICS WEB command. Documentation link: <a
+ * href="https://www.ibm.com/docs/en/cics-ts/6.x?topic=summary-receive-zos-communications-server-default">WEB
+ * Command</a>
+ *
+ * <p>This class tests all variations of the WEB command found in the link above.
+ */
+
+public class TestCICSSoapfaultStatement {
+    // Test Strings
+    private static final String SOAPFAULT_DELETE_VALID = "SOAPFAULT DELETE";
+
+    private static final String SOAPFAULT_ADD_1 = "SOAPFAULT ADD FAULTSTRING({$varOne}) FAULTSTRLEN({$varOne}) NATLANG({$varOne}) FROMCCSID({$varOne})";
+    private static final String SOAPFAULT_ADD_2 = "SOAPFAULT ADD FAULTSTRING({$varOne})";
+
+    private static final String SOAPFAULT_CREATE_1 = "SOAPFAULT CREATE FAULTCODE({$varOne}) FAULTSTRING({$varOne}) FAULTSTRLEN({$varOne}) NATLANG({$varOne}) ROLE({$varOne}) ROLELENGTH({$varOne}) FAULTACTOR({$varOne}) FAULTACTLEN({$varOne}) DETAIL({$varOne}) DETAILLENGTH({$varOne}) FROMCCSID({$varOne})";
+    private static final String SOAPFAULT_CREATE_2 = "SOAPFAULT CREATE CLIENT FAULTSTRING({$varOne})";
+
+    // Invalid Tests
+    private static final String SOAPFAULT_DELETE_INVALID = "SOAPFAULT DELETE {CLIENT|errorOne}";
+    private static final String SOAPFAULT_DELETE_INVALID_2 = "SOAPFAULT DELETE {DELETE|errorOne} NOHANDLE";
+    private static final String SOAPFAULT_ADD_INVALID = "SOAPFAULT ADD {FAULTSTRING|errorOne}({$varOne}) {SUBCODESTR|errorTwo}({$varOne})";
+    private static final String SOAPFAULT_CREATE_INVALID = "SOAPFAULT CREATE {CLIENT|errorOne} {FAULTCODESTR|errorTwo}({$varOne}) FAULTSTRING({$varOne})";
+
+    // Valid Test Cases
+    @Test
+    void testDelete() {
+        CICSTestUtils.noErrorTest(SOAPFAULT_DELETE_VALID);
+    }
+
+    @Test
+    void testAdd() {
+        CICSTestUtils.noErrorTest(SOAPFAULT_ADD_1);
+        CICSTestUtils.noErrorTest(SOAPFAULT_ADD_2);
+    }
+
+    @Test
+    void testCreate() {
+        CICSTestUtils.noErrorTest(SOAPFAULT_CREATE_1);
+        CICSTestUtils.noErrorTest(SOAPFAULT_CREATE_2);
+    }
+
+    // Invalid Tests
+    @Test
+    void testDeleteInvalid() {
+        HashMap<String, Diagnostic> expectedDiagnostics = new HashMap<>();
+        expectedDiagnostics.put("errorOne", new Diagnostic(new Range(), "Extraneous input CLIENT", DiagnosticSeverity.Error, ErrorSource.PARSING.getText()));
+        CICSTestUtils.errorTest(SOAPFAULT_DELETE_INVALID, expectedDiagnostics);
+    }
+
+    @Test
+    void testDeleteInvalid2() {
+        HashMap<String, Diagnostic> expectedDiagnostics = new HashMap<>();
+        expectedDiagnostics.put("errorOne", new Diagnostic(new Range(), "Excessive options provided for: DELETE", DiagnosticSeverity.Warning, ErrorSource.PARSING.getText()));
+        CICSTestUtils.errorTest(SOAPFAULT_DELETE_INVALID_2, expectedDiagnostics);
+    }
+
+    @Test
+    void testAddInvalid() {
+        HashMap<String, Diagnostic> expectedDiagnostics = new HashMap<>();
+        expectedDiagnostics.put("errorOne", new Diagnostic(new Range(), "Exactly one option required, options are mutually exclusive: FAULTSTRING or SUBCODESTR", DiagnosticSeverity.Error, ErrorSource.PARSING.getText()));
+        expectedDiagnostics.put("errorTwo", new Diagnostic(new Range(), "Exactly one option required, options are mutually exclusive: FAULTSTRING or SUBCODESTR", DiagnosticSeverity.Error, ErrorSource.PARSING.getText()));
+        CICSTestUtils.errorTest(SOAPFAULT_ADD_INVALID, expectedDiagnostics);
+    }
+
+    @Test
+    void testCreateInvalid() {
+        HashMap<String, Diagnostic> expectedDiagnostics = new HashMap<>();
+        expectedDiagnostics.put("errorOne", new Diagnostic(new Range(), "Exactly one option required, options are mutually exclusive: FAULTCODE, FAULTCODESTR, CLIENT, SERVER, SENDER or RECEIVER", DiagnosticSeverity.Error, ErrorSource.PARSING.getText()));
+        expectedDiagnostics.put("errorTwo", new Diagnostic(new Range(), "Exactly one option required, options are mutually exclusive: FAULTCODE, FAULTCODESTR, CLIENT, SERVER, SENDER or RECEIVER", DiagnosticSeverity.Error, ErrorSource.PARSING.getText()));
+        CICSTestUtils.errorTest(SOAPFAULT_CREATE_INVALID, expectedDiagnostics);
+    }
+}
