WMDE\BannerServer\Tests\Unit\UseCase\BannerSelection\BannerSelectionUseCaseTest

Complexity

Total Complexity

8

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Importance

Changes	3
Bugs	1	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	test_given_display_width_range_filters_banners()	0	13	1
A	test_when_banner_is_returned_then_view_count_is_incremented()	0	11	1
A	test_given_visitor_with_category_of_campaign_then_no_banner_is_shown()	0	18	1
A	test_when_no_banner_is_returned_then_view_count_is_unchanged()	0	11	1
A	test_given_display_width_range_with_multiple_banners_selects_correct_banner()	0	17	1
A	test_given_one_percent_ratio_then_limit_is_applied_for_two_percent_rng()	0	11	1
A	test_given_max_percentage_then_limit_is_not_applied()	0	12	1
A	test_given_one_percent_ratio_then_limit_is_not_applied_for_one_percent_rng()	0	12	1

<?php

declare( strict_types = 1 );

namespace WMDE\BannerServer\Tests\Unit\UseCase\BannerSelection;

use PHPUnit\Framework\Attributes\CoversClass;

The type PHPUnit\Framework\Attributes\CoversClass was not found. Maybe you did not declare it correctly or list all dependencies?

use PHPUnit\Framework\TestCase;
use WMDE\BannerServer\Entity\BannerSelection\ImpressionThreshold;
use WMDE\BannerServer\Entity\Visitor;
use WMDE\BannerServer\Tests\Fixtures\CampaignFixture;
use WMDE\BannerServer\Tests\Fixtures\VisitorFixture;
use WMDE\BannerServer\Tests\Utils\FakeRandomIntegerGenerator;
use WMDE\BannerServer\UseCase\BannerSelection\BannerSelectionUseCase;
use WMDE\BannerServer\Utils\SystemRandomIntegerGenerator;

#[CoversClass( BannerSelectionUseCase::class )]
class BannerSelectionUseCaseTest extends TestCase {

	public function test_given_max_percentage_then_limit_is_not_applied(): void {
		$useCase = new BannerSelectionUseCase(
			CampaignFixture::getTrueRandomTestCampaignCollection( 100 ),
			new ImpressionThreshold( 10 ),
			new SystemRandomIntegerGenerator()
		);

		$bannerSelectionData = $useCase->selectBanner( VisitorFixture::getFirstTimeVisitor() );
		$this->assertEquals( 'test', $bannerSelectionData->getVisitorData()->getBucketIdentifier() );
		$this->assertSame( 1, $bannerSelectionData->getVisitorData()->getTotalImpressionCount() );
		$this->assertEquals( 'TestBanner', $bannerSelectionData->getBannerIdentifier() );
		$this->assertEquals( CampaignFixture::getTestCampaignEndDate(), $bannerSelectionData->getCampaignEnd() );
	}

	public function test_given_one_percent_ratio_then_limit_is_not_applied_for_one_percent_rng(): void {
		$useCase = new BannerSelectionUseCase(
			CampaignFixture::getTrueRandomTestCampaignCollection( 1 ),
			new ImpressionThreshold( 10 ),
			new FakeRandomIntegerGenerator( 1 )
		);

		$bannerSelectionData = $useCase->selectBanner( VisitorFixture::getFirstTimeVisitor() );
		$this->assertEquals( 'test', $bannerSelectionData->getVisitorData()->getBucketIdentifier() );
		$this->assertSame( 1, $bannerSelectionData->getVisitorData()->getTotalImpressionCount() );
		$this->assertEquals( 'TestBanner', $bannerSelectionData->getBannerIdentifier() );
		$this->assertEquals( CampaignFixture::getTestCampaignEndDate(), $bannerSelectionData->getCampaignEnd() );
	}

	public function test_given_one_percent_ratio_then_limit_is_applied_for_two_percent_rng(): void {
		$useCase = new BannerSelectionUseCase(
			CampaignFixture::getTrueRandomTestCampaignCollection( 1 ),
			new ImpressionThreshold( 10 ),
			new FakeRandomIntegerGenerator( 2 )
		);

		$bannerSelectionData = $useCase->selectBanner( VisitorFixture::getFirstTimeVisitor() );
		$this->assertFalse( $bannerSelectionData->displayBanner() );
		$this->assertNull( $bannerSelectionData->getVisitorData()->getBucketIdentifier() );
		$this->assertSame( 0, $bannerSelectionData->getVisitorData()->getTotalImpressionCount() );
	}

	public function test_given_visitor_with_category_of_campaign_then_no_banner_is_shown(): void {
		$useCase = new BannerSelectionUseCase(
			CampaignFixture::getTrueRandomTestCampaignCollection( 100 ),
			new ImpressionThreshold( 10 ),
			new SystemRandomIntegerGenerator()
		);
		$visitor = new Visitor( 0,
			null,
			500,
			CampaignFixture::TEST_CATEGORY,
			'another-irrelevant-category'
		);

		$bannerSelectionData = $useCase->selectBanner( $visitor );

		$this->assertFalse( $bannerSelectionData->displayBanner(), 'No banner should be selected' );
		$this->assertNull( $bannerSelectionData->getVisitorData()->getBucketIdentifier() );
		$this->assertSame( 0, $bannerSelectionData->getVisitorData()->getTotalImpressionCount() );
	}

	public function test_when_banner_is_returned_then_view_count_is_incremented(): void {
		$useCase = new BannerSelectionUseCase(
			CampaignFixture::getTrueRandomTestCampaignCollection( 100 ),
			new ImpressionThreshold( 10 ),
			new SystemRandomIntegerGenerator()
		);

		$bannerSelectionData = $useCase->selectBanner( VisitorFixture::getTestVisitor() );
		$this->assertEquals(
			VisitorFixture::VISITOR_TEST_IMPRESSION_COUNT + 1,
			$bannerSelectionData->getVisitorData()->getTotalImpressionCount()
		);
	}

	public function test_when_no_banner_is_returned_then_view_count_is_unchanged(): void {
		$useCase = new BannerSelectionUseCase(
			CampaignFixture::getTrueRandomTestCampaignCollection( 1 ),
			new ImpressionThreshold( 10 ),
			new FakeRandomIntegerGenerator( 2 )
		);

		$bannerSelectionData = $useCase->selectBanner( VisitorFixture::getTestVisitor() );
		$this->assertEquals(
			VisitorFixture::VISITOR_TEST_IMPRESSION_COUNT,
			$bannerSelectionData->getVisitorData()->getTotalImpressionCount()
		);
	}

	public function test_given_display_width_range_filters_banners(): void {
		$smallMobileMaxWidth = 400;

		$useCase = new BannerSelectionUseCase(
			CampaignFixture::getFixedViewportWidthCampaignCollection( $smallMobileMaxWidth ),
			new ImpressionThreshold( 10 ),
			new SystemRandomIntegerGenerator()
		);

		$bannerSelectionData = $useCase->selectBanner( VisitorFixture::getTestVisitor() );

		$this->assertFalse( $bannerSelectionData->displayBanner(),
			'No banner should be selected, because campaign was for mobile, visitor was desktop width.' );
	}

	public function test_given_display_width_range_with_multiple_banners_selects_correct_banner(): void {
		$desktopMinWidth = 600;
		$desktopIdentifier = 'C20_WMDE_Test_01';
		$mobileMaxWidth = 600;
		$mobileIdentifier = 'C20_WMDE_Test_Mobile_01';

		$useCase = new BannerSelectionUseCase(
			CampaignFixture::getMixedFixedViewportWidthCampaignCollection( $desktopMinWidth, $mobileMaxWidth, $desktopIdentifier, $mobileIdentifier ),
			new ImpressionThreshold( 10 ),
			new SystemRandomIntegerGenerator()
		);

		$desktopSelectionData = $useCase->selectBanner( VisitorFixture::getTestVisitor( 1000 ) );
		$mobileSelectionData = $useCase->selectBanner( VisitorFixture::getTestVisitor( 320 ) );

		$this->assertEquals( $desktopIdentifier, $desktopSelectionData->getBannerIdentifier() );
		$this->assertEquals( $mobileIdentifier, $mobileSelectionData->getBannerIdentifier() );
	}
}