AddDonationUseCaseTest::getSucceedingPolicyValidatorMock() - Code Metrics - Inspection of "Merge pull request #835 from wmde/never-moderate-e..." - wmde/FundraisingFrontend - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bd2868...16a7fa )

by Jeroen De

created 2017-03-01 17:20 UTC

getSucceedingPolicyValidatorMock() A

↳ Parent: AddDonationUseCaseTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	0

<?php

declare( strict_types = 1 );

namespace WMDE\Fundraising\Frontend\DonationContext\Tests\Integration\UseCases\AddDonation;

use PHPUnit_Framework_MockObject_MockObject;
use WMDE\Euro\Euro;
use WMDE\Fundraising\Frontend\DonationContext\Authorization\DonationTokenFetcher;
use WMDE\Fundraising\Frontend\DonationContext\Authorization\DonationTokens;
use WMDE\Fundraising\Frontend\DonationContext\Domain\Model\Donation;
use WMDE\Fundraising\Frontend\DonationContext\Domain\Model\DonorName;
use WMDE\Fundraising\Frontend\DonationContext\Domain\Repositories\DonationRepository;
use WMDE\Fundraising\Frontend\DonationContext\Infrastructure\DonationConfirmationMailer;
use WMDE\Fundraising\Frontend\DonationContext\Tests\Fixtures\FakeDonationRepository;
use WMDE\Fundraising\Frontend\DonationContext\Tests\Fixtures\FixedDonationTokenFetcher;
use WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\AddDonationPolicyValidator;
use WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\AddDonationRequest;
use WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\AddDonationUseCase;
use WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\AddDonationValidationResult;
use WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\AddDonationValidator;
use WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\ReferrerGeneralizer;
use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\PaymentType;
use WMDE\Fundraising\Frontend\PaymentContext\Domain\TransferCodeGenerator;
use WMDE\Fundraising\Frontend\DonationContext\Tests\Data\ValidDonation;
use WMDE\Fundraising\Frontend\Validation\ConstraintViolation;

/**
 * @covers WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\AddDonationUseCase
 *
 * @license GNU GPL v2+
 * @author Kai Nissen < [email protected] >
 * @author Jeroen De Dauw < [email protected] >
 */
class AddDonationUseCaseTest extends \PHPUnit\Framework\TestCase {

	private const UPDATE_TOKEN = 'a very nice token';
	private const ACCESS_TOKEN = 'kindly allow me access';

	/**
	 * @var \DateTime
	 */
	private $oneHourInTheFuture;

	public function setUp() {
		$this->oneHourInTheFuture = ( new \DateTime() )->add( $this->newOneHourInterval() );
	}

	public function testWhenValidationSucceeds_successResponseIsCreated() {
		$useCase = $this->newValidationSucceedingUseCase();

		$this->assertTrue( $useCase->addDonation( $this->newMinimumDonationRequest() )->isSuccessful() );
	}

	private function newValidationSucceedingUseCase(): AddDonationUseCase {
		return new AddDonationUseCase(
			$this->newRepository(),
			$this->getSucceedingValidatorMock(),
			$this->getSucceedingPolicyValidatorMock(),
			new ReferrerGeneralizer( 'http://foo.bar', [] ),
			$this->newMailer(),

			$this->newTransferCodeGenerator(),
			$this->newTokenFetcher()
		);
	}

	/**
	 * @return DonationConfirmationMailer|PHPUnit_Framework_MockObject_MockObject
	 */
	private function newMailer(): DonationConfirmationMailer {
		return $this->getMockBuilder( DonationConfirmationMailer::class )
			->disableOriginalConstructor()
			->getMock();
	}

	private function newTokenFetcher(): DonationTokenFetcher {
		return new FixedDonationTokenFetcher( new DonationTokens(
			self::ACCESS_TOKEN,
			self::UPDATE_TOKEN
		) );
	}

	private function newOneHourInterval(): \DateInterval {
		return new \DateInterval( 'PT1H' );
	}

	private function newRepository(): DonationRepository {
		return new FakeDonationRepository();
	}

	public function testValidationFails_responseObjectContainsViolations() {
		$useCase = new AddDonationUseCase(
			$this->newRepository(),
			$this->getFailingValidatorMock( new ConstraintViolation( 'foo', 'bar' ) ),
			$this->getSucceedingPolicyValidatorMock(),
			new ReferrerGeneralizer( 'http://foo.bar', [] ),
			$this->newMailer(),

			$this->newTransferCodeGenerator(),
			$this->newTokenFetcher()
		);

		$result = $useCase->addDonation( $this->newMinimumDonationRequest() );
		$this->assertEquals( [ new ConstraintViolation( 'foo', 'bar' ) ], $result->getValidationErrors() );
	}

	public function testValidationFails_responseObjectContainsRequestObject() {
		$useCase = new AddDonationUseCase(
			$this->newRepository(),
			$this->getFailingValidatorMock( new ConstraintViolation( 'foo', 'bar' ) ),
			$this->getSucceedingPolicyValidatorMock(),
			new ReferrerGeneralizer( 'http://foo.bar', [] ),
			$this->newMailer(),

			$this->newTransferCodeGenerator(),
			$this->newTokenFetcher()
		);

		$request = $this->newInvalidDonationRequest();
		$useCase->addDonation( $request );
		$this->assertEquals( $this->newInvalidDonationRequest(), $request );
	}

	private function getSucceedingValidatorMock(): AddDonationValidator {
		$validator = $this->getMockBuilder( AddDonationValidator::class )
			->disableOriginalConstructor()
			->getMock();

		$validator->method( 'validate' )->willReturn( new AddDonationValidationResult() );

		return $validator;
	}

	private function getFailingValidatorMock( ConstraintViolation $violation ): AddDonationValidator {
		$validator = $this->getMockBuilder( AddDonationValidator::class )
			->disableOriginalConstructor()
			->getMock();

		$validator->method( 'validate' )->willReturn( new AddDonationValidationResult( $violation ) );

		return $validator;
	}

	private function getSucceedingPolicyValidatorMock(): AddDonationPolicyValidator {
		$validator = $this->getMockBuilder( AddDonationPolicyValidator::class )
			->disableOriginalConstructor()
			->getMock();

		$validator->method( 'needsModeration' )->willReturn( false );

		return $validator;
	}

	private function getFailingPolicyValidatorMock(): AddDonationPolicyValidator {
		$validator = $this->getMockBuilder( AddDonationPolicyValidator::class )
			->disableOriginalConstructor()
			->getMock();

		$validator->method( 'needsModeration' )->willReturn( true );

		return $validator;
	}

	private function newMinimumDonationRequest(): AddDonationRequest {
		$donationRequest = new AddDonationRequest();
		$donationRequest->setAmount( Euro::newFromString( '1.00' ) );
		$donationRequest->setPaymentType( PaymentType::BANK_TRANSFER );
		$donationRequest->setDonorType( DonorName::PERSON_ANONYMOUS );
		return $donationRequest;
	}

	private function newInvalidDonationRequest(): AddDonationRequest {
		$donationRequest = new AddDonationRequest();
		$donationRequest->setPaymentType( PaymentType::DIRECT_DEBIT );
		$donationRequest->setAmount( Euro::newFromInt( 0 ) );
		$donationRequest->setDonorType( DonorName::PERSON_ANONYMOUS );
		return $donationRequest;
	}

	public function testGivenInvalidRequest_noConfirmationEmailIsSend() {
		$mailer = $this->newMailer();

		$mailer->expects( $this->never() )->method( $this->anything() );
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

		$useCase = new AddDonationUseCase(
			$this->newRepository(),
			$this->getFailingValidatorMock( new ConstraintViolation( 'foo', 'bar' ) ),
			$this->getSucceedingPolicyValidatorMock(),
			new ReferrerGeneralizer( 'http://foo.bar', [] ),
			$mailer,
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
			$this->newTransferCodeGenerator(),
			$this->newTokenFetcher()
		);

		$useCase->addDonation( $this->newMinimumDonationRequest() );
	}

	private function newTransferCodeGenerator(): TransferCodeGenerator {
		return $this->createMock( TransferCodeGenerator::class );
	}

	public function testGivenValidRequest_confirmationEmailIsSent() {
		$mailer = $this->newMailer();
		$donation = $this->newValidAddDonationRequestWithEmail( '[email protected]' );

		$mailer->expects( $this->once() )
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
			->method( 'sendConfirmationMailFor' )
			->with( $this->isInstanceOf( Donation::class ) );

		$useCase = $this->newUseCaseWithMailer( $mailer );
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

		$useCase->addDonation( $donation );
	}

	public function testGivenValidRequestWithExternalPaymentType_confirmationEmailIsNotSent() {
		$mailer = $this->newMailer();

		$mailer->expects( $this->never() )->method( $this->anything() );
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

		$useCase = $this->newUseCaseWithMailer( $mailer );
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

		$request = $this->newValidAddDonationRequestWithEmail( '[email protected]' );
		$request->setPaymentType( 'PPL' );
		$useCase->addDonation( $request );
	}

	public function testGivenValidRequestWithPolicyViolation_donationIsModerated() {
		$useCase = new AddDonationUseCase(
			$this->newRepository(),
			$this->getSucceedingValidatorMock(),
			$this->getFailingPolicyValidatorMock(),
			new ReferrerGeneralizer( 'http://foo.bar', [] ),
			$this->newMailer(),

			$this->newTransferCodeGenerator(),
			$this->newTokenFetcher()
		);

		$response = $useCase->addDonation( $this->newValidAddDonationRequestWithEmail( '[email protected]' ) );
		$this->assertTrue( $response->getDonation()->needsModeration() );
	}

	public function testGivenPolicyViolationForExternalPaymentDonation_donationIsNotModerated() {
		$useCase = new AddDonationUseCase(
			$this->newRepository(),
			$this->getSucceedingValidatorMock(),
			$this->getFailingPolicyValidatorMock(),
			new ReferrerGeneralizer( 'http://foo.bar', [] ),
			$this->newMailer(),

			$this->newTransferCodeGenerator(),
			$this->newTokenFetcher()
		);

		$request = $this->newValidAddDonationRequestWithEmail( '[email protected]' );
		$request->setPaymentType( 'PPL' );
		$response = $useCase->addDonation( $request );
		$this->assertFalse( $response->getDonation()->needsModeration() );
	}

	private function newUseCaseWithMailer( DonationConfirmationMailer $mailer ) {
		return new AddDonationUseCase(
			$this->newRepository(),
			$this->getSucceedingValidatorMock(),
			$this->getSucceedingPolicyValidatorMock(),
			new ReferrerGeneralizer( 'http://foo.bar', [] ),
			$mailer,
			$this->newTransferCodeGenerator(),
			$this->newTokenFetcher()
		);
	}

	private function newValidAddDonationRequestWithEmail( string $email ): AddDonationRequest {
		$request = $this->newMinimumDonationRequest();

		$request->setDonorType( DonorName::PERSON_PRIVATE );
		$request->setDonorFirstName( ValidDonation::DONOR_FIRST_NAME );
		$request->setDonorLastName( ValidDonation::DONOR_LAST_NAME );
		$request->setDonorCompany( '' );
		$request->setDonorSalutation( ValidDonation::DONOR_SALUTATION );
		$request->setDonorTitle( ValidDonation::DONOR_TITLE );
		$request->setDonorStreetAddress( ValidDonation::DONOR_STREET_ADDRESS );
		$request->setDonorCity( ValidDonation::DONOR_CITY );
		$request->setDonorPostalCode( ValidDonation::DONOR_POSTAL_CODE );
		$request->setDonorCountryCode( ValidDonation::DONOR_COUNTRY_CODE );
		$request->setDonorEmailAddress( $email );

		return $request;
	}

	private function newValidCompanyDonationRequest(): AddDonationRequest {
		$request = $this->newMinimumDonationRequest();

		$request->setDonorType( DonorName::PERSON_COMPANY );
		$request->setDonorFirstName( '' );
		$request->setDonorLastName( '' );
		$request->setDonorCompany( ValidDonation::DONOR_LAST_NAME );
		$request->setDonorSalutation( '' );
		$request->setDonorTitle( '' );
		$request->setDonorStreetAddress( ValidDonation::DONOR_STREET_ADDRESS );
		$request->setDonorCity( ValidDonation::DONOR_CITY );
		$request->setDonorPostalCode( ValidDonation::DONOR_POSTAL_CODE );
		$request->setDonorCountryCode( ValidDonation::DONOR_COUNTRY_CODE );
		$request->setDonorEmailAddress( ValidDonation::DONOR_EMAIL_ADDRESS );

		return $request;
	}

	public function testWhenAdditionWorks_successResponseContainsTokens() {
		$useCase = $this->newValidationSucceedingUseCase();

		$response = $useCase->addDonation( $this->newMinimumDonationRequest() );

		$this->assertSame( self::UPDATE_TOKEN, $response->getUpdateToken() );
		$this->assertSame( self::ACCESS_TOKEN, $response->getAccessToken() );
	}

	public function testWhenAddingCompanyDonation_salutationFieldIsSet() {
		$useCase = $this->newValidationSucceedingUseCase();

		$response = $useCase->addDonation( $this->newValidCompanyDonationRequest() );

		$this->assertSame( DonorName::COMPANY_SALUTATION, $response->getDonation()->getDonor()->getName()->getSalutation() );
	}

}


Push — master ( bd2868...16a7fa )

getSucceedingPolicyValidatorMock() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			declare( strict_types = 1 );
4
5			namespace WMDE\Fundraising\Frontend\DonationContext\Tests\Integration\UseCases\AddDonation;
6
7			use PHPUnit_Framework_MockObject_MockObject;
8			use WMDE\Euro\Euro;
9			use WMDE\Fundraising\Frontend\DonationContext\Authorization\DonationTokenFetcher;
10			use WMDE\Fundraising\Frontend\DonationContext\Authorization\DonationTokens;
11			use WMDE\Fundraising\Frontend\DonationContext\Domain\Model\Donation;
12			use WMDE\Fundraising\Frontend\DonationContext\Domain\Model\DonorName;
13			use WMDE\Fundraising\Frontend\DonationContext\Domain\Repositories\DonationRepository;
14			use WMDE\Fundraising\Frontend\DonationContext\Infrastructure\DonationConfirmationMailer;
15			use WMDE\Fundraising\Frontend\DonationContext\Tests\Fixtures\FakeDonationRepository;
16			use WMDE\Fundraising\Frontend\DonationContext\Tests\Fixtures\FixedDonationTokenFetcher;
17			use WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\AddDonationPolicyValidator;
18			use WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\AddDonationRequest;
19			use WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\AddDonationUseCase;
20			use WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\AddDonationValidationResult;
21			use WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\AddDonationValidator;
22			use WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\ReferrerGeneralizer;
23			use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\PaymentType;
24			use WMDE\Fundraising\Frontend\PaymentContext\Domain\TransferCodeGenerator;
25			use WMDE\Fundraising\Frontend\DonationContext\Tests\Data\ValidDonation;
26			use WMDE\Fundraising\Frontend\Validation\ConstraintViolation;
27
28			/**
29			* @covers WMDE\Fundraising\Frontend\DonationContext\UseCases\AddDonation\AddDonationUseCase
30			*
31			* @license GNU GPL v2+
32			* @author Kai Nissen < [email protected] >
33			* @author Jeroen De Dauw < [email protected] >
34			*/
35			class AddDonationUseCaseTest extends \PHPUnit\Framework\TestCase {
36
37			private const UPDATE_TOKEN = 'a very nice token';
38			private const ACCESS_TOKEN = 'kindly allow me access';
39
40			/**

wmde / FundraisingFrontend

Push — master ( bd2868...16a7fa )

getSucceedingPolicyValidatorMock() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like