Merge branch 'release/3.1.0'

Author: rhatherall

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [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)
+
+**Implemented enhancements:**
+
+- Add support for matching requests by query params [\#46](https://github.com/appercept/Delphi-WebMocks/pull/46) ([rhatherall](https://github.com/rhatherall))
+
 ## [3.0.1](https://github.com/appercept/Delphi-WebMocks/tree/3.0.1) (2021-02-08)
 
 [Full Changelog](https://github.com/appercept/Delphi-WebMocks/compare/3.0.0...3.0.1)
@@ -131,7 +139,6 @@
 - Add `URLFor` method [\#12](https://github.com/appercept/Delphi-WebMocks/issues/12)
 - Replace usages of Indy HTTP terms with terms used in the RFCs [\#11](https://github.com/appercept/Delphi-WebMocks/issues/11)
 - Request history logging [\#10](https://github.com/appercept/Delphi-WebMocks/issues/10)
-- Request header matching by regular-expressions [\#5](https://github.com/appercept/Delphi-WebMocks/issues/5)
 
 **Merged pull requests:**
 
@@ -146,6 +153,7 @@
 - Request content matching by regular-expressions [\#9](https://github.com/appercept/Delphi-WebMocks/issues/9)
 - Request content matching by value [\#8](https://github.com/appercept/Delphi-WebMocks/issues/8)
 - Response headers [\#7](https://github.com/appercept/Delphi-WebMocks/issues/7)
+- Request header matching by regular-expressions [\#5](https://github.com/appercept/Delphi-WebMocks/issues/5)
 - Request path matching by regular-expressions [\#4](https://github.com/appercept/Delphi-WebMocks/issues/4)
 - Delphi 10.3.2 is out [\#2](https://github.com/appercept/Delphi-WebMocks/issues/2)
 - Request header matching by value [\#1](https://github.com/appercept/Delphi-WebMocks/issues/1)

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 2.0](https://getitnow.embarcadero.com/WebMocks-2.0/) is available
+[WebMocks 3.0.1](https://getitnow.embarcadero.com/WebMocks-3.0.1/) 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,10 +34,18 @@ not be found in your test projects.
 
 ## Installation: Manual
 1. Download and extract the latest version
-   [3.0.0](https://github.com/appercept/Delphi-WebMocks/archive/3.0.0.zip).
+   [3.1.0](https://github.com/appercept/Delphi-WebMocks/archive/3.1.0.zip).
 2. In "Tools > Options" under the "Language / Delphi / Library" add the
    extracted `Source` directory to the "Library path" and "Browsing path".
 
+## Getting Started
+If you'd like a gentle introduction to WebMocks for Delphi, there is a series of
+articles published on [DEV](https://dev.to) starting with [Testing HTTP clients
+in Delphi with DUnitX and WebMocks](https://dev.to/rhatherall/testing-http-clients-in-delphi-with-dunitx-and-webmocks-25ck).
+
+[Delphi-WebMocks-Demos](https://github.com/appercept/Delphi-WebMocks-Demos)
+contains a set of demonstrations to accompany the articles.
+
 ## Upgrading from versions prior to 2.0.0
 Version 2 has dropped the `Delphi.` namespace from all units. Any projects
 upgrade to version 2 or later will need to drop the `Delphi.` prefix from any

Source/WebMock.Static.RequestStub.pas

@@ -66,6 +66,8 @@   TWebMockStaticRequestStub = class(TInterfacedObject, IWebMockRequestStub)
     function WithJSON(const APath: string; const AValue: Float64): TWebMockStaticRequestStub; overload;
     function WithJSON(const APath: string; const AValue: Integer): TWebMockStaticRequestStub; overload;
     function WithJSON(const APath: string; const AValue: string): TWebMockStaticRequestStub; overload;
+    function WithQueryParam(const AName, AValue: string): TWebMockStaticRequestStub; overload;
+    function WithQueryParam(const AName: string; const APattern: TRegEx): TWebMockStaticRequestStub; overload;
 
     // IWebMockRequestStub
     function IsMatch(ARequest: IWebMockHTTPRequest): Boolean;
@@ -245,6 +247,28 @@ function TWebMockStaticRequestStub.WithJSON(const APath,
   Result := Self;
 end;
 
+function TWebMockStaticRequestStub.WithQueryParam(const AName: string;
+  const APattern: TRegEx): TWebMockStaticRequestStub;
+begin
+  Matcher.QueryParams.AddOrSetValue(
+    AName,
+    TWebMockStringRegExMatcher.Create(APattern)
+  );
+
+  Result := Self;
+end;
+
+function TWebMockStaticRequestStub.WithQueryParam(const AName,
+  AValue: string): TWebMockStaticRequestStub;
+begin
+  Matcher.QueryParams.AddOrSetValue(
+    AName,
+    TWebMockStringWildcardMatcher.Create(AValue)
+  );
+
+  Result := Self;
+end;
+
 function TWebMockStaticRequestStub.WithJSON(const APath: string;
   const AValue: Boolean): TWebMockStaticRequestStub;
 begin

Tests/Features/WebMock.Matching.Tests.pas

@@ -62,6 +62,14 @@   TWebMockMatchingTests = class(TObject)
     [TestCase('No Resource by ID', 'GET,^/resource/\d+$,resource/abc')]
     procedure RequestWithMethodAndRegExPath_NotMatching_RespondsNotImplemented(const AMatcherMethod, AMatcherURIPattern, ARequestURI: string);
     [Test]
+    procedure Request_MatchingQueryParam_RespondsOK;
+    [Test]
+    procedure Request_NotMatchingQueryParam_RespondsNotImplemented;
+    [Test]
+    procedure Request_MatchingQueryParamByRegEx_RespondsOK;
+    [Test]
+    procedure Request_NotMatchingQueryParamByRegEx_RespondsNotImplemented;
+    [Test]
     procedure Request_MatchingSingleHeader_RespondsOK;
     [Test]
     procedure Request_NotMatchingSingleHeader_RespondsNotImplemented;
@@ -133,6 +141,26 @@ procedure TWebMockMatchingTests.Request_MatchingMultipleHeaders_RespondsOK;
   Assert.AreEqual(200, LResponse.StatusCode);
 end;
 
+procedure TWebMockMatchingTests.Request_MatchingQueryParamByRegEx_RespondsOK;
+var
+  LResponse: IHTTPResponse;
+begin
+  WebMock.StubRequest('*', '*').WithQueryParam('Param1', TRegEx.Create('Value\d'));
+  LResponse := WebClient.Get(WebMock.URLFor('/endpoint?Param1=Value1'));
+
+  Assert.AreEqual(200, LResponse.StatusCode);
+end;
+
+procedure TWebMockMatchingTests.Request_MatchingQueryParam_RespondsOK;
+var
+  LResponse: IHTTPResponse;
+begin
+  WebMock.StubRequest('*', '*').WithQueryParam('Param1', 'Value1');
+  LResponse := WebClient.Get(WebMock.URLFor('/endpoint?Param1=Value1'));
+
+  Assert.AreEqual(200, LResponse.StatusCode);
+end;
+
 procedure TWebMockMatchingTests.Request_MatchingSingleHeaderByRegEx_RespondsOK;
 var
   LHeaderName: string;
@@ -179,6 +207,26 @@ procedure TWebMockMatchingTests.StubWithMethodAndStringURI_NotMatching_RespondsN
   Assert.AreEqual(501, LResponse.StatusCode);
 end;
 
+procedure TWebMockMatchingTests.Request_NotMatchingQueryParamByRegEx_RespondsNotImplemented;
+var
+  LResponse: IHTTPResponse;
+begin
+  WebMock.StubRequest('*', '*').WithQueryParam('Param1', TRegEx.Create('Value\d'));
+  LResponse := WebClient.Get(WebMock.URLFor('/endpoint?Param1=ValueA'));
+
+  Assert.AreEqual(501, LResponse.StatusCode);
+end;
+
+procedure TWebMockMatchingTests.Request_NotMatchingQueryParam_RespondsNotImplemented;
+var
+  LResponse: IHTTPResponse;
+begin
+  WebMock.StubRequest('*', '*').WithQueryParam('Param1', 'Value1');
+  LResponse := WebClient.Get(WebMock.URLFor('/endpoint?Param1=Value2'));
+
+  Assert.AreEqual(501, LResponse.StatusCode);
+end;
+
 procedure TWebMockMatchingTests.Request_NotMatchingSingleHeaderByRegEx_RespondsNotImplemented;
 var
   LHeaderName: string;

Tests/WebMock.Static.RequestStub.Tests.pas

@@ -98,6 +98,14 @@   TWebMockStaticRequestStubTests = class(TObject)
     procedure WithJSON_GivenPathAndString_ReturnsSelf;
     [Test]
     procedure WithJSON_GivenPathAndString_SetsMatcherForContent;
+    [Test]
+    procedure WithQueryParam_GivenString_ReturnsSelf;
+    [Test]
+    procedure WithQueryParam_GivenString_SetsMatcherForParam;
+    [Test]
+    procedure WithQueryParam_GivenRegEx_ReturnsSelf;
+    [Test]
+    procedure WithQueryParam_GivenRegEx_SetsMatcherForParam;
   end;
 
 implementation
@@ -408,6 +416,50 @@ procedure TWebMockStaticRequestStubTests.WithJSON_GivenPathAndString_SetsMatcher
   Assert.IsTrue(StubbedRequest.Matcher.Body is TWebMockJSONMatcher);
 end;
 
+procedure TWebMockStaticRequestStubTests.WithQueryParam_GivenRegEx_ReturnsSelf;
+begin
+  Assert.AreSame(
+    StubbedRequest,
+    StubbedRequest.WithQueryParam('name', TRegEx.Create('pattern'))
+  );
+end;
+
+procedure TWebMockStaticRequestStubTests.WithQueryParam_GivenRegEx_SetsMatcherForParam;
+var
+  LParamName: string;
+  LParamPattern: TRegEx;
+begin
+  LParamName := 'Header2';
+  LParamPattern := TRegEx.Create('');
+
+  StubbedRequest.WithQueryParam(LParamName, LParamPattern);
+
+  Assert.AreEqual(
+    LParamPattern,
+    (StubbedRequest.Matcher.QueryParams[LParamName] as TWebMockStringRegExMatcher).RegEx
+  );
+end;
+
+procedure TWebMockStaticRequestStubTests.WithQueryParam_GivenString_ReturnsSelf;
+begin
+  Assert.AreSame(StubbedRequest, StubbedRequest.WithQueryParam('name', 'value'));
+end;
+
+procedure TWebMockStaticRequestStubTests.WithQueryParam_GivenString_SetsMatcherForParam;
+var
+  LParamName, LParamValue: string;
+begin
+  LParamName := 'Name1';
+  LParamValue := 'Value1';
+
+  StubbedRequest.WithQueryParam(LParamName, LParamValue);
+
+  Assert.AreEqual(
+    LParamValue,
+    (StubbedRequest.Matcher.QueryParams[LParamName] as TWebMockStringWildcardMatcher).Value
+  );
+end;
+
 initialization
   TDUnitX.RegisterTestFixture(TWebMockStaticRequestStubTests);
 end.

Tests/WebMocks.Tests.dproj

@@ -7,7 +7,7 @@
         <TargetedPlatforms>5251</TargetedPlatforms>
         <AppType>Console</AppType>
         <FrameworkType>None</FrameworkType>
-        <ProjectVersion>19.1</ProjectVersion>
+        <ProjectVersion>19.2</ProjectVersion>
         <Platform Condition="'$(Platform)'==''">Win32</Platform>
     </PropertyGroup>
     <PropertyGroup Condition="'$(Config)'=='Base' or '$(Base)'!=''">