ViewsConfigUpdaterTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\views\Kernel;

use Drupal\Core\Config\FileStorage;
use Drupal\views\ViewsConfigUpdater;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\IgnoreDeprecations;
use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;

/**
 * Tests Drupal\views\ViewsConfigUpdater.
 */
class ViewsConfigUpdaterTest extends ViewsKernelTestBase {
  
  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'views_config_entity_test',
    'entity_test',
    'text',
    'field',
    'node',
  ];
  
  /**
   * Tests ViewsConfigUpdater.
   */
  public function testViewsConfigUpdater() : void {
    // ViewsConfigUpdater currently contains no actual configuration update
    // logic. Replace this method with a real test when it does.
    $this->markTestSkipped();
  }
  
  /**
   * Tests the `needsRssViewModeUpdate` method.
   */
  public function testUpdateRssViewMode() : void {
    $this->strictConfigSchema = FALSE;
    /** @var \Drupal\views\ViewsConfigUpdater $view_config_updater */
    $view_config_updater = \Drupal::classResolver(ViewsConfigUpdater::class);
    // Load the test view.
    $view_id = 'views.view.test_display_feed';
    $test_view = $this->loadTestView($view_id);
    $display = $test_view->getDisplay('feed_1');
    // Check the initial view mode.
    $rowViewMode = $display['display_options']['row']['options']['view_mode'] ?? FALSE;
    $this->assertEquals('default', $rowViewMode);
    // Update the view mode using the method under test.
    $view_config_updater->needsRssViewModeUpdate($test_view, 'old_view_mode');
    // Assert if the view mode was updated correctly.
    $display = $test_view->getDisplay('feed_1');
    $updatedRowViewMode = $display['display_options']['row']['options']['view_mode'] ?? FALSE;
    $this->assertEquals('old_view_mode', $updatedRowViewMode);
  }
  
  /**
   * Tests the `needsRssViewModeUpdate` method.
   */
  public function testUpdateRssViewModeWithoutKnownPreviousMode() : void {
    $this->installEntitySchema('node');
    $this->installConfig([
      'text',
      'field',
      'node',
    ]);
    $this->strictConfigSchema = FALSE;
    /** @var \Drupal\views\ViewsConfigUpdater $view_config_updater */
    $view_config_updater = \Drupal::classResolver(ViewsConfigUpdater::class);
    // Load the test view.
    $view_id = 'views.view.test_display_feed';
    $test_view = $this->loadTestView($view_id);
    $display = $test_view->getDisplay('feed_1');
    // Check the initial view mode.
    $rowViewMode = $display['display_options']['row']['options']['view_mode'] ?? FALSE;
    $this->assertEquals('default', $rowViewMode);
    // Update the view mode using the method under test.
    $view_config_updater->needsRssViewModeUpdate($test_view);
    // Assert if the view mode was updated correctly.
    $display = $test_view->getDisplay('feed_1');
    $updatedRowViewMode = $display['display_options']['row']['options']['view_mode'] ?? FALSE;
    // This should be the first node view mode since we have nothing else
    $this->assertEquals('rss', $updatedRowViewMode);
  }
  
  /**
   * Tests if onSave also updates the view.
   */
  public function testUpdateRssViewModeWithoutKnownPreviousModeOnSaveHandler() : void {
    $this->installEntitySchema('node');
    $this->installConfig([
      'text',
      'field',
      'node',
    ]);
    $this->strictConfigSchema = FALSE;
    // Load the test view.
    $view_id = 'views.view.test_display_feed';
    $test_view = $this->loadTestView($view_id);
    $display = $test_view->getDisplay('feed_1');
    // Check the initial view mode.
    $rowViewMode = $display['display_options']['row']['options']['view_mode'] ?? FALSE;
    $this->assertEquals('default', $rowViewMode);
    $test_view->save();
    // Assert if the view mode was updated correctly onSave.
    $display = $test_view->getDisplay('feed_1');
    $updatedRowViewMode = $display['display_options']['row']['options']['view_mode'] ?? FALSE;
    // This should be the first node view mode since we have nothing else
    $this->assertEquals('rss', $updatedRowViewMode);
  }
  
  /**
   * Tests the `needsRssViewModeUpdate` method.
   */
  public function testUpdateRssViewModeSkipsOtherType() : void {
    $this->strictConfigSchema = FALSE;
    /** @var \Drupal\views\ViewsConfigUpdater $view_config_updater */
    $view_config_updater = \Drupal::classResolver(ViewsConfigUpdater::class);
    // Load the test view.
    $view_id = 'views.view.test_display_feed_no_update';
    $test_view = $this->loadTestView($view_id);
    $display = $test_view->getDisplay('feed_1');
    // Check the initial view mode.
    $rowViewMode = $display['display_options']['row']['options']['view_mode'] ?? FALSE;
    $this->assertEquals('default', $rowViewMode);
    // Update the view mode using the method under test.
    $view_config_updater->needsRssViewModeUpdate($test_view, 'old_view_mode');
    // Assert if the view mode was updated correctly.
    $display = $test_view->getDisplay('feed_1');
    $updatedRowViewMode = $display['display_options']['row']['options']['view_mode'] ?? FALSE;
    $this->assertEquals('default', $updatedRowViewMode);
  }
  
  /**
   * Loads a test view.
   *
   * @param string $view_id
   *   The view config ID.
   *
   * @return \Drupal\views\ViewEntityInterface
   *   A view entity object.
   */
  protected function loadTestView($view_id) {
    // We just instantiate the test view from the raw configuration, as it may
    // not be possible to save it, due to its faulty schema.
    $config_dir = $this->getModulePath('views') . '/tests/fixtures/update';
    $file_storage = new FileStorage($config_dir);
    $values = $file_storage->read($view_id);
    /** @var \Drupal\views\ViewEntityInterface $test_view */
    $test_view = $this->container
      ->get('entity_type.manager')
      ->getStorage('view')
      ->create($values);
    return $test_view;
  }

}