From 687b46389df2950d791f799f7ed1122e39efb967 Mon Sep 17 00:00:00 2001
From: James Brooks <james@bluebaytravel.co.uk>
Date: Mon, 14 Sep 2015 08:47:51 +0100
Subject: [PATCH] Started work on Events tests

---
 app/Events/User/UserEventInterface.php        | 17 +++++
 app/Events/User/UserWasAddedEvent.php         |  4 +-
 app/Events/User/UserWasRemovedEvent.php       |  4 +-
 tests/AbstractAnemicTestCase.php              | 67 +++++++++++++++++++
 tests/Events/AbstractEventTestCase.php        | 54 +++++++++++++++
 .../Events/User/AbstractUserEventTestCase.php | 23 +++++++
 tests/Events/User/UserWasAddedEventTest.php   | 26 +++++++
 7 files changed, 193 insertions(+), 2 deletions(-)
 create mode 100644 app/Events/User/UserEventInterface.php
 create mode 100644 tests/AbstractAnemicTestCase.php
 create mode 100644 tests/Events/AbstractEventTestCase.php
 create mode 100644 tests/Events/User/AbstractUserEventTestCase.php
 create mode 100644 tests/Events/User/UserWasAddedEventTest.php

diff --git a/app/Events/User/UserEventInterface.php b/app/Events/User/UserEventInterface.php
new file mode 100644
index 00000000..f9f88df3
--- /dev/null
+++ b/app/Events/User/UserEventInterface.php
@@ -0,0 +1,17 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Cachet\Events\User;
+
+interface UserEventInterface
+{
+    //
+}
diff --git a/app/Events/User/UserWasAddedEvent.php b/app/Events/User/UserWasAddedEvent.php
index e230ba95..d0e72749 100644
--- a/app/Events/User/UserWasAddedEvent.php
+++ b/app/Events/User/UserWasAddedEvent.php
@@ -13,7 +13,7 @@ namespace CachetHQ\Cachet\Events\User;
 
 use CachetHQ\Cachet\Models\User;
 
-class UserWasAddedEvent
+final class UserWasAddedEvent implements UserEventInterface
 {
     /**
      * The user that has been added.
@@ -24,6 +24,8 @@ class UserWasAddedEvent
 
     /**
      * Create a new user was added event instance.
+     *
+     * @return void
      */
     public function __construct(User $user)
     {
diff --git a/app/Events/User/UserWasRemovedEvent.php b/app/Events/User/UserWasRemovedEvent.php
index f7af80fc..141d08a6 100644
--- a/app/Events/User/UserWasRemovedEvent.php
+++ b/app/Events/User/UserWasRemovedEvent.php
@@ -13,7 +13,7 @@ namespace CachetHQ\Cachet\Events\User;
 
 use CachetHQ\Cachet\Models\User;
 
-class UserWasRemovedEvent
+final class UserWasRemovedEvent implements UserEventInterface
 {
     /**
      * The user that has been removed.
@@ -24,6 +24,8 @@ class UserWasRemovedEvent
 
     /**
      * Create a new user was removed event instance.
+     *
+     * @return void
      */
     public function __construct(User $user)
     {
diff --git a/tests/AbstractAnemicTestCase.php b/tests/AbstractAnemicTestCase.php
new file mode 100644
index 00000000..005c4fb8
--- /dev/null
+++ b/tests/AbstractAnemicTestCase.php
@@ -0,0 +1,67 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Tests\Cachet;
+
+use ReflectionClass;
+
+/**
+ * This is the abstract anemic test case class.
+ *
+ * @author Graham Campbell <graham@alt-three.com>
+ */
+abstract class AbstractAnemicTestCase extends AbstractTestCase
+{
+    public function testClassIsFinal()
+    {
+        $rc = new ReflectionClass($this->getObjectAndParams()['object']);
+
+        $this->assertTrue($rc->isFinal());
+    }
+
+    public function testPropertiesMatchTheConstructor()
+    {
+        $rc = new ReflectionClass($this->getObjectAndParams()['object']);
+
+        $properties = array_map(function ($property) {
+            return $property->getName();
+        }, $rc->getProperties());
+
+        $params = array_map(function ($param) {
+            return $param->getName();
+        }, $rc->getMethod('__construct')->getParameters());
+
+        if ($this->objectHasRules()) {
+            $params[] = 'rules';
+        }
+
+        $this->assertSame($properties, $params);
+    }
+
+    public function testPropertiesAreCorrectlyDefined()
+    {
+        $rc = new ReflectionClass($this->getObjectAndParams()['object']);
+
+        foreach ($rc->getProperties() as $property) {
+            $this->assertTrue($property->isPublic());
+            $this->assertFalse($property->isStatic());
+        }
+    }
+
+    public function testPropertyAccessBehavesCorrectly()
+    {
+        extract($this->getObjectAndParams());
+
+        foreach ($params as $key => $value) {
+            $this->assertSame($value, $object->{$key});
+        }
+    }
+}
diff --git a/tests/Events/AbstractEventTestCase.php b/tests/Events/AbstractEventTestCase.php
new file mode 100644
index 00000000..3dd75ce0
--- /dev/null
+++ b/tests/Events/AbstractEventTestCase.php
@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Tests\Cachet\Events;
+
+use ReflectionClass;
+use CachetHQ\Cachet\Providers\EventServiceProvider;
+use CachetHQ\Tests\Cachet\AbstractAnemicTestCase;
+
+/**
+ * This is the abstract event test case class.
+ *
+ * @author Graham Campbell <graham@alt-three.com>
+ */
+abstract class AbstractEventTestCase extends AbstractAnemicTestCase
+{
+    protected function objectHasRules()
+    {
+        return false;
+    }
+
+    public function testEventImplementsTheCorrectInterfaces()
+    {
+        $event = $this->getObjectAndParams()['object'];
+
+        foreach ($this->getEventInterfaces() as $interface) {
+            $this->assertInstanceOf($interface, $event);
+        }
+    }
+
+    /*public function testEventHasRegisteredHandlers()
+    {
+        $property = (new ReflectionClass(EventServiceProvider::class))->getProperty('listen');
+        $property->setAccessible(true);
+
+        $class = get_class($this->getObjectAndParams()['object']);
+        $mappings = $property->getValue(new EventServiceProvider($this->app));
+
+        $this->assertTrue(isset($mappings[$class]));
+        $this->assertGreaterThan(0, count($mappings[$class]));
+
+        foreach ($mappings[$class] as $handler) {
+            $this->assertInstanceOf($handler, $this->app->make($handler));
+        }
+    }*/
+}
diff --git a/tests/Events/User/AbstractUserEventTestCase.php b/tests/Events/User/AbstractUserEventTestCase.php
new file mode 100644
index 00000000..c257749f
--- /dev/null
+++ b/tests/Events/User/AbstractUserEventTestCase.php
@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Tests\Cachet\Events\User;
+
+use CachetHQ\Cachet\Events\User\UserEventInterface;
+use CachetHQ\Tests\Cachet\Events\AbstractEventTestCase;
+
+class AbstractUserEventTestCase extends AbstractEventTestCase
+{
+    protected function getEventInterfaces()
+    {
+        return [UserEventInterface::class];
+    }
+}
diff --git a/tests/Events/User/UserWasAddedEventTest.php b/tests/Events/User/UserWasAddedEventTest.php
new file mode 100644
index 00000000..124e1d1d
--- /dev/null
+++ b/tests/Events/User/UserWasAddedEventTest.php
@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of CachetHQ.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Tests\Cachet\Events\User;
+
+use CachetHQ\Cachet\Events\User\UserWasAddedEvent;
+use CachetHQ\Cachet\Models\User;
+
+class UserWasAddedEventTest extends AbstractUserEventTestCase
+{
+    protected function getObjectAndParams()
+    {
+        $params = ['user' => new User()];
+        $object = new UserWasAddedEvent($params['user']);
+
+        return compact('params', 'object');
+    }
+}