Merge branch 'release/3.2.0'

Author: rhatherall

CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [3.2.0](https://github.com/appercept/Delphi-WebMocks/tree/3.2.0) (2022-06-20)
+
+[Full Changelog](https://github.com/appercept/Delphi-WebMocks/compare/3.1.0...3.2.0)
+
+**Implemented enhancements:**
+
+- Add support for matching JSON content by RegEx [\#52](https://github.com/appercept/Delphi-WebMocks/pull/52) ([rhatherall](https://github.com/rhatherall))
+- Add support for matching content by XML values [\#51](https://github.com/appercept/Delphi-WebMocks/pull/51) ([rhatherall](https://github.com/rhatherall))
+- Add support for asserting HEAD requests [\#48](https://github.com/appercept/Delphi-WebMocks/pull/48) ([rhatherall](https://github.com/rhatherall))
+
+**Fixed bugs:**
+
+- Plain query parameters \(without values\) can cause exceptions [\#49](https://github.com/appercept/Delphi-WebMocks/issues/49)
+
+**Closed issues:**
+
+- It is not currently possible to make assertions on HEAD requests [\#47](https://github.com/appercept/Delphi-WebMocks/issues/47)
+
+**Merged pull requests:**
+
+- Fix exception matching query params with no value [\#50](https://github.com/appercept/Delphi-WebMocks/pull/50) ([rhatherall](https://github.com/rhatherall))
+
 ## [3.1.0](https://github.com/appercept/Delphi-WebMocks/tree/3.1.0) (2021-03-09)
 
 [Full Changelog](https://github.com/appercept/Delphi-WebMocks/compare/3.0.1...3.1.0)

README.md

@@ -20,7 +20,7 @@ should install version
 [2.0.0](https://github.com/appercept/Delphi-WebMocks/releases/tag/2.0.0).
 
 ## Installation: GetIt
-[WebMocks 3.0.1](https://getitnow.embarcadero.com/WebMocks-3.0.1/) is available
+[WebMocks 3.1.0](https://getitnow.embarcadero.com/webmocks/) is available
 through Embarcadero's package manager for Delphi
 [GetIt](https://getitnow.embarcadero.com/). If you have a recent version of
 Delphi including GetIt then this should be the preferred installation method.
@@ -34,7 +34,7 @@ not be found in your test projects.
 
 ## Installation: Manual
 1. Download and extract the latest version
-   [3.1.0](https://github.com/appercept/Delphi-WebMocks/archive/3.1.0.zip).
+   [3.2.0](https://github.com/appercept/Delphi-WebMocks/archive/3.2.0.zip).
 2. In "Tools > Options" under the "Language / Delphi / Library" add the
    extracted `Source` directory to the "Library path" and "Browsing path".
 
@@ -253,6 +253,32 @@ The first argument can be a path. For example, in the following JSON, the path
 }
 ```
 
+NOTE: Strings patterns can be matched by passing a regular expression as the
+second argument. For example:
+```Delphi
+WebMock.StubRequest('*', '*')
+  .WithJSON('objects[0].key', TRegEx.Create('value\s\d+'));
+```
+
+#### Request matching by XML
+HTTP request can be matched by XML data values submitted. For example:
+```Delphi
+WebMock.StubRequest('*', '*')
+  .WithXML('/Object/Attr1', 'Value 1');
+```
+
+The first argument is an XPath expression. The previous example would make a
+positive match against the following document:
+```XML
+<?xml version="1.0" encoding="UTF-8"?>
+<Object>
+  <Attr1>Value 1</Attr1>
+</Object>
+```
+
+The second argument can be a boolean, floating point, integer, or string
+value.
+
 #### Request matching by predicate function
 If matching logic is required to be more complex than the simple matching, a
 predicate function can be provided in the test to allow custom inspection/logic
@@ -436,7 +462,7 @@ WebMock.Assert.Get('/').WasRequested; // Passes
 ```
 
 As with request stubbing you can match requests by HTTP Method, URI, Query
-Parameters, Headers, and Body content (including `WithJSON`).
+Parameters, Headers, and Body content (including `WithJSON` and `WithXML`).
 ```Delphi
 WebMock.Assert
   .Patch('/resource`)
@@ -461,7 +487,7 @@ performing extra unwanted requests.
 This project follows [Semantic Versioning](https://semver.org).
 
 ## License
-Copyright ©2019-2021 Richard Hatherall <[email protected]>
+Copyright ©2019-2022 Richard Hatherall <[email protected]>
 
 WebMocks is distributed under the terms of the Apache License (Version 2.0).
 

Source/WebMock.Assertion.pas

@@ -36,6 +36,7 @@ interface
   WebMock.HTTP.RequestMatcher;
 
 type
+
   TWebMockAssertion = class(TObject)
   private
     FMatcher: IWebMockHTTPRequestMatcher;
@@ -45,6 +46,7 @@   TWebMockAssertion = class(TObject)
     constructor Create(const AHistory: IInterfaceList);
     function Delete(const AURI: string): TWebMockAssertion;
     function Get(const AURI: string): TWebMockAssertion;
+    function Head(const AURI: string): TWebMockAssertion;
     function Patch(const AURI: string): TWebMockAssertion;
     function Post(const AURI: string): TWebMockAssertion;
     function Put(const AURI: string): TWebMockAssertion;
@@ -63,6 +65,9 @@   TWebMockAssertion = class(TObject)
     function WithJSON(const APath: string; AValue: Float64): TWebMockAssertion; overload;
     function WithJSON(const APath: string; AValue: Integer): TWebMockAssertion; overload;
     function WithJSON(const APath: string; AValue: string): TWebMockAssertion; overload;
+    function WithJSON(const APath: string; APattern: TRegEx): TWebMockAssertion; overload;
+    function WithXML(const AXPath, AValue: string): TWebMockAssertion; overload;
+    function WithXML(const AXPath: string; APattern: TRegEx): TWebMockAssertion; overload;
     procedure WasRequested;
     procedure WasNotRequested;
     property History: IInterfaceList read FHistory;
@@ -95,6 +100,11 @@ function TWebMockAssertion.Get(const AURI: string): TWebMockAssertion;
   Result := Request('GET', AURI);
 end;
 
+function TWebMockAssertion.Head(const AURI: string): TWebMockAssertion;
+begin
+  Result := Request('HEAD', AURI);
+end;
+
 function TWebMockAssertion.MatchesHistory: Boolean;
 var
   I: Integer;
@@ -264,6 +274,22 @@ function TWebMockAssertion.WithQueryParam(const AName: string;
   Result := Self;
 end;
 
+function TWebMockAssertion.WithXML(const AXPath: string;
+  APattern: TRegEx): TWebMockAssertion;
+begin
+  Matcher.Builder.WithXML(AXPath, APattern);
+
+  Result := Self;
+end;
+
+function TWebMockAssertion.WithXML(const AXPath,
+  AValue: string): TWebMockAssertion;
+begin
+  Matcher.Builder.WithXML(AXPath, AValue);
+
+  Result := Self;
+end;
+
 function TWebMockAssertion.WithQueryParam(const AName,
   AValue: string): TWebMockAssertion;
 begin
@@ -272,4 +298,12 @@ function TWebMockAssertion.WithQueryParam(const AName,
   Result := Self;
 end;
 
+function TWebMockAssertion.WithJSON(const APath: string;
+  APattern: TRegEx): TWebMockAssertion;
+begin
+  Matcher.Builder.WithJSON(APath, APattern);
+
+  Result := Self;
+end;
+
 end.

Source/WebMock.HTTP.RequestMatcher.pas

@@ -61,8 +61,11 @@ interface
     function WithJSON(const APath: string; AValue: Float64): IWebMockHTTPRequestMatcherBuilder; overload;
     function WithJSON(const APath: string; AValue: Integer): IWebMockHTTPRequestMatcherBuilder; overload;
     function WithJSON(const APath: string; AValue: string): IWebMockHTTPRequestMatcherBuilder; overload;
+    function WithJSON(const APath: string; APattern: TRegEx): IWebMockHTTPRequestMatcherBuilder; overload;
     function WithQueryParam(const AName, AValue: string): IWebMockHTTPRequestMatcherBuilder; overload;
     function WithQueryParam(const AName: string; const APattern: TRegEx): IWebMockHTTPRequestMatcherBuilder; overload;
+    function WithXML(const AName, AValue: string): IWebMockHTTPRequestMatcherBuilder; overload;
+    function WithXML(const AName: string; const APattern: TRegEx): IWebMockHTTPRequestMatcherBuilder; overload;
   end;
 
   TWebMockHTTPRequestMatcher = class(TInterfacedObject,
@@ -88,8 +91,11 @@     TBuilder = class(TInterfacedObject, IWebMockHTTPRequestMatcherBuilder)
       function WithJSON(const APath: string; AValue: Float64): IWebMockHTTPRequestMatcherBuilder; overload;
       function WithJSON(const APath: string; AValue: Integer): IWebMockHTTPRequestMatcherBuilder; overload;
       function WithJSON(const APath: string; AValue: string): IWebMockHTTPRequestMatcherBuilder; overload;
+      function WithJSON(const APath: string; APattern: TRegEx): IWebMockHTTPRequestMatcherBuilder; overload;
       function WithQueryParam(const AName, AValue: string): IWebMockHTTPRequestMatcherBuilder; overload;
       function WithQueryParam(const AName: string; const APattern: TRegEx): IWebMockHTTPRequestMatcherBuilder; overload;
+      function WithXML(const AXPath, AValue: string): IWebMockHTTPRequestMatcherBuilder; overload;
+      function WithXML(const AXPath: string; const APattern: TRegEx): IWebMockHTTPRequestMatcherBuilder; overload;
     end;
 
   private
@@ -130,7 +136,8 @@ implementation
   WebMock.JSONMatcher,
   WebMock.StringWildcardMatcher,
   WebMock.StringAnyMatcher,
-  WebMock.StringRegExMatcher;
+  WebMock.StringRegExMatcher,
+  WebMock.XMLMatcher;
 
 { TWebMockHTTPRequestMatcher }
 
@@ -199,7 +206,13 @@ function TWebMockHTTPRequestMatcher.ExtractURIQueryParams(const AURI: string): T
     for LQueryPair in LQueryPairs do
     begin
       LQueryParts := LQueryPair.Split(['='], 2);
-      Result.Add(TNetEncoding.URL.Decode(LQueryParts[0]), TNetEncoding.URL.Decode(LQueryParts[1]));
+      if Length(LQueryParts) = 1 then
+        Result.Add(TNetEncoding.URL.Decode(LQueryParts[0]), '')
+      else
+        Result.Add(
+          TNetEncoding.URL.Decode(LQueryParts[0]),
+          TNetEncoding.URL.Decode(LQueryParts[1])
+        );
     end;
   end
 end;
@@ -427,6 +440,28 @@ function TWebMockHTTPRequestMatcher.TBuilder.WithQueryParam(const AName: string;
   Result := Self;
 end;
 
+function TWebMockHTTPRequestMatcher.TBuilder.WithXML(const AXPath: string;
+  const APattern: TRegEx): IWebMockHTTPRequestMatcherBuilder;
+begin
+  if not (Matcher.Body is TWebMockXMLMatcher) then
+    Matcher.Body := TWebMockXMLMatcher.Create;
+
+  (Matcher.Body as TWebMockXMLMatcher).Add(AXPath, APattern);
+
+  Result := Self;
+end;
+
+function TWebMockHTTPRequestMatcher.TBuilder.WithXML(const AXPath,
+  AValue: string): IWebMockHTTPRequestMatcherBuilder;
+begin
+  if not (Matcher.Body is TWebMockXMLMatcher) then
+    Matcher.Body := TWebMockXMLMatcher.Create;
+
+  (Matcher.Body as TWebMockXMLMatcher).Add(AXPath, AValue);
+
+  Result := Self;
+end;
+
 function TWebMockHTTPRequestMatcher.TBuilder.WithQueryParam(const AName,
   AValue: string): IWebMockHTTPRequestMatcherBuilder;
 begin
@@ -438,4 +473,15 @@ function TWebMockHTTPRequestMatcher.TBuilder.WithQueryParam(const AName,
   Result := Self;
 end;
 
+function TWebMockHTTPRequestMatcher.TBuilder.WithJSON(const APath: string;
+  APattern: TRegEx): IWebMockHTTPRequestMatcherBuilder;
+begin
+  if not (Matcher.Body is TWebMockJSONMatcher) then
+    Matcher.Body := TWebMockJSONMatcher.Create;
+
+  (Matcher.Body as TWebMockJSONMatcher).Add(APath, APattern);
+
+  Result := Self;
+end;
+
 end.

Source/WebMock.JSONMatcher.pas

@@ -30,6 +30,7 @@ interface
 uses
   System.Classes,
   System.JSON,
+  System.RegularExpressions,
   WebMock.StringMatcher;
 
 type
@@ -38,6 +39,19 @@ interface
     function IsMatch(const AJSON: TJSONValue): Boolean;
   end;
 
+  TWebMockJSONPatternMatcher = class(TInterfacedObject, IWebMockJSONValueMatcher)
+  private
+    FPath: string;
+    FPattern: TRegEx;
+  public
+    constructor Create(const APath: string; const APattern: TRegEx);
+    property Path: string read FPath;
+    property Pattern: TRegEx read FPattern;
+
+    { IWebMockJSONValueMatcher }
+    function IsMatch(const AJSON: TJSONValue): Boolean;
+  end;
+
   TWebMockJSONValueMatcher<T> = class(TInterfacedObject, IWebMockJSONValueMatcher)
   private
     FPath: string;
@@ -58,7 +72,8 @@   TWebMockJSONMatcher = class(TInterfacedObject, IStringMatcher)
   public
     constructor Create;
     destructor Destroy; override;
-    procedure Add<T>(const APath: string; const AValue: T);
+    procedure Add<T>(const APath: string; const AValue: T); overload;
+    procedure Add(const APath: string; const APattern: TRegEx); overload;
     property ValueMatchers: TInterfaceList read GetValueMatchers;
 
     { IStringMatcher }
@@ -73,6 +88,11 @@ implementation
 
 { TWebMockJSONMatcher }
 
+procedure TWebMockJSONMatcher.Add(const APath: string; const APattern: TRegEx);
+begin
+  ValueMatchers.Add(TWebMockJSONPatternMatcher.Create(APath, APattern));
+end;
+
 procedure TWebMockJSONMatcher.Add<T>(const APath: string; const AValue: T);
 var
   LMatcher: IWebMockJSONValueMatcher;
@@ -144,4 +164,24 @@ function TWebMockJSONValueMatcher<T>.IsMatch(const AJSON: TJSONValue): Boolean;
     Result := False;
 end;
 
+{ TWebMockJSONPatternMatcher }
+
+constructor TWebMockJSONPatternMatcher.Create(const APath: string;
+  const APattern: TRegEx);
+begin
+  inherited Create;
+  FPath := APath;
+  FPattern := APattern;
+end;
+
+function TWebMockJSONPatternMatcher.IsMatch(const AJSON: TJSONValue): Boolean;
+var
+  LValue: string;
+begin
+  if AJSON.TryGetValue<string>(Path, LValue) then
+    Result := Pattern.IsMatch(LValue)
+  else
+    Result := False;
+end;
+
 end.