Skip to content

Code standards updated to PHP 7.1 #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 27, 2021
Merged

Code standards updated to PHP 7.1 #12

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b56249d
Code standards updated to PHP 7.1
TavoNiievez May 12, 2021
cbdb60c
Added more typehints
TavoNiievez May 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:

strategy:
matrix:
php: [5.6, 7.0, 7.1, 7.2, 7.3, 7.4, 8.0]
php: [7.1, 7.2, 7.3, 7.4, 8.0]

steps:
- name: Checkout code
Expand Down
74 changes: 38 additions & 36 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,40 @@
{
"name":"codeception/module-phpbrowser",
"description":"Codeception module for testing web application over HTTP",
"keywords":["codeception", "http", "functional-testing"],
"homepage":"http://codeception.com/",
"type":"library",
"license":"MIT",
"authors":[
{
"name":"Michael Bodnarchuk"
},
{
"name":"Gintautas Miselis"
}
],
"minimum-stability": "RC",
"require": {
"php": ">=5.6.0 <9.0",
"guzzlehttp/guzzle": "^6.3|^7.0",
"codeception/lib-innerbrowser": "^1.3",
"codeception/codeception": "*@dev"
},
"require-dev": {
"codeception/module-rest": "^1.0"
},
"conflict": {
"codeception/codeception": "<4.0"
},
"suggest": {
"codeception/phpbuiltinserver": "Start and stop PHP built-in web server for your tests"
},
"autoload":{
"classmap": ["src/"]
},
"config": {
"classmap-authoritative": true
}
"name": "codeception/module-phpbrowser",
"description": "Codeception module for testing web application over HTTP",
"keywords": [ "codeception", "http", "functional-testing" ],
"homepage": "https://codeception.com/",
"type": "library",
"license": "MIT",
"authors": [
{
"name": "Michael Bodnarchuk"
},
{
"name": "Gintautas Miselis"
}
],
"minimum-stability": "RC",
"require": {
"php": "^7.1 || ^8.0",
"guzzlehttp/guzzle": "^6.3|^7.0",
"codeception/lib-innerbrowser": "^1.3",
"codeception/codeception": "*@dev"
},
"require-dev": {
"codeception/module-rest": "^1.0"
},
"conflict": {
"codeception/codeception": "<4.0"
},
"suggest": {
"codeception/phpbuiltinserver": "Start and stop PHP built-in web server for your tests"
},
"autoload": {
"classmap": [
"src/"
]
},
"config": {
"classmap-authoritative": true
}
}
4 changes: 4 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ A Codeception module for testing web application over HTTP.
[![Total Downloads](https://poser.pugx.org/codeception/module-phpbrowser/downloads)](https://packagist.org/packages/codeception/module-phpbrowser)
[![License](https://poser.pugx.org/codeception/module-phpbrowser/license)](/LICENSE)

## Requirements

* `PHP 7.1` or higher.

## Installation

```
Expand Down
110 changes: 60 additions & 50 deletions src/Codeception/Lib/Connector/Guzzle.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
<?php

declare(strict_types=1);

namespace Codeception\Lib\Connector;

use Aws\Credentials\Credentials;
Expand All @@ -14,22 +17,38 @@
use GuzzleHttp\Psr7\Request as Psr7Request;
use GuzzleHttp\Psr7\Response as Psr7Response;
use GuzzleHttp\Psr7\Uri as Psr7Uri;
use Symfony\Component\BrowserKit\AbstractBrowser as Client;
use Symfony\Component\BrowserKit\AbstractBrowser;
use Symfony\Component\BrowserKit\Request as BrowserKitRequest;
use Symfony\Component\BrowserKit\Response as BrowserKitResponse;

class Guzzle extends Client
class Guzzle extends AbstractBrowser
{
/**
* @var array
*/
protected $requestOptions = [
'allow_redirects' => false,
'headers' => [],
];

/**
* @var int
*/
protected $refreshMaxInterval = 0;

/**
* @var \Aws\Credentials\Credentials|null
*/
protected $awsCredentials;

/**
* @var \Aws\Signature\SignatureV4|null
*/
protected $awsSignature;

/** @var GuzzleClient */
/**
* @var GuzzleClient
*/
protected $client;

/**
Expand All @@ -43,14 +62,14 @@ class Guzzle extends Client
*
* @param int $seconds Number of seconds
*/
public function setRefreshMaxInterval($seconds)
public function setRefreshMaxInterval(int $seconds): void
{
$this->refreshMaxInterval = $seconds;
}

public function setClient(GuzzleClient $client)
public function setClient(GuzzleClient $guzzleClient): void
{
$this->client = $client;
$this->client = $guzzleClient;
}

/**
Expand All @@ -63,9 +82,9 @@ public function setClient(GuzzleClient $client)
* @param string $name the name of the header
* @param string $value the value of the header
*/
public function setHeader($name, $value)
public function setHeader(string $name, string $value): void
{
if ((string)$value === '') {
if ($value === '') {
$this->deleteHeader($name);
} else {
$this->requestOptions['headers'][$name] = $value;
Expand All @@ -78,19 +97,14 @@ public function setHeader($name, $value)
*
* @param string $name the name of the header to delete.
*/
public function deleteHeader($name)
public function deleteHeader(string $name): void
{
unset($this->requestOptions['headers'][$name]);
}

/**
* @param string $username
* @param string $password
* @param string $type Default: 'basic'
*/
public function setAuth($username, $password, $type = 'basic')
public function setAuth(string $username, string $password, string $type = 'basic'): void
{
if (!$username) {
if ($username === '') {
unset($this->requestOptions['auth']);
return;
}
Expand All @@ -100,14 +114,12 @@ public function setAuth($username, $password, $type = 'basic')
/**
* Taken from Mink\BrowserKitDriver
*
* @param Psr7Response $response
*
* @return BrowserKitResponse
*/
protected function createResponse(Psr7Response $response)
protected function createResponse(Psr7Response $psr7Response): BrowserKitResponse
{
$body = (string) $response->getBody();
$headers = $response->getHeaders();
$body = (string) $psr7Response->getBody();
$headers = $psr7Response->getHeaders();

$contentType = null;

Expand All @@ -119,26 +131,26 @@ protected function createResponse(Psr7Response $response)
}

if (strpos($contentType, 'charset=') === false) {
if (preg_match('/<meta[^>]+charset *= *["\']?([a-zA-Z\-0-9]+)/i', $body, $matches)) {
if (preg_match('#<meta[^>]+charset *= *["\']?([a-zA-Z\-0-9]+)#i', $body, $matches)) {
$contentType .= ';charset=' . $matches[1];
}
$headers['Content-Type'] = [$contentType];
}

$status = $response->getStatusCode();
$status = $psr7Response->getStatusCode();
if ($status < 300 || $status >= 400) {
$matches = [];

$matchesMeta = preg_match(
'/<meta[^>]+http-equiv="refresh" content="\s*(\d*)\s*;\s*url=(.*?)"/i',
'#<meta[^>]+http-equiv="refresh" content="\s*(\d*)\s*;\s*url=(.*?)"#i',
$body,
$matches
);

if (!$matchesMeta && isset($headers['Refresh'])) {
// match by header
preg_match(
'/^\s*(\d*)\s*;\s*url=(.*)/i',
'#^\s*(\d*)\s*;\s*url=(.*)#i',
(string) reset($headers['Refresh']),
$matches
);
Expand All @@ -150,15 +162,15 @@ protected function createResponse(Psr7Response $response)

if ($uri->withFragment('') !== $currentUri->withFragment('')) {
$status = 302;
$headers['Location'] = $matchesMeta ? htmlspecialchars_decode($uri) : (string)$uri;
$headers['Location'] = $matchesMeta ? htmlspecialchars_decode((string) $uri) : (string)$uri;
}
}
}

return new BrowserKitResponse($body, $status, $headers);
}

public function getAbsoluteUri($uri)
protected function getAbsoluteUri($uri)
{
$baseUri = $this->client->getConfig('base_uri');
if (strpos($uri, '://') === false && strpos($uri, '//') !== 0) {
Expand All @@ -172,7 +184,7 @@ public function getAbsoluteUri($uri)
}
// relative url
if (!$this->getHistory()->isEmpty()) {
return Uri::mergeUrls((string)$this->getHistory()->current()->getUri(), $uri);
return Uri::mergeUrls($this->getHistory()->current()->getUri(), $uri);
}
}
return Uri::mergeUrls($baseUri, $uri);
Expand Down Expand Up @@ -214,7 +226,7 @@ protected function doRequest($request)
return $this->createResponse($response);
}

protected function extractHeaders(BrowserKitRequest $request)
protected function extractHeaders(BrowserKitRequest $request): array
{
$headers = [];
$server = $request->getServer();
Expand All @@ -231,39 +243,37 @@ protected function extractHeaders(BrowserKitRequest $request)
return $headers;
}

protected function extractFormData(BrowserKitRequest $request)
protected function extractFormData(BrowserKitRequest $browserKitRequest): ?array
{
if (!in_array(strtoupper($request->getMethod()), ['POST', 'PUT', 'PATCH', 'DELETE'])) {
if (!in_array(strtoupper($browserKitRequest->getMethod()), ['POST', 'PUT', 'PATCH', 'DELETE'])) {
return null;
}

// guessing if it is a form data
$headers = $request->getServer();
if (isset($headers['HTTP_CONTENT_TYPE'])) {
// not a form
if ($headers['HTTP_CONTENT_TYPE'] !== 'application/x-www-form-urlencoded') {
return null;
}
$headers = $browserKitRequest->getServer();
// not a form
if (isset($headers['HTTP_CONTENT_TYPE']) && $headers['HTTP_CONTENT_TYPE'] !== 'application/x-www-form-urlencoded') {
return null;
}
if ($request->getContent() !== null) {
if ($browserKitRequest->getContent() !== null) {
return null;
}
return $request->getParameters();
return $browserKitRequest->getParameters();
}

protected function extractMultipartFormData(BrowserKitRequest $request)
protected function extractMultipartFormData(BrowserKitRequest $browserKitRequest)
{
if (!in_array(strtoupper($request->getMethod()), ['POST', 'PUT', 'PATCH'])) {
if (!in_array(strtoupper($browserKitRequest->getMethod()), ['POST', 'PUT', 'PATCH'])) {
return [];
}

$parts = $this->mapFiles($request->getFiles());
$parts = $this->mapFiles($browserKitRequest->getFiles());
if (empty($parts)) {
return [];
}

foreach ($request->getParameters() as $k => $v) {
$parts = $this->formatMultipart($parts, $k, $v);
foreach ($browserKitRequest->getParameters() as $k => $parameter) {
$parts = $this->formatMultipart($parts, $k, $parameter);
}
return $parts;
}
Expand All @@ -272,15 +282,15 @@ protected function formatMultipart($parts, $key, $value)
{
if (is_array($value)) {
foreach ($value as $subKey => $subValue) {
$parts = array_merge($this->formatMultipart([], $key."[$subKey]", $subValue), $parts);
$parts = array_merge($this->formatMultipart([], $key.sprintf('[%s]', $subKey), $subValue), $parts);
}
return $parts;
}
$parts[] = ['name' => $key, 'contents' => (string) $value];
return $parts;
}

protected function mapFiles($requestFiles, $arrayName = '')
protected function mapFiles($requestFiles, $arrayName = ''): array
{
$files = [];
foreach ($requestFiles as $name => $info) {
Expand All @@ -292,7 +302,7 @@ protected function mapFiles($requestFiles, $arrayName = '')
if (isset($info['tmp_name'])) {
if ($info['tmp_name']) {
$handle = fopen($info['tmp_name'], 'rb');
$filename = isset($info['name']) ? $info['name'] : null;
$filename = $info['name'] ?? null;
$file = [
'name' => $name,
'contents' => $handle,
Expand All @@ -319,7 +329,7 @@ protected function mapFiles($requestFiles, $arrayName = '')
return $files;
}

protected function extractCookies($host)
protected function extractCookies($host): \GuzzleHttp\Cookie\CookieJar
{
$jar = [];
$cookies = $this->getCookieJar()->all();
Expand All @@ -333,7 +343,7 @@ protected function extractCookies($host)
return new CookieJar(false, $jar);
}

public static function createHandler($handler)
public static function createHandler($handler): \GuzzleHttp\HandlerStack
{
if ($handler instanceof HandlerStack) {
return $handler;
Expand All @@ -353,7 +363,7 @@ public static function createHandler($handler)
return HandlerStack::create();
}

public function setAwsAuth($config)
public function setAwsAuth($config): void
{
$this->awsCredentials = new Credentials($config['key'], $config['secret']);
$this->awsSignature = new SignatureV4($config['service'], $config['region']);
Expand Down
Loading