class FeaturesAssignTest in Features 8.4

Same name and namespace in other branches

8.3 tests/src/Kernel/FeaturesAssignTest.php \Drupal\Tests\features\Kernel\FeaturesAssignTest

The Feature Assign test.

@group features

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\features\Kernel\FeaturesAssignTest

Expanded class hierarchy of FeaturesAssignTest

File

tests/src/Kernel/FeaturesAssignTest.php, line 15

Namespace

Drupal\Tests\features\Kernel

View source

class FeaturesAssignTest extends KernelTestBase {
  const PACKAGE_NAME = 'my_test_package';

  // Installed test feature package.
  const TEST_INSTALLED_PACKAGE = 'test_mybundle_core';

  // Uninstalled test feature package.
  const TEST_UNINSTALLED_PACKAGE = 'test_feature';

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'features',
    'node',
    'system',
    'user',
    self::TEST_INSTALLED_PACKAGE,
  ];

  /**
   * The Feature Manager.
   *
   * @var \Drupal\features\FeaturesManager
   */
  protected $featuresManager;

  /**
   * The Feature Assigner.
   *
   * @var \Drupal\features\FeaturesAssigner
   */
  protected $assigner;

  /**
   * The Feature Bundle.
   *
   * @var \Drupal\features\FeaturesBundleInterface
   */
  protected $bundle;

  /**
   * The variable.
   *
   * @var mixed
   * @todo Remove the disabled strict config schema checking.
   */
  protected $strictConfigSchema = FALSE;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installConfig('features');
    $this
      ->installConfig('system');
    $this->featuresManager = \Drupal::service('features.manager');
    $this->assigner = \Drupal::service('features_assigner');
    $this->bundle = $this->assigner
      ->getBundle();

    // Turn off all assignment plugins.
    $this->bundle
      ->setEnabledAssignments([]);

    // Start with an empty configuration collection.
    $this->featuresManager
      ->setConfigCollection([]);
  }

  /**
   * @covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentAlter
   */
  public function testAssignAlter() {
    $method_id = 'alter';

    // Enable the method.
    $this
      ->enableAssignmentMethod($method_id);

    // Add some configuration.
    $this
      ->addConfigurationItem('example.settings', [
      '_core' => [
        'something',
      ],
      'uuid' => 'something',
    ], [
      'type' => FeaturesManagerInterface::SYSTEM_SIMPLE_CONFIG,
    ]);
    $this
      ->addConfigurationItem('node.type.article', [
      '_core' => [
        'something',
      ],
      'uuid' => 'something',
      'permissions' => [
        'first',
        'second',
      ],
    ], [
      'type' => 'node_type',
    ]);
    $this
      ->addConfigurationItem('user.role.test', [
      '_core' => [
        'something',
      ],
      'uuid' => 'something',
      'permissions' => [
        'first',
        'second',
      ],
    ], [
      'type' => 'user_role',
    ]);

    // Set all settings to FALSE.
    $settings = [
      'core' => FALSE,
      'uuid' => FALSE,
      'user_permissions' => FALSE,
    ];
    $this->bundle
      ->setAssignmentSettings($method_id, $settings);
    $this->assigner
      ->applyAssignmentMethod($method_id);
    $config = $this->featuresManager
      ->getConfigCollection();
    $this
      ->assertNotEmpty($config['example.settings'], 'Expected config not created.');
    $this
      ->assertNotEmpty($config['node.type.article'], 'Expected config not created.');
    $this
      ->assertNotEmpty($config['user.role.test'], 'Expected config not created.');
    $example_settings_data = $config['example.settings']
      ->getData();
    $this
      ->assertEquals($example_settings_data['_core'], [
      'something',
    ], 'Expected _core value missing.');
    $this
      ->assertEquals($example_settings_data['uuid'], 'something', 'Expected uuid value missing.');
    $node_type_data = $config['node.type.article']
      ->getData();
    $this
      ->assertEquals($node_type_data['_core'], [
      'something',
    ], 'Expected _core value missing.');
    $this
      ->assertEquals($node_type_data['uuid'], 'something', 'Expected uuid value missing.');
    $this
      ->assertEquals($node_type_data['permissions'], [
      'first',
      'second',
    ], 'Expected permissions value missing.');
    $user_role_data = $config['user.role.test']
      ->getData();
    $this
      ->assertEquals($user_role_data['_core'], [
      'something',
    ], 'Expected _core value missing.');
    $this
      ->assertEquals($user_role_data['uuid'], 'something', 'Expected uuid value missing.');
    $this
      ->assertEquals($user_role_data['permissions'], [
      'first',
      'second',
    ], 'Expected permissions value missing.');

    // Set all settings to TRUE.
    $settings = [
      'core' => TRUE,
      'uuid' => TRUE,
      'user_permissions' => TRUE,
    ];
    $this->bundle
      ->setAssignmentSettings($method_id, $settings);
    $this->assigner
      ->applyAssignmentMethod($method_id);
    $config = $this->featuresManager
      ->getConfigCollection();
    $this
      ->assertNotEmpty($config['example.settings'], 'Expected config not created.');
    $this
      ->assertNotEmpty($config['node.type.article'], 'Expected config not created.');
    $this
      ->assertNotEmpty($config['user.role.test'], 'Expected config not created.');
    $example_settings_data = $config['example.settings']
      ->getData();
    $this
      ->assertFalse(isset($example_settings_data['_core']), 'Unexpected _core value present.');

    // Uuid should be retained for simple configuration.
    $this
      ->assertEquals($example_settings_data['uuid'], 'something', 'Expected uuid value missing.');
    $node_type_data = $config['node.type.article']
      ->getData();
    $this
      ->assertFalse(isset($node_type_data['_core']), 'Unexpected _core value present.');
    $this
      ->assertFalse(isset($node_type_data['uuid']), 'Unexpected uuid value present.');

    // Permissions should be stripped only for user_role configuration.
    $this
      ->assertEquals($node_type_data['permissions'], [
      'first',
      'second',
    ], 'Expected permissions value missing.');
    $user_role_data = $config['user.role.test']
      ->getData();
    $this
      ->assertFalse(isset($user_role_data['_core']), 'Unexpected _core value present.');
    $this
      ->assertFalse(isset($user_role_data['uuid']), 'Unexpected uuid value present.');
    $this
      ->assertFalse(isset($user_role_data['permissions']), 'Unexpected permissions value present.');
  }

  /**
   * @covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentBaseType
   */
  public function testAssignBase() {
    $method_id = 'base';

    // Enable the method.
    $this
      ->enableAssignmentMethod($method_id);

    // Test the default options for the base assignment method.
    // Test node type assignments.
    // Declare the node_type entity 'article'.
    $this
      ->addConfigurationItem('node.type.article', [], [
      'shortName' => 'article',
      'label' => 'Article',
      'type' => 'node_type',
      'dependents' => [
        'field.field.node.article.body',
      ],
    ]);

    // Add a piece of dependent configuration.
    $this
      ->addConfigurationItem('field.field.node.article.body', [], [
      'shortName' => 'node.article.body',
      'label' => 'Body',
      'type' => 'field_config',
      'dependents' => [],
    ]);
    $this->assigner
      ->applyAssignmentMethod($method_id);
    $packages = $this->featuresManager
      ->getPackages();
    $expected_package_names = [
      'article',
      'user',
    ];
    $this
      ->assertEquals($expected_package_names, array_keys($packages), 'Expected packages not created.');

    // Dependents like field.field.node.article.body should not be assigned.
    $expected_config_items = [
      'node.type.article',
    ];
    $this
      ->assertEquals($expected_config_items, $packages['article']
      ->getConfig(), 'Expected configuration items not present in article package.');
  }

  /**
   * @covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentCoreType
   */
  public function testAssignCore() {
    $method_id = 'core';

    // Enable the method.
    $this
      ->enableAssignmentMethod($method_id);

    // Test the default options for the core assignment method.
    // Add a piece of configuration of a core type.
    $this
      ->addConfigurationItem('field.storage.node.body', [], [
      'shortName' => 'node.body',
      'label' => 'node.body',
      'type' => 'field_storage_config',
      'dependents' => [
        'field.field.node.article.body',
      ],
    ]);

    // Add a piece of configuration of a non-core type.
    $this
      ->addConfigurationItem('field.field.node.article.body', [], [
      'shortName' => 'node.article.body',
      'label' => 'Body',
      'type' => 'field_config',
      'dependents' => [],
    ]);
    $this->assigner
      ->applyAssignmentMethod($method_id);
    $packages = $this->featuresManager
      ->getPackages();
    $expected_package_names = [
      'core',
    ];
    $this
      ->assertEquals($expected_package_names, array_keys($packages), 'Expected packages not created.');
    $this
      ->assertTrue(in_array('field.storage.node.body', $packages['core']
      ->getConfig(), 'Expected configuration item not present in core package.'));
    $this
      ->assertFalse(in_array('field.field.node.article.body', $packages['core']
      ->getConfig(), 'Unexpected configuration item present in core package.'));
  }

  /**
   * @covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentDependency
   */
  public function testAssignDependency() {
    $method_id = 'dependency';

    // Enable the method.
    $this
      ->enableAssignmentMethod($method_id);

    // Test the default options for the base assignment method.
    // Test node type assignments.
    // Declare the node_type entity 'article'.
    $this
      ->addConfigurationItem('node.type.article', [], [
      'shortName' => 'article',
      'label' => 'Article',
      'type' => 'node_type',
      'dependents' => [
        'field.field.node.article.body',
      ],
    ]);

    // Add a piece of dependent configuration.
    $this
      ->addConfigurationItem('field.field.node.article.body', [], [
      'shortName' => 'node.article.body',
      'label' => 'Body',
      'type' => 'field_config',
      'dependents' => [],
    ]);
    $this->featuresManager
      ->initPackage(self::PACKAGE_NAME, 'My test package');
    $this->featuresManager
      ->assignConfigPackage(self::PACKAGE_NAME, [
      'node.type.article',
    ]);
    $this->assigner
      ->applyAssignmentMethod($method_id);
    $packages = $this->featuresManager
      ->getPackages();
    $expected_package_names = [
      self::PACKAGE_NAME,
    ];
    $this
      ->assertEquals($expected_package_names, array_keys($packages), 'Expected packages not created.');
    $expected_config_items = [
      'node.type.article',
      'field.field.node.article.body',
    ];
    $this
      ->assertEquals($expected_config_items, $packages[self::PACKAGE_NAME]
      ->getConfig(), 'Expected configuration items not present in article package.');
  }

  /**
   * @covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentExclude
   */
  public function testAssignExclude() {
    $method_id = 'exclude';

    // Enable the method.
    $this
      ->enableAssignmentMethod($method_id);

    // Also enable Packages and Core plugins.
    $this
      ->enableAssignmentMethod('packages', FALSE);
    $this
      ->enableAssignmentMethod('core', FALSE);

    // Apply the bundle.
    $this->bundle = $this->assigner
      ->loadBundle('test_mybundle');
    $this->assigner
      ->applyAssignmentMethod('packages');
    $packages = $this->featuresManager
      ->getPackages();
    $this
      ->assertNotEmpty($packages[self::TEST_INSTALLED_PACKAGE], 'Expected package not created.');

    // 1. When Required is set to True, config should stay with the module
    // First, test with "Required" set to True.
    $packages[self::TEST_INSTALLED_PACKAGE]
      ->setRequired(TRUE);
    $this->featuresManager
      ->setPackages($packages);
    $this->assigner
      ->applyAssignmentMethod('exclude');
    $this->assigner
      ->applyAssignmentMethod('core');
    $this->assigner
      ->applyAssignmentMethod('existing');
    $packages = $this->featuresManager
      ->getPackages();
    $expected_config_items = [
      'core.date_format.long',
    ];
    $this
      ->assertEquals($expected_config_items, $packages[self::TEST_INSTALLED_PACKAGE]
      ->getConfig(), 'Expected configuration items not present in existing test_core package.');

    // 2. When Required is set to False, config still stays with module
    // Because the module is installed.
    $this
      ->reset();
    $this->bundle = $this->assigner
      ->loadBundle('test_mybundle');
    $this->assigner
      ->applyAssignmentMethod('packages');
    $packages = $this->featuresManager
      ->getPackages();
    $this
      ->assertNotEmpty($packages[self::TEST_INSTALLED_PACKAGE], 'Expected test_mybundle_core package not created.');

    // Set "Required" set to False.
    $packages[self::TEST_INSTALLED_PACKAGE]
      ->setRequired(FALSE);
    $this->featuresManager
      ->setPackages($packages);
    $this->assigner
      ->applyAssignmentMethod('exclude');
    $this->assigner
      ->applyAssignmentMethod('core');
    $this->assigner
      ->applyAssignmentMethod('existing');
    $packages = $this->featuresManager
      ->getPackages();
    $this
      ->assertFalse(array_key_exists('core', $packages), 'Core package should not be created.');
    $expected_config_items = [
      'core.date_format.long',
    ];
    $this
      ->assertEquals($expected_config_items, $packages[self::TEST_INSTALLED_PACKAGE]
      ->getConfig(), 'Expected configuration items not present in existing test_core package.');

    // 3. When Required is set to False and module is NOT installed,
    // Config stays with module if it doesn't match the current namespace
    $this
      ->reset();

    // Load a bundle different from TEST_UNINSTALLED_PACKAGE.
    $this->bundle = $this->assigner
      ->loadBundle('test_mybundle');
    $this->assigner
      ->applyAssignmentMethod('packages');
    $packages = $this->featuresManager
      ->getPackages();
    $this
      ->assertNotEmpty($packages[self::TEST_UNINSTALLED_PACKAGE], 'Expected test_feature package not created.');
    $this
      ->assertNotEmpty($packages[self::TEST_INSTALLED_PACKAGE], 'Expected test_mybundle_core package not created.');

    // Mark package as uninstalled, set "Required" set to False.
    $packages[self::TEST_UNINSTALLED_PACKAGE]
      ->setRequired(FALSE);
    $this->featuresManager
      ->setPackages($packages);
    $this->assigner
      ->applyAssignmentMethod('exclude');
    $this->assigner
      ->applyAssignmentMethod('core');
    $this->assigner
      ->applyAssignmentMethod('existing');
    $packages = $this->featuresManager
      ->getPackages();
    $this
      ->assertFalse(array_key_exists('core', $packages), 'Core package should not be created.');
    $expected_config_items = [
      'core.date_format.short',
      'system.cron',
    ];
    $this
      ->assertEquals($expected_config_items, $packages[self::TEST_UNINSTALLED_PACKAGE]
      ->getConfig(), 'Expected configuration items not present in existing test_feature package.');

    // 4. When Required is set to False and module is NOT installed,
    // Config is reassigned within modules that match the namespace.
    $this
      ->reset();

    // Load the bundle used in TEST_UNINSTALLED_PACKAGE.
    $this->bundle = $this->assigner
      ->loadBundle('test');
    if (empty($this->bundle) || $this->bundle
      ->isDefault()) {

      // Since we uninstalled the test_feature, we probably need to create
      // an empty "test" bundle.
      $this->bundle = $this->assigner
        ->createBundleFromDefault('test');
    }
    $this->assigner
      ->applyAssignmentMethod('packages');
    $packages = $this->featuresManager
      ->getPackages();
    $this
      ->assertNotEmpty($packages[self::TEST_UNINSTALLED_PACKAGE], 'Expected test_feature package not created.');

    // Set "Required" set to False.
    $packages[self::TEST_UNINSTALLED_PACKAGE]
      ->setRequired(FALSE);
    $this->featuresManager
      ->setPackages($packages);
    $this->assigner
      ->applyAssignmentMethod('exclude');
    $this->assigner
      ->applyAssignmentMethod('core');
    $this->assigner
      ->applyAssignmentMethod('existing');
    $packages = $this->featuresManager
      ->getPackages();
    $this
      ->assertNotEmpty($packages['core'], 'Expected Core package not created.');

    // Ensure "core" package is not confused with "test_core" module
    // Since we are in a bundle.
    $this
      ->assertEmpty($packages['core']
      ->getExtension(), 'Autogenerated core package should not have an extension');

    // Core config should be reassigned from TEST_UNINSTALLED_PACKAGE into Core.
    $expected_config_items = [
      'system.cron',
    ];
    $this
      ->assertEquals($expected_config_items, $packages[self::TEST_UNINSTALLED_PACKAGE]
      ->getConfig(), 'Expected configuration items not present in existing test_feature package.');
    $expected_config_items = [
      'core.date_format.short',
    ];
    $this
      ->assertEquals($expected_config_items, $packages['core']
      ->getConfig(), 'Expected configuration items not present in core package.');
  }

  /**
   * @covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentExclude
   */
  public function testAssignExisting() {
    $method_id = 'existing';

    // Enable the method.
    $this
      ->enableAssignmentMethod($method_id);

    // Also enable Packages plugin.
    $this
      ->enableAssignmentMethod('packages', FALSE);

    // First create the existing packages.
    $this->assigner
      ->applyAssignmentMethod('packages');

    // Now move config into those existing packages.
    $this->assigner
      ->applyAssignmentMethod($method_id);
    $packages = $this->featuresManager
      ->getPackages();
    $this
      ->assertNotEmpty($packages[self::TEST_INSTALLED_PACKAGE], 'Expected package not created.');
    $this
      ->assertNotEmpty($packages[self::TEST_UNINSTALLED_PACKAGE], 'Expected package not created.');

    // Turn off any "required" option in package to let config get reassigned.
    $package = $packages[self::TEST_INSTALLED_PACKAGE];
    $package
      ->setRequired(TRUE);
    $expected_config_items = [
      'core.date_format.long',
    ];
    $this
      ->assertEquals($expected_config_items, $packages[self::TEST_INSTALLED_PACKAGE]
      ->getConfig(), 'Expected configuration items not present in existing package.');
    $expected_config_items = [
      'core.date_format.short',
      'system.cron',
    ];
    $this
      ->assertEquals($expected_config_items, $packages[self::TEST_UNINSTALLED_PACKAGE]
      ->getConfig(), 'Expected configuration items not present in existing package.');
  }

  /**
   * @covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentForwardDependency
   */
  public function testAssignForwardDependency() {
    $method_id = 'forward_dependency';

    // Enable the method.
    $this
      ->enableAssignmentMethod($method_id);

    // Add some configuration.
    // Two parent items.
    $this
      ->addConfigurationItem('parent1', [], [
      'type' => 'node_type',
      'dependents' => [
        'grandparent',
      ],
    ]);
    $this
      ->addConfigurationItem('parent2', [], [
      'type' => 'node_type',
      'dependents' => [],
    ]);

    // Something that belongs to just one parent.
    $this
      ->addConfigurationItem('child1', [], [
      'type' => 'node_type',
      'dependents' => [
        'parent1',
      ],
    ]);

    // Something that belongs to both parents.
    $this
      ->addConfigurationItem('child2', [], [
      'type' => 'node_type',
      'dependents' => [
        'parent1',
        'parent2',
      ],
    ]);

    // Something that indirectly belongs to parent1.
    $this
      ->addConfigurationItem('grandchild', [], [
      'type' => 'node_type',
      'dependents' => [
        'child1',
      ],
    ]);

    // A dependent, not a dependency.
    $this
      ->addConfigurationItem('grandparent', [], [
      'type' => 'node_type',
      'dependents' => [],
    ]);

    // Something completely unrelated.
    $this
      ->addConfigurationItem('stranger', [], [
      'type' => 'node_type',
      'dependents' => [],
    ]);
    $this->featuresManager
      ->initPackage(self::PACKAGE_NAME, 'My test package');
    $this->featuresManager
      ->assignConfigPackage(self::PACKAGE_NAME, [
      'parent1',
    ]);
    $other_package_name = 'other_package';
    $this->featuresManager
      ->initPackage($other_package_name, 'Other package');
    $this->featuresManager
      ->assignConfigPackage($other_package_name, [
      'parent2',
    ]);
    $this->assigner
      ->applyAssignmentMethod($method_id);
    $packages = $this->featuresManager
      ->getPackages();
    $expected_package_names = [
      self::PACKAGE_NAME,
      $other_package_name,
    ];
    sort($expected_package_names);
    $actual_package_names = array_keys($packages);
    sort($actual_package_names);
    $this
      ->assertEquals($expected_package_names, $actual_package_names, 'Expected packages not created.');
    $expected_config_items = [
      'parent1',
      'child1',
      'grandchild',
    ];
    sort($expected_config_items);
    $actual_config_items = $packages[self::PACKAGE_NAME]
      ->getConfig();
    sort($actual_config_items);
    $this
      ->assertEquals($expected_config_items, $actual_config_items, 'Expected configuration items not present in article package.');
  }

  /**
   * @covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentNamespace
   */
  public function testAssignNamespace() {
    $method_id = 'namespace';

    // Enable the method.
    $this
      ->enableAssignmentMethod($method_id);

    // Apply the bundle.
    $this->bundle = $this->assigner
      ->loadBundle('test_mybundle');
    $package_data = [
      'article' => [
        // Items that should be assigned to 'article'.
        'article',
        'article-after',
        'before.article',
        'something_article',
        'something-article',
        'something.article',
        'article_something',
        'article-something',
        'article.something',
        'something_article_something',
        'something-article-something',
        'something.article.something',
        'something.article_something',
      ],
      'article_after' => [
        // Items that should be assigned to 'article_after'.
        'article_after',
        'something_article_after',
        'something-article_after',
        'something.article_after',
        'article_after_something',
        'article_after-something',
        'article_after.something',
        'something_article_after_something',
        'something-article_after-something',
        'something.article_after.something',
        'something.article_after_something',
      ],
      'before_article' => [
        // Items that should be assigned to 'before_article'.
        'before_article',
        'something_before_article',
        'something-before_article',
        'something.before_article',
        'before_article_something',
        'before_article-something',
        'before_article.something',
        'something_before_article_something',
        'something-before_article-something',
        'something.before_article.something',
        'something.before_article_something',
      ],
      // Emulate an existing feature, which has a machine name prefixed by
      // the bundle name.
      'test_mybundle_page' => [
        // Items that should be assigned to 'test_mybundle_page'.
        // Items should match the short name, 'page'.
        'page',
        'page-after',
        'before.page',
        'something_page',
        'something-page',
        'something.page',
        'page_something',
        'page-something',
        'page.something',
        'something_page_something',
        'something-page-something',
        'something.page.something',
        'something.page_something',
      ],
    ];
    foreach ($package_data as $machine_name => $config_short_names) {
      $this->featuresManager
        ->initPackage($machine_name, 'My test package ' . $machine_name);
      foreach ($config_short_names as $short_name) {
        $this
          ->addConfigurationItem('node.type.' . $short_name, [], [
          'type' => 'node_type',
          'shortName' => $short_name,
        ]);
      }
    }

    // Add some config that should not be matched.
    $config_short_names = [
      'example',
      'example_something',
      'article~',
      'myarticle',
    ];
    foreach ($config_short_names as $short_name) {
      $this
        ->addConfigurationItem('node.type.' . $short_name, [], [
        'type' => 'node_type',
        'shortName' => $short_name,
      ]);
    }
    $this->assigner
      ->applyAssignmentMethod($method_id);
    $packages = $this->featuresManager
      ->getPackages();
    foreach ($package_data as $machine_name => $config_short_names) {
      $this
        ->assertNotEmpty($packages[$machine_name], 'Expected package ' . $machine_name . ' not created.');
      array_walk($config_short_names, function (&$value) {
        $value = 'node.type.' . $value;
      });
      sort($config_short_names);
      $package_config = $packages[$machine_name]
        ->getConfig();
      sort($package_config);
      $this
        ->assertEquals($config_short_names, $package_config, 'Expected configuration items not present in ' . $machine_name . ' package.');
    }
  }

  /**
   * @covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentOptionalType
   */
  public function testAssignOptionalType() {
    $method_id = 'optional';

    // Enable the method.
    $this
      ->enableAssignmentMethod($method_id);
    $settings = [
      'types' => [
        'config' => [
          'image_style',
        ],
      ],
    ];
    $this->bundle
      ->setAssignmentSettings($method_id, $settings);

    // Add some configuration.
    $this
      ->addConfigurationItem('node.type.article', [], [
      'type' => 'node_type',
    ]);
    $this
      ->addConfigurationItem('image.style.test', [], [
      'type' => 'image_style',
    ]);
    $this->featuresManager
      ->initPackage(self::PACKAGE_NAME, 'My test package');
    $this->assigner
      ->applyAssignmentMethod($method_id);
    $packages = $this->featuresManager
      ->getPackages();
    $this
      ->assertNotEmpty($packages[self::PACKAGE_NAME], 'Expected package not created.');
    $config = $this->featuresManager
      ->getConfigCollection();
    $this
      ->assertNotEmpty($config['node.type.article'], 'Expected config not created.');
    $this
      ->assertNotEmpty($config['image.style.test'], 'Expected config not created.');
    $this
      ->assertNull($config['node.type.article']
      ->getSubdirectory(), 'Expected package subdirectory not set to default.');
    $this
      ->assertEquals($config['image.style.test']
      ->getSubdirectory(), InstallStorage::CONFIG_OPTIONAL_DIRECTORY, 'Expected package subdirectory not set to optional.');
  }

  /**
   * @covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentPackages
   */
  public function testAssignPackages() {
    $method_id = 'packages';

    // A configuration item that will be excluded.
    $this
      ->addConfigurationItem('system.theme', [], [
      'type' => FeaturesManagerInterface::SYSTEM_SIMPLE_CONFIG,
    ]);

    // A configuration item that will be required.
    $this
      ->addConfigurationItem('core.date_format.long', [], [
      'type' => 'date_format',
    ]);

    // A configuration item that will be neither excluded nor required.
    $this
      ->addConfigurationItem('system.theme', [], [
      'type' => FeaturesManagerInterface::SYSTEM_SIMPLE_CONFIG,
    ]);

    // Enable the method.
    $this
      ->enableAssignmentMethod($method_id);
    $this->assigner
      ->applyAssignmentMethod($method_id);
    $packages = $this->featuresManager
      ->getPackages();
    $this
      ->assertNotEmpty($packages[self::TEST_INSTALLED_PACKAGE], 'Expected package not created.');
    $config = $this->featuresManager
      ->getConfigCollection();
    $this
      ->assertTrue(in_array(self::TEST_INSTALLED_PACKAGE, $config['system.theme']
      ->getPackageExcluded()), 'Configuration item not excluded from package.');
    $this
      ->assertFalse(in_array(self::TEST_INSTALLED_PACKAGE, $config['system.site']
      ->getPackageExcluded()), 'Configuration item excluded from package.');
    $this
      ->assertEquals(self::TEST_INSTALLED_PACKAGE, $config['core.date_format.long']
      ->getPackage(), 'Required item not assigned to package.');
    $this
      ->assertNotEquals(self::TEST_INSTALLED_PACKAGE, $config['system.site']
      ->getPackage(), 'Unrequired item assigned to package.');
  }

  /**
   * @covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentProfile
   */
  public function testAssignProfile() {
    $method_id = 'profile';

    // Enable the method.
    $this
      ->enableAssignmentMethod($method_id);

    // Add some configuration.
    $this
      ->addConfigurationItem('shortcut.myshortcut', [], [
      'type' => 'shortcut_set',
    ]);
    $this
      ->addConfigurationItem('node.type.article', [], [
      'type' => 'node_type',
    ]);
    $this
      ->addConfigurationItem('image.style.test', [], [
      'type' => 'image_style',
    ]);
    $this
      ->addConfigurationItem('system.cron', [], [
      'type' => FeaturesManagerInterface::SYSTEM_SIMPLE_CONFIG,
    ]);
    $this->bundle = $this->assigner
      ->createBundleFromDefault('myprofile');
    $this->bundle
      ->setProfileName('myprofile');
    $this->bundle
      ->setIsProfile(TRUE);
    $this->assigner
      ->applyAssignmentMethod($method_id);
    $packages = $this->featuresManager
      ->getPackages();
    $this
      ->assertNotEmpty($packages['myprofile'], 'Expected package not created.');
    $expected_config_items = [
      'shortcut.myshortcut',
      'system.cron',
      'system.theme',
    ];
    $this
      ->assertEquals($expected_config_items, $packages['myprofile']
      ->getConfig(), 'Expected configuration items not present in package.');
  }

  /**
   * @covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentSiteType
   */
  public function testAssignSiteType() {
    $method_id = 'site';

    // Enable the method.
    $this
      ->enableAssignmentMethod($method_id);

    // Test the default options for the site assignment method.
    // Add a piece of configuration of a site type.
    $this
      ->addConfigurationItem('filter.format.plain_text', [], [
      'shortName' => 'plain_text',
      'label' => 'Plain text',
      'type' => 'filter_format',
    ]);

    // Add a piece of configuration of a non-site type.
    $this
      ->addConfigurationItem('field.field.node.article.body', [], [
      'shortName' => 'node.article.body',
      'label' => 'Body',
      'type' => 'field_config',
      'dependents' => [],
    ]);
    $this->assigner
      ->applyAssignmentMethod($method_id);
    $packages = $this->featuresManager
      ->getPackages();
    $expected_package_names = [
      'site',
    ];
    $this
      ->assertEquals($expected_package_names, array_keys($packages), 'Expected packages not created.');
    $this
      ->assertTrue(in_array('filter.format.plain_text', $packages['site']
      ->getConfig(), 'Expected configuration item not present in site package.'));
    $this
      ->assertFalse(in_array('field.field.node.article.body', $packages['site']
      ->getConfig(), 'Unexpected configuration item present in site package.'));
  }

  /**
   * Enables a specified assignment method.
   *
   * @param string $method_id
   *   The ID of an assignment method.
   * @param bool $exclusive
   *   (optional) Whether to set the method as the only enabled method.
   *   Defaults to TRUE.
   */
  protected function enableAssignmentMethod($method_id, $exclusive = TRUE) {
    if ($exclusive) {
      $this->bundle
        ->setEnabledAssignments([
        $method_id,
      ]);
    }
    else {
      $enabled = array_keys($this->bundle
        ->getEnabledAssignments());
      $enabled[] = $method_id;
      $this->bundle
        ->setEnabledAssignments($enabled);
    }
  }

  /**
   * Adds a configuration item.
   *
   * @param string $name
   *   The config name.
   * @param array $data
   *   The config data.
   * @param array $properties
   *   (optional) Additional properties set on the object.
   */
  protected function addConfigurationItem($name, array $data = [], array $properties = []) {
    $config_collection = $this->featuresManager
      ->getConfigCollection();
    $config_collection[$name] = new ConfigurationItem($name, $data, $properties);
    $this->featuresManager
      ->setConfigCollection($config_collection);
  }

  /**
   * Reset the config to reapply assignment plugins.
   */
  protected function reset() {
    $this->assigner
      ->reset();

    // Start with an empty configuration collection.
    $this->featuresManager
      ->setConfigCollection([]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	1
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings	protected static	function	Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	protected	function
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
FeaturesAssignTest::$assigner	protected	property	The Feature Assigner.
FeaturesAssignTest::$bundle	protected	property	The Feature Bundle.
FeaturesAssignTest::$featuresManager	protected	property	The Feature Manager.
FeaturesAssignTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
FeaturesAssignTest::$strictConfigSchema	protected	property	The variable. Overrides KernelTestBase::$strictConfigSchema
FeaturesAssignTest::addConfigurationItem	protected	function	Adds a configuration item.
FeaturesAssignTest::enableAssignmentMethod	protected	function	Enables a specified assignment method.
FeaturesAssignTest::PACKAGE_NAME		constant
FeaturesAssignTest::reset	protected	function	Reset the config to reapply assignment plugins.
FeaturesAssignTest::setUp	protected	function	Overrides KernelTestBase::setUp
FeaturesAssignTest::testAssignAlter	public	function	@covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentAlter
FeaturesAssignTest::testAssignBase	public	function	@covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentBaseType
FeaturesAssignTest::testAssignCore	public	function	@covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentCoreType
FeaturesAssignTest::testAssignDependency	public	function	@covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentDependency
FeaturesAssignTest::testAssignExclude	public	function	@covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentExclude
FeaturesAssignTest::testAssignExisting	public	function	@covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentExclude
FeaturesAssignTest::testAssignForwardDependency	public	function	@covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentForwardDependency
FeaturesAssignTest::testAssignNamespace	public	function	@covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentNamespace
FeaturesAssignTest::testAssignOptionalType	public	function	@covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentOptionalType
FeaturesAssignTest::testAssignPackages	public	function	@covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentPackages
FeaturesAssignTest::testAssignProfile	public	function	@covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentProfile
FeaturesAssignTest::testAssignSiteType	public	function	@covers Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentSiteType
FeaturesAssignTest::TEST_INSTALLED_PACKAGE		constant
FeaturesAssignTest::TEST_UNINSTALLED_PACKAGE		constant
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	1
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated	protected	function	Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	26
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		6
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated	public	function	BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.

You are here

class FeaturesAssignTest in Features 8.4

Hierarchy

File

Namespace

Members

API Navigation