ConfigTranslationOverviewTest.php

<?php

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

use Drupal\Component\Utility\Html;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\node\Entity\NodeType;
use Drupal\Tests\BrowserTestBase;

/**
 * Translate settings and entities to various languages.
 *
 * @group config_translation
 */
class ConfigTranslationOverviewTest extends BrowserTestBase {
  
  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'block',
    'config_test',
    'config_translation',
    'config_translation_test',
    'contact',
    'contextual',
    'entity_test_operation',
    'field_ui',
    'node',
    'views',
    'views_ui',
  ];
  
  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';
  
  /**
   * Languages to enable.
   *
   * @var array
   */
  protected $langcodes = [
    'fr',
    'ta',
  ];
  
  /**
   * String translation storage object.
   *
   * @var \Drupal\locale\StringStorageInterface
   */
  protected $localeStorage;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $permissions = [
      'translate configuration',
      'administer languages',
      'administer site configuration',
      'administer contact forms',
      'access site-wide contact form',
      'access contextual links',
      'administer views',
    ];
    // Create and log in user.
    $this->drupalLogin($this->drupalCreateUser($permissions));
    // Add languages.
    foreach ($this->langcodes as $langcode) {
      ConfigurableLanguage::createFromLangcode($langcode)->save();
    }
    $this->localeStorage = $this->container
      ->get('locale.storage');
    $this->drupalPlaceBlock('local_tasks_block');
    $this->drupalPlaceBlock('page_title_block');
  }
  
  /**
   * Tests the config translation mapper page.
   */
  public function testMapperListPage() : void {
    $this->drupalGet('admin/config/regional/config-translation');
    $this->assertSession()
      ->linkByHrefExists('admin/config/regional/config-translation/config_test');
    $this->assertSession()
      ->linkByHrefExists('admin/config/people/accounts/translate');
    // Make sure there is only a single operation for each dropbutton, either
    // 'List' or 'Translate'.
    foreach ($this->cssSelect('ul.dropbutton') as $dropbutton) {
      $this->assertCount(1, $dropbutton->findAll('xpath', 'li'));
      $this->assertTrue($dropbutton->getText() === 'Translate' || $dropbutton->getText() === 'List');
    }
    $labels = [
      '&$nxd~i0',
      'some "label" with quotes',
      $this->randomString(),
    ];
    $storage = \Drupal::entityTypeManager()->getStorage('config_test');
    foreach ($labels as $label) {
      $test_entity = $storage->create([
        'id' => $this->randomMachineName(),
        'label' => $label,
      ]);
      $test_entity->save();
      $base_url = 'admin/structure/config_test/manage/' . $test_entity->id();
      $this->drupalGet('admin/config/regional/config-translation/config_test');
      $this->assertSession()
        ->linkByHrefExists($base_url . '/translate');
      $this->assertSession()
        ->assertEscaped($test_entity->label());
      // Make sure there is only a single 'Translate' operation for each
      // dropbutton.
      foreach ($this->cssSelect('ul.dropbutton') as $dropbutton) {
        $this->assertCount(1, $dropbutton->findAll('xpath', 'li'));
        $this->assertSame('Translate', $dropbutton->getText());
      }
      $entity_type = \Drupal::entityTypeManager()->getDefinition($test_entity->getEntityTypeId());
      $this->drupalGet($base_url . '/translate');
      $title = $test_entity->label() . ' ' . $entity_type->getSingularLabel();
      $title = 'Translations for <em class="placeholder">' . Html::escape($title) . '</em>';
      $this->assertSession()
        ->responseContains($title);
      $this->assertSession()
        ->responseContains('<th>Language</th>');
      $this->drupalGet($base_url);
      $this->assertSession()
        ->linkExists('Translate test configuration');
    }
  }
  
  /**
   * Tests availability of hidden entities in the translation overview.
   */
  public function testHiddenEntities() : void {
    // Hidden languages are only available to translate through the
    // configuration translation listings.
    $this->drupalGet('admin/config/regional/config-translation/configurable_language');
    $this->assertSession()
      ->pageTextContains('Not applicable');
    $this->assertSession()
      ->linkByHrefExists('admin/config/regional/language/edit/zxx/translate');
    $this->assertSession()
      ->pageTextContains('Not specified');
    $this->assertSession()
      ->linkByHrefExists('admin/config/regional/language/edit/und/translate');
    // Hidden date formats are only available to translate through the
    // configuration translation listings. Test a couple of them.
    $this->drupalGet('admin/config/regional/config-translation/date_format');
    $this->assertSession()
      ->pageTextContains('HTML Date');
    $this->assertSession()
      ->linkByHrefExists('admin/config/regional/date-time/formats/manage/html_date/translate');
    $this->assertSession()
      ->pageTextContains('HTML Year');
    $this->assertSession()
      ->linkByHrefExists('admin/config/regional/date-time/formats/manage/html_year/translate');
  }
  
  /**
   * Tests that overrides do not affect listing screens.
   */
  public function testListingPageWithOverrides() : void {
    $original_label = 'Default';
    $overridden_label = 'Overridden label';
    $config_test_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('config_test');
    // Set up an override.
    $settings['config']['config_test.dynamic.dotted.default']['label'] = (object) [
      'value' => $overridden_label,
      'required' => TRUE,
    ];
    $this->writeSettings($settings);
    // Test that the overridden label is loaded with the entity.
    $this->assertEquals($overridden_label, $config_test_storage->load('dotted.default')
      ->label());
    // Test that the original label on the listing page is intact.
    $this->drupalGet('admin/config/regional/config-translation/config_test');
    $this->assertSession()
      ->pageTextContains($original_label);
    $this->assertSession()
      ->pageTextNotContains($overridden_label);
  }
  
  /**
   * Tests the field listing for the translate operation.
   */
  public function testListingFieldsPage() : void {
    // Create a content type.
    $node_type = NodeType::create([
      'type' => 'basic',
      'name' => 'Basic',
    ]);
    $node_type->save();
    $field = FieldConfig::create([
      // The field storage is guaranteed to exist because it is supplied by the
      // node module.
'field_storage' => FieldStorageConfig::loadByName('node', 'body'),
      'bundle' => $node_type->id(),
      'label' => 'Body',
      'settings' => [
        'display_summary' => FALSE,
      ],
    ]);
    $field->save();
    $this->drupalGet('admin/config/regional/config-translation/node_fields');
    $this->assertSession()
      ->pageTextContains('Body');
    $this->assertSession()
      ->pageTextContains('Basic');
    $this->assertSession()
      ->linkByHrefExists('admin/structure/types/manage/basic/fields/node.basic.body/translate');
  }

}