Append query params to URL for HEAD requests

Author: JasonBenett

src/Codeception/Module/REST.php

@@ -71,6 +71,8 @@
  */
 class REST extends CodeceptionModule implements DependsOnModule, PartedModule, API, ConflictsWithModule
 {
+    const QUERY_PARAMS_AWARE_METHODS = ['GET', 'HEAD'];
+
     protected $config = [
         'url' => '',
         'aws' => ''
@@ -610,17 +612,18 @@ protected function execute($method, $url, $parameters = [], $files = [])
         $this->params = $parameters;
 
         $parameters = $this->encodeApplicationJson($method, $parameters);
+        $isQueryParamsAwareMethod = in_array($method, self::QUERY_PARAMS_AWARE_METHODS, true);
 
-        if (is_array($parameters) || $method === 'GET') {
-            if (!empty($parameters) && $method === 'GET') {
+        if (is_array($parameters) || $isQueryParamsAwareMethod) {
+            if (!empty($parameters) && $isQueryParamsAwareMethod) {
                 if (strpos($url, '?') !== false) {
                     $url .= '&';
                 } else {
                     $url .= '?';
                 }
                 $url .= http_build_query($parameters);
             }
-            if ($method == 'GET') {
+            if ($isQueryParamsAwareMethod) {
                 $this->debugSection("Request", "$method $url");
                 $files = [];
             } else {
@@ -675,7 +678,9 @@ protected function binaryToDebugString($data)
 
     protected function encodeApplicationJson($method, $parameters)
     {
-        if ($method !== 'GET' && array_key_exists('Content-Type', $this->connectionModule->headers)
+        if (
+            array_key_exists('Content-Type', $this->connectionModule->headers)
+            && !in_array($method, self::QUERY_PARAMS_AWARE_METHODS, true)
             && ($this->connectionModule->headers['Content-Type'] === 'application/json'
                 || preg_match('!^application/.+\+json$!', $this->connectionModule->headers['Content-Type'])
             )

tests/data/rest/server.php

@@ -14,7 +14,7 @@ function RESTServer()
 
         // get the request data
         $data = NULL;
-        if ($_SERVER['REQUEST_METHOD'] == 'GET') {
+        if ($_SERVER['REQUEST_METHOD'] === 'GET') {
             $data = $_GET;
         } else if ($tmp = file_get_contents('php://input')) {
             $data = json_decode($tmp);

tests/unit/Codeception/Module/RestTest.php

@@ -1,5 +1,7 @@
 <?php
 
+use Codeception\Configuration;
+use Codeception\Example;
 use Codeception\Module\UniversalFramework;
 use Codeception\Test\Unit;
 use Codeception\Util\Stub;
@@ -17,9 +19,9 @@ class RestTest extends Unit
 
     public function _setUp()
     {
-        $index = \Codeception\Configuration::dataDir() . '/rest/index.php';
+        $index = Configuration::dataDir() . '/rest/index.php';
 
-        $container = \Codeception\Util\Stub::make('Codeception\Lib\ModuleContainer');
+        $container = Stub::make('Codeception\Lib\ModuleContainer');
         $connectionModule = new UniversalFramework($container, ['index' => $index]);
         $connectionModule->_initialize();
         $this->module = Stub::make('\Codeception\Module\REST');
@@ -204,16 +206,30 @@ public function testApplicationJsonIncludesObjectSerialized()
         $this->assertJson($request->getContent());
     }
 
-    public function testGetApplicationJsonNotIncludesJsonAsContent()
+    /**
+     * @param string $method
+     *
+     * @dataProvider queryParamsAwareMethods
+     */
+    public function testGetApplicationJsonNotIncludesJsonAsContent($method)
     {
+        $method = 'send' . $method;
         $this->module->haveHttpHeader('Content-Type', 'application/json');
-        $this->module->sendGET('/', ['name' => 'john']);
+        $this->module->$method('/', ['name' => 'john']);
         /** @var $request \Symfony\Component\BrowserKit\Request  **/
         $request = $this->module->client->getRequest();
         $this->assertNull($request->getContent());
         $this->assertContains('john', $request->getParameters());
     }
 
+    public function queryParamsAwareMethods()
+    {
+        return [
+            ['Get'],
+            ['Head'],
+        ];
+    }
+
     public function testUrlIsFull()
     {
         $this->module->sendGET('/api/v1/users');
@@ -529,7 +545,7 @@ public function testRestExecute($configUrl, $requestUrl, $expectedFullUrl)
 
         $config = ['url' => $configUrl];
 
-        /** @var \Codeception\Module\REST */
+        /** @var REST */
         $module = Stub::make('\Codeception\Module\REST');
         $module->_setConfig($config);
         $module->_inject($connectionModule);