FlattenExceptionTest.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Debug\Tests\Exception;

use Symfony\Component\Debug\Exception\FlattenException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException;
use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Symfony\Component\HttpKernel\Exception\NotAcceptableHttpException;
use Symfony\Component\HttpKernel\Exception\ConflictHttpException;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpKernel\Exception\GoneHttpException;
use Symfony\Component\HttpKernel\Exception\LengthRequiredHttpException;
use Symfony\Component\HttpKernel\Exception\PreconditionFailedHttpException;
use Symfony\Component\HttpKernel\Exception\PreconditionRequiredHttpException;
use Symfony\Component\HttpKernel\Exception\ServiceUnavailableHttpException;
use Symfony\Component\HttpKernel\Exception\TooManyRequestsHttpException;
use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;
class FlattenExceptionTest extends \PHPUnit_Framework_TestCase {
  public function testStatusCode() {
    $flattened = FlattenException::create(new \RuntimeException(), 403);
    $this
      ->assertEquals('403', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new \RuntimeException());
    $this
      ->assertEquals('500', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new NotFoundHttpException());
    $this
      ->assertEquals('404', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new UnauthorizedHttpException('Basic realm="My Realm"'));
    $this
      ->assertEquals('401', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new BadRequestHttpException());
    $this
      ->assertEquals('400', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new NotAcceptableHttpException());
    $this
      ->assertEquals('406', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new ConflictHttpException());
    $this
      ->assertEquals('409', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new MethodNotAllowedHttpException(array(
      'POST',
    )));
    $this
      ->assertEquals('405', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new AccessDeniedHttpException());
    $this
      ->assertEquals('403', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new GoneHttpException());
    $this
      ->assertEquals('410', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new LengthRequiredHttpException());
    $this
      ->assertEquals('411', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new PreconditionFailedHttpException());
    $this
      ->assertEquals('412', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new PreconditionRequiredHttpException());
    $this
      ->assertEquals('428', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new ServiceUnavailableHttpException());
    $this
      ->assertEquals('503', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new TooManyRequestsHttpException());
    $this
      ->assertEquals('429', $flattened
      ->getStatusCode());
    $flattened = FlattenException::create(new UnsupportedMediaTypeHttpException());
    $this
      ->assertEquals('415', $flattened
      ->getStatusCode());
  }
  public function testHeadersForHttpException() {
    $flattened = FlattenException::create(new MethodNotAllowedHttpException(array(
      'POST',
    )));
    $this
      ->assertEquals(array(
      'Allow' => 'POST',
    ), $flattened
      ->getHeaders());
    $flattened = FlattenException::create(new UnauthorizedHttpException('Basic realm="My Realm"'));
    $this
      ->assertEquals(array(
      'WWW-Authenticate' => 'Basic realm="My Realm"',
    ), $flattened
      ->getHeaders());
    $flattened = FlattenException::create(new ServiceUnavailableHttpException('Fri, 31 Dec 1999 23:59:59 GMT'));
    $this
      ->assertEquals(array(
      'Retry-After' => 'Fri, 31 Dec 1999 23:59:59 GMT',
    ), $flattened
      ->getHeaders());
    $flattened = FlattenException::create(new ServiceUnavailableHttpException(120));
    $this
      ->assertEquals(array(
      'Retry-After' => 120,
    ), $flattened
      ->getHeaders());
    $flattened = FlattenException::create(new TooManyRequestsHttpException('Fri, 31 Dec 1999 23:59:59 GMT'));
    $this
      ->assertEquals(array(
      'Retry-After' => 'Fri, 31 Dec 1999 23:59:59 GMT',
    ), $flattened
      ->getHeaders());
    $flattened = FlattenException::create(new TooManyRequestsHttpException(120));
    $this
      ->assertEquals(array(
      'Retry-After' => 120,
    ), $flattened
      ->getHeaders());
  }

  /**
   * @dataProvider flattenDataProvider
   */
  public function testFlattenHttpException(\Exception $exception, $statusCode) {
    $flattened = FlattenException::create($exception);
    $flattened2 = FlattenException::create($exception);
    $flattened
      ->setPrevious($flattened2);
    $this
      ->assertEquals($exception
      ->getMessage(), $flattened
      ->getMessage(), 'The message is copied from the original exception.');
    $this
      ->assertEquals($exception
      ->getCode(), $flattened
      ->getCode(), 'The code is copied from the original exception.');
    $this
      ->assertEquals(get_class($exception), $flattened
      ->getClass(), 'The class is set to the class of the original exception');
  }

  /**
   * @dataProvider flattenDataProvider
   */
  public function testPrevious(\Exception $exception, $statusCode) {
    $flattened = FlattenException::create($exception);
    $flattened2 = FlattenException::create($exception);
    $flattened
      ->setPrevious($flattened2);
    $this
      ->assertSame($flattened2, $flattened
      ->getPrevious());
    $this
      ->assertSame(array(
      $flattened2,
    ), $flattened
      ->getAllPrevious());
  }

  /**
   * @dataProvider flattenDataProvider
   */
  public function testLine(\Exception $exception) {
    $flattened = FlattenException::create($exception);
    $this
      ->assertSame($exception
      ->getLine(), $flattened
      ->getLine());
  }

  /**
   * @dataProvider flattenDataProvider
   */
  public function testFile(\Exception $exception) {
    $flattened = FlattenException::create($exception);
    $this
      ->assertSame($exception
      ->getFile(), $flattened
      ->getFile());
  }

  /**
   * @dataProvider flattenDataProvider
   */
  public function testToArray(\Exception $exception, $statusCode) {
    $flattened = FlattenException::create($exception);
    $flattened
      ->setTrace(array(), 'foo.php', 123);
    $this
      ->assertEquals(array(
      array(
        'message' => 'test',
        'class' => 'Exception',
        'trace' => array(
          array(
            'namespace' => '',
            'short_class' => '',
            'class' => '',
            'type' => '',
            'function' => '',
            'file' => 'foo.php',
            'line' => 123,
            'args' => array(),
          ),
        ),
      ),
    ), $flattened
      ->toArray());
  }
  public function flattenDataProvider() {
    return array(
      array(
        new \Exception('test', 123),
        500,
      ),
    );
  }
  public function testRecursionInArguments() {
    $a = array(
      'foo',
      array(
        2,
        &$a,
      ),
    );
    $exception = $this
      ->createException($a);
    $flattened = FlattenException::create($exception);
    $trace = $flattened
      ->getTrace();
    $this
      ->assertContains('*DEEP NESTED ARRAY*', serialize($trace));
  }
  private function createException($foo) {
    return new \Exception();
  }
  public function testSetTraceIncompleteClass() {
    $flattened = FlattenException::create(new \Exception('test', 123));
    $flattened
      ->setTrace(array(
      array(
        'file' => __FILE__,
        'line' => 123,
        'function' => 'test',
        'args' => array(
          unserialize('O:14:"BogusTestClass":0:{}'),
        ),
      ),
    ), 'foo.php', 123);
    $this
      ->assertEquals(array(
      array(
        'message' => 'test',
        'class' => 'Exception',
        'trace' => array(
          array(
            'namespace' => '',
            'short_class' => '',
            'class' => '',
            'type' => '',
            'function' => '',
            'file' => 'foo.php',
            'line' => 123,
            'args' => array(),
          ),
          array(
            'namespace' => '',
            'short_class' => '',
            'class' => '',
            'type' => '',
            'function' => 'test',
            'file' => __FILE__,
            'line' => 123,
            'args' => array(
              array(
                'incomplete-object',
                'BogusTestClass',
              ),
            ),
          ),
        ),
      ),
    ), $flattened
      ->toArray());
  }

}