TourTestBasic.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\tour\Functional;


/**
 * Simple tour tips test base.
 */
abstract class TourTestBasic extends TourTestBase {
    
    /**
     * Tour tip attributes to be tested. Keyed by the path.
     *
     * @var array
     *   An array of tip attributes, keyed by path.
     *
     * @code
     * protected $tips = array(
     *   '/foo/bar' => array(
     *     array('data-id' => 'foo'),
     *     array('data-class' => 'bar'),
     *   ),
     * );
     * @endcode
     */
    protected $tips = [];
    
    /**
     * An admin user with administrative permissions for tour.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $adminUser;
    
    /**
     * The permissions required for a logged in user to test tour tips.
     *
     * @var array
     *   A list of permissions.
     */
    protected $permissions = [
        'access tour',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Make sure we are using distinct default and administrative themes for
        // the duration of these tests.
        $this->container
            ->get('theme_installer')
            ->install([
            'olivero',
            'claro',
        ]);
        $this->config('system.theme')
            ->set('default', 'olivero')
            ->set('admin', 'claro')
            ->save();
        $this->permissions[] = 'view the administration theme';
        // Create an admin user to view tour tips.
        $this->adminUser = $this->drupalCreateUser($this->permissions);
        $this->drupalLogin($this->adminUser);
    }
    
    /**
     * A simple tip test.
     */
    public function testTips() {
        foreach ($this->tips as $path => $attributes) {
            $this->drupalGet($path);
            $this->assertTourTips($attributes);
        }
    }

}