magento2-docker/dev/tests/api-functional/testsuite/Magento/GraphQl/SendFriend/SendFriendTest.php

481 lines
15 KiB
PHP
Executable File

<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\GraphQl\SendFriend;
use Magento\Catalog\Api\ProductRepositoryInterface;
use Magento\Framework\Exception\AuthenticationException;
use Magento\Integration\Api\CustomerTokenServiceInterface;
use Magento\SendFriend\Model\SendFriend;
use Magento\SendFriend\Model\SendFriendFactory;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\TestCase\GraphQlAbstract;
/**
* Tests for send email to friend
*/
class SendFriendTest extends GraphQlAbstract
{
/**
* @var SendFriendFactory
*/
private $sendFriendFactory;
/**
* @var ProductRepositoryInterface
*/
private $productRepository;
/**
* @var CustomerTokenServiceInterface
*/
private $customerTokenService;
protected function setUp(): void
{
$this->sendFriendFactory = Bootstrap::getObjectManager()->get(SendFriendFactory::class);
$this->productRepository = Bootstrap::getObjectManager()->get(ProductRepositoryInterface::class);
$this->customerTokenService = Bootstrap::getObjectManager()->get(CustomerTokenServiceInterface::class);
}
/**
* @magentoApiDataFixture Magento/GraphQl/Catalog/_files/simple_product.php
* @magentoConfigFixture default_store sendfriend/email/enabled 1
* @magentoConfigFixture default_store sendfriend/email/allow_guest 1
*/
public function testSendFriendGuestEnable()
{
$productId = (int)$this->productRepository->get('simple_product')->getId();
$recipients = '{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 2"
email:"recipient2@mail.com"
}';
$query = $this->getQuery($productId, $recipients);
$response = $this->graphQlMutation($query);
$this->assertResponse($response);
}
/**
* @magentoApiDataFixture Magento/GraphQl/Catalog/_files/simple_product.php
* @magentoConfigFixture default_store sendfriend/email/enabled 1
* @magentoConfigFixture default_store sendfriend/email/allow_guest 0
*/
public function testSendFriendGuestDisableAsGuest()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage('The current customer isn\'t authorized.');
$productId = (int)$this->productRepository->get('simple_product')->getId();
$recipients = '{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 2"
email:"recipient2@mail.com"
}';
$query = $this->getQuery($productId, $recipients);
$response = $this->graphQlMutation($query);
$this->assertResponse($response);
}
/**
* @magentoApiDataFixture Magento/Customer/_files/customer.php
* @magentoApiDataFixture Magento/GraphQl/Catalog/_files/simple_product.php
* @magentoConfigFixture default_store sendfriend/email/enabled 0
*/
public function testSendFriendDisableAsCustomer()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage('"Email to a Friend" is not enabled.');
$productId = (int)$this->productRepository->get('simple_product')->getId();
$recipients = '{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 2"
email:"recipient2@mail.com"
}';
$query = $this->getQuery($productId, $recipients);
$response = $this->graphQlMutation($query, [], '', $this->getHeaderMap());
$this->assertResponse($response);
}
/**
* @magentoApiDataFixture Magento/Customer/_files/customer.php
* @magentoConfigFixture default_store sendfriend/email/enabled 1
*/
public function testSendWithoutExistProduct()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage(
'The product that was requested doesn\'t exist. Verify the product and try again.'
);
$productId = 2018;
$recipients = '{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 2"
email:"recipient2@mail.com"
}';
$query = $this->getQuery($productId, $recipients);
$this->graphQlMutation($query, [], '', $this->getHeaderMap());
}
/**
* @magentoApiDataFixture Magento/Customer/_files/customer.php
* @magentoApiDataFixture Magento/GraphQl/Catalog/_files/simple_product.php
* @magentoConfigFixture default_store sendfriend/email/enabled 1
*/
public function testMaxSendEmailToFriend()
{
/** @var SendFriend $sendFriend */
$sendFriend = $this->sendFriendFactory->create();
$productId = (int)$this->productRepository->get('simple_product')->getId();
$recipients = '{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 1"
email:"recipient1@mail.com"
}';
$query = $this->getQuery($productId, $recipients);
$this->expectException(\Exception::class);
$this->expectExceptionMessage("No more than {$sendFriend->getMaxRecipients()} emails can be sent at a time.");
$this->graphQlMutation($query, [], '', $this->getHeaderMap());
}
/**
* @magentoApiDataFixture Magento/Customer/_files/customer.php
* @magentoApiDataFixture Magento/Catalog/_files/product_simple.php
* @magentoConfigFixture default_store sendfriend/email/enabled 1
* @dataProvider sendFriendsErrorsDataProvider
* @param string $input
* @param string $errorMessage
*/
public function testErrors(string $input, string $errorMessage)
{
$query =
<<<QUERY
mutation {
sendEmailToFriend(
input: {
$input
}
) {
sender {
name
email
message
}
recipients {
name
email
}
}
}
QUERY;
$this->expectException(\Exception::class);
$this->expectExceptionMessage($errorMessage);
$this->graphQlMutation($query, [], '', $this->getHeaderMap());
}
/**
* @magentoApiDataFixture Magento/Customer/_files/customer.php
* @magentoApiDataFixture Magento/GraphQl/Catalog/_files/simple_product.php
* @magentoConfigFixture default_store sendfriend/email/enabled 1
* @magentoConfigFixture default_store sendfriend/email/max_per_hour 1
* @magentoApiDataFixture Magento/SendFriend/Fixtures/sendfriend_configuration.php
*/
public function testLimitMessagesPerHour()
{
$productId = (int)$this->productRepository->get('simple_product')->getId();
$recipients = '{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 2"
email:"recipient2@mail.com"
}';
$query = $this->getQuery($productId, $recipients);
$this->expectException(\Exception::class);
$this->expectExceptionMessage(
"You can't send messages more than 1 times an hour."
);
$this->graphQlMutation($query, [], '', $this->getHeaderMap());
$this->graphQlMutation($query, [], '', $this->getHeaderMap());
}
/**
* @magentoApiDataFixture Magento/Customer/_files/customer.php
* @magentoApiDataFixture Magento/GraphQl/Catalog/_files/simple_product.php
* @magentoConfigFixture default_store sendfriend/email/enabled 1
*/
public function testSendProductWithoutSenderEmail()
{
$productId = (int)$this->productRepository->get('simple_product')->getId();
$recipients = '{
name: "Recipient Name 1"
email:""
}';
$query = $this->getQuery($productId, $recipients);
$this->expectException(\Exception::class);
$this->expectExceptionMessage('GraphQL response contains errors: Please provide Email for all of recipients.');
$this->graphQlMutation($query, [], '', $this->getHeaderMap());
}
/**
* @magentoApiDataFixture Magento/Customer/_files/customer.php
* @magentoApiDataFixture Magento/GraphQl/Catalog/_files/simple_product_without_visibility.php
* @magentoConfigFixture default_store sendfriend/email/enabled 1
*/
public function testSendProductWithoutVisibility()
{
$productId = (int)$this->productRepository->get('simple_product_without_visibility')->getId();
$recipients = '{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 2"
email:"recipient2@mail.com"
}';
$query = $this->getQuery($productId, $recipients);
$this->expectExceptionMessage(
'The product that was requested doesn\'t exist. Verify the product and try again.'
);
$this->graphQlMutation($query, [], '', $this->getHeaderMap());
}
/**
* @return array
*/
public function sendFriendsErrorsDataProvider(): array
{
return array_merge(
$this->getRecipientErrors(),
$this->getSenderErrors()
);
}
/**
* @return array
*/
private function getRecipientErrors(): array
{
return [
[
'product_id: 1
sender: {
name: "Name"
email: "e@mail.com"
message: "Lorem Ipsum"
}
recipients: [
{
name: ""
email:"recipient1@mail.com"
},
{
name: ""
email:"recipient2@mail.com"
}
]',
'Please provide Name for all of recipients.'
],
[
'product_id: 1
sender: {
name: "Name"
email: "e@mail.com"
message: "Lorem Ipsum"
}
recipients: [
{
name: "Recipient Name 1"
email:""
},
{
name: "Recipient Name 2"
email:""
}
]',
'Please provide Email for all of recipients.'
],
];
}
/**
* @return array
*/
private function getSenderErrors(): array
{
return [
[
'product_id: 1
sender: {
name: ""
email: "e@mail.com"
message: "Lorem Ipsum"
}
recipients: [
{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 2"
email:"recipient2@mail.com"
}
]',
'Please provide Name of sender.'
],
[
'product_id: 1
sender: {
name: "Name"
email: ""
message: "Lorem Ipsum"
}
recipients: [
{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 2"
email:"recipient2@mail.com"
}
]',
'Please provide Email of sender.'
],
[
'product_id: 1
sender: {
name: "Name"
email: "e@mail.com"
message: ""
}
recipients: [
{
name: "Recipient Name 1"
email:"recipient1@mail.com"
},
{
name: "Recipient Name 2"
email:"recipient2@mail.com"
}
]',
'Please provide Message.'
],
];
}
/**
* Generic assertions for send a friend response
*
* @param array $response
*/
private function assertResponse(array $response): void
{
self::assertEquals('Name', $response['sendEmailToFriend']['sender']['name']);
self::assertEquals('e@mail.com', $response['sendEmailToFriend']['sender']['email']);
self::assertEquals('Lorem Ipsum', $response['sendEmailToFriend']['sender']['message']);
self::assertEquals('Recipient Name 1', $response['sendEmailToFriend']['recipients'][0]['name']);
self::assertEquals('recipient1@mail.com', $response['sendEmailToFriend']['recipients'][0]['email']);
self::assertEquals('Recipient Name 2', $response['sendEmailToFriend']['recipients'][1]['name']);
self::assertEquals('recipient2@mail.com', $response['sendEmailToFriend']['recipients'][1]['email']);
}
/**
* Retrieve customer authorization headers
*
* @param string $username
* @param string $password
* @return array
* @throws AuthenticationException
*/
private function getHeaderMap(string $username = 'customer@example.com', string $password = 'password'): array
{
$customerToken = $this->customerTokenService->createCustomerAccessToken($username, $password);
$headerMap = ['Authorization' => 'Bearer ' . $customerToken];
return $headerMap;
}
/**
* @param int $productId
* @param string $recipients
* @return string
*/
private function getQuery(int $productId, string $recipients): string
{
return <<<QUERY
mutation {
sendEmailToFriend(
input: {
product_id: {$productId}
sender: {
name: "Name"
email: "e@mail.com"
message: "Lorem Ipsum"
}
recipients: [{$recipients}]
}
) {
sender {
name
email
message
}
recipients {
name
email
}
}
}
QUERY;
}
}