sarga/tests/_support/FunctionalTester.php

<?php

use Webkul\User\Models\Admin;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Auth;
use Webkul\Customer\Models\Customer;
use Illuminate\Support\Facades\Route;
use Illuminate\Routing\RouteCollection;

/**
 * Inherited Methods
 * @method void wantToTest($text)
 * @method void wantTo($text)
 * @method void execute($callable)
 * @method void expectTo($prediction)
 * @method void expect($prediction)
 * @method void amGoingTo($argumentation)
 * @method void am($role)
 * @method void lookForwardTo($achieveValue)
 * @method void comment($description)
 * @method void pause()
 *
 * @SuppressWarnings(PHPMD)
 */
class FunctionalTester extends \Codeception\Actor
{
    use _generated\FunctionalTesterActions;

    /**
     * Define custom actions here
     */

    /**
     * Set the logged in user to the admin identity.
     *
     * @param \Webkul\User\Models\Admin|null $admin
     *
     * @throws \Exception
     * @returns Admin
     */
    public function loginAsAdmin(Admin $admin = null): Admin
    {
        $I = $this;

        if (! $admin) {
            $admin = $I->grabRecord(Admin::class, ['email' => 'admin@example.com']);
        }

        if (! $admin) {
            throw new \Exception(
                'Admin user not found in database. Please ensure Seeders are executed');
        }

        Auth::guard('admin')
            ->login($admin);

        $I->seeAuthentication('admin');

        return $admin;
    }

    /**
     * Set the logged in user to the customer identity.
     *
     * @param \Webkul\User\Models\Customer|null $customer
     *
     * @throws \Exception
     * @returns Customer
     */
    public function loginAsCustomer(Customer $customer = null): Customer
    {
        $I = $this;

        if (! $customer) {
            $customer = $I->have(Customer::class);
        }

        Auth::guard('customer')
            ->login($customer);

        $I->seeAuthentication('customer');

        return $customer;
    }

    /**
     * @param string $name
     */
    public function amOnAdminRoute(string $name, array $params = [])
    {
        $I = $this;
        $I->amOnRoute($name, $params);
        $I->seeCurrentRouteIs($name);

        /** @var RouteCollection $routes */
        $routes = Route::getRoutes();
        $middlewares = $routes->getByName($name)->middleware();
        $I->assertContains('admin', $middlewares, 'check that admin middleware is applied');
    }

    /**
     * Set specific Webkul/Core configuration keys to a given value
     *
     * // TODO: change method as soon as there is a method to set core config data
     *
     * @param $data array containing 'code => value' pairs
     *
     * @return void
     */
    public function setConfigData($data): void
    {
        foreach ($data as $key => $value) {
            if (DB::table('core_config')->where('code', '=', $key)->exists()) {
                DB::table('core_config')
                    ->where('code', '=', $key)
                    ->update(['value' => $value]);
            } else {
                DB::table('core_config')->insert([
                    'code'         => $key,
                    'value'        => $value,
                    'channel_code' => null,
                    'locale_code'  => null,
                    'created_at'   => date('Y-m-d H:i:s'),
                    'updated_at'   => date('Y-m-d H:i:s'),
                ]);
            }
        }
    }
}