Changes request matchers to match on identity instead of patterns.

New requests must match stored requests exactly. This change is necessary because of many misunderstandings why a request is not matched.

Author: adri

src/VCR/RequestMatcher.php

@@ -30,7 +30,7 @@ public static function matchMethod(Request $first, Request $second)
  */
  public static function matchUrl(Request $first, Request $second)
  {
- return !((null !== $first->getPath()) and ((string) $first->getPath() != (string) $second->getPath()));
+ return $first->getPath() === $second->getPath();
  }
 
  /**
@@ -43,12 +43,7 @@ public static function matchUrl(Request $first, Request $second)
  */
  public static function matchHost(Request $first, Request $second)
  {
- if (null !== $first->getHost()
- && !preg_match('#'.str_replace('#', '\\#', $first->getHost()).'#i', $second->getHost())) {
- return false;
- }
-
- return true;
+ return $first->getHost() === $second->getHost();
  }
 
  /**
@@ -61,15 +56,9 @@ public static function matchHost(Request $first, Request $second)
  */
  public static function matchHeaders(Request $first, Request $second)
  {
- $firstHeaders = $first->getHeaders();
- foreach ($second->getHeaders() as $key => $pattern) {
- if (!array_key_exists($key, $firstHeaders)
- || $pattern !== $firstHeaders[$key]) {
- return false;
- }
- }
+ // Use array_filter to ignore headers which are null.
 
- return true;
+ return array_filter($first->getHeaders()) === array_filter($second->getHeaders());
  }
 
  /**
@@ -82,11 +71,7 @@ public static function matchHeaders(Request $first, Request $second)
  */
  public static function matchBody(Request $first, Request $second)
  {
- if (null !== $first->getBody() && (string) $first->getBody() != (string) $second->getBody() ) {
- return false;
- }
-
- return true;
+ return $first->getBody() === $second->getBody();
  }
 
  /**
@@ -99,11 +84,7 @@ public static function matchBody(Request $first, Request $second)
  */
  public static function matchPostFields(Request $first, Request $second)
  {
- if (null !== $first->getPostFields() && $first->getPostFields() != $second->getPostFields()) {
- return false;
- }
-
- return true;
+ return $first->getPostFields() === $second->getPostFields();
  }
 
  /**
@@ -116,9 +97,6 @@ public static function matchPostFields(Request $first, Request $second)
  */
  public static function matchQueryString(Request $first, Request $second)
  {
- if (null !== $first->getQuery() && $first->getQuery() != $second->getQuery()) {
- return false;
- }
- return true;
+ return $first->getQuery() === $second->getQuery();
  }
 }

tests/VCR/RequestMatcherTest.php

@@ -61,6 +61,19 @@ public function testMatchingHeaders()
  $this->assertFalse(RequestMatcher::matchHeaders($first, $second));
  }
 
+ public function testHeaderMatchingDisallowsMissingHeaders()
+ {
+ $first = new Request('GET', 'http://example.com', array('Accept' => 'Everything', 'MyHeader' => 'value'));
+ $second = new Request('GET', 'http://example.com', array('Accept' => 'Everything'));
+
+ $this->assertFalse(RequestMatcher::matchHeaders($first, $second));
+
+ $first = new Request('GET', 'http://example.com', array('Accept' => 'Everything'));
+ $second = new Request('GET', 'http://example.com', array('Accept' => 'Everything', 'MyHeader' => 'value'));
+
+ $this->assertFalse(RequestMatcher::matchHeaders($first, $second));
+ }
+
  public function testHeaderMatchingAllowsEmptyVals()
  {
  $first = new Request('GET', 'http://example.com', array('Accept' => null, 'Content-Type' => 'application/json'));

tests/fixtures/unittest_soap_test

@@ -5,7 +5,6 @@
  headers:
  Host: wsf.cdyne.com
  Content-Type: 'application/soap+xml; charset=utf-8; action="http://ws.cdyne.com/WeatherWS/GetCityWeatherByZIP"'
- Content-Length: '260'
  body: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<env:Envelope xmlns:env=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:ns1=\"http://ws.cdyne.com/WeatherWS/\"><env:Body><ns1:GetCityWeatherByZIP><ns1:ZIP>10013</ns1:ZIP></ns1:GetCityWeatherByZIP></env:Body></env:Envelope>\n"
  response:
  status: 200
@@ -20,3 +19,27 @@
  Date: 'Fri, 25 Apr 2014 09:22:59 GMT'
  Content-Length: '756'
  body: '<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><GetCityWeatherByZIPResponse xmlns="http://ws.cdyne.com/WeatherWS/"><GetCityWeatherByZIPResult><Success>true</Success><ResponseText>City Found</ResponseText><State>NY</State><City>New York</City><WeatherStationCity>White Plains</WeatherStationCity><WeatherID>3</WeatherID><Description>Mostly Cloudy</Description><Temperature>1337</Temperature><RelativeHumidity>75</RelativeHumidity><Wind>NE7</Wind><Pressure>30.12F</Pressure><Visibility /><WindChill /><Remarks /></GetCityWeatherByZIPResult></GetCityWeatherByZIPResponse></soap:Body></soap:Envelope>'
+-
+ request:
+ method: POST
+ url: 'http://wsf.cdyne.com/WeatherWS/Weather.asmx'
+ headers:
+ Host: wsf.cdyne.com
+ Content-Type: 'application/soap+xml; charset=utf-8; action="http://ws.cdyne.com/WeatherWS/GetCityWeatherByZIP"'
+ body: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<env:Envelope xmlns:env=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:ns1=\"http://ws.cdyne.com/WeatherWS/\"><env:Body><ns1:GetCityWeatherByZIP><ns1:ZIP>10013</ns1:ZIP></ns1:GetCityWeatherByZIP></env:Body></env:Envelope>\n"
+ response:
+ status:
+ http_version: '1.1'
+ code: '200'
+ message: OK
+ headers:
+ Cache-Control: no-cache
+ Pragma: no-cache
+ Content-Type: 'application/soap+xml; charset=utf-8'
+ Expires: '-1'
+ Server: Microsoft-IIS/7.5
+ X-AspNet-Version: 2.0.50727
+ X-Powered-By: ASP.NET
+ Date: 'Sat, 21 Feb 2015 14:09:36 GMT'
+ Content-Length: '753'
+ body: '<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><GetCityWeatherByZIPResponse xmlns="http://ws.cdyne.com/WeatherWS/"><GetCityWeatherByZIPResult><Success>true</Success><ResponseText>City Found</ResponseText><State>NY</State><City>New York</City><WeatherStationCity>White Plains</WeatherStationCity><WeatherID>15</WeatherID><Description>N/A</Description><Temperature>63</Temperature><RelativeHumidity>87</RelativeHumidity><Wind>E7</Wind><Pressure>29.97S</Pressure><Visibility /><WindChill /><Remarks /></GetCityWeatherByZIPResult></GetCityWeatherByZIPResponse></soap:Body></soap:Envelope>'