ViewsUITourTest.php

<?php

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

use Drupal\Tests\tour\Functional\TourTestBase;
use Drupal\language\Entity\ConfigurableLanguage;

/**
 * Tests the Views UI tour.
 *
 * @group tour
 * @group legacy
 */
class ViewsUITourTest extends TourTestBase {
    
    /**
     * An admin user with administrative permissions for views.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $adminUser;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * String translation storage object.
     *
     * @var \Drupal\locale\StringStorageInterface
     */
    protected $localeStorage;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'views_ui',
        'tour',
        'language',
        'locale',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->adminUser = $this->drupalCreateUser([
            'administer views',
            'access tour',
        ]);
        $this->drupalLogin($this->adminUser);
    }
    
    /**
     * Tests views_ui tour tip availability.
     */
    public function testViewsUiTourTips() {
        // Create a basic view that shows all content, with a page and a block
        // display.
        $view['label'] = $this->randomMachineName(16);
        $view['id'] = $this->randomMachineName(16);
        $view['page[create]'] = 1;
        $view['page[path]'] = $this->randomMachineName(16);
        $this->drupalGet('admin/structure/views/add');
        $this->submitForm($view, 'Save and edit');
        $this->assertTourTips();
    }
    
    /**
     * Tests views_ui tour tip availability in a different language.
     */
    public function testViewsUiTourTipsTranslated() {
        $langcode = 'nl';
        // Add a default locale storage for this test.
        $this->localeStorage = $this->container
            ->get('locale.storage');
        // Add Dutch language programmatically.
        ConfigurableLanguage::createFromLangcode($langcode)->save();
        // Handler titles that need translations.
        $handler_titles = [
            'Format',
            'Fields',
            'Sort criteria',
            'Filter criteria',
        ];
        foreach ($handler_titles as $handler_title) {
            // Create source string.
            $source = $this->localeStorage
                ->createString([
                'source' => $handler_title,
            ]);
            $source->save();
            $this->createTranslation($source, $langcode);
        }
        // Create a basic view that shows all content, with a page and a block
        // display.
        $view['label'] = $this->randomMachineName(16);
        $view['id'] = $this->randomMachineName(16);
        $view['page[create]'] = 1;
        $view['page[path]'] = $this->randomMachineName(16);
        // Load the page in dutch.
        $this->drupalGet($langcode . '/admin/structure/views/add');
        $this->submitForm($view, 'Save and edit');
        $this->assertTourTips();
    }
    
    /**
     * Creates single translation for source string.
     */
    public function createTranslation($source, $langcode) {
        return $this->localeStorage
            ->createTranslation([
            'lid' => $source->lid,
            'language' => $langcode,
            'translation' => $this->randomMachineName(100),
        ])
            ->save();
    }

}