heisencache-8.x-1.x-dev/src/Heisencache/tests/DebugSubscriberTest.php

<?php
/**
 * @file
 * Unit tests for the DebugSubscriber class.
 *
 * @author: Frederic G. MARAND <fgm@osinet.fr>
 *
 * @copyright (c) 2013-2014 Ouest Systèmes Informatiques (OSInet).
 *
 * @license General Public License version 2 or later
 */

namespace Drupal\heisencache\tests;

use Drupal\heisencache\DebugSubscriber;
use Drupal\heisencache\EventEmitter;
use Drupal\heisencache\MissSubscriber;
use PHPUnit\Framework\TestCase;

class DebugSubscriberTest extends TestCase {
  /**
   * Fully qualified class name for DebugSubscriber.
   */
  const FQCN = 'Drupal\heisencache\DebugSubscriber';

  protected $events = NULL;

  public function setUp() {
    $this->events = array_merge(
      Cache::getEmittedEvents(),
      MissSubscriber::getEmittedEvents()
    );
  }

  public function testExplicitEventRegistration() {
    $event1 = 'event1';
    $event2 = 'event2';
    $events = array($event1, $event2);

    $sub = new DebugSubscriber($events);
    $actual = $sub->getSubscribedEvents();
    $this->assertEquals($actual, $events);
  }

  public function testImplicitEventRegistration() {
    $sub = new DebugSubscriber();
    $actual = $sub->getSubscribedEvents();
    $this->assertEquals($actual, $this->events);
  }

  public function testEventHandling() {
    $channel = "some_bin";

    /** @var \Drupal\heisencache\Tests\MockEventSubscriberInterface $mock */
    $mock = $this->getMockBuilder(self::FQCN)
      ->onlyMethods(['getSubscribedEvents', 'show'])
      ->getMock();
    $mock->expects($this->exactly(count($this->events)))
      ->method('show');
    $mock->expects($this->once())
      ->method('getSubscribedEvents')
      ->will($this->returnValue($this->events));

    $emitter = new EventEmitter();
    try {
      $emitter->register($mock);
    }
    catch (\InvalidArgumentException $e) {
      $this->fail("Registering the DebugSubscriber on the Emitter failed: " . $e->getMessage());
    }

    $eventMap = array(
      'onCacheConstruct' => array('bin'),
      'onShutdown' => array('bin'),

      'beforeGet' => array('k'),
      'afterGet' => array('k', 'v'),

      'beforeGetMultiple' => array(array('k1', 'k2')),
      'afterGetMultiple' =>array( array('k1', 'k2')),

      'beforeSet' => array('k', 'v'),
      'afterSet' => array('k', 'v'),

      'beforeClear' => array(),
      'afterClear' => array(),

      'beforeIsEmpty' => array(),
      'afterIsEmpty' => array(),

      'miss' => array(),
      'missMultiple' => array(),
    );

    foreach ($eventMap as $eventName => $eventArgs) {
      array_unshift($eventArgs, $channel);
      array_unshift($eventArgs, $eventName);
      $notified = call_user_func_array(array($emitter, 'emit'), $eventArgs);
      $this->assertEquals(1, $notified, "Event $eventName caused one notification");
    }
  }

  public function testShow() {
    $arg = 'foo';
    $sub = new DebugSubscriber();
    $sub->show($arg);
    $this->expectOutputRegex('/' . __FUNCTION__ . "\($arg\)/");
  }
}