stemcell/dev/tests/api-functional/testsuite/Magento/GraphQl/Customer/GetAddressesWithCustomAttributesTest.php

<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\GraphQl\Customer;

use Magento\Customer\Api\AddressMetadataInterface;
use Magento\Customer\Api\Data\CustomerInterface;
use Magento\Customer\Test\Fixture\Customer;
use Magento\Customer\Test\Fixture\CustomerAttribute;
use Magento\Eav\Api\Data\AttributeInterface;
use Magento\Eav\Api\Data\AttributeOptionInterface;
use Magento\Eav\Model\Entity\Attribute\Backend\ArrayBackend;
use Magento\Eav\Model\Entity\Attribute\Source\Table;
use Magento\Eav\Test\Fixture\AttributeOption as AttributeOptionFixture;
use Magento\Framework\Exception\AuthenticationException;
use Magento\Framework\ObjectManagerInterface;
use Magento\Integration\Api\CustomerTokenServiceInterface;
use Magento\TestFramework\Fixture\DataFixture;
use Magento\TestFramework\Fixture\DataFixtureStorageManager;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\TestCase\GraphQlAbstract;

/**
 * GraphQl tests for @see \Magento\CustomerGraphQl\Model\Customer\GetCustomer.
 */
#[
    DataFixture(
        CustomerAttribute::class,
        [
            'entity_type_id' => AddressMetadataInterface::ATTRIBUTE_SET_ID_ADDRESS,
            'attribute_set_id' => AddressMetadataInterface::ATTRIBUTE_SET_ID_ADDRESS,
            'frontend_input' => 'multiselect',
            'source_model' => Table::class,
            'backend_model' => ArrayBackend::class,
            'attribute_code' => 'labels',
            'attribute_group_id' => 1,
            'sort_order' => 2,
        ],
        'multiselect_customer_address_attribute'
    ),
    DataFixture(
        CustomerAttribute::class,
        [
            'entity_type_id' => AddressMetadataInterface::ATTRIBUTE_SET_ID_ADDRESS,
            'attribute_code' => 'planet',
            'sort_order' => 1,
            'attribute_set_id' => AddressMetadataInterface::ATTRIBUTE_SET_ID_ADDRESS,
            'attribute_group_id' => 1,
        ],
        'varchar_customer_address_attribute'
    ),
    DataFixture(
        AttributeOptionFixture::class,
        [
            'entity_type' => AddressMetadataInterface::ATTRIBUTE_SET_ID_ADDRESS,
            'attribute_code' => '$multiselect_customer_address_attribute.attribute_code$',
            'label' => 'far',
            'sort_order' => 20
        ],
        'multiselect_customer_address_attribute_option_1'
    ),
    DataFixture(
        AttributeOptionFixture::class,
        [
            'entity_type' => AddressMetadataInterface::ATTRIBUTE_SET_ID_ADDRESS,
            'attribute_code' => '$multiselect_customer_address_attribute.attribute_code$',
            'sort_order' => 10,
            'label' => 'foreign',
            'is_default' => true
        ],
        'multiselect_customer_address_attribute_option_2'
    ),
    DataFixture(
        Customer::class,
        [
            'email' => 'john@doe.com',
            'addresses' => [
                [
                    'country_id' => 'US',
                    'region_id' => 32,
                    'city' => 'Boston',
                    'street' => ['10 Milk Street'],
                    'postcode' => '02108',
                    'telephone' => '1234567890',
                    'default_billing' => true,
                    'default_shipping' => true,
                    'custom_attributes' => [
                        [
                            'attribute_code' => 'labels',
                            'selected_options' => [
                                ['value' => '$multiselect_customer_address_attribute_option_1.value$'],
                                ['value' => '$multiselect_customer_address_attribute_option_2.value$']
                            ],
                        ],
                        [
                            'attribute_code' => 'planet',
                            'value' => 'Earth'
                        ]
                    ],
                ],
            ],
        ],
        'customer'
    ),
]
class GetAddressesWithCustomAttributesTest extends GraphQlAbstract
{
    /**
     * @var string
     */
    private $currentPassword = 'password';

    /**
     * @var CustomerTokenServiceInterface
     */
    private $customerTokenService;

    /**
     * @var ObjectManagerInterface
     */
    private $objectManager;

    /**
     * @var AttributeInterface|null
     */
    private $varcharCustomerAddressAttribute;

    /**
     * @var AttributeInterface|null
     */
    private $multiselectCustomerAddressAttribute;

    /**
     * @var AttributeOptionInterface|null
     */
    private $multiselectCustomerAttributeOption1;

    /**
     * @var AttributeOptionInterface|null
     */
    private $multiselectCustomerAttributeOption2;

    /**
     * @var CustomerInterface|null
     */
    private $customer;

    /**
     * @inheridoc
     */
    protected function setUp(): void
    {
        parent::setUp();

        $this->objectManager = Bootstrap::getObjectManager();
        $this->customerTokenService = $this->objectManager->get(CustomerTokenServiceInterface::class);

        $this->varcharCustomerAddressAttribute = DataFixtureStorageManager::getStorage()->get(
            'varchar_customer_address_attribute'
        );
        $this->multiselectCustomerAddressAttribute = DataFixtureStorageManager::getStorage()->get(
            'multiselect_customer_address_attribute'
        );
        $this->multiselectCustomerAttributeOption1 = DataFixtureStorageManager::getStorage()->get(
            'multiselect_customer_address_attribute_option_1'
        );
        $this->multiselectCustomerAttributeOption2 = DataFixtureStorageManager::getStorage()->get(
            'multiselect_customer_address_attribute_option_2'
        );
        $this->customer = DataFixtureStorageManager::getStorage()->get('customer');
    }

    /**
     * @param string $email
     * @param string $password
     * @return array
     * @throws AuthenticationException
     */
    private function getCustomerAuthHeaders(string $email, string $password): array
    {
        $customerToken = $this->customerTokenService->createCustomerAccessToken($email, $password);

        return ['Authorization' => 'Bearer ' . $customerToken];
    }

    public function testGetCustomAddressAttributes()
    {
        $query = <<<QUERY
query {
    customer {
        firstname
        lastname
        email
        addresses {
            country_id
            custom_attributesV2 {
                code
                ... on AttributeValue {
                    value
                }
                ... on AttributeSelectedOptions {
                    selected_options {
                        label
                        value
                    }
                }
            }
        }
    }
}
QUERY;

        $response = $this->graphQlQuery(
            $query,
            [],
            '',
            $this->getCustomerAuthHeaders($this->customer->getEmail(), $this->currentPassword)
        );

        $this->assertEquals(
            [
                'customer' => [
                    'firstname' => $this->customer->getFirstname(),
                    'lastname' => $this->customer->getLastname(),
                    'email' => $this->customer->getEmail(),
                    'addresses' => [
                        [
                            'country_id' => 'US',
                            'custom_attributesV2' => [
                                [
                                    'code' => $this->varcharCustomerAddressAttribute->getAttributeCode(),
                                    'value' => 'Earth'
                                ],
                                [
                                    'code' => $this->multiselectCustomerAddressAttribute->getAttributeCode(),
                                    'selected_options' => [
                                        [
                                            'label' => $this->multiselectCustomerAttributeOption2->getLabel(),
                                            'value' => $this->multiselectCustomerAttributeOption2->getValue(),
                                        ],
                                        [
                                            'label' => $this->multiselectCustomerAttributeOption1->getLabel(),
                                            'value' => $this->multiselectCustomerAttributeOption1->getValue(),
                                        ]
                                    ]
                                ]
                            ]
                        ]
                    ]
                ]
            ],
            $response
        );
    }

    public function testGetFilteredCustomAddressAttributes()
    {
        $query = <<<QUERY
query {
    customer {
        firstname
        lastname
        email
        addresses {
            country_id
            custom_attributesV2(attributeCodes: ["%s"]) {
                code
                ... on AttributeValue {
                    value
                }
                ... on AttributeSelectedOptions {
                    selected_options {
                        label
                        value
                    }
                }
            }
        }
    }
}
QUERY;

        $response = $this->graphQlQuery(
            sprintf($query, $this->multiselectCustomerAddressAttribute->getAttributeCode()),
            [],
            '',
            $this->getCustomerAuthHeaders($this->customer->getEmail(), $this->currentPassword)
        );

        $this->assertEquals(
            [
                'customer' => [
                    'firstname' => $this->customer->getFirstname(),
                    'lastname' => $this->customer->getLastname(),
                    'email' => $this->customer->getEmail(),
                    'addresses' => [
                        [
                            'country_id' => 'US',
                            'custom_attributesV2' => [
                                [
                                    'code' => $this->multiselectCustomerAddressAttribute->getAttributeCode(),
                                    'selected_options' => [
                                        [
                                            'label' => $this->multiselectCustomerAttributeOption2->getLabel(),
                                            'value' => $this->multiselectCustomerAttributeOption2->getValue(),
                                        ],
                                        [
                                            'label' => $this->multiselectCustomerAttributeOption1->getLabel(),
                                            'value' => $this->multiselectCustomerAttributeOption1->getValue(),
                                        ]
                                    ]
                                ]
                            ]
                        ]
                    ]
                ]
            ],
            $response
        );
    }
}