monica/tests/TestCase.php

<?php

namespace Tests;

use App\Models\Account;
use App\Models\Contact;
use App\Models\User;
use App\Models\Vault;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
use Laravel\Sanctum\Sanctum;
use ReturnTypeWillChange;

abstract class TestCase extends BaseTestCase
{
    use CreatesApplication;

    /**
     * Create an User in an account.
     */
    public function createUser($abilities = ['read', 'write']): User
    {
        return tap(User::factory()->create(), function (User $user) use ($abilities) {
            Sanctum::actingAs($user, $abilities);
        });
    }

    /**
     * Create an User with the administrator privilege in an account.
     */
    public function createAdministrator(): User
    {
        return User::factory()->administrator()->create();
    }

    /**
     * Create an account.
     */
    public function createAccount(): Account
    {
        return Account::factory()->create();
    }

    /**
     * Create a vault.
     */
    public function createVault(Account $account): Vault
    {
        return Vault::factory()->create([
            'account_id' => $account->id,
        ]);
    }

    /**
     * Create a vault.
     *
     * @param  Account  $account
     */
    public function createVaultUser(User $user, int $permission = Vault::PERMISSION_VIEW): Vault
    {
        return tap(Vault::factory()->create([
            'account_id' => $user->account_id,
            'description' => "Contacts for {$user->email}",
        ]), fn (Vault $vault) => $this->setPermissionInVault($user, $permission, $vault));
    }

    /**
     * Set the user with the given permission in the given vault.
     */
    public function setPermissionInVault(User $user, int $permission, Vault $vault): Vault
    {
        $contact = Contact::factory()->create([
            'vault_id' => $vault->id,
        ]);
        $vault->users()->save($user, [
            'permission' => $permission,
            'contact_id' => $contact->id,
        ]);

        return $vault;
    }

    /**
     * Call protected/private method of a class.
     */
    #[ReturnTypeWillChange]
    public function invokePrivateMethod(object &$object, string $methodName, array $parameters = []): mixed
    {
        $reflection = new \ReflectionClass(get_class($object));
        $method = $reflection->getMethod($methodName);
        $method->setAccessible(true);

        return $method->invokeArgs($object, $parameters);
    }

    /**
     * Set protected/private property of a class.
     */
    public function setPrivateValue(object &$object, string $propertyName, mixed $value): void
    {
        $reflection = new \ReflectionClass(get_class($object));
        $property = $reflection->getProperty($propertyName);
        $property->setAccessible(true);

        $property->setValue($object, $value);
    }

    /**
     * Get protected/private property of a class.
     */
    public function getPrivateValue(object &$object, string $propertyName): mixed
    {
        $reflection = new \ReflectionClass(get_class($object));
        $property = $reflection->getProperty($propertyName);
        $property->setAccessible(true);

        return $property->getValue($object);
    }
}