Support proxy prefix removal

rowanhill · Dec 31, 2021 · df79a1f · df79a1f
1 parent 2e61a2b
commit df79a1f
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 3 deletions.
diff --git a/src/WireMock/Client/ResponseDefinitionBuilder.php b/src/WireMock/Client/ResponseDefinitionBuilder.php
@@ -29,6 +29,8 @@ class ResponseDefinitionBuilder
     private $_transformerParameters = array();
 
     protected $_additionalRequestHeaders = array();
+    /** @var string */
+    protected $_proxyUrlPrefixToRemove;
 
     /**
      * @param int $status
@@ -222,7 +224,8 @@ public function build()
             $this->_chunkedDribbleDelay,
             $this->_fault,
             $this->_transformers,
-            $this->_transformerParameters
+            $this->_transformerParameters,
+            $this->_proxyUrlPrefixToRemove
         );
     }
 }
@@ -250,4 +253,14 @@ public function withAdditionalRequestHeader($headerName, $value)
         $this->_additionalRequestHeaders[$headerName] = $value;
         return $this;
     }
+
+    /**
+     * @param string $proxyUrlPrefixToRemove
+     * @return $this
+     */
+    public function withProxyUrlPrefixToRemove($proxyUrlPrefixToRemove)
+    {
+        $this->_proxyUrlPrefixToRemove = $proxyUrlPrefixToRemove;
+        return $this;
+    }
 }
diff --git a/src/WireMock/Http/ResponseDefinition.php b/src/WireMock/Http/ResponseDefinition.php
@@ -36,6 +36,8 @@ class ResponseDefinition
     private $_transformers = array();
     /** @var array */
     private $_transformerParameters = array();
+    /** @var string */
+    private $_proxyUrlPrefixToRemove;
 
     /**
      * ResponseDefinition constructor.
@@ -68,7 +70,8 @@ public function __construct(
         $chunkedDribbleDelay,
         $fault,
         $transformers,
-        $transformerParameters
+        $transformerParameters,
+        $proxyUrlPrefixToRemove
     ) {
         $this->_status = $status;
         $this->_statusMessage = $statusMessage;
@@ -84,6 +87,7 @@ public function __construct(
         $this->_transformers = $transformers;
         $this->_transformerParameters = $transformerParameters;
         $this->_additionalProxyRequestHeaders = $additionalProxyRequestHeaders;
+        $this->_proxyUrlPrefixToRemove = $proxyUrlPrefixToRemove;
     }
 
     /**
@@ -198,6 +202,14 @@ public function getTransformerParameters()
         return $this->_transformerParameters;
     }
 
+    /**
+     * @return string
+     */
+    public function getProxyUrlPrefixToRemove()
+    {
+        return $this->_proxyUrlPrefixToRemove;
+    }
+
     public function toArray()
     {
         $array = array();
@@ -241,6 +253,9 @@ public function toArray()
         if ($this->_transformerParameters) {
             $array['transformerParameters'] = $this->_transformerParameters;
         }
+        if ($this->_proxyUrlPrefixToRemove) {
+            $array['proxyUrlPrefixToRemove'] = $this->_proxyUrlPrefixToRemove;
+        }
         return $array;
     }
 
@@ -271,7 +286,8 @@ public static function fromArray(array $array)
                 null,
             isset($array['fault']) ? $array['fault'] : null,
             isset($array['transformers']) ? $array['transformers'] : null,
-            isset($array['transformerParameters']) ? $array['transformerParameters'] : null
+            isset($array['transformerParameters']) ? $array['transformerParameters'] : null,
+            isset($array['proxyUrlPrefixToRemove']) ? $array['proxyUrlPrefixToRemove'] : null
         );
     }
 }
diff --git a/test/WireMock/Integration/ProxyingIntegrationTest.php b/test/WireMock/Integration/ProxyingIntegrationTest.php
@@ -34,4 +34,18 @@ public function testAdditionProxiedRequestHeadersCanBeSet()
         assertThat($stubMappingArray['response']['additionalProxyRequestHeaders'], equalTo(array('X-Header' => 'val')));
         assertThatTheOnlyMappingPresentIs($stubMapping);
     }
+
+    public function testProxyUrlPrefixToRemoveCanBeSet()
+    {
+        // when
+        $stubMapping = self::$_wireMock->stubFor(WireMock::get(WireMock::urlEqualTo("/other/service/doc/123"))
+            ->willReturn(WireMock::aResponse()
+                ->proxiedFrom("http://otherhost.com/approot")
+                ->withProxyUrlPrefixToRemove("/other/service")));
+
+        // then
+        $stubMappingArray = $stubMapping->toArray();
+        assertThat($stubMappingArray['response']['proxyUrlPrefixToRemove'], equalTo('/other/service'));
+        assertThatTheOnlyMappingPresentIs($stubMapping);
+    }
 }