Add fail option for regex extractor

src/components/src/main/java/org/apache/jmeter/extractor/RegexExtractor.java

@@ -25,6 +25,7 @@
 import java.util.regex.PatternSyntaxException;
 
 import org.apache.commons.text.StringEscapeUtils;
+import org.apache.jmeter.assertions.AssertionResult;
 import org.apache.jmeter.processor.PostProcessor;
 import org.apache.jmeter.samplers.SampleResult;
 import org.apache.jmeter.testelement.AbstractScopedTestElement;
@@ -71,6 +72,8 @@ public class RegexExtractor extends AbstractScopedTestElement implements PostPro
 
     private static final String UNDERSCORE = "_";  // $NON-NLS-1$
 
+    private static final String FAILIFNOTFOUND = "RegexExtractor.fail_if_not_found";
+
     private static final boolean USE_JAVA_REGEX = !JMeterUtils.getPropDefault(
             "jmeter.regex.engine", "oro").equalsIgnoreCase("oro");
 
@@ -126,6 +129,9 @@ private void extractWithOroRegex(SampleResult previousResult, JMeterVariables va
         try {
             pattern = JMeterUtils.getPatternCache().getPattern(regex, Perl5Compiler.READ_ONLY_MASK);
             List<MatchResult> matches = processMatches(pattern, regex, previousResult, matchNumber, vars);
+            if(matches.isEmpty() && isFailIfNotFound()){
+                failResult(previousResult);
+            }
             int prevCount = 0;
             String prevString = vars.get(refName + REF_MATCH_NR);
             if (prevString != null) {
@@ -184,6 +190,9 @@ private void extractWithJavaRegex(SampleResult previousResult, JMeterVariables v
         try {
             pattern = JMeterUtils.compilePattern(regex);
             List<java.util.regex.MatchResult> matches = processMatches(pattern, previousResult, matchNumber, vars);
+            if(matches.isEmpty() && isFailIfNotFound()){
+                failResult(previousResult);
+            }
             int prevCount = 0;
             String prevString = vars.get(refName + REF_MATCH_NR);
             if (prevString != null) {
@@ -234,6 +243,22 @@ private void extractWithJavaRegex(SampleResult previousResult, JMeterVariables v
         }
     }
 
+    private void failResult(SampleResult previousResult){
+        AssertionResult res = new AssertionResult(getName());
+        res.setFailure(true);
+        String sourceDescription = useUrl() ? "URL"
+                : useHeaders() ? "response headers"
+                : useRequestHeaders() ? "request headers"
+                : useCode() ? "response code"
+                : useMessage() ? "response message"
+                : useUnescapedBody() ? "unescaped body"
+                : useBodyAsDocument() ? "document"
+                : "body";  // Covers both empty and USE_BODY cases
+        res.setFailureMessage("Pattern not found in " + sourceDescription + " - " + getRegex());
+        previousResult.addAssertionResult(res);
+        previousResult.setSuccessful(false);
+    }
+
     private String getInputString(SampleResult result) {
         String inputString = useUrl() ? result.getUrlAsString() // Bug 39707
                 : useHeaders() ? result.getResponseHeaders()
@@ -688,4 +713,14 @@ public boolean useMessage() {
     public void setUseField(String actionCommand) {
         set(getSchema().getMatchTarget(), actionCommand);
     }
+
+    public void setFailIfNotFound(Boolean isFailing){
+        log.warn("Setting fail as " + isFailing);
+        setProperty(FAILIFNOTFOUND, isFailing);
+    }
+
+    public boolean isFailIfNotFound(){
+        return getPropertyAsBoolean(FAILIFNOTFOUND);
+    }
+
 }

src/components/src/main/java/org/apache/jmeter/extractor/gui/RegexExtractorGui.java

@@ -27,6 +27,7 @@
 import javax.swing.ButtonGroup;
 import javax.swing.JCheckBox;
 import javax.swing.JComponent;
+import javax.swing.JLabel;
 import javax.swing.JPanel;
 import javax.swing.JRadioButton;
 
@@ -52,6 +53,7 @@ public class RegexExtractorGui extends AbstractPostProcessorGui {
     private JLabeledTextField defaultField;
     private JLabeledTextField matchNumberField;
     private JLabeledTextField refNameField;
+    private JLabel failResultField;
     private JRadioButton useBody;
     private JRadioButton useUnescapedBody;
     private JRadioButton useBodyAsDocument;
@@ -62,6 +64,7 @@ public class RegexExtractorGui extends AbstractPostProcessorGui {
     private JRadioButton useMessage;
     private ButtonGroup group;
     private JCheckBox emptyDefaultValue;
+    private JCheckBox failResult;
 
     public RegexExtractorGui() {
         super();
@@ -93,6 +96,7 @@ public void configure(TestElement el) {
             emptyDefaultValue.setSelected(re.isEmptyDefaultValue());
             matchNumberField.setText(re.getMatchNumberAsString());
             refNameField.setText(re.getRefName());
+            failResult.setSelected(re.isFailIfNotFound());
         }
     }
 
@@ -124,6 +128,7 @@ public void modifyTestElement(TestElement extractor) {
             regex.setDefaultValue(defaultField.getText());
             regex.setDefaultEmptyValue(emptyDefaultValue.isSelected());
             regex.setMatchNumber(matchNumberField.getText());
+            regex.setFailIfNotFound(failResult.isSelected());
         }
     }
 
@@ -142,6 +147,7 @@ public void clearGui() {
         emptyDefaultValue.setSelected(false);
         refNameField.setText(""); //$NON-NLS-1$
         matchNumberField.setText(""); //$NON-NLS-1$
+        failResult.setSelected(false);
     }
 
     private void init() { // WARNING: called from ctor so must not be overridden (i.e. must be private or final)
@@ -208,6 +214,8 @@ private JPanel makeParameterPanel() {
         templateField = new JLabeledTextField(JMeterUtils.getResString("template_field")); //$NON-NLS-1$
         refNameField = new JLabeledTextField(JMeterUtils.getResString("ref_name_field")); //$NON-NLS-1$
         matchNumberField = new JLabeledTextField(JMeterUtils.getResString("match_num_field")); //$NON-NLS-1$
+        failResultField = new JLabel(JMeterUtils.getResString("fail_if_not_matched_field"));
+        failResult = new JCheckBox();
 
         JPanel panel = new JPanel(new GridBagLayout());
         GridBagConstraints gbc = new GridBagConstraints();
@@ -220,6 +228,8 @@ private JPanel makeParameterPanel() {
         resetContraints(gbc);
         addField(panel, matchNumberField, gbc);
         resetContraints(gbc);
+        addField(panel, failResultField, failResult, gbc);
+        resetContraints(gbc);
         gbc.weighty = 1;
 
         defaultField = new JLabeledTextField(JMeterUtils.getResString("default_value_field")); //$NON-NLS-1$
@@ -253,6 +263,14 @@ private static void addField(JPanel panel, JLabeledTextField field, GridBagConst
         panel.add(item.get(1), gbc.clone());
     }
 
+    private static void addField(JPanel panel, JLabel label, JCheckBox checkBox, GridBagConstraints gbc) {
+        panel.add(label, gbc.clone());
+        gbc.gridx++;
+        gbc.weightx = 1;
+        gbc.fill = GridBagConstraints.HORIZONTAL;
+        panel.add(checkBox, gbc.clone());
+    }
+
     // Next line
     private static void resetContraints(GridBagConstraints gbc) {
         gbc.gridx = 0;

src/components/src/test/java/org/apache/jmeter/extractor/TestRegexExtractor.java

@@ -50,6 +50,7 @@ public void setUp() {
         extractor.setThreadContext(jmctx);
         extractor.setRefName("regVal");
         result = new SampleResult();
+        result.setSuccessful(true);
         String data = "<company-xmlext-query-ret><row><value field=\"RetCode\">LIS_OK</value>\n" +
                 "<value field=\"RetCodeExtension\"></value><value field=\"alias\"></value>\n" +
                 "<value field=\"positioncount\"></value><value field=\"invalidpincount\">0</value>\n" +
@@ -480,4 +481,100 @@ public void testScope2() {
         final String found = vars.get("regVal");
         assertTrue(found.equals("ONE") || found.equals("TWO"));
     }
+
+    @Test
+    public void testFailIfNotFound() {
+        extractor.setRegex("notfound");
+        extractor.setTemplate("$1$");
+        extractor.setMatchNumber(1);
+        extractor.setFailIfNotFound(true);
+        extractor.process();
+        assertFalse(result.isSuccessful(), "Result should be marked as failed");
+        assertEquals(1, result.getAssertionResults().length, "Should have one assertion result");
+        assertEquals("Pattern not found in body - notfound",
+                result.getAssertionResults()[0].getFailureMessage(),
+                "Should have correct failure message with source");
+    }
+
+    @Test
+    public void testFailIfNotFoundWhenFound() {
+        extractor.setRegex("<value field=\"RetCode\">([^<]+)</value>");
+        extractor.setTemplate("$1$");
+        extractor.setMatchNumber(1);
+        extractor.setFailIfNotFound(true);
+        extractor.process();
+        assertTrue(result.isSuccessful(), "Result should remain successful when pattern is found");
+        assertEquals(0, result.getAssertionResults().length, "Should have no assertion results");
+    }
+
+    @Test
+    public void testNotFailIfNotFoundWhenNotFound() {
+        extractor.setRegex("notfound");
+        extractor.setTemplate("$1$");
+        extractor.setMatchNumber(1);
+        extractor.setFailIfNotFound(false);
+        extractor.process();
+        assertTrue(result.isSuccessful(), "Result should remain successful when failIfNotFound is false");
+        assertEquals(0, result.getAssertionResults().length, "Should have no assertion results");
+    }
+
+    @Test
+    public void testFailIfNotFoundWithMatchAll() {
+        extractor.setRegex("notfound");
+        extractor.setTemplate("$1$");
+        extractor.setMatchNumber(-1);
+        extractor.setFailIfNotFound(true);
+        extractor.process();
+        assertFalse(result.isSuccessful(), "Result should be marked as failed");
+        assertEquals("0", vars.get("regVal_matchNr"), "matchNr should be 0 when no matches found");
+        assertEquals(1, result.getAssertionResults().length, "Should have one assertion result");
+    }
+
+    @Test
+    public void testFailIfNotFoundWithRandomMatch() {
+        extractor.setRegex("notfound");
+        extractor.setTemplate("$1$");
+        extractor.setMatchNumber(0);
+        extractor.setFailIfNotFound(true);
+        extractor.process();
+        assertFalse(result.isSuccessful(), "Result should be marked as failed");
+        assertNull(vars.get("regVal_matchNr"), "matchNr should not be set for random match mode");
+    }
+
+    @Test
+    public void testFailIfNotFoundWithDifferentSources() {
+        extractor.setUseField(RegexExtractor.USE_HDRS); // Headers
+        extractor.setRegex("notfound");
+        extractor.setFailIfNotFound(true);
+        extractor.process();
+        assertEquals("Pattern not found in response headers - notfound",
+                result.getAssertionResults()[0].getFailureMessage());
+
+        result = new SampleResult(); // Reset result
+        result.setSuccessful(true);
+        jmctx.setPreviousResult(result);
+        extractor.setUseField(RegexExtractor.USE_URL); // URL
+        extractor.process();
+        assertEquals("Pattern not found in URL - notfound",
+                result.getAssertionResults()[0].getFailureMessage());
+
+        result = new SampleResult();
+        result.setSuccessful(true);
+        jmctx.setPreviousResult(result);
+        extractor.setUseField(RegexExtractor.USE_CODE); // Response code
+        extractor.process();
+        assertEquals("Pattern not found in response code - notfound",
+                result.getAssertionResults()[0].getFailureMessage());
+    }
+
+    @Test
+    public void testFailIfNotFoundWithEmptyResponse() {
+        result.setResponseData("", null);
+        extractor.setRegex("something");
+        extractor.setFailIfNotFound(true);
+        extractor.process();
+        assertFalse(result.isSuccessful(), "Result should be marked as failed");
+        assertEquals("Pattern not found in body - something",
+                result.getAssertionResults()[0].getFailureMessage());
+    }
 }

src/core/src/main/resources/org/apache/jmeter/resources/messages.properties

@@ -347,6 +347,7 @@ export_transactions_menu=Export transactions for report
 export_transactions_names_action=Export transactions for report
 export_transactions_title=Export Transactions Result
 expression_field=CSS Selector expression\:
+fail_if_not_matched_field=Fail if not matched
 field_name=Field name
 file=File
 file_already_in_use=That file is already in use