<?php
/**
* PHPCI - Continuous Integration for PHP
*
* @copyright	Copyright 2013, Block 8 Limited.
* @license		https://github.com/Block8/PHPCI/blob/master/LICENSE.md
* @link			http://www.phptesting.org/
*/

namespace PHPCI\Plugin\Tests;
use PHPCI\Plugin\Email as EmailPlugin;

define('PHPCI_BIN_DIR', "FAKEPHPCIBIN");

/**
* Unit test for the PHPUnit plugin.
* @author meadsteve
*/
class EmailTest extends  \PHPUnit_Framework_TestCase
{

	/**
	 * @var EmailPlugin $testedPhpUnit
	 */
	protected $testedEmailPlugin;

	/**
	 * @var \PHPUnit_Framework_MockObject_MockObject $mockCiBuilder
	 */
	protected $mockCiBuilder;

    /**
     * @var \PHPUnit_Framework_MockObject_MockObject $mockMailer
     */
    protected $mockMailer;

	public function setUp()
	{
		$this->mockCiBuilder = $this->getMock(
			'\PHPCI\Builder',
			array('getConfig'),
			array(),
			"mockBuilder",
			false
		);
		$this->mockCiBuilder->buildPath = "/";
        $this->mockCiBuilder->expects($this->any())
            ->method('getConfig')
            ->with('email_settings')
            ->will($this->returnValue(array(
                'from_address'  => "test-from-address@example.com"
            )));

        $this->mockMailer = $this->getMock(
			'\Swift_Mailer',
			array('send'),
			array(),
			"mockMailer",
			false
		);

		$this->loadEmailPluginWithOptions();
	}

	protected function loadEmailPluginWithOptions($arrOptions = array())
	{
		$this->testedEmailPlugin = new EmailPlugin(
            $this->mockCiBuilder,
            $arrOptions,
            $this->mockMailer
        );
	}

	/**
	 * @covers PHPUnit::execute
	 */
	public function testExecute_ReturnsTrueWithoutArgs()
	{
		$returnValue = $this->testedEmailPlugin->execute();
		$expectedReturn = true;

		$this->assertEquals($expectedReturn, $returnValue);
	}

    /**
	 * @covers PHPUnit::sendEmail
	 */
    public function testSendEmail_CallsMailerSend()
    {
        $this->mockMailer->expects($this->once())
            ->method('send');
        $this->testedEmailPlugin->sendEmail("test@email.com", "hello", "body");
    }

    /**
	 * @covers PHPUnit::sendEmail
	 */
    public function testSendEmail_BuildsAMessageObject()
    {
        $subject = "Test mail";
        $body = "Message Body";
        $toAddress = "test@example.com";

        $this->mockMailer->expects($this->once())
            ->method('send')
            ->with($this->isInstanceOf('\Swift_Message'), $this->anything());
        $this->testedEmailPlugin->sendEmail($toAddress, $subject, $body);
    }

    /**
	 * @covers PHPUnit::sendEmail
	 */
    public function testSendEmail_BuildsExpectedMessage()
    {
        $subject = "Test mail";
        $body = "Message Body";
        $toAddress = "test@example.com";
        $expectedMessage = \Swift_Message::newInstance($subject)
            ->setFrom('test-from-address@example.com')
            ->setTo($toAddress)
            ->setBody($body);

        /** @var \Swift_Message $actualMail */
        $actualMail = null;
        $this->catchMailPassedToSend($actualMail);

        $this->testedEmailPlugin->sendEmail($toAddress, $subject, $body);

        $this->assertSystemMail(
            $toAddress,
            'test-from-address@example.com',
            $body,
            $subject,
            $actualMail
        );
    }

    /**
     * @param \Swift_Message $actualMail   passed by ref and populated with
     *                                     the message object the mock mailer
     *                                     receives.
     */
    protected function catchMailPassedToSend(&$actualMail)
    {
        $this->mockMailer->expects($this->once())
            ->method('send')
            ->will(
                $this->returnCallback(
                    function ($passedMail) use (&$actualMail) {
                        $actualMail = $passedMail;
                        return array();
                    }
                )
            );
    }

    /**
     * Asserts that the actual mail object is populated as expected.
     *
     * @param string $expectedToAddress
     * @param $expectedFromAddress
     * @param string $expectedBody
     * @param string $expectedSubject
     * @param \Swift_Message $actualMail
     */
    protected function assertSystemMail($expectedToAddress,
                                        $expectedFromAddress,
                                        $expectedBody,
                                        $expectedSubject,
                                        $actualMail)
    {
        $this->assertEquals(
            array($expectedFromAddress => null),
            $actualMail->getFrom()
        );

        $this->assertEquals(
            array($expectedToAddress => null),
            $actualMail->getTo()
        );

        $this->assertEquals(
            $expectedBody,
            $actualMail->getBody()
        );

        $this->assertEquals(
            $expectedSubject,
            $actualMail->getSubject()
        );
    }
}