ConfigUpdaterTest.php in Commerce Core 8.2

Namespace

Drupal\Tests\commerce\Kernel

File

tests/src/Kernel/ConfigUpdaterTest.php

<?php

namespace Drupal\Tests\commerce\Kernel;


/**
 * Tests the ConfigUpdater class.
 *
 * @group commerce
 */
class ConfigUpdaterTest extends CommerceKernelTestBase {

  /**
   * Enable modules.
   *
   * @var array
   */
  public static $modules = [
    'commerce_update_test',
  ];

  /**
   * The config updater service.
   *
   * @var \Drupal\commerce\Config\ConfigUpdaterInterface
   */
  protected $configUpdater;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installConfig('commerce_update_test');
    $this->configUpdater = $this->container
      ->get('commerce.config_updater');
  }

  /**
   * Tests loading configuration from active storage.
   */
  public function testLoadFromActive() {
    $config_name = 'commerce_store.commerce_store_type.testing';
    $data = $this->configUpdater
      ->loadFromActive($config_name);
    $this
      ->assertEquals($data['id'], 'testing');
  }

  /**
   * Tests loading configuration from extension storage.
   */
  public function testLoadFromExtension() {
    $config_name = 'views.view.commerce_stores';
    $data = $this->configUpdater
      ->loadFromExtension($config_name);
    $this
      ->assertEquals($data['id'], 'commerce_stores');
  }

  /**
   * Tests checking whether configuration was modified.
   */
  public function testIsModified() {
    $config_name = 'commerce_store.commerce_store_type.testing';
    $config = $this->configUpdater
      ->loadFromActive($config_name);
    $this
      ->assertEmpty($this->configUpdater
      ->isModified($config));

    /** @var \Drupal\commerce_store\Entity\StoreTypeInterface $store_type */
    $store_type = \Drupal::entityTypeManager()
      ->getStorage('commerce_store_type')
      ->load('testing');
    $store_type
      ->setDescription('The default store');
    $store_type
      ->save();
    $config = $this->configUpdater
      ->loadFromActive($config_name);
    $this
      ->assertNotEmpty($this->configUpdater
      ->isModified($config));
  }

  /**
   * Tests importing configuration.
   */
  public function testImport() {
    $config_name = 'commerce_store.commerce_store_type.testing';
    $this->configUpdater
      ->delete([
      $config_name,
    ]);
    $result = $this->configUpdater
      ->import([
      $config_name,
    ]);
    $failed = $result
      ->getFailed();
    $succeeded = $result
      ->getSucceeded();
    $this
      ->assertEmpty($failed);
    $this
      ->assertEquals($succeeded[$config_name], "{$config_name} was successfully imported");
    $result = $this->configUpdater
      ->import([
      $config_name,
    ]);
    $failed = $result
      ->getFailed();
    $succeeded = $result
      ->getSucceeded();
    $this
      ->assertEmpty($succeeded);
    $this
      ->assertEquals($failed[$config_name], "{$config_name} already exists, use revert to update");
  }

  /**
   * Tests reverting configuration.
   */
  public function testRevert() {
    $config_name = 'commerce_store.commerce_store_type.testing';

    /** @var \Drupal\commerce_store\Entity\StoreTypeInterface $store_type */
    $store_type = \Drupal::entityTypeManager()
      ->getStorage('commerce_store_type')
      ->load('testing');
    $store_type
      ->setDescription('The default store');
    $store_type
      ->save();
    $result = $this->configUpdater
      ->revert([
      $config_name,
    ]);
    $failed = $result
      ->getFailed();
    $succeeded = $result
      ->getSucceeded();
    $this
      ->assertEmpty($failed);
    $this
      ->assertEquals($succeeded[$config_name], "Skipped: {$config_name} was not reverted because it was modified by the user");
    $result = $this->configUpdater
      ->revert([
      $config_name,
    ], FALSE);
    $succeeded = $result
      ->getSucceeded();
    $this
      ->assertNotEmpty($succeeded);
    $this
      ->assertEquals($succeeded[$config_name], "{$config_name} was successfully reverted");

    /** @var \Drupal\commerce_store\Entity\StoreTypeInterface $store_type */
    $store_type = \Drupal::entityTypeManager()
      ->getStorage('commerce_store_type')
      ->load('testing');
    $this
      ->assertEmpty($store_type
      ->getDescription());
  }

  /**
   * Tests deleting configuration.
   */
  public function testDelete() {
    $config_name = 'commerce_store.commerce_store_type.testing';
    $result = $this->configUpdater
      ->delete([
      $config_name,
    ]);
    $failed = $result
      ->getFailed();
    $succeeded = $result
      ->getSucceeded();
    $this
      ->assertEmpty($failed);
    $this
      ->assertEquals($succeeded[$config_name], "{$config_name} was successfully deleted");
  }

}

Classes

Name	Description
ConfigUpdaterTest	Tests the ConfigUpdater class.