maciejslawik / freshmail

tests/Campaign/CampaignTestHandlerTest.php

<?php
/**
 * File: CampaignTestHandlerTest.php
 *
 * @author      Maciej Sławik <maciekslawik@gmail.com>
 * Github:      https://github.com/maciejslawik
 */

namespace MSlwk\FreshMail\Test\Campaign;

use MSlwk\FreshMail\Handler\Campaign\CampaignTestHandler;
use MSlwk\FreshMail\Tests\BaseTest;
use PHPUnit\Framework\TestCase;
use MSlwk\FreshMail\Error\ErrorHandler;
use MSlwk\FreshMail\Exception\Campaign\FreshMailCampaignException;

/**
 * Class CampaignTestHandlerTest
 *
 * @package MSlwk\FreshMail\Test\Campaign
 */
class CampaignTestHandlerTest extends TestCase
{
    use BaseTest;

    /**
     * @param $sendRequestReturnValue
     * @return \PHPUnit_Framework_MockObject_MockObject

The type PHPUnit_Framework_MockObject_MockObject was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getCampaignTestHandlerMock($sendRequestReturnValue)
    {
        $campaignTestHandler = $this->getMockBuilder('\MSlwk\FreshMail\Handler\Campaign\CampaignTestHandler')

The function PHPUnit\Framework\MockObject\MockBuilder::setMethods() has been deprecated: https://github.com/sebastianbergmann/phpunit/pull/3687

            ->setConstructorArgs([new ErrorHandler(), '', ''])
            ->setMethods(['sendRequest'])
            ->getMock();

        $campaignTestHandler->expects($this->once())
            ->method('sendRequest')
            ->will($this->returnValue($sendRequestReturnValue));

        return $campaignTestHandler;

The expression return $campaignTestHandler returns the type PHPUnit\Framework\MockObject\MockObject which is incompatible with the documented return type PHPUnit_Framework_MockObject_MockObject.

    }

    public function testCampaignTestSuccessfullySent()
    {
        $campaignTestHandler = $this->getCampaignTestHandlerMock('{"status":"OK"}');
        $returnValue = $campaignTestHandler->testCampaign('id_hash', ['test@test.com']);
        self::assertNull($returnValue);
    }

    public function testApiEndpoint()
    {
        $accountCreateHandler = new CampaignTestHandler(new ErrorHandler(), '', '');
        $expectedApiEndpoint = '/rest/campaigns/sendTest';
        $returnedApiEndpoint = $this->getApiEndpoint($accountCreateHandler);
        self::assertEquals($expectedApiEndpoint, $returnedApiEndpoint);
    }

    public function testIncorrectCampaignHash()
    {
        $campaignTestHandler = $this->getCampaignTestHandlerMock(
            '{"errors":[{ "message":"Incorrect campaign hash", "code":"1721" }], "status":"errors"}'
        );
        $this->expectException(FreshMailCampaignException::class);
        $campaignTestHandler->testCampaign('id_hash', ['test@test.com']);
    }

    public function testEmptyEmail()
    {
        $campaignTestHandler = $this->getCampaignTestHandlerMock(
            '{"errors":[{ "message":"Missing email address", "code":"1722" }], "status":"errors"}'
        );
        $this->expectException(FreshMailCampaignException::class);
        $campaignTestHandler->testCampaign('id_hash', ['test@test.com']);
    }

    public function testAtLeastOneEmailInvalid()
    {
        $campaignTestHandler = $this->getCampaignTestHandlerMock(
            '{"errors":[{ "message":"At least one email is invalid", "code":"1723" }], "status":"errors"}'
        );
        $this->expectException(FreshMailCampaignException::class);
        $campaignTestHandler->testCampaign('id_hash', ['test@test.com']);
    }

    public function testCampaignDoesntExist()
    {
        $campaignTestHandler = $this->getCampaignTestHandlerMock(
            '{"errors":[{ "message":"Requested campaign doesnt exist", "code":"1724" }], "status":"errors"}'
        );
        $this->expectException(FreshMailCampaignException::class);
        $campaignTestHandler->testCampaign('id_hash', ['test@test.com']);
    }

    public function testCampaignNotReadyToSend()
    {
        $campaignTestHandler = $this->getCampaignTestHandlerMock(
            '{"errors":[{ "message":"Campaign not ready to send", "code":"1725" }], "status":"errors"}'
        );
        $this->expectException(FreshMailCampaignException::class);
        $campaignTestHandler->testCampaign('id_hash', ['test@test.com']);
    }

    public function testSendingFailed()
    {
        $campaignTestHandler = $this->getCampaignTestHandlerMock(
            '{"errors":[{ "message":"Sending the campaign failed", "code":"1726" }], "status":"errors"}'
        );
        $this->expectException(FreshMailCampaignException::class);
        $campaignTestHandler->testCampaign('id_hash', ['test@test.com']);
    }
}