ConfigCRUDTest.php 6.52 KB
Newer Older
1
2
3
4
5
6
7
8
9
<?php

/**
 * @file
 * Definition of Drupal\config\Tests\ConfigCRUDTest.
 */

namespace Drupal\config\Tests;

10
use Drupal\Core\Config\ConfigNameException;
11
use Drupal\simpletest\DrupalUnitTestBase;
12
13
14
15

/**
 * Tests CRUD operations on configuration objects.
 */
16
class ConfigCRUDTest extends DrupalUnitTestBase {
17
18
19
20
21
22
23
24
25
26
27
28
  public static function getInfo() {
    return array(
      'name' => 'CRUD operations',
      'description' => 'Tests CRUD operations on configuration objects.',
      'group' => 'Configuration',
    );
  }

  /**
   * Tests CRUD operations.
   */
  function testCRUD() {
29
    $storage = $this->container->get('config.storage');
30
31
32
    $name = 'config_test.crud';

    $config = config($name);
33
34
35
    $this->assertIdentical($config->isNew(), TRUE);

    // Create a new configuration object.
36
37
    $config->set('value', 'initial');
    $config->save();
38
    $this->assertIdentical($config->isNew(), FALSE);
39

40
    // Verify the active configuration contains the saved value.
41
42
43
44
45
46
    $actual_data = $storage->read($name);
    $this->assertIdentical($actual_data, array('value' => 'initial'));

    // Update the configuration object instance.
    $config->set('value', 'instance-update');
    $config->save();
47
    $this->assertIdentical($config->isNew(), FALSE);
48

49
    // Verify the active configuration contains the updated value.
50
51
52
53
54
55
    $actual_data = $storage->read($name);
    $this->assertIdentical($actual_data, array('value' => 'instance-update'));

    // Verify a call to config() immediately returns the updated value.
    $new_config = config($name);
    $this->assertIdentical($new_config->get(), $config->get());
56
    $this->assertIdentical($config->isNew(), FALSE);
57
58
59
60
61
62

    // Delete the configuration object.
    $config->delete();

    // Verify the configuration object is empty.
    $this->assertIdentical($config->get(), array());
63
    $this->assertIdentical($config->isNew(), TRUE);
64

65
    // Verify the active configuration contains no value.
66
    $actual_data = $storage->read($name);
67
    $this->assertIdentical($actual_data, FALSE);
68
69
70
71

    // Verify config() returns no data.
    $new_config = config($name);
    $this->assertIdentical($new_config->get(), $config->get());
72
    $this->assertIdentical($config->isNew(), TRUE);
73
74
75
76

    // Re-create the configuration object.
    $config->set('value', 're-created');
    $config->save();
77
    $this->assertIdentical($config->isNew(), FALSE);
78

79
    // Verify the active configuration contains the updated value.
80
81
82
83
84
85
    $actual_data = $storage->read($name);
    $this->assertIdentical($actual_data, array('value' => 're-created'));

    // Verify a call to config() immediately returns the updated value.
    $new_config = config($name);
    $this->assertIdentical($new_config->get(), $config->get());
86
    $this->assertIdentical($config->isNew(), FALSE);
87
88
89
90
91
92
93

    // Rename the configuration object.
    $new_name = 'config_test.crud_rename';
    $config->rename($new_name);
    $renamed_config = config($new_name);
    $this->assertIdentical($renamed_config->get(), $config->get());
    $this->assertIdentical($renamed_config->isNew(), FALSE);
94
95
96
97
98
99
100
101
102
103
104

    // Merge data into the configuration object.
    $new_config = config($new_name);
    $expected_values = array(
      'value' => 'herp',
      '404' => 'derp',
    );
    $new_config->merge($expected_values);
    $new_config->save();
    $this->assertIdentical($new_config->get('value'), $expected_values['value']);
    $this->assertIdentical($new_config->get('404'), $expected_values['404']);
105
106
  }

107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
  /**
   * Tests the validation of configuration object names.
   */
  function testNameValidation() {
    // Verify that an object name without namespace causes an exception.
    $name = 'nonamespace';
    $message = 'Expected ConfigNameException was thrown for a name without a namespace.';
    try {
      config($name)->save();
      $this->fail($message);
    }
    catch (ConfigNameException $e) {
      $this->pass($message);
    }

    // Verify that a name longer than the maximum length causes an exception.
    $name = 'config_test.herman_melville.moby_dick_or_the_whale.harper_1851.now_small_fowls_flew_screaming_over_the_yet_yawning_gulf_a_sullen_white_surf_beat_against_its_steep_sides_then_all_collapsed_and_the_great_shroud_of_the_sea_rolled_on_as_it_rolled_five_thousand_years_ago';
    $message = 'Expected ConfigNameException was thrown for a name longer than Config::MAX_NAME_LENGTH.';
    try {
      config($name)->save();
      $this->fail($message);
    }
    catch (ConfigNameException $e) {
      $this->pass($message);
    }

    // Verify that disallowed characters in the name cause an exception.
    $characters = $test_characters = array(':', '?', '*', '<', '>', '"', '\'', '/', '\\');
    foreach ($test_characters as $i => $c) {
      try {
        $name = 'namespace.object' . $c;
        $config = config($name);
        $config->save();
      }
      catch (ConfigNameException $e) {
        unset($test_characters[$i]);
      }
    }
    $this->assertTrue(empty($test_characters), format_string('Expected ConfigNameException was thrown for all invalid name characters: @characters', array(
      '@characters' => implode(' ', $characters),
    )));

    // Verify that a valid config object name can be saved.
    $name = 'namespace.object';
    $message = 'ConfigNameException was not thrown for a valid object name.';
    try {
      $config = config($name);
      $config->save();
      $this->pass($message);
    }
    catch (\Exception $e) {
      $this->fail($message);
    }

    // Verify an exception is thrown when importing configuration with an
    // invalid name (missing a namespace).
    $message = 'Expected ConfigNameException was thrown when attempting to install invalid configuration.';
    try {
      $this->enableModules(array('config_test_invalid_name'));
166
      $this->installConfig(array('config_test_invalid_name'));
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
      $this->fail($message);
    }
    catch (ConfigNameException $e) {
      $this->pass($message);
    }

    // Write configuration with an invalid name (missing a namespace) to
    // staging.
    $storage = $this->container->get('config.storage');
    $staging = $this->container->get('config.storage.staging');
    $manifest_data = config('manifest.invalid_object_name')->get();
    $manifest_data['new']['name'] = 'invalid';
    $staging->write('manifest.invalid_object_name', $manifest_data);

    // Verify that an exception is thrown when synchronizing.
    $message = 'Expected ConfigNameException was thrown when attempting to sync invalid configuration.';
    try {
      config_import();
      $this->fail($message);
    }
    catch (ConfigNameException $e) {
      $this->pass($message);
    }
  }

192
}