Your IP : 216.73.216.220
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Backend\Test\Mftf\Helper;
use Magento\Framework\Filesystem\Driver\File;
use Magento\FunctionalTestingFramework\Helper\Helper;
/**
* Class for MFTF helpers for curl requests.
*/
class CurlHelpers extends Helper
{
/**
* Asserts that a curl request's response contains an expected string
*
* @param string $url
* @param string $expectedString
* @param string $postBody
* @param string $cookieName
* @param string $message
* @return void
*
*/
public function assertCurlResponseContainsString(
$url,
$expectedString,
$postBody = null,
$cookieName = 'admin',
$message = ''
): void {
$cookie = $this->getCookie($cookieName);
$curlResponse = $this->getCurlResponse($url, $cookie, $postBody);
$this->assertStringContainsString($expectedString, $curlResponse, $message);
}
/**
* Asserts that an MD5 encoded image retrieved via a curl request equals the expected string
*
* @param string $url
* @param string $expectedString
* @param string $postBody
* @param string $cookieName
* @param string $message
* @return void
*
*/
public function assertImageContentIsEqual(
$url,
$expectedString,
$postBody = null,
$cookieName = null,
$message = ''
): void {
$cookie = $this->getCookie($cookieName);
$imageContent = $this->getCurlResponse($url, $cookie, $postBody);
// md5() here is not for cryptographic use.
// phpcs:ignore Magento2.Security.InsecureFunction
$imageContentMD5 = md5($imageContent);
$this->assertStringContainsString($expectedString, $imageContentMD5, $message);
}
/**
* Assert a that a curl request's response does not contain an expected string
*
* @param string $url
* @param string $expectedString
* @param string $postBody
* @param string $cookieName
* @return void
*
*/
public function assertCurlResponseDoesNotContainString(
$url,
$expectedString,
$postBody = null,
$cookieName = 'admin'
): void {
$cookie = $this->getCookie($cookieName);
$curlResponse = $this->getCurlResponse($url, $cookie, $postBody);
$this->assertStringNotContainsString($expectedString, $curlResponse);
}
/**
* Assert a that a curl request's response headers contains an expected string
*
* @param string $url
* @param string $expectedString
* @param string $postBody
* @param string $cookieName
* @return void
*
*/
public function assertCurlResponseHeadersContainsString(
$url,
$expectedString,
$postBody = null,
$cookieName = 'admin'
): void {
$cookie = $this->getCookie($cookieName);
$curlResponse = $this->getCurlResponse(
$url,
$cookie,
$postBody,
[
CURLOPT_NOBODY => true,
CURLOPT_HEADER => true,
]
);
$this->assertStringContainsString($expectedString, $curlResponse);
}
/**
* Saves file to provided $targetPath with content retrieved from file by $url
*
* @param string $url
* @param string $targetPath File path where to save downloaded data from $url
* @param string $cookieName
* @param string|null $postBody
* @throws \Exception
*/
public function downloadFile(
string $url,
string $targetPath,
string $cookieName = 'admin',
?string $postBody = null
): void {
$cookie = $this->getCookie($cookieName);
$content = $this->getCurlResponse($url, $cookie, $postBody);
$targetPath = (substr($targetPath, 0, 1) === '/') ? $targetPath : MAGENTO_BP . '/' . $targetPath;
$driver = new File();
$driver->filePutContents($targetPath, $content);
}
/**
* Sends a curl request with the provided URL & cookie. Returns the response
*
* @param string $url
* @param string $cookie
* @param string $postBody
* @param array $options
* @return string
*
*/
private function getCurlResponse($url, $cookie = null, $postBody = null, array $options = []): string
{
// Start Session
$session = curl_init($url);
// Set Options
if ($postBody) {
$data = json_decode($postBody, true);
curl_setopt($session, CURLOPT_POST, true);
curl_setopt($session, CURLOPT_POSTFIELDS, $data);
}
curl_setopt($session, CURLOPT_COOKIE, $cookie);
curl_setopt($session, CURLOPT_RETURNTRANSFER, true);
foreach ($options as $option => $value) {
curl_setopt($session, $option, $value);
}
// Execute
$response = curl_exec($session);
curl_close($session);
return $response;
}
/**
* Gets the value of the specified cookie and returns the key value pair of the cookie
*
* @param string $cookieName
* @return string
*
*/
private function getCookie($cookieName = 'admin'): string
{
try {
$webDriver = $this->getModule('\Magento\FunctionalTestingFramework\Module\MagentoWebDriver');
$cookieValue = $webDriver->grabCookie($cookieName);
return $cookieName . '=' . $cookieValue;
} catch (\Exception $exception) {
$this->fail($exception->getMessage());
return '';
}
}
}