class ConfigCase

  1. 8.0.x tests/configTest.php ConfigCase
  2. 7.x tests/configTest.php ConfigCase
  3. master tests/configTest.php ConfigCase

Tests for Configuration Management commands for D8+. @group commands @group config




Expanded class hierarchy of ConfigCase


Contains filters are case sensitive
Namesort descending Modifiers Type Description
CommandUnishTestCase::$coverage_data protected property Code coverage data collected during a single test.
CommandUnishTestCase::$defaultIdleTimeout private property Default idle timeout for commands.
CommandUnishTestCase::$defaultTimeout private property Default timeout for commands.
CommandUnishTestCase::$idleTimeout protected property Idle timeouts for commands.
CommandUnishTestCase::$process private property Process of last executed command.
CommandUnishTestCase::$timeout protected property Timeout for command.
CommandUnishTestCase::assertLogHasMessage function Ensure that an expected log message appears in the Drush log.
CommandUnishTestCase::drush function Invoke drush in via execute().
CommandUnishTestCase::drush_major_version function
CommandUnishTestCase::execute function Actually runs the command.
CommandUnishTestCase::EXIT_ERROR constant
CommandUnishTestCase::EXIT_SUCCESS constant
CommandUnishTestCase::getErrorOutput function Accessor for the last stderr output, trimmed.
CommandUnishTestCase::getErrorOutputAsList function Accessor for the last stderr output, rtrimmed and split on newlines.
CommandUnishTestCase::getErrorOutputRaw function Accessor for the last stderr output, non-trimmed.
CommandUnishTestCase::getOutput function Accessor for the last output, trimmed.
CommandUnishTestCase::getOutputAsList function Accessor for the last output, rtrimmed and split on newlines.
CommandUnishTestCase::getOutputFromJSON function Accessor for the last output, decoded from json.
CommandUnishTestCase::getOutputRaw function Accessor for the last output, non-trimmed.
CommandUnishTestCase::parse_backend_output function A slightly less functional copy of drush_backend_parse_output().
CommandUnishTestCase::run public function Override the run method, so we can add in our code coverage data after the test has run.
CommandUnishTestCase::UNISH_EXITCODE_USER_ABORT constant
ConfigCase::options function
ConfigCase::setUp function
ConfigCase::testConfigEdit public function Tests editing config from a file (not interactively).
ConfigCase::testConfigExportImport function
ConfigCase::testConfigGetSet function
ConfigCase::testConfigList function
UnishTestCase::$sites private static property A list of Drupal sites that have been recently installed. They key is the site name and values are details about each site.
UnishTestCase::bit_bucket function Borrowed from Drush. Checks operating system and returns supported bit bucket folder.
UnishTestCase::convert_path function Converts a Windows path (dir1\dir2\dir3) into a Unix path (dir1/dir2/dir3). Also converts a cygwin "drive emulation" path (/cygdrive/c/dir1) into a proper drive path, still with Unix slashes (c:/dir1).
UnishTestCase::db_driver function
UnishTestCase::db_url function
UnishTestCase::directory_cache function
UnishTestCase::drupalSitewideDirectory function
UnishTestCase::escapeshellarg public static function
UnishTestCase::fetchInstallDrupal function
UnishTestCase::getSites function
UnishTestCase::get_tar_executable public static function
UnishTestCase::is_windows public static function
UnishTestCase::log function Print a log message to the console.
UnishTestCase::log_level function
UnishTestCase::mkdir public function
UnishTestCase::randomString public function Helper function to generate a random string of arbitrary length.
UnishTestCase::recursive_copy public function
UnishTestCase::setUpBeforeClass public static function Assure that each class starts with an empty sandbox directory and a clean environment -
UnishTestCase::setUpDrupal function
UnishTestCase::setUpFreshSandBox public static function Remove any pre-existing sandbox, then create a new one.
UnishTestCase::tearDownAfterClass public static function Runs after all tests in a class are run. Remove sandbox directory.
UnishTestCase::tick function Print out a tick mark.
UnishTestCase::unish_file_aliases function Prepare the contents of an aliases file.
UnishTestCase::webroot function
UnishTestCase::writeSiteAlias function
UnishTestCase::_escapeshellarg_windows public static function
UnishTestCase::__construct function


tests/configTest.php, line 10

View source
class ConfigCase extends CommandUnishTestCase {

  function setUp() {
      $this->markTestSkipped('Config only available on D8+.');

    if (!$this->getSites()) {
      $this->setUpDrupal(1, TRUE);

  function testConfigGetSet() {
    $options = $this->options();
    $this->drush('config-set', array('', 'name', 'config_test'), $options);
    $this->drush('config-get', array('', 'name'), $options);
    $this->assertEquals("'': config_test", $this->getOutput(), 'Config was successfully set and get.');

  function testConfigList() {
    $options = $this->options();
    $this->drush('config-list', array(), $options);
    $result = $this->getOutputAsList();
    $this->assertNotEmpty($result, 'An array of config names was returned.');
    $this->assertTrue(in_array('update.settings', $result), 'update.settings name found in the config names.');

    $this->drush('config-list', array('system'), $options);
    $result = $this->getOutputAsList();
    $this->assertTrue(in_array('', $result), ' found in list of config names with "system" prefix.');

    $this->drush('config-list', array('system'), $options + array('format' => 'json'));
    $result = $this->getOutputFromJSON();
    $this->assertNotEmpty($result, 'Valid, non-empty JSON output was returned.');

  function testConfigExportImport() {
    $options = $this->options();
    // Get path to sync dir.
    $this->drush('core-status', array(), $options + array('format' => 'json'));
    $sync = $this->webroot() . '/' . $this->getOutputFromJSON('config-sync');
    $system_site_yml = $sync . '/';
    $core_extension_yml = $sync . '/core.extension.yml';

    // Test export
    $this->drush('config-export', array(), $options);

    // Test import by finish the round trip.
    $contents = file_get_contents($system_site_yml);
    $contents = preg_replace('/front: .*/', 'front: unish', $contents);
    $contents = file_put_contents($system_site_yml, $contents);
    $this->drush('config-import', array(), $options);
    $this->drush('config-get', array('', 'page'), $options + array('format' => 'json'));
    $page = $this->getOutputFromJSON('');
    $this->assertContains('unish', $page->front, 'Config was successfully imported.');

    $this->drush('pm-enable', array('tracker'), $options);
    $ignored_modules = array('skip-modules' => 'tracker');

    // Run config-export again - note that 'tracker' is enabled, but we
    // are going to ignore it on write, so no changes should be written
    // to core.extension when it is exported.
    $this->drush('config-export', array(), $options + $ignored_modules);
    $contents = file_get_contents($core_extension_yml);
    $this->assertNotContains('tracker', $contents);

    // Run config-import again, but ignore 'tracker' when importing.
    // It is not presently in the exported configuration, because we enabled
    // it after export.  If we imported again without adding 'tracker' with
    // 'skip-modules' option, then it would be disabled.
    $this->drush('config-import', array(), $options + $ignored_modules);
    $this->drush('config-get', array('core.extension', 'module'), $options + array('format' => 'yaml'));
    $modules = $this->getOutput();
    $this->assertContains('tracker', $modules, 'Tracker module appears in extension list after import, as it should.');

    // Run config-export one final time.  'tracker' is still enabled, even
    // though it was ignored in the previous import/export operations.
    // When we remove the skip-modules option, then 'tracker' will
    // be exported.
    $this->drush('config-export', array(), $options);
    $contents = file_get_contents($core_extension_yml);
    $this->assertContains('tracker', $contents);

   * Tests editing config from a file (not interactively).
  public function testConfigEdit() {
    // Write out edits to a file.
    $config = "name: 'TEST NAME'\nmail:";
    $path = UNISH_SANDBOX . '/';
    file_put_contents($path, $config);

    $options = $this->options();
    $options += array(
      'file' => $path,
      'yes' => NULL,
    $this->drush('config-edit', array(), $options);
    $this->drush('config-get', array(''), $this->options());
    $this->assertEquals($config, $this->getOutput());

  function options() {
    return array(
      'yes' => NULL,
      'root' => $this->webroot(),
      'uri' => key($this->getSites()),