Merge pull request #10294 from annando/http-input-data
New class to process HTTP input data
This commit is contained in:
GitHub
commit
de2c43ce4b
8 changed files with 601 additions and 3 deletions
97
tests/Util/HTTPInputDataDouble.php
Normal file
97
tests/Util/HTTPInputDataDouble.php
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
<?php
|
||||
/**
|
||||
* @copyright Copyright (C) 2010-2021, the Friendica project
|
||||
*
|
||||
* @license GNU AGPL version 3 or any later version
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace Friendica\Test\Util;
|
||||
|
||||
use Friendica\Util\HTTPInputData;
|
||||
|
||||
/**
|
||||
* This class is used to enable testability for HTTPInputData
|
||||
* It overrides the two PHP input functionality with custom content
|
||||
*/
|
||||
class HTTPInputDataDouble extends HTTPInputData
|
||||
{
|
||||
/** @var false|resource */
|
||||
protected static $injectedStream = false;
|
||||
/** @var false|string */
|
||||
protected static $injectedContent = false;
|
||||
/** @var false|string */
|
||||
protected static $injectedContentType = false;
|
||||
|
||||
/**
|
||||
* injects the PHP input stream for a test
|
||||
*
|
||||
* @param false|resource $stream
|
||||
*/
|
||||
public static function setPhpInputStream($stream)
|
||||
{
|
||||
self::$injectedStream = $stream;
|
||||
}
|
||||
|
||||
/**
|
||||
* injects the PHP input content for a test
|
||||
*
|
||||
* @param false|string $content
|
||||
*/
|
||||
public static function setPhpInputContent($content)
|
||||
{
|
||||
self::$injectedContent = $content;
|
||||
}
|
||||
|
||||
/**
|
||||
* injects the PHP input content type for a test
|
||||
*
|
||||
* @param false|string $contentType
|
||||
*/
|
||||
public static function setPhpInputContentType($contentType)
|
||||
{
|
||||
self::$injectedContentType = $contentType;
|
||||
}
|
||||
|
||||
/** {@inheritDoc} */
|
||||
protected static function getPhpInputStream()
|
||||
{
|
||||
return static::$injectedStream;
|
||||
}
|
||||
|
||||
/** {@inheritDoc} */
|
||||
protected static function getPhpInputContent()
|
||||
{
|
||||
return static::$injectedContent;
|
||||
}
|
||||
|
||||
/** {@inheritDoc} */
|
||||
protected static function getContentType()
|
||||
{
|
||||
return static::$injectedContentType;
|
||||
}
|
||||
|
||||
protected static function fetchFileData($stream, string $boundary, array $headers, string $filename)
|
||||
{
|
||||
$data = parent::fetchFileData($stream, $boundary, $headers, $filename);
|
||||
if (!empty($data['tmp_name'])) {
|
||||
unlink($data['tmp_name']);
|
||||
$data['tmp_name'] = $data['name'];
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
}
|
||||
1
tests/datasets/http/form-urlencoded-json.httpinput
Normal file
1
tests/datasets/http/form-urlencoded-json.httpinput
Normal file
|
|
@ -0,0 +1 @@
|
|||
{"media_ids":[],"sensitive":false,"status":"Test Status","visibility":"private","spoiler_text":"Title"}
|
||||
1
tests/datasets/http/form-urlencoded.httpinput
Normal file
1
tests/datasets/http/form-urlencoded.httpinput
Normal file
|
|
@ -0,0 +1 @@
|
|||
title=Test2
|
||||
BIN
tests/datasets/http/multipart-file.httpinput
Normal file
BIN
tests/datasets/http/multipart-file.httpinput
Normal file
Binary file not shown.
50
tests/datasets/http/multipart.httpinput
Normal file
50
tests/datasets/http/multipart.httpinput
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
--43395968-f65c-437e-b536-5b33e3e3c7e5
|
||||
Content-Disposition: form-data; name="display_name"
|
||||
Content-Transfer-Encoding: binary
|
||||
Content-Type: multipart/form-data; charset=utf-8
|
||||
Content-Length: 9
|
||||
|
||||
User Name
|
||||
--43395968-f65c-437e-b536-5b33e3e3c7e5
|
||||
Content-Disposition: form-data; name="note"
|
||||
Content-Transfer-Encoding: binary
|
||||
Content-Type: multipart/form-data; charset=utf-8
|
||||
Content-Length: 8
|
||||
|
||||
About me
|
||||
--43395968-f65c-437e-b536-5b33e3e3c7e5
|
||||
Content-Disposition: form-data; name="locked"
|
||||
Content-Transfer-Encoding: binary
|
||||
Content-Type: multipart/form-data; charset=utf-8
|
||||
Content-Length: 5
|
||||
|
||||
false
|
||||
--43395968-f65c-437e-b536-5b33e3e3c7e5
|
||||
Content-Disposition: form-data; name="fields_attributes[0][name]"
|
||||
Content-Transfer-Encoding: binary
|
||||
Content-Type: multipart/form-data; charset=utf-8
|
||||
Content-Length: 10
|
||||
|
||||
variable 1
|
||||
--43395968-f65c-437e-b536-5b33e3e3c7e5
|
||||
Content-Disposition: form-data; name="fields_attributes[0][value]"
|
||||
Content-Transfer-Encoding: binary
|
||||
Content-Type: multipart/form-data; charset=utf-8
|
||||
Content-Length: 7
|
||||
|
||||
value 1
|
||||
--43395968-f65c-437e-b536-5b33e3e3c7e5
|
||||
Content-Disposition: form-data; name="fields_attributes[1][name]"
|
||||
Content-Transfer-Encoding: binary
|
||||
Content-Type: multipart/form-data; charset=utf-8
|
||||
Content-Length: 10
|
||||
|
||||
variable 2
|
||||
--43395968-f65c-437e-b536-5b33e3e3c7e5
|
||||
Content-Disposition: form-data; name="fields_attributes[1][value]"
|
||||
Content-Transfer-Encoding: binary
|
||||
Content-Type: multipart/form-data; charset=utf-8
|
||||
Content-Length: 7
|
||||
|
||||
value 2
|
||||
--43395968-f65c-437e-b536-5b33e3e3c7e5--
|
||||
152
tests/src/Util/HTTPInputDataTest.php
Normal file
152
tests/src/Util/HTTPInputDataTest.php
Normal file
|
|
@ -0,0 +1,152 @@
|
|||
<?php
|
||||
/**
|
||||
* @copyright Copyright (C) 2010-2021, the Friendica project
|
||||
*
|
||||
* @license GNU AGPL version 3 or any later version
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace Friendica\Test\src\Util;
|
||||
|
||||
use Friendica\Test\MockedTest;
|
||||
use Friendica\Test\Util\HTTPInputDataDouble;
|
||||
use Friendica\Util\HTTPInputData;
|
||||
|
||||
/**
|
||||
* Testing HTTPInputData
|
||||
*
|
||||
* @see HTTPInputData
|
||||
*/
|
||||
class HTTPInputDataTest extends MockedTest
|
||||
{
|
||||
/**
|
||||
* Returns the data stream for the unit test
|
||||
* Each array element of the first hierarchy represents one test run
|
||||
* Each array element of the second hierarchy represents the parameters, passed to the test function
|
||||
*
|
||||
* @return array[]
|
||||
*/
|
||||
public function dataStream()
|
||||
{
|
||||
return [
|
||||
'multipart' => [
|
||||
'contenttype' => 'multipart/form-data;boundary=43395968-f65c-437e-b536-5b33e3e3c7e5;charset=utf8',
|
||||
'input' => file_get_contents(__DIR__ . '/../../datasets/http/multipart.httpinput'),
|
||||
'expected' => [
|
||||
'variables' => [
|
||||
'display_name' => 'User Name',
|
||||
'note' => 'About me',
|
||||
'locked' => 'false',
|
||||
'fields_attributes' => [
|
||||
0 => [
|
||||
'name' => 'variable 1',
|
||||
'value' => 'value 1',
|
||||
],
|
||||
1 => [
|
||||
'name' => 'variable 2',
|
||||
'value' => 'value 2',
|
||||
]
|
||||
]
|
||||
],
|
||||
'files' => []
|
||||
]
|
||||
],
|
||||
'multipart-file' => [
|
||||
'contenttype' => 'multipart/form-data;boundary=6d4d5a40-651a-4468-a62e-5a6ca2bf350d;charset=utf8',
|
||||
'input' => file_get_contents(__DIR__ . '/../../datasets/http/multipart-file.httpinput'),
|
||||
'expected' => [
|
||||
'variables' => [
|
||||
'display_name' => 'Vorname Nachname',
|
||||
'note' => 'About me',
|
||||
'fields_attributes' => [
|
||||
0 => [
|
||||
'name' => 'variable 1',
|
||||
'value' => 'value 1',
|
||||
],
|
||||
1 => [
|
||||
'name' => 'variable 2',
|
||||
'value' => 'value 2',
|
||||
]
|
||||
]
|
||||
],
|
||||
'files' => [
|
||||
'avatar' => [
|
||||
'name' => '8ZUCS34Y5XNH',
|
||||
'type' => 'image/png',
|
||||
'tmp_name' => '8ZUCS34Y5XNH',
|
||||
'error' => 0,
|
||||
'size' => 349330
|
||||
],
|
||||
'header' => [
|
||||
'name' => 'V2B6Z1IICGPM',
|
||||
'type' => 'image/png',
|
||||
'tmp_name' => 'V2B6Z1IICGPM',
|
||||
'error' => 0,
|
||||
'size' => 1323635
|
||||
]
|
||||
]
|
||||
]
|
||||
],
|
||||
'form-urlencoded' => [
|
||||
'contenttype' => 'application/x-www-form-urlencoded;charset=utf8',
|
||||
'input' => file_get_contents(__DIR__ . '/../../datasets/http/form-urlencoded.httpinput'),
|
||||
'expected' => [
|
||||
'variables' => [
|
||||
'title' => 'Test2',
|
||||
],
|
||||
'files' => []
|
||||
]
|
||||
],
|
||||
'form-urlencoded-json' => [
|
||||
'contenttype' => 'application/x-www-form-urlencoded;charset=utf8',
|
||||
'input' => file_get_contents(__DIR__ . '/../../datasets/http/form-urlencoded-json.httpinput'),
|
||||
'expected' => [
|
||||
'variables' => [
|
||||
'media_ids' => [],
|
||||
'sensitive' => false,
|
||||
'status' => 'Test Status',
|
||||
'visibility' => 'private',
|
||||
'spoiler_text' => 'Title'
|
||||
],
|
||||
'files' => []
|
||||
]
|
||||
]
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests the HTTPInputData::process() method
|
||||
*
|
||||
* @param string $contentType The content typer of the transmitted data
|
||||
* @param string $input The input, we got from the data stream
|
||||
* @param array $expected The expected output
|
||||
*
|
||||
* @dataProvider dataStream
|
||||
* @see HTTPInputData::process()
|
||||
*/
|
||||
public function testHttpInput(string $contentType, string $input, array $expected)
|
||||
{
|
||||
HTTPInputDataDouble::setPhpInputContentType($contentType);
|
||||
HTTPInputDataDouble::setPhpInputContent($input);
|
||||
$stream = fopen('php://memory', 'r+');
|
||||
fwrite($stream, $input);
|
||||
rewind($stream);
|
||||
|
||||
HTTPInputDataDouble::setPhpInputStream($stream);
|
||||
$output = HTTPInputDataDouble::process();
|
||||
$this->assertEqualsCanonicalizing($expected, $output);
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue