Merge pull request #3 from langleyfoxall/feature/writing-tests

Added tests correctly

CHANGELOG.md

@@ -4,6 +4,7 @@
 - Can select events to ignore in the Config File
 - Can select credentials to be omitted from the database in the Config File, such as passwords
 - Developers can now add authentication events easily through the `AuthenticationLogSubscriber`
+- Tests have been implemented to ensure the package works correctly throughout development
 
 ## v0.1
 

tests/Feature/AuthenticationLogSubscriberTest.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace LangleyFoxall\LaravelAuthenticationLog\Tests\Feature;
+
+use Illuminate\Auth\Authenticatable;
+use Illuminate\Auth\Events\Failed;
+use Illuminate\Auth\Events\Login;
+use Illuminate\Auth\Events\Logout;
+use Illuminate\Contracts\Auth\Authenticatable as AuthAuthenticatable;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Event;
+use LangleyFoxall\LaravelAuthenticationLog\Tests\TestCase;
+use LangleyFoxall\LaravelAuthenticationLog\Models\AuthenticationLogRecord;
+use LangleyFoxall\LaravelAuthenticationLog\Subscribers\AuthenticationLogSubscriber;
+use LangleyFoxall\LaravelAuthenticationLog\Tests\Models\User;
+use Orchestra\Testbench\Factories\UserFactory;
+
+class AuthenticationLogSubscriberTest extends TestCase
+{
+    use RefreshDatabase;
+
+    public function setUp() : void
+    {
+        parent::setUp();
+    }
+
+    public function test_a_log_record_is_created_when_a_login_event_is_fired()
+    {
+        $user = new User;
+        $user->id = 1;
+
+        $event = new Login('web', $user, false);
+
+        Event::dispatch($event);
+
+        $this->assertDatabaseHas('authentication_log_records', [
+            'authenticatable_id' => $user->id,
+            'authenticatable_type' => get_class($user),
+            'eventType' => get_class($event)
+        ]);
+    }
+
+    public function test_a_log_record_is_created_when_a_logout_event_is_fired()
+    {
+        $user = new User;
+        $user->id = 1;
+
+        $event = new Logout('web', $user);
+
+        Event::dispatch($event);
+
+        $this->assertDatabaseHas('authentication_log_records', [
+            'authenticatable_id' => $user->id,
+            'authenticatable_type' => get_class($user),
+            'eventType' => get_class($event)
+        ]);
+    }
+
+    public function test_a_log_record_is_created_when_a_failed_event_is_fired()
+    {
+        $credentials = [
+            'name' => 'notJohn',
+        ];
+
+        $event = new Failed('web', null, $credentials);
+
+        Event::dispatch($event);
+
+        $this->assertDatabaseHas('authentication_log_records', [
+            'credentials' => json_encode($credentials),
+            'eventType' => get_class($event)
+        ]);
+    }
+}

tests/Models/User.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace LangleyFoxall\LaravelAuthenticationLog\Tests\Models;
+
+use Illuminate\Contracts\Auth\Authenticatable;
+use Illuminate\Database\Eloquent\Model;
+
+class User implements Authenticatable
+{
+    public $id;
+
+    // no-op -- method definitions given to comply with Authenticatable Interface,
+    //          purely for testing purposes only
+    public function getAuthIdentifierName(){}
+    public function getAuthIdentifier(){}
+    public function getAuthPassword(){}
+    public function getRememberToken(){}
+    public function setRememberToken($value){}
+    public function getRememberTokenName(){}
+
+
+}

tests/TestCase.php

@@ -20,5 +20,6 @@ protected function getPackageProviders($app)
 
     protected function getEnvironmentSetUp($app)
     {
+
     }
 }

tests/Unit/AuthenticationLogRecordTest.php

@@ -17,6 +17,7 @@ public function test_creating_an_authenticationLogRecord_stores_it_in_a_database
         $attributes = [
             'authenticatable_id' => 1,
             'authenticatable_type' => "Test Type",
+            'eventType' => 'testEvent',
             'recorded_at' => $timeLog
         ];