WMDE\Fundraising\AddressChangeContext\Tests\Unit\DataAccess\DoctrineAddressChangeRepositoryTest

Complexity

Total Complexity

14

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	3	1
A	testGivenValidCompanyDonationUuid_addressChangeIsReturned()	0	10	1
A	testGivenInvalidDonationUuid_nullIsReturned()	0	4	1
A	testGivenValidPersonalDonationUuid_addressChangeIsReturned()	0	10	1
A	testGivenAddressChangeWithReceiptOptIn_optInIsStoredCorrectly()	0	8	1
A	testGivenAddressChangeWithAddress_itIsStoredCorrectly()	0	16	1
A	testGivenExportedAddressChange_itsStateIsStoredCorrectly()	0	12	1
A	newPersonalAddress()	0	10	1
A	testGivenAddressChangeWithReceiptOptOut_optOutIsStoredCorrectly()	0	9	1
A	retrieveAddressChangeByUuid()	0	4	1
A	storeAddressChange()	0	15	2
A	assertDatePropertyIsSet()	0	7	1
A	newCompanyAddress()	0	7	1

<?php

declare( strict_types = 1 );

namespace WMDE\Fundraising\AddressChangeContext\Tests\Unit\DataAccess;

use Doctrine\ORM\EntityManager;
use PHPUnit\Framework\TestCase;
use WMDE\Fundraising\AddressChange\DataAccess\DoctrineAddressChangeRepository;
use WMDE\Fundraising\AddressChange\Domain\Model\Address;
use WMDE\Fundraising\AddressChange\Domain\Model\AddressChange;
use WMDE\Fundraising\AddressChangeContext\Tests\TestEnvironment;

/**
 * @covers \WMDE\Fundraising\AddressChange\DataAccess\DoctrineAddressChangeRepository
 */
class DoctrineAddressChangeRepositoryTest extends TestCase {

	const VALID_UPDATE_TOKEN_PERSONAL_DONATION = '2a54c0a1-fc94-4ef8-8b0a-7c2ed8565521';
	const VALID_UPDATE_TOKEN_PERSONAL_MEMBERSHIP = 'ce4449f9-8317-41fa-acc3-4a878e26845d';
	const VALID_UPDATE_TOKEN_COMPANY_DONATION = 'c52258ba-fed1-476a-a7e5-c721df087c12';
	const VALID_UPDATE_TOKEN_COMPANY_MEMBERSHIP = '8d11d2ba-5ec5-4ec8-a08c-0ac7b8654b59';
	const INVALID_UPDATE_TOKEN = '72dfed91-fa40-4af0-9e80-c6010ab29cd1';

	/** @var EntityManager */
	private $em;

	public function setUp(): void {
		$this->em = TestEnvironment::newInstance()->getFactory()->getEntityManager();
		parent::setUp();
	}

	public function testGivenValidPersonalDonationUuid_addressChangeIsReturned(): void {
		$this->storeAddressChange( self::VALID_UPDATE_TOKEN_PERSONAL_DONATION, true );
		$retrievedAddressChange = $this->retrieveAddressChangeByUuid( self::VALID_UPDATE_TOKEN_PERSONAL_DONATION );

		$this->assertNotNull( $retrievedAddressChange );
		$this->assertSame(
			self::VALID_UPDATE_TOKEN_PERSONAL_DONATION,
			$retrievedAddressChange->getCurrentIdentifier()
		);
		$this->assertTrue( $retrievedAddressChange->isPersonalAddress() );
	}

	public function testGivenValidCompanyDonationUuid_addressChangeIsReturned(): void {
		$this->storeAddressChange( self::VALID_UPDATE_TOKEN_COMPANY_DONATION, false );
		$retrievedAddressChange = $this->retrieveAddressChangeByUuid( self::VALID_UPDATE_TOKEN_COMPANY_DONATION );

		$this->assertNotNull( $retrievedAddressChange );
		$this->assertSame(
			self::VALID_UPDATE_TOKEN_COMPANY_DONATION,
			$retrievedAddressChange->getCurrentIdentifier()
		);
		$this->assertTrue( $retrievedAddressChange->isCompanyAddress() );
	}

	public function testGivenInvalidDonationUuid_nullIsReturned(): void {
		$addressChangeRepository = new DoctrineAddressChangeRepository( $this->em );
		$addressChange = $addressChangeRepository->getAddressChangeByUuid( self::INVALID_UPDATE_TOKEN );
		$this->assertNull( $addressChange );
	}

	public function testGivenAddressChangeWithAddress_itIsStoredCorrectly(): void {
		$addressChangeRepository = new DoctrineAddressChangeRepository( $this->em );
		$addressChange = AddressChange::createNewPersonAddressChange( null, $this->newPersonalAddress() );
		$addressChangeRepository->storeAddressChange( $addressChange );
		$now = new \DateTime();

		$this->em->clear( AddressChange::class );
		$retrievedAddressChange = $addressChangeRepository->getAddressChangeByUuid( $addressChange->getCurrentIdentifier() );
		$this->assertNotNull( $retrievedAddressChange );
		$this->assertNotNull( $retrievedAddressChange->getAddress() );
		$this->assertNotNull( $addressChange->getAddress() ); // avoid PHPStan errors when accessing address later
		$this->assertFalse( $retrievedAddressChange->isExported() );
		$this->assertDatePropertyIsSet( $now, $retrievedAddressChange, 'createdAt' );

It seems like $retrievedAddressChange can also be of type null; however, parameter $addressChange of WMDE\Fundraising\AddressChangeContext\Tests\Unit\DataAccess\DoctrineAddressChangeRepositoryTest::assertDatePropertyIsSet() does only seem to accept WMDE\Fundraising\AddressChange\Domain\Model\AddressChange, maybe add an additional type check?

		$this->assertDatePropertyIsSet( $now, $retrievedAddressChange, 'modifiedAt' );
		$this->assertSame( $addressChange->getCurrentIdentifier(), $retrievedAddressChange->getCurrentIdentifier() );
		$this->assertSame( $addressChange->getAddress()->isPersonalAddress(), $retrievedAddressChange->getAddress()->isPersonalAddress() );
	}

	public function testGivenAddressChangeWithReceiptOptIn_optInIsStoredCorrectly(): void {
		$addressChangeRepository = new DoctrineAddressChangeRepository( $this->em );
		$addressChange = AddressChange::createNewCompanyAddressChange();
		$addressChangeRepository->storeAddressChange( $addressChange );

		$this->em->clear( AddressChange::class );
		$retrievedAddressChange = $addressChangeRepository->getAddressChangeByUuid( $addressChange->getCurrentIdentifier() );
		$this->assertTrue( $retrievedAddressChange->isOptedIntoDonationReceipt() );
	}

	public function testGivenAddressChangeWithReceiptOptOut_optOutIsStoredCorrectly(): void {
		$addressChangeRepository = new DoctrineAddressChangeRepository( $this->em );
		$addressChange = AddressChange::createNewCompanyAddressChange();
		$addressChange->optOutOfDonationReceipt();
		$addressChangeRepository->storeAddressChange( $addressChange );

		$this->em->clear( AddressChange::class );
		$retrievedAddressChange = $addressChangeRepository->getAddressChangeByUuid( $addressChange->getCurrentIdentifier() );
		$this->assertFalse( $retrievedAddressChange->isOptedIntoDonationReceipt() );
	}

	public function testGivenExportedAddressChange_itsStateIsStoredCorrectly(): void {
		$addressChangeRepository = new DoctrineAddressChangeRepository( $this->em );
		$addressChange = AddressChange::createNewPersonAddressChange( null, $this->newPersonalAddress() );
		$addressChange->markAsExported();
		$addressChangeRepository->storeAddressChange( $addressChange );
		$now = new \DateTime();

		$this->em->clear( AddressChange::class );
		$retrievedAddressChange = $addressChangeRepository->getAddressChangeByUuid( $addressChange->getCurrentIdentifier() );
		$this->assertNotNull( $retrievedAddressChange );
		$this->assertTrue( $retrievedAddressChange->isExported() );
		$this->assertDatePropertyIsSet( $now, $retrievedAddressChange, 'exportDate' );

It seems like $retrievedAddressChange can also be of type null; however, parameter $addressChange of WMDE\Fundraising\AddressChangeContext\Tests\Unit\DataAccess\DoctrineAddressChangeRepositoryTest::assertDatePropertyIsSet() does only seem to accept WMDE\Fundraising\AddressChange\Domain\Model\AddressChange, maybe add an additional type check?

	}

	private function storeAddressChange( string $uuid, bool $isPersonal = true ): void {
		if ( $isPersonal ) {
			$addressChange = AddressChange::createNewPersonAddressChange(
				$uuid,
				$this->newPersonalAddress()
			);
		} else {
			$addressChange = AddressChange::createNewCompanyAddressChange(
				$uuid,
				$this->newCompanyAddress()
			);
		}
		$this->em->persist( $addressChange );
		$this->em->flush();
		$this->em->clear( AddressChange::class );
	}

	private function retrieveAddressChangeByUuid( string $uuid ): ?AddressChange {
		$addressChangeRepository = new DoctrineAddressChangeRepository( $this->em );
		return $addressChangeRepository->getAddressChangeByUuid(
			$uuid
		);
	}

	private function newPersonalAddress(): Address {
		return Address::newPersonalAddress(
			'Herr',
			'Prof. Dr.',
			'Test',
			'User',
			'Teststreet 12345',
			'98765',
			'Berlin',
			'Germany'
		);
	}

	private function newCompanyAddress(): Address {
		return Address::newCompanyAddress(
			'Test Company',
			'Teststreet 123',
			'324324',
			'Not Berlin',
			'Somewhere'
		);
	}

	private function assertDatePropertyIsSet( \DateTime $expectedDate, AddressChange $addressChange, string $propertyName, float $delta = 1.0 ): void {
		// We're peeking into private properties to make sure the dates, which are not exposed through getters at the domain level,
		// are properly written at the DB level
		$dateField = new \ReflectionProperty( AddressChange::class, $propertyName );
		$dateField->setAccessible( true );
		$actualDate = $dateField->getValue( $addressChange );
		$this->assertEqualsWithDelta( $actualDate->getTimestamp(), $expectedDate->getTimestamp(), $delta, 'Dates do not match.' );
	}
}