Add convenient method for matching absence of form param in a request #2193

G-Basak · 2023-05-28T12:27:56Z

This pull request adds a convenient method for matching absence of form param in a request.
Usage example :

//after this pull request
verify(
    getRequestedFor(urlPathEqualTo("without/formParam"))
        .withoutFormParam("test-form-param"));

It was possible to verify the same even without this method as shown below, but felt counter-intuitive (given there is already a withoutHeader method).

//before this pull request
verify(
    getRequestedFor(urlPathEqualTo("without/formParam"))
        .withFormParam("test-form-param", absent()));

References

This change was inspired by withoutHeader and follows similar pattern.

wiremock/src/main/java/com/github/tomakehurst/wiremock/matching/RequestPatternBuilder.java

Line 166 in 2f8b526

public RequestPatternBuilder withoutHeader(String key) {
There is another PR for adding similar method for query param.
Add convenient method for matching absence of query param in a request #2192
It was necessary to add jackson annotation to prevent failure when de-serializing near-miss response.
src/main/java/com/github/tomakehurst/wiremock/http/FormParameter.java JSON changes are no longer needed.

Submitter checklist

The PR request is well described and justified, including the body and the references
The PR title represents the desired changelog entry
The repository's code style is followed (see the contributing guide)
Test coverage that demonstrates that the change works as expected
For new features, there's necessary documentation in this pull request or in a subsequent PR to wiremock.org

oleg-nenashev

LGTM

…-of-form-param-in-a-request

oleg-nenashev · 2023-07-12T10:03:43Z

Fixed merged conflicts, I hope

G-Basak · 2023-07-12T23:30:51Z

src/main/java/com/github/tomakehurst/wiremock/standalone/WireMockServerRunner.java

+import com.github.tomakehurst.wiremock.WireMockServer;
+import com.github.tomakehurst.wiremock.common.FatalStartupException;
+import com.github.tomakehurst.wiremock.common.FileSource;
+import com.github.tomakehurst.wiremock.http.ResponseDefinition;
+import com.github.tomakehurst.wiremock.matching.RequestPattern;
+import com.github.tomakehurst.wiremock.stubbing.StubMapping;
+import java.io.PrintStream;
+


Only formatting changes because of spotless

G-Basak · 2023-07-12T23:30:58Z

src/main/java/com/github/tomakehurst/wiremock/standalone/WireMockServerRunner.java

+    System.setErr(
+        new PrintStream(err) {
+          @Override
+          public void println(String s) {
+            if (!s.startsWith("SLF4J")) {
+              super.println(s);
+            }
+          }
+
+          @Override
+          public void println(char[] chars) {
+            if (!new String(chars).startsWith("SLF4J")) {
+              super.println(chars);
+            }
+          }
+
+          @Override
+          public void println(Object o) {
+            if (!o.toString().startsWith("SLF4J")) {
+              super.println(o);
+            }
+          }
+        });


Only formatting changes because of spotless

G-Basak · 2023-07-12T23:36:42Z

Fixed merged conflicts, I hope

Finally figured that we can't use multipart/form-data. So switched test to application/form-url-encoded.

oleg-nenashev · 2023-07-13T09:42:07Z

src/main/java/com/github/tomakehurst/wiremock/http/FormParameter.java

+  @JsonProperty
+  @Override
+  public String key() {
+    return super.key();
+  }
+
+  @JsonProperty
+  @Override
+  public List<String> values() {
+    return super.values();
+  }
+


Should exposing those APIs to JSON be considered another new feature in the changelog?

Sorry, I am not sure what you meant by release logs. Is it the PR title?

I have added a point in the PR description why this change is necessary.
The absence of this is actually a bug. The near-miss response deserialization is not possible without the annotation. I can try to reproduce the same and put out another PR just fixing this aspect before we merge this PR.

@oleg-nenashev
I checked it a bit more. Looks like those JSON changes are no longer needed for the tests to pass.
Something must have changed after I had raised the PR. In any case I removed these changes.

G-Basak added 3 commits May 28, 2023 17:47

Add convenient method for matching absence of a form param in a request

1010026

Add jackson annotation to prevent failure during deserialization

e9fc258

Add tests for withoutFormParam

4f6cdca

G-Basak marked this pull request as ready for review May 28, 2023 12:40

G-Basak mentioned this pull request May 28, 2023

Add convenient method for matching absence of query param in a request #2192

Merged

5 tasks

G-Basak marked this pull request as draft May 28, 2023 12:43

Fix formatting

fe572a8

G-Basak marked this pull request as ready for review May 28, 2023 12:52

oleg-nenashev approved these changes Jul 5, 2023

View reviewed changes

oleg-nenashev added the enhancement label Jul 5, 2023

Merge branch 'master' into add-convenient-method-for-matching-absence…

e98c243

…-of-form-param-in-a-request

oleg-nenashev requested a review from a team as a code owner July 12, 2023 10:03

Use application/form-url-encoded instead of multipart/form-data for test

6bd905b

G-Basak commented Jul 12, 2023

View reviewed changes

G-Basak requested a review from oleg-nenashev July 13, 2023 06:27

oleg-nenashev reviewed Jul 13, 2023

View reviewed changes

Remove json property annotation

9b754eb

G-Basak requested a review from oleg-nenashev July 13, 2023 17:44

oleg-nenashev approved these changes Jul 17, 2023

View reviewed changes

oleg-nenashev merged commit c041ae3 into wiremock:master Jul 17, 2023
7 checks passed

G-Basak deleted the add-convenient-method-for-matching-absence-of-form-param-in-a-request branch July 17, 2023 21:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add convenient method for matching absence of form param in a request #2193

Add convenient method for matching absence of form param in a request #2193

G-Basak commented May 28, 2023 •

edited

oleg-nenashev left a comment

oleg-nenashev commented Jul 12, 2023

G-Basak Jul 12, 2023

G-Basak Jul 12, 2023

G-Basak commented Jul 12, 2023

oleg-nenashev Jul 13, 2023 •

edited

G-Basak Jul 13, 2023 •

edited

G-Basak Jul 13, 2023

Add convenient method for matching absence of form param in a request #2193

Add convenient method for matching absence of form param in a request #2193

Conversation

G-Basak commented May 28, 2023 • edited

References

Submitter checklist

oleg-nenashev left a comment

Choose a reason for hiding this comment

oleg-nenashev commented Jul 12, 2023

G-Basak Jul 12, 2023

Choose a reason for hiding this comment

G-Basak Jul 12, 2023

Choose a reason for hiding this comment

G-Basak commented Jul 12, 2023

oleg-nenashev Jul 13, 2023 • edited

Choose a reason for hiding this comment

G-Basak Jul 13, 2023 • edited

Choose a reason for hiding this comment

G-Basak Jul 13, 2023

Choose a reason for hiding this comment

G-Basak commented May 28, 2023 •

edited

oleg-nenashev Jul 13, 2023 •

edited

G-Basak Jul 13, 2023 •

edited