Add test trait for account handling

src/Test/FirebaseUserTrait.php

@@ -0,0 +1,115 @@
+<?php namespace Tatter\Firebase\Test;
+
+use CodeIgniter\Test\Fabricator;
+use Kreait\Firebase\Auth\UserRecord;
+use Tatter\Firebase\Model;
+
+/**
+ * Trait to use when testing requires a valid Firebase user account.
+ */
+trait FirebaseUserTrait
+{
+	/**
+	 * Instance of the Firebase SDK.
+	 *
+	 * @var Kreait\Firebase\Auth
+	 */
+	protected static $auth;
+
+	/**
+	 * Fabricator for generating faux content.
+	 *
+	 * @var CodeIgniter\Test\Fabricator
+	 */
+	protected static $fabricator;
+
+	/**
+	 * Array of user account UIDs to be removed.
+	 *
+	 * @var array
+	 */
+	protected $firebaseUserCache;
+
+	/**
+	 * Ensures the static instances are loaded.
+	 *
+	 * @param array $data
+	 *
+	 * @return $this
+	 */
+	protected function initAuth()
+	{
+		if (! self::$auth)
+		{
+			self::$auth = service('firebase')->auth;
+		}
+
+		if (! self::$fabricator)
+		{
+			self::$fabricator = new Fabricator('Tatter\Firebase\Model', [
+				'email'       => 'email',
+				'displayName' => 'name',
+				//'phoneNumber' => 'phoneNumber', // Faker phone numbers aren't currently acceptable
+			]);
+		}
+	}
+
+	/**
+	 * Creates a random Firebase Auth user on-the-fly.
+	 *
+	 * @param array|null $overrides  Overriding data to use with the Fabricator
+	 *
+	 * @return Kreait\Firebase\Auth\UserRecord
+	 */
+	protected function createFirebaseUser(array $overrides = null): UserRecord
+	{
+		$this->initAuth();
+
+		if ($overrides)
+		{
+			self::$fabricator->setOverrides($overrides, false);
+		}
+
+		// Generate random data from the fabricator
+		$data = self::$fabricator->makeArray();
+
+		// Make sure there is a password
+		if (empty($data['password']))
+		{
+			$data['password'] = bin2hex(random_bytes(16));
+		}
+
+		// Create the user account
+		$user = self::$auth->createUser($data);
+
+		// Store it in the cache for removal later
+		$this->firebaseUserCache[] = $user->uid;
+
+		return $user;
+	}
+
+	/**
+	 * Removes a Firebase Auth user.
+	 *
+	 * @param string $uid
+	 */
+	protected function removeFirebaseUser(string $uid)
+	{
+		$this->initAuth();
+
+		self::$auth->deleteUser($uid);
+
+		$this->firebaseUserCache = array_diff($this->firebaseUserCache, [$uid]);
+	}
+
+	/**
+	 * Removes any Firebase Auth users in the cache.
+	 */
+	protected function firebaseUserTearDown()
+	{
+		foreach ($this->firebaseUserCache as $uid)
+		{
+			$this->removeFirebaseUser($uid);
+		}
+	}
+}

tests/unit/FirebaseUserTraitTest.php

@@ -0,0 +1,67 @@
+<?php
+
+use Kreait\Firebase\Auth\UserRecord;
+use Kreait\Firebase\Exception\Auth\UserNotFound;
+
+class FirebaseUserTraitTest extends \CodeIgniter\Test\CIUnitTestCase
+{
+	use \Tatter\Firebase\Test\FirebaseUserTrait;
+
+	/**
+	 * Instance of the Firebase SDK.
+	 *
+	 * @var Kreait\Firebase\Auth
+	 */
+	protected $firebase;
+
+	public function setUp(): void
+	{
+		parent::setUp();
+
+		$this->firebase = service('firebase')->auth;
+	}
+
+	public function tearDown(): void
+	{
+		parent::tearDown();
+
+		$this->firebaseUserTearDown();
+	}
+
+	public function testCreateUserReturnsUserRecord()
+	{
+		$user = $this->createFirebaseUser();
+
+		$this->assertInstanceOf(UserRecord::class, $user);
+	}
+
+	public function testCreateUserCreatesUser()
+	{
+		$user = $this->createFirebaseUser();
+
+		$test = $this->firebase->getUser($user->uid);
+
+		$this->assertInstanceOf(UserRecord::class, $test);
+		$this->assertEquals($user->email, $test->email);
+	}
+
+	public function testRemoveUserRemovesUser()
+	{
+		$user = $this->createFirebaseUser();
+		$this->removeFirebaseUser($user->uid);
+
+		$this->expectException(UserNotFound::class);
+
+		$test = $this->firebase->getUser($user->uid);
+	}
+
+	public function testTearDownRemovesUser()
+	{
+		$user = $this->createFirebaseUser();
+		$this->firebaseUserTearDown();
+
+		$this->expectException(UserNotFound::class);
+
+		$test = $this->firebase->getUser($user->uid);
+	}
+}