tfboe / fm-lib

tests/Unit/Exceptions/HandlerTest.php

<?php
declare(strict_types=1);
/**
 * Created by PhpStorm.
 * User: benedikt
 * Date: 10/1/17
 * Time: 2:08 PM
 */

namespace Tfboe\FmLib\Tests\Unit\Exceptions;


use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Support\MessageBag;
use Illuminate\Validation\ValidationException;
use Illuminate\Validation\Validator;
use Symfony\Component\HttpFoundation\Response;
use Tfboe\FmLib\Exceptions\AuthenticationException;
use Tfboe\FmLib\Exceptions\DuplicateException;
use Tfboe\FmLib\Exceptions\Handler;
use Tfboe\FmLib\Exceptions\PlayerAlreadyExists;
use Tfboe\FmLib\Exceptions\ReferenceException;
use Tfboe\FmLib\Exceptions\UnorderedPhaseNumberException;
use Tfboe\FmLib\Tests\Helpers\UnitTestCase;

/**
 * Class HandlerTest
 * @package Tfboe\FmLib\Tests\Unit\Exceptions
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class HandlerTest extends UnitTestCase
{
//<editor-fold desc="Public Methods">
  /**
   * @covers \Tfboe\FmLib\Exceptions\Handler::render
   * @covers \Tfboe\FmLib\Exceptions\Handler::getExceptionHTTPStatusCode
   * @covers \Tfboe\FmLib\Exceptions\Handler::getExceptionName
   * @covers \Tfboe\FmLib\Exceptions\Handler::getJsonMessage
   * @uses   \Tfboe\FmLib\Exceptions\AuthenticationException
   * @uses   \Tfboe\FmLib\Exceptions\DuplicateException
   * @uses   \Tfboe\FmLib\Exceptions\PlayerAlreadyExists
   * @uses   \Tfboe\FmLib\Exceptions\ReferenceException
   * @uses   \Tfboe\FmLib\Exceptions\UnorderedPhaseNumberException
   */
  public function testRender()
  {
    $handler = $this->handler();
    $exception = new \Exception("Exception message");
    $res = $handler->render($this->request(), $exception);
    self::assertInstanceOf(JsonResponse::class, $res);
    /** @var JsonResponse $res */
    self::assertEquals(['status' => 500, 'message' => 'Exception message', 'name' => 'InternalException'],
      $res->getData(true));

    $exception = new \Exception("Exception message", 402);
    $res = $handler->render($this->request(), $exception);
    self::assertInstanceOf(JsonResponse::class, $res);
    /** @var JsonResponse $res */
    self::assertEquals(['status' => 402, 'message' => 'Exception message', 'name' => 'InternalException'],
      $res->getData(true));

    $exception = new AuthenticationException("Authentication Exception message");
    $res = $handler->render($this->request(), $exception);
    self::assertInstanceOf(JsonResponse::class, $res);
    /** @var JsonResponse $res */
    self::assertEquals(['status' => 401, 'message' => 'Authentication Exception message',
      'name' => 'AuthenticationException'], $res->getData(true));

    $exception = new DuplicateException('value', 'name', 'array');
    $res = $handler->render($this->request(), $exception);
    self::assertInstanceOf(JsonResponse::class, $res);
    /** @var JsonResponse $res */
    self::assertEquals(['status' => 409, 'message' => 'Duplicate Exception',
      'name' => 'DuplicateException', 'duplicateValue' => 'value', 'arrayName' => 'array'], $res->getData(true));

    $exception = new ReferenceException('value', 'name');
    $res = $handler->render($this->request(), $exception);
    self::assertInstanceOf(JsonResponse::class, $res);
    /** @var JsonResponse $res */
    self::assertEquals(['status' => 409, 'message' => 'Reference Exception',
      'name' => 'ReferenceException', 'referenceValue' => 'value', 'referenceName' => 'name'], $res->getData(true));

    $exception = new UnorderedPhaseNumberException(2, 1);
    $res = $handler->render($this->request(), $exception);
    self::assertInstanceOf(JsonResponse::class, $res);
    /** @var JsonResponse $res */
    self::assertEquals(['status' => 409, 'message' => 'Unordered Phase Number Exception',
      'name' => 'UnorderedPhaseNumberException', 'previousPhaseNumber' => 2, 'nextPhaseNumber' => 1],
      $res->getData(true));

    $exception = new PlayerAlreadyExists([]);
    $res = $handler->render($this->request(), $exception);
    self::assertInstanceOf(JsonResponse::class, $res);
    /** @var JsonResponse $res */
    self::assertEquals(['status' => 409, 'message' => 'Some players do already exist',
      'name' => 'PlayerAlreadyExistsException', 'players' => []], $res->getData(true));

    // test trace in debug mode

    $exception = new PlayerAlreadyExists([]);
    $res = $handler->render($this->request(), $exception, true);
    self::assertInstanceOf(JsonResponse::class, $res);
    /** @var JsonResponse $res */
    $data = $res->getData(true);
    self::assertArraySubset(['status' => 409, 'message' => 'Some players do already exist',

The method PHPUnit\Framework\Assert::assertArraySubset() has been deprecated with message: https://github.com/sebastianbergmann/phpunit/issues/3494

      'name' => 'PlayerAlreadyExistsException', 'players' => []], $data);
    self::assertArrayHasKey('trace', $data);
    self::assertNotEmpty($data['trace']);
  }

  /**
   * @covers \Tfboe\FmLib\Exceptions\Handler::render
   * @covers \Tfboe\FmLib\Exceptions\Handler::getExceptionHTTPStatusCode
   * @covers \Tfboe\FmLib\Exceptions\Handler::getExceptionName
   * @covers \Tfboe\FmLib\Exceptions\Handler::getJsonMessage
   */
  public function testRenderValidationErrors()
  {
    $handler = $this->handler();
    $validator = $this->createMock(Validator::class);
    $errors = $this->createMock(MessageBag::class);
    $errors->method('messages')->willReturn(['username' => ['The username field is required.']]);

The method method() does not seem to exist on object<PHPUnit\Framework\MockObject\MockObject>.

    $validator->method('errors')->willReturn($errors);

The method method() does not seem to exist on object<PHPUnit\Framework\MockObject\MockObject>.

    /** @var \Illuminate\Validation\Validator $validator */
    $exception = new ValidationException($validator, new Response('', 422));
    $request = $this->request();
    $res = $handler->render($request, $exception);
    self::assertInstanceOf(JsonResponse::class, $res);
    /** @var JsonResponse $res */
    self::assertEquals(['message' => 'The given data was invalid.', 'errors' =>
      ['username' => ['The username field is required.']],
      'status' => 422, 'name' => 'ValidationException'], $res->getData(true));
  }
//</editor-fold desc="Public Methods">

//<editor-fold desc="Private Methods">
  /**
   * @return Handler a new handler
   */
  private function handler()
  {
    return new Handler();
  }

  /**
   * @return Request a new request
   */
  private function request()
  {
    return new Request();
  }
//</editor-fold desc="Private Methods">
}