You are here

Home » API reference » Config Actions 8 » ConfigActionsPluginTest.php

class ConfigActionsPluginTest in Config Actions 8

test the ConfigActions plugins

@group config_actions

Hierarchy

Expanded class hierarchy of ConfigActionsPluginTest

File

tests/src/Kernel/ConfigActionsPluginTest.php, line 14

Namespace

Drupal\Tests\config_actions\Kernel
View source 
class ConfigActionsPluginTest extends KernelTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'node',
    'system',
    'user',
    'config_actions',
    'test_config_actions',
  ];

  /**
   * Prevent strict schema errors during test.
   */
  protected $strictConfigSchema = FALSE;

  /**
   * @var \Drupal\config_actions\ConfigActionsService
   */
  protected $configActions;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installConfig('system');
    $this
      ->installConfig('node');
    $this
      ->installConfig('test_config_actions');
    $this->configActions = $this->container
      ->get('config_actions');
  }

  /**
   * Helper function to load a specific configuration item
   * @param string $id
   * @return array of config data
   */
  protected function getConfig($id) {
    return $this->container
      ->get('config.factory')
      ->get($id)
      ->get();
  }

  /**
   * Helper function to delete a specific configuration item
   * @param string $id
   */
  protected function deleteConfig($id) {
    return $this->container
      ->get('config.factory')
      ->getEditable($id)
      ->delete();
  }

  /**
   * Test string replacement.
   */
  public function testReplace() {

    // Config data taken from core.date_format.long.yml
    // Additional keys added to test the string and key replacement system
    $source = [
      'langcode' => 'en',
      'status' => true,
      'dependencies' => [],
      'id' => '@format@',
      'label' => 'Default long date',
      'locked' => false,
      'pattern' => 'l, F j, Y - H:i',
      '@key@' => 'date',
    ];

    // $vars get replaced everywhere (options AND source data values and keys)
    $replace = [
      // Test replacement in 'value' option.
      '@test@' => 'new',
      // Test replacement in loaded data value (id).
      '@format@' => 'long',
      // Test replacement in loaded data key.
      '@key@' => 'date',
      //
      'date' => [
        'with' => 'datetime',
        'type' => 'value',
        // Only change loaded data values, so does not replace in 'value' option
        'in' => [
          'load',
        ],
      ],
      'label' => [
        'with' => 'mylabel',
        // Only change loaded key values, so does not replace in 'path' option
        'type' => 'key',
      ],
    ];
    $value = 'My @test@ date';
    $action = [
      'plugin' => 'change',
      'source' => $source,
      // Original 'label' key was changed to 'mylabel'
      // But path is not replaced with 'mymylabel' because only keys were replaced.
      'path' => [
        'mylabel',
      ],
      'value' => $value,
      'replace' => $replace,
      'replace_in' => [
        'value',
        'load',
        'path',
      ],
    ];
    $new_config = $this->configActions
      ->processAction($action);
    $source['mylabel'] = 'My new date';
    $source['id'] = 'long';
    unset($source['label']);
    $source['date'] = 'datetime';
    unset($source['@key@']);
    self::assertEquals($source, $new_config);
  }

  /**
   * Test using @property@ replacement in options
   */
  public function testOptionReplace() {
    $action = [
      'plugin' => 'change',
      'source' => '@id@',
      'path' => [
        'label',
      ],
      'actions' => [
        'core.date_format.short' => [
          'value' => 'Test short date',
        ],
        'core.date_format.long' => [
          'value' => 'Test long date',
        ],
      ],
    ];
    $config = $this->configActions
      ->processAction($action);
    $short_config = $this
      ->getConfig('core.date_format.short');
    $long_config = $this
      ->getConfig('core.date_format.long');
    self::assertEquals('Test short date', $short_config['label']);
    self::assertEquals('Test long date', $long_config['label']);
  }

  /**
   * Test "source" option that is used in many plugins.
   */
  public function testSource() {
    $source = [
      'mykey' => 'myvalue',
      'label' => 'This is a @test@',
    ];
    $dest = 'core.date_format.long';
    $replace = [
      'label' => [
        'with' => 'mylabel',
        // We only want to replace the 'value' option, not the 'path'.
        'in' => [
          'value',
        ],
      ],
      '@test@' => 'new',
    ];
    $value = 'My @test@ label';
    $action = [
      'plugin' => 'change',
      'source' => $source,
      'dest' => $dest,
      'path' => [
        'label',
      ],
      'value' => $value,
      'replace' => $replace,
    ];
    $orig_config = $this
      ->getConfig($dest);
    $tree = $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($dest);
    $source['label'] = 'My new mylabel';

    // First, test the raw return value
    self::assertEquals($source, $tree);

    // Now test what was actually stored in the config because of the schema
    // where you can't just add the 'newkey'
    $orig_config['label'] = 'My new mylabel';
    self::assertEquals($orig_config, $new_config);
    self::assertArrayNotHasKey('mykey', $new_config);
  }

  /**
   * @covers \Drupal\config_actions\Plugin\ConfigActions\ConfigActionsDelete
   */
  public function testDelete() {
    $source = 'core.date_format.long';
    $action = [
      'plugin' => 'delete',
      'source' => $source,
      'path' => [
        'label',
      ],
    ];
    $orig_config = $this
      ->getConfig($source);
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($source);
    $orig_config['label'] = '';
    self::assertEquals($orig_config, $new_config);

    // Test pruning the data
    $source = 'core.date_format.long';
    $action = [
      'plugin' => 'delete',
      'source' => $source,
      'path' => [
        'label',
      ],
      'prune' => TRUE,
    ];
    $orig_config = $this
      ->getConfig($source);
    $new_config = $this->configActions
      ->processAction($action);

    // Cannot use getConfig to test because Drupal won't actually delete the key
    unset($orig_config['label']);
    self::assertEquals($orig_config, $new_config);

    // Test deleting entire config entity
    $source = 'core.date_format.long';
    $action = [
      'plugin' => 'delete',
      'source' => $source,
    ];
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($source);
    self::assertEmpty($new_config);
  }

  /**
   * @covers \Drupal\config_actions\Plugin\ConfigActions\ConfigActionsChange
   */
  public function testChange() {
    $source = 'core.date_format.long';
    $value = 'My new label';
    $action = [
      'plugin' => 'change',
      'source' => $source,
      'path' => [
        'label',
      ],
      'value' => $value,
    ];
    $orig_config = $this
      ->getConfig($source);
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($source);
    $orig_config['label'] = $value;
    self::assertEquals($orig_config, $new_config);
    $value = 'Another new label';
    $action = [
      'plugin' => 'change',
      'source' => $source,
      'value' => [
        'label' => $value,
      ],
    ];
    $orig_config = $this
      ->getConfig($source);
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($source);
    $orig_config['label'] = $value;
    self::assertEquals($orig_config, $new_config);
    $new_value = 'New Value';
    $action = [
      'plugin' => 'change',
      'source' => $source,
      'path' => [
        'label',
      ],
      'value' => $new_value,
      'current_value' => $value,
    ];
    $orig_config = $this
      ->getConfig($source);
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($source);
    $orig_config['label'] = $new_value;
    self::assertEquals($orig_config, $new_config);
    $action = [
      'plugin' => 'change',
      'source' => $source,
      'path' => [
        'label',
      ],
      'value' => $value,
      'current_value' => 'NONE',
    ];
    $this
      ->expectException(\Exception::class);
    $this
      ->expectExceptionMessage('Failed to validate path value for config action.');
    $this->configActions
      ->processAction($action);
  }

  /**
   * @covers \Drupal\config_actions\Plugin\ConfigActions\ConfigActionsAdd
   */
  public function testAdd() {

    // Find a config file that has an array we can add to without violating schema.
    $source = 'system.action.node_delete_action';

    // Create a new key and value in config.
    $value = [
      'abc' => 123,
      'def' => 'test',
    ];
    $action = [
      'plugin' => 'add',
      'source' => $source,
      'path' => [
        'newkey',
      ],
      'value' => $value,
    ];
    $orig_config = $this
      ->getConfig($source);
    $tree = $this->configActions
      ->processAction($action);
    $orig_config['newkey'] = $value;

    // First check raw data transformation contains new key.
    self::assertEquals($orig_config, $tree);

    // Now check actual stored config since you can't just add new key values to schema.
    $new_config = $this
      ->getConfig($source);
    self::assertArrayNotHasKey('newkey', $new_config);

    // "Append" additional data to existing key.
    $value = 'mydata';
    $action = [
      'plugin' => 'add',
      'source' => $source,
      'path' => [
        'configuration',
      ],
      'value' => $value,
    ];
    $orig_config = $this
      ->getConfig($source);
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($source);
    $orig_config['configuration'] = [
      $value,
    ];
    self::assertEquals($orig_config, $new_config);

    // Now add another additional value to existing key.
    $value2 = 'another';
    $action = [
      'plugin' => 'add',
      'source' => $source,
      'path' => [
        'configuration',
      ],
      'value' => $value2,
    ];
    $orig_config = $this
      ->getConfig($source);
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($source);
    $orig_config['configuration'] = [
      $value,
      $value2,
    ];
    self::assertEquals($orig_config, $new_config);

    // Test "change" vs "add".
    $action = [
      'plugin' => 'change',
      'source' => $source,
      'path' => [
        'configuration',
      ],
      'value' => [
        $value,
      ],
    ];
    $orig_config = $this
      ->getConfig($source);
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($source);
    $orig_config['configuration'] = [
      $value,
    ];
    self::assertEquals($orig_config, $new_config);
  }

  /**
   * Test nested actions.
   */
  public function testNested() {
    $source = 'core.date_format.@format@';
    $value = 'My new label';
    $action = [
      // Test global options passed to actions.
      'source' => $source,
      'path' => [
        'label',
      ],
      'replace_in' => [
        'source',
      ],
      'actions' => [
        'long-action' => [
          'replace' => [
            '@format@' => 'long',
          ],
          'actions' => [
            'change-action' => [
              'plugin' => 'change',
              'value' => $value,
            ],
            'change-status' => [
              'plugin' => 'change',
              // Test overriding path option for specific action.
              'path' => [
                'locked',
              ],
              'value' => true,
            ],
          ],
        ],
        'short-action' => [
          'plugin' => 'change',
          'value' => $value,
          // Test a different format variable
          'replace' => [
            '@format@' => 'short',
          ],
        ],
      ],
    ];
    $orig_config_long = $this
      ->getConfig('core.date_format.long');
    $orig_config_short = $this
      ->getConfig('core.date_format.short');
    $this->configActions
      ->processAction($action);
    $new_config_long = $this
      ->getConfig('core.date_format.long');
    $new_config_short = $this
      ->getConfig('core.date_format.short');
    $orig_config_long['label'] = $value;
    $orig_config_long['locked'] = true;
    $orig_config_short['label'] = $value;
    self::assertEquals($orig_config_long, $new_config_long);
    self::assertEquals($orig_config_short, $new_config_short);
  }

  /**
   * @covers \Drupal\config_actions\Plugin\ConfigActions\ConfigActionsChange
   */
  public function testTemplate() {

    // Test basic template function using change plugin.
    $config_id = 'field.storage.node.myimage';
    $source_file = dirname(__FILE__) . '/field.storage.node.image.yml';
    $dest = 'field.storage.node.@field_name@';
    $replace = [
      '@field_name@' => 'myimage',
      '@cardinality@' => 2,
    ];
    $action = [
      'source' => $source_file,
      'dest' => $dest,
      'replace' => $replace,
    ];
    $orig_config = Yaml::decode(file_get_contents($source_file));
    $orig_config = ConfigActionsTransform::replace($orig_config, $replace);
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($config_id);
    self::assertEquals($orig_config, $new_config);
    self::assertTrue(is_int($new_config['cardinality']), 'Cardinality test should set config as integer value');

    // Clean up for next test.
    $this
      ->deleteConfig($config_id);

    // Test replace_in to prevent string replacement
    $dest = 'field.storage.node.field_name';
    $replace = [
      'field_name' => 'myimage',
      '@cardinality@' => 1,
    ];
    $action = [
      'source' => $source_file,
      'dest' => $dest,
      'replace' => $replace,
      'replace_in' => [],
    ];
    $orig_config = Yaml::decode(file_get_contents($source_file));
    $tree = $this->configActions
      ->processAction($action);
    self::assertEquals($orig_config, $tree);

    // Check saved config
    $new_config = $this
      ->getConfig($dest);
    self::assertEquals($orig_config, $new_config);

    // Ensure config didn't get created with new name.
    $new_config = $this
      ->getConfig($config_id);
    self::assertEmpty($new_config);

    // Clean up for next test.
    $this
      ->deleteConfig($config_id);

    // Test using an array of sources to override existing config
    // First time it should create new config
    $dest = $config_id;
    $replace = [
      '@field_name@' => 'myimage',
    ];
    $action = [
      'source' => [
        '@dest@',
        $source_file,
      ],
      'dest' => $dest,
      'replace' => $replace,
      'value' => [
        'cardinality' => 2,
        'translatable' => true,
      ],
    ];
    $orig_config = Yaml::decode(file_get_contents($source_file));
    $orig_config = ConfigActionsTransform::replace($orig_config, $replace);
    $orig_config['cardinality'] = 2;
    $orig_config['translatable'] = true;
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($config_id);
    self::assertEquals($orig_config, $new_config);

    // Second time it should use existing config
    // Changing 'translatable', but 'cardinality' should still be 2,
    // and NOT the 1 that is in the original template/default
    // Clear cache to ensure previous data isn't still being used.
    $this->configActions
      ->clearSourceCache();
    $dest = $config_id;
    $replace = [
      '@field_name@' => 'myimage',
    ];
    $action = [
      'source' => [
        '@dest@',
        $source_file,
      ],
      'dest' => $dest,
      'replace' => $replace,
      'value' => [
        'translatable' => false,
      ],
    ];
    $orig_config = Yaml::decode(file_get_contents($source_file));
    $orig_config = ConfigActionsTransform::replace($orig_config, $replace);
    $orig_config['cardinality'] = 2;
    $orig_config['translatable'] = false;
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($config_id);
    self::assertEquals($orig_config, $new_config);
  }

  /**
   * @covers \Drupal\config_actions\Plugin\ConfigActions\ConfigActionsInclude
   */
  public function testInclude() {

    // First, just call the field_storage action to test a simple include.
    $replace = [
      '@field_name@' => 'myimage',
      '@cardinality@' => 1,
    ];
    $action = [
      'plugin' => 'include',
      'module' => 'test_config_actions',
      'action' => 'field_storage',
      'replace' => $replace,
    ];
    $path = drupal_get_path('module', 'test_config_actions') . '/config/templates';
    $source = $path . '/field.storage.node.image.yml';
    $orig_config = Yaml::decode(file_get_contents($source));
    $orig_config = ConfigActionsTransform::replace($orig_config, $replace);
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig('field.storage.node.myimage');
    self::assertEquals($orig_config, $new_config);
    self::assertTrue(is_int($new_config['cardinality']), 'Cardinality test should set config as integer value');

    // Next, call the field_instance action which has two sub-actions that have
    // their own bundles defined.
    $replace = [
      '@field_name@' => 'myimage',
      // This bundle is ignored because sub-actions have their own bundle replace.
      '@bundle@' => 'mypage',
    ];
    $replace_article = [
      '@field_name@' => 'myimage',
      '@bundle@' => 'article',
    ];
    $replace_page = [
      '@field_name@' => 'myimage',
      '@bundle@' => 'page',
    ];
    $action = [
      'plugin' => 'include',
      'module' => 'test_config_actions',
      'action' => 'field_instance',
      'replace' => $replace,
    ];
    $path = drupal_get_path('module', 'test_config_actions') . '/config/templates';
    $source = $path . '/field.field.node.image.yml';
    $orig_config = Yaml::decode(file_get_contents($source));
    $orig_config_article = ConfigActionsTransform::replace($orig_config, $replace_article);
    $orig_config_page = ConfigActionsTransform::replace($orig_config, $replace_page);
    $this->configActions
      ->processAction($action);
    $new_config_article = $this
      ->getConfig('field.field.node.article.myimage');
    $new_config_page = $this
      ->getConfig('field.field.node.page.myimage');
    self::assertEquals($orig_config_article, $new_config_article);
    self::assertEquals($orig_config_page, $new_config_page);
    $this
      ->deleteConfig('field.field.node.article.myimage');
    $this
      ->deleteConfig('field.field.node.page.myimage');

    // Next, call one of the sub-actions directly.
    // Now we can override the bundle in the sub-action.
    $action = [
      'plugin' => 'include',
      'module' => 'test_config_actions',
      'action' => 'field_instance:article',
      'replace' => $replace,
    ];
    $orig_config = Yaml::decode(file_get_contents($source));
    $orig_config = ConfigActionsTransform::replace($orig_config, $replace);
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig('field.field.node.mypage.myimage');
    $new_config_article = $this
      ->getConfig('field.field.node.article.myimage');
    $new_config_page = $this
      ->getConfig('field.field.node.page.myimage');
    self::assertEquals($orig_config, $new_config);
    self::assertEmpty($new_config_article);
    self::assertEmpty($new_config_page);

    // Next, run actions in a single file.
    $config_id = 'core.date_format.short';
    $action = [
      'plugin' => 'include',
      'module' => 'test_config_actions',
      'file' => $config_id,
    ];
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($config_id);
    self::assertEquals('Test short date', $new_config['label']);

    // Test allowing .yml in the file name.
    $config_id = 'core.date_format.short';
    $label = 'New short date';
    $action = [
      'plugin' => 'include',
      'module' => 'test_config_actions',
      'file' => $config_id . '.yml',
      '@label@' => $label,
    ];
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($config_id);
    self::assertEquals($label, $new_config['label']);
  }

  /**
   * Test the pipeline for saving config
   */
  function testPipeline() {
    $source = 'user.role.myrole';
    $action = [
      // Test global options passed to actions.
      'source' => $source,
      'path' => [
        'permissions',
      ],
      'actions' => [
        'add-permission-1' => [
          'plugin' => 'add',
          'value' => 'permission1',
        ],
        // Doing a Prune here would fail without a pipeline since the
        // config couldn't be saved without the permissions config key.
        'delete-permissions' => [
          'plugin' => 'delete',
          'prune' => TRUE,
        ],
        'add-permission-2' => [
          'plugin' => 'add',
          'value' => 'permission2',
        ],
      ],
    ];
    $this->configActions
      ->processAction($action);
    $new_config = $this
      ->getConfig($source);
    self::assertEquals([
      'permission2',
    ], $new_config['permissions']);
  }

}

Members

Namesort descending 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
ConfigActionsPluginTest::$configActions protected property
ConfigActionsPluginTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
ConfigActionsPluginTest::$strictConfigSchema protected property Prevent strict schema errors during test. Overrides KernelTestBase::$strictConfigSchema
ConfigActionsPluginTest::deleteConfig protected function Helper function to delete a specific configuration item
ConfigActionsPluginTest::getConfig protected function Helper function to load a specific configuration item
ConfigActionsPluginTest::setUp protected function Overrides KernelTestBase::setUp
ConfigActionsPluginTest::testAdd public function @covers \Drupal\config_actions\Plugin\ConfigActions\ConfigActionsAdd
ConfigActionsPluginTest::testChange public function @covers \Drupal\config_actions\Plugin\ConfigActions\ConfigActionsChange
ConfigActionsPluginTest::testDelete public function @covers \Drupal\config_actions\Plugin\ConfigActions\ConfigActionsDelete
ConfigActionsPluginTest::testInclude public function @covers \Drupal\config_actions\Plugin\ConfigActions\ConfigActionsInclude
ConfigActionsPluginTest::testNested public function Test nested actions.
ConfigActionsPluginTest::testOptionReplace public function Test using @property@ replacement in options
ConfigActionsPluginTest::testPipeline function Test the pipeline for saving config
ConfigActionsPluginTest::testReplace public function Test string replacement.
ConfigActionsPluginTest::testSource public function Test "source" option that is used in many plugins.
ConfigActionsPluginTest::testTemplate public function @covers \Drupal\config_actions\Plugin\ConfigActions\ConfigActionsChange
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.
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.