Add fail option for regex extractor #6256

jgaalen · 2024-03-22T16:02:20Z

Description

This change adds the option to automatically fail a sampler if a regular expression extraction can't find any matches.

Motivation and Context

This saves the need to add an assertion with a regex to be sure there are matches. This will either save doing the regex matching twice and/or improved the scripts by failing if the extraction fails rather fail later when there is no value

Based on this discussion. Thanks to @asfimport for initiating this and providing code

How Has This Been Tested?

I've tested this on HTTP Requests only with different types of matches (1: single extraction, 0: random and -1 to match multiple fields)

Screenshots (if appropriate):

Types of changes

New feature (non-breaking change which adds functionality)

Checklist:

My code follows the code style of this project.
I have updated the documentation accordingly.

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

vlsi · 2024-03-24T08:09:06Z

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

@@ -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();


Could you use JEditableCheckBox here?

emptyDefaultValue is also a JCheckBox(), so what would a JEditableCheckbox do better?

I'm using JLabel + JCheckBox here because it's nicer to have the label in the same row as the others and the checkbox in the column of the input fields

JEditableCheckbox would allow using ${..} expressions while JCheckBox, see #5944

I see, although the JEditableCheckbox is a nice feature to paramaterize scripts, I don't think it's a good usecase on this specific checkbox. I don't see a reason to parameterize a specific regex extractor. The other checkboxes on the Regex Extractor aren't an editable checkbox as well.
I can give it a try tho, If it doesn't help, it doesn't hurt

vlsi

Have you considered adding test case for the feature?

vlsi · 2024-03-24T08:09:32Z

src/core/src/testFixtures/java/org/apache/jmeter/junit/JMeterTestCase.java

@@ -41,7 +41,7 @@
 * {@code @Isolated}.
 */
 @Isolated
-public abstract class JMeterTestCase {
+public abstract class  JMeterTestCase {


Please refrain from making changes that are not a part of the PR

Sorry, somehow it was updated by a plugin I guess and didn't bothered fixing it. Will undo this

vlsi · 2024-03-24T08:09:39Z

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

@@ -57,7 +58,7 @@ public class RegexExtractor extends AbstractScopedTestElement implements PostPro
     *  These are passed to the setUseField() method
     *
     *  Do not change these values!
-    */
+     */


Please refrain from making changes that are not a part of the PR

vlsi · 2024-03-24T08:09:50Z

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

+        log.debug("Input = '{}'", inputString);
+        return inputString;


Please refrain from making changes that are not a part of the PR

vlsi · 2024-03-24T08:09:53Z

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

@@ -472,7 +484,7 @@ private void initTemplate() {
        PatternMatcher matcher = JMeterUtils.getMatcher();
        Pattern templatePattern = JMeterUtils.getPatternCache().getPattern("\\$(\\d+)\\$"  // $NON-NLS-1$
                , Perl5Compiler.READ_ONLY_MASK
-                | Perl5Compiler.SINGLELINE_MASK);
+                        | Perl5Compiler.SINGLELINE_MASK);


Please refrain from making changes that are not a part of the PR

vlsi · 2024-03-24T08:13:02Z

src/dist-check/src/test/java/org/apache/jmeter/junit/JMeterTest.java

@@ -382,6 +382,7 @@ public void GUIComponents2(GuiComponentHolder componentHolder) throws Exception
        IGNORED_PROPERTIES.add(LoopControllerSchema.INSTANCE.getContinueForever());
        IGNORED_PROPERTIES.add(RegexExtractorSchema.INSTANCE.getMatchTarget());
        IGNORED_PROPERTIES.add(RegexExtractorSchema.INSTANCE.getDefaultIsEmpty());
+        IGNORED_PROPERTIES.add(RegexExtractorSchema.INSTANCE.getFailIfNotFound());


Could you clarify why adding the property here? Ideally the list of "ignored properties" should be empty. I should add a clarification javadoc to IGNORED_PROPERTIES so it clarifies its purpose.

I have no idea, if I don't add this line the build fails on the tests:

org.opentest4j.AssertionFailedError: GUI element class org.apache.jmeter.extractor.gui.RegexExtractorGui org.apache.jmeter.extractor.gui.RegexExtractorGui[${test_TestElement.name},0,0,0x0,invalid,layout=java.awt.BorderLayout,alignmentX=0.0,alignmentY=0.0,border=javax.swing.border.EmptyBorder@10142fa,flags=9,maximumSize=,minimumSize=,preferredSize=] be able to pass all the properties to a different TestElement ==> expected: <org.apache.jmeter.extractor.RegexExtractor::class { props { it[name] = "\${test_TestElement.name}" it[guiClass] = "org.apache.jmeter.extractor.gui.RegexExtractorGui" it[referenceName] = "\${test_RegexExtractor.refname}" it[regularExpression] = "\${test_RegexExtractor.regex}" it[template] = "\${test_RegexExtractor.template}" it[default] = "\${test_RegexExtractor.default}" it[matchNumber] = "\${test_RegexExtractor.match_number}" it[failIfNotFound] = "\${test_RegexExtractor.fail_if_not_found}" it[comments] = "\${test_TestPlan.comments}" } } > but was: <org.apache.jmeter.extractor.RegexExtractor::class { props { it[name] = "\${test_TestElement.name}" it[guiClass] = "org.apache.jmeter.extractor.gui.RegexExtractorGui" it[comments] = "\${test_TestPlan.comments}" it[referenceName] = "\${test_RegexExtractor.refname}" it[regularExpression] = "\${test_RegexExtractor.regex}" it[template] = "\${test_RegexExtractor.template}" it[default] = "\${test_RegexExtractor.default}" it[matchNumber] = "\${test_RegexExtractor.match_number}" it[failIfNotFound] = false } }

vlsi · 2024-03-25T16:05:09Z

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

+        previousResult.setSuccessful(false);
+        AssertionResult res = new AssertionResult(getName());
+        res.setFailure(true);
+        res.setFailureMessage("Pattern not found: " + getRegex());


I suggest including the "source" that was checked against the regexp. In other words, something like `Pattern ... not found in ...<response body | ... >"

jgaalen · 2024-03-25T20:44:03Z

Have you considered adding test case for the feature?

Not really, I'm not really into this. I've tried to make something out of an earlier existing (working) code for this feature as you've asked me to create a PR and would love this feature in JMeter, but I'm not a java developer. Can you help me out?

jgaalen · 2024-11-08T15:38:47Z

Have you considered adding test case for the feature?

I've added unit tests and fixed some of your items. Seems to be working out really well

Add fail option for regex extractor

0550942

jgaalen mentioned this pull request Mar 22, 2024

Add ability for RegexExtractor to fail sampler result if there is no match #3364

Open

vlsi reviewed Mar 22, 2024

View reviewed changes

src/components/src/main/java/org/apache/jmeter/extractor/RegexExtractor.java Show resolved Hide resolved

Add fail option for regex extractor

67424b4

vlsi reviewed Mar 24, 2024

View reviewed changes

vlsi requested changes Mar 25, 2024

View reviewed changes

jvangaalen added 3 commits November 8, 2024 16:16

Add unit tests

07cda84

Merge branch 'master' into add-fail-regex-extractor

6d26e75

Undo unrelated changes

dffd95a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add fail option for regex extractor #6256

Add fail option for regex extractor #6256

jgaalen commented Mar 22, 2024

vlsi Mar 24, 2024

jgaalen Mar 24, 2024

jgaalen Mar 24, 2024

vlsi Mar 25, 2024

jgaalen Mar 25, 2024

vlsi left a comment

vlsi Mar 24, 2024

jgaalen Mar 25, 2024

vlsi Mar 24, 2024

vlsi Mar 24, 2024

vlsi Mar 24, 2024

vlsi Mar 24, 2024

jgaalen Mar 25, 2024 •

edited

Loading

vlsi Mar 25, 2024

jgaalen commented Mar 25, 2024 •

edited

Loading

jgaalen commented Nov 8, 2024

Add fail option for regex extractor #6256

Are you sure you want to change the base?

Add fail option for regex extractor #6256

Conversation

jgaalen commented Mar 22, 2024

Description

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vlsi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jgaalen Mar 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jgaalen commented Mar 25, 2024 • edited Loading

jgaalen commented Nov 8, 2024

jgaalen Mar 25, 2024 •

edited

Loading

jgaalen commented Mar 25, 2024 •

edited

Loading