mautic / mautic

app/bundles/PageBundle/Tests/Controller/PublicControllerTest.php

<?php

/*
 * @copyright   2016 Mautic Contributors. All rights reserved
 * @author      Mautic
 *
 * @link        http://mautic.org
 *
 * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace Mautic\PageBundle\Tests\Controller;

use Mautic\CoreBundle\Entity\IpAddress;
use Mautic\CoreBundle\Exception\InvalidDecodedStringException;
use Mautic\CoreBundle\Factory\ModelFactory;
use Mautic\CoreBundle\Helper\CookieHelper;
use Mautic\CoreBundle\Helper\IpLookupHelper;
use Mautic\CoreBundle\Security\Permissions\CorePermissions;
use Mautic\CoreBundle\Templating\Helper\AnalyticsHelper;
use Mautic\CoreBundle\Templating\Helper\AssetsHelper;
use Mautic\LeadBundle\Entity\Lead;
use Mautic\LeadBundle\Helper\PrimaryCompanyHelper;
use Mautic\LeadBundle\Model\LeadModel;
use Mautic\PageBundle\Controller\PublicController;
use Mautic\PageBundle\Entity\Page;
use Mautic\PageBundle\Entity\Redirect;
use Mautic\PageBundle\Event\TrackingEvent;

The type Mautic\PageBundle\Event\TrackingEvent was not found. Maybe you did not declare it correctly or list all dependencies?

use Mautic\PageBundle\Model\PageModel;
use Mautic\PageBundle\Model\RedirectModel;
use PHPUnit\Framework\TestCase;
use Symfony\Bridge\Monolog\Logger;
use Symfony\Component\DependencyInjection\Container;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Router;

class PublicControllerTest extends TestCase
{
    /** @var PublicControllerTest */
    private $controller;

    /** @var Container */
    private $container;

    /** @var Logger */
    private $logger;

    /** @var ModelFactory */
    private $modelFactory;

    /** @var RedirectModel */
    private $redirectModel;

    /** @var Redirect */
    private $redirect;

    /** @var Request */
    private $request;

    /** @var IpLookupHelper */
    private $ipLookupHelper;

    /** @var IpAddress */
    private $ipAddress;

    /** @var LeadModel */
    private $leadModel;

    /** @var PageModel */
    private $pageModel;

    /** @var PrimaryCompanyHelper */
    private $primaryCompanyHelper;

    protected function setUp(): void
    {
        $this->controller           = new PublicController();

It seems like new Mautic\PageBundle\Controller\PublicController() of type Mautic\PageBundle\Controller\PublicController is incompatible with the declared type Mautic\PageBundle\Tests\Controller\PublicControllerTest of property $controller.

        $this->request              = new Request();
        $this->container            = $this->createMock(Container::class);

It seems like $this->createMock(Symfony\Component\DependencyInjection\Container::class) of type PHPUnit\Framework\MockObject\MockObject is incompatible with the declared type Symfony\Component\DependencyInjection\Container of property $container.

        $this->logger               = $this->createMock(Logger::class);

It seems like $this->createMock(Symfony\Bridge\Monolog\Logger::class) of type PHPUnit\Framework\MockObject\MockObject is incompatible with the declared type Symfony\Bridge\Monolog\Logger of property $logger.

        $this->modelFactory         = $this->createMock(ModelFactory::class);

It seems like $this->createMock(Mautic\CoreBundle\Factory\ModelFactory::class) of type PHPUnit\Framework\MockObject\MockObject is incompatible with the declared type Mautic\CoreBundle\Factory\ModelFactory of property $modelFactory.

        $this->redirectModel        = $this->createMock(RedirectModel::class);

It seems like $this->createMock(Mautic\PageBundle\Model\RedirectModel::class) of type PHPUnit\Framework\MockObject\MockObject is incompatible with the declared type Mautic\PageBundle\Model\RedirectModel of property $redirectModel.

        $this->redirect             = $this->createMock(Redirect::class);

It seems like $this->createMock(Mautic\PageBundle\Entity\Redirect::class) of type PHPUnit\Framework\MockObject\MockObject is incompatible with the declared type Mautic\PageBundle\Entity\Redirect of property $redirect.

        $this->ipLookupHelper       = $this->createMock(IpLookupHelper::class);

It seems like $this->createMock(Mautic\CoreBundle\Helper\IpLookupHelper::class) of type PHPUnit\Framework\MockObject\MockObject is incompatible with the declared type Mautic\CoreBundle\Helper\IpLookupHelper of property $ipLookupHelper.

        $this->ipAddress            = $this->createMock(IpAddress::class);

It seems like $this->createMock(Mautic\CoreBundle\Entity\IpAddress::class) of type PHPUnit\Framework\MockObject\MockObject is incompatible with the declared type Mautic\CoreBundle\Entity\IpAddress of property $ipAddress.

        $this->leadModel            = $this->createMock(LeadModel::class);

It seems like $this->createMock(Mautic\LeadBundle\Model\LeadModel::class) of type PHPUnit\Framework\MockObject\MockObject is incompatible with the declared type Mautic\LeadBundle\Model\LeadModel of property $leadModel.

        $this->pageModel            = $this->createMock(PageModel::class);

It seems like $this->createMock(Mautic\PageBundle\Model\PageModel::class) of type PHPUnit\Framework\MockObject\MockObject is incompatible with the declared type Mautic\PageBundle\Model\PageModel of property $pageModel.

        $this->primaryCompanyHelper = $this->createMock(PrimaryCompanyHelper::class);

It seems like $this->createMock(Mautic\LeadBundle\Helper\PrimaryCompanyHelper::class) of type PHPUnit\Framework\MockObject\MockObject is incompatible with the declared type Mautic\LeadBundle\Helper\PrimaryCompanyHelper of property $primaryCompanyHelper.

        $this->controller->setContainer($this->container);
        $this->controller->setRequest($this->request);

        parent::setUp();
    }

    /**
     * Test that the appropriate variant is displayed based on hit counts and variant weights.
     */
    public function testVariantPageWeightsAreAppropriate()
    {
        // Each of these should return the one with the greatest weight deficit based on
        // A = 50%
        // B = 25%
        // C = 25%

        // A = 0/50; B = 0/25; C = 0/25
        $this->assertEquals('pageA', $this->getVariantContent(0, 0, 0));

        // A = 100/50; B = 0/25; C = 0/25
        $this->assertEquals('pageB', $this->getVariantContent(1, 0, 0));

        // A = 50/50; B = 50/25; C = 0/25;
        $this->assertEquals('pageC', $this->getVariantContent(1, 1, 0));

        // A = 33/50; B = 33/25; C = 33/25;
        $this->assertEquals('pageA', $this->getVariantContent(1, 1, 1));

        // A = 66/50; B = 33/25; C = 0/25
        $this->assertEquals('pageC', $this->getVariantContent(2, 1, 0));

        // A = 50/50; B = 25/25; C = 25/25
        $this->assertEquals('pageA', $this->getVariantContent(2, 1, 1));

        // A = 33/50; B = 66/50; C = 0/25
        $this->assertEquals('pageC', $this->getVariantContent(1, 2, 0));

        // A = 25/50; B = 50/50; C = 25/25
        $this->assertEquals('pageA', $this->getVariantContent(1, 2, 1));

        // A = 55/50; B = 18/25; C = 27/25
        $this->assertEquals('pageB', $this->getVariantContent(6, 2, 3));

        // A = 50/50; B = 25/25; C = 25/25
        $this->assertEquals('pageA', $this->getVariantContent(6, 3, 3));
    }

    /**
     * @param $aCount
     * @param $bCount
     * @param $cCount
     *
     * @return string
     */
    private function getVariantContent($aCount, $bCount, $cCount)
    {
        $pageEntityB = $this->getMockBuilder(Page::class)
            ->disableOriginalConstructor()
            ->getMock();
        $pageEntityB->method('getId')
            ->will($this->returnValue(2));
        $pageEntityB->method('isPublished')
            ->will($this->returnValue(true));
        $pageEntityB->method('getVariantHits')
            ->will($this->returnValue($bCount));
        $pageEntityB->method('getTranslations')
            ->will($this->returnValue([]));
        $pageEntityB->method('isTranslation')
            ->will($this->returnValue(false));
        $pageEntityB->method('getContent')
            ->will($this->returnValue(null));
        $pageEntityB->method('getCustomHtml')
            ->will($this->returnValue('pageB'));
        $pageEntityB->method('getVariantSettings')
            ->will($this->returnValue(['weight' => '25']));

        $pageEntityC = $this->getMockBuilder(Page::class)
            ->disableOriginalConstructor()
            ->getMock();
        $pageEntityC->method('getId')
            ->will($this->returnValue(3));
        $pageEntityC->method('isPublished')
            ->will($this->returnValue(true));
        $pageEntityC->method('getVariantHits')
            ->will($this->returnValue($cCount));
        $pageEntityC->method('getTranslations')
            ->will($this->returnValue([]));
        $pageEntityC->method('isTranslation')
            ->will($this->returnValue(false));
        $pageEntityC->method('getContent')
            ->will($this->returnValue(null));
        $pageEntityC->method('getCustomHtml')
            ->will($this->returnValue('pageC'));
        $pageEntityC->method('getVariantSettings')
            ->will($this->returnValue(['weight' => '25']));

        $pageEntityA = $this->getMockBuilder(Page::class)
            ->disableOriginalConstructor()
            ->getMock();
        $pageEntityA->method('getId')
            ->will($this->returnValue(1));
        $pageEntityA->method('isPublished')
            ->will($this->returnValue(true));
        $pageEntityA->method('getVariants')
            ->will($this->returnValue([$pageEntityA, [2 => $pageEntityB, 3 => $pageEntityC]]));
        $pageEntityA->method('getVariantHits')
            ->will($this->returnValue($aCount));
        $pageEntityA->method('getTranslations')
            ->will($this->returnValue([]));
        $pageEntityA->method('isTranslation')
            ->will($this->returnValue(false));
        $pageEntityA->method('getContent')
            ->will($this->returnValue(null));
        $pageEntityA->method('getCustomHtml')
            ->will($this->returnValue('pageA'));
        $pageEntityA->method('getVariantSettings')
            ->will($this->returnValue(['weight' => '50']));

        $cookieHelper = $this->getMockBuilder(CookieHelper::class)
            ->disableOriginalConstructor()
            ->getMock();

        $ipHelper = $this->getMockBuilder(IpLookupHelper::class)
            ->disableOriginalConstructor()
            ->getMock();
        $ipHelper->method('getIpAddress')
            ->will($this->returnValue(new IpAddress()));

        $assetHelper = $this->getMockBuilder(AssetsHelper::class)
            ->disableOriginalConstructor()
            ->getMock();

        $mauticSecurity = $this->getMockBuilder(CorePermissions::class)
            ->disableOriginalConstructor()
            ->getMock();
        $mauticSecurity->method('hasEntityAccess')
            ->will($this->returnValue(false));

        $analyticsHelper = $this->getMockBuilder(AnalyticsHelper::class)
            ->disableOriginalConstructor()
            ->getMock();

        $pageModel = $this->getMockBuilder(PageModel::class)
            ->disableOriginalConstructor()
            ->getMock();
        $pageModel->method('getHitQuery')
            ->will($this->returnValue([]));
        $pageModel->method('getEntityBySlugs')
            ->will($this->returnValue($pageEntityA));
        $pageModel->method('hitPage')
            ->will($this->returnValue(true));

        $leadModel = $this->getMockBuilder(LeadModel::class)
            ->disableOriginalConstructor()
            ->getMock();
        $leadModel->method('getContactFromRequest')
            ->will($this->returnValue(new Lead()));

        $router = $this->getMockBuilder(Router::class)
            ->disableOriginalConstructor()
            ->getMock();

        $dispatcher = new EventDispatcher();

        $modelFactory = $this->getMockBuilder(ModelFactory::class)
            ->disableOriginalConstructor()
            ->getMock();
        $modelFactory->method('getModel')
            ->will(
                $this->returnValueMap(
                    [
                        ['page', $pageModel],
                        ['lead', $leadModel],
                    ]
                )
            );

        $container = $this->getMockBuilder(Container::class)
            ->disableOriginalConstructor()
            ->getMock();
        $container->method('has')
            ->will($this->returnValue(true));
        $container->method('get')
            ->will(
                $this->returnValueMap(
                    [
                        ['mautic.helper.cookie', Container::EXCEPTION_ON_INVALID_REFERENCE, $cookieHelper],
                        ['templating.helper.assets', Container::EXCEPTION_ON_INVALID_REFERENCE, $assetHelper],
                        ['mautic.helper.ip_lookup', Container::EXCEPTION_ON_INVALID_REFERENCE, $ipHelper],
                        ['mautic.security', Container::EXCEPTION_ON_INVALID_REFERENCE, $mauticSecurity],
                        ['mautic.helper.template.analytics', Container::EXCEPTION_ON_INVALID_REFERENCE, $analyticsHelper],
                        ['mautic.page.model.page', Container::EXCEPTION_ON_INVALID_REFERENCE, $pageModel],
                        ['mautic.lead.model.lead', Container::EXCEPTION_ON_INVALID_REFERENCE, $leadModel],
                        ['router', Container::EXCEPTION_ON_INVALID_REFERENCE, $router],
                        ['event_dispatcher', Container::EXCEPTION_ON_INVALID_REFERENCE, $dispatcher],
                        ['mautic.model.factory', Container::EXCEPTION_ON_INVALID_REFERENCE, $modelFactory],
                    ]
                )
            );

        $this->request->attributes->set('ignore_mismatch', true);

        $this->controller->setContainer($container);

The method setContainer() does not exist on Mautic\PageBundle\Tests\Controller\PublicControllerTest.

        $response = $this->controller->indexAction('/page/a', $this->request);

The method indexAction() does not exist on Mautic\PageBundle\Tests\Controller\PublicControllerTest.

        return $response->getContent();
    }

    public function testThatInvalidClickTroughGetsProcessed()
    {
        $redirectId  = 'someRedirectId';
        $clickTrough = 'someClickTroughValue';
        $redirectUrl = 'https://someurl.test/';

        $this->redirectModel->expects($this->once())

The method expects() does not exist on Mautic\PageBundle\Model\RedirectModel.

            ->method('getRedirectById')
            ->with($redirectId)
            ->willReturn($this->redirect);

        $this->modelFactory->expects($this->exactly(3))

The method expects() does not exist on Mautic\CoreBundle\Factory\ModelFactory.

            ->method('getModel')
            ->withConsecutive(['page.redirect'], ['lead'], ['page'])
            ->willReturnOnConsecutiveCalls($this->redirectModel, $this->leadModel, $this->pageModel);

        $this->redirect->expects($this->once())

The method expects() does not exist on Mautic\PageBundle\Entity\Redirect. Since you implemented __call, consider adding a @method annotation.

            ->method('isPublished')
            ->with(false)
            ->willReturn(true);

        $this->redirect->expects($this->once())
            ->method('getUrl')
            ->willReturn($redirectUrl);

        $this->ipLookupHelper->expects($this->once())

The method expects() does not exist on Mautic\CoreBundle\Helper\IpLookupHelper.

            ->method('getIpAddress')
            ->willReturn($this->ipAddress);

        $this->ipAddress->expects($this->once())

The method expects() does not exist on Mautic\CoreBundle\Entity\IpAddress.

            ->method('isTrackable')
            ->willReturn(true);

        $getContactFromRequestCallback = function ($queryFields) use ($clickTrough) {
            if (empty($queryFields)) {
                return null;
            }

            throw new InvalidDecodedStringException($clickTrough);
        };

        $this->leadModel->expects($this->exactly(2))

The method expects() does not exist on Mautic\LeadBundle\Model\LeadModel.

            ->method('getContactFromRequest')
            ->will($this->returnCallback($getContactFromRequestCallback));

        $this->container->expects($this->exactly(6))

The method expects() does not exist on Symfony\Component\DependencyInjection\Container.

            ->method('get')
            ->withConsecutive(
                ['monolog.logger.mautic'],
                ['mautic.model.factory'],
                ['mautic.helper.ip_lookup'],
                ['mautic.model.factory'],
                ['mautic.model.factory'],
                ['mautic.lead.helper.primary_company']
                )
            ->willReturnOnConsecutiveCalls(
                $this->logger,
                $this->modelFactory,
                $this->ipLookupHelper,
                $this->modelFactory,
                $this->modelFactory,
                $this->primaryCompanyHelper
        );

        $this->request->query->set('ct', $clickTrough);

        $response = $this->controller->redirectAction($redirectId);

The method redirectAction() does not exist on Mautic\PageBundle\Tests\Controller\PublicControllerTest.

        $this->assertInstanceOf(RedirectResponse::class, $response);
    }
}