ManageFieldsTest.php 17.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
<?php

/**
 * @file
 * Definition of Drupal\field_ui\Tests\ManageFieldsTest.
 */

namespace Drupal\field_ui\Tests;

/**
 * Tests the functionality of the 'Manage fields' screen.
 */
class ManageFieldsTest extends FieldUiTestBase {
  public static function getInfo() {
    return array(
      'name' => 'Manage fields',
      'description' => 'Test the Field UI "Manage fields" screen.',
      'group' => 'Field UI',
    );
  }

  function setUp() {
    parent::setUp();

    // Create random field name.
    $this->field_label = $this->randomName(8);
    $this->field_name_input =  strtolower($this->randomName(8));
    $this->field_name = 'field_'. $this->field_name_input;

    // Create Basic page and Article node types.
    $this->drupalCreateContentType(array('type' => 'page', 'name' => 'Basic page'));
    $this->drupalCreateContentType(array('type' => 'article', 'name' => 'Article'));

    // Create a vocabulary named "Tags".
    $vocabulary = entity_create('taxonomy_vocabulary', array(
      'name' => 'Tags',
37
      'vid' => 'tags',
38 39
      'langcode' => LANGUAGE_NOT_SPECIFIED,
    ));
40
    $vocabulary->save();
41 42

    $field = array(
43
      'field_name' => 'field_' . $vocabulary->id(),
44 45 46 47 48
      'type' => 'taxonomy_term_reference',
    );
    field_create_field($field);

    $instance = array(
49
      'field_name' => 'field_' . $vocabulary->id(),
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
      'entity_type' => 'node',
      'label' => 'Tags',
      'bundle' => 'article',
    );
    field_create_instance($instance);
  }

  /**
   * Runs the field CRUD tests.
   *
   * In order to act on the same fields, and not create the fields over and over
   * again the following tests create, update and delete the same fields.
   */
  function testCRUDFields() {
    $this->manageFieldsPage();
    $this->createField();
    $this->updateField();
    $this->addExistingField();
68
    $this->cardinalitySettings();
69 70 71 72
  }

  /**
   * Tests the manage fields page.
73 74 75
   *
   * @param string $type
   *   (optional) The name of a content type.
76
   */
77 78 79
  function manageFieldsPage($type = '') {
    $type = empty($type) ? $this->type : $type;
    $this->drupalGet('admin/structure/types/manage/' . $type . '/fields');
80 81 82 83 84 85 86 87 88 89
    // Check all table columns.
    $table_headers = array(
      t('Label'),
      t('Machine name'),
      t('Field type'),
      t('Widget'),
      t('Operations'),
    );
    foreach ($table_headers as $table_header) {
      // We check that the label appear in the table headings.
90
      $this->assertRaw($table_header . '</th>', format_string('%table_header table header was found.', array('%table_header' => $table_header)));
91 92
    }

93
    // "Add new field" and "Re-use existing field" aren't a table heading so just
94
    // test the text.
95
    foreach (array('Add new field', 'Re-use existing field') as $element) {
96
      $this->assertText($element, format_string('"@element" was found.', array('@element' => $element)));
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
    }
  }

  /**
   * Tests adding a new field.
   *
   * @todo Assert properties can bet set in the form and read back in $field and
   * $instances.
   */
  function createField() {
    // Create a test field.
    $edit = array(
      'fields[_add_new_field][label]' => $this->field_label,
      'fields[_add_new_field][field_name]' => $this->field_name_input,
    );
    $this->fieldUIAddNewField('admin/structure/types/manage/' . $this->type, $edit);

114
    // Assert the field appears in the "re-use existing field" section for
115 116
    // different entity types; e.g. if a field was added in a node entity, it
    // should also appear in the 'taxonomy term' entity.
117 118
    $vocabulary = taxonomy_vocabulary_load('tags');
    $this->drupalGet('admin/structure/taxonomy/' . $vocabulary->id() . '/fields');
119
    $this->assertTrue($this->xpath('//select[@name="fields[_add_existing_field][field_name]"]//option[@value="' . $this->field_name . '"]'), 'Existing field was found in account settings.');
120 121 122 123 124 125 126
  }

  /**
   * Tests editing an existing field.
   */
  function updateField() {
    // Go to the field edit page.
127
    $this->drupalGet('admin/structure/types/manage/' . $this->type . '/fields/' . $this->field_name . '/field-settings');
128 129 130 131 132

    // Populate the field settings with new settings.
    $string = 'updated dummy test string';
    $edit = array(
      'field[settings][test_field_setting]' => $string,
133 134 135 136 137 138
    );
    $this->drupalPost(NULL, $edit, t('Save field settings'));

    // Go to the field instance edit page.
    $this->drupalGet('admin/structure/types/manage/' . $this->type . '/fields/' . $this->field_name);
    $edit = array(
139 140 141 142 143 144 145 146 147
      'instance[settings][test_instance_setting]' => $string,
      'instance[widget][settings][test_widget_setting]' => $string,
    );
    $this->drupalPost(NULL, $edit, t('Save settings'));

    // Assert the field settings are correct.
    $this->assertFieldSettings($this->type, $this->field_name, $string);

    // Assert redirection back to the "manage fields" page.
148
    $this->assertUrl('admin/structure/types/manage/' . $this->type . '/fields');
149 150 151 152 153 154
  }

  /**
   * Tests adding an existing field in another content type.
   */
  function addExistingField() {
155
    // Check "Re-use existing field" appears.
156
    $this->drupalGet('admin/structure/types/manage/page/fields');
157
    $this->assertRaw(t('Re-use existing field'), '"Re-use existing field" was found.');
158 159 160 161

    // Check that the list of options respects entity type restrictions on
    // fields. The 'comment' field is restricted to the 'comment' entity type
    // and should not appear in the list.
162
    $this->assertFalse($this->xpath('//select[@id="edit-add-existing-field-field-name"]//option[@value="comment"]'), 'The list of options respects entity type restrictions.');
163 164 165 166 167 168 169 170 171

    // Add a new field based on an existing field.
    $edit = array(
      'fields[_add_existing_field][label]' => $this->field_label . '_2',
      'fields[_add_existing_field][field_name]' => $this->field_name,
    );
    $this->fieldUIAddExistingField("admin/structure/types/manage/page", $edit);
  }

172 173 174 175 176 177 178
  /**
   * Tests the cardinality settings of a field.
   *
   * We do not test if the number can be submitted with anything else than a
   * numeric value. That is tested already in FormTest::testNumber().
   */
  function cardinalitySettings() {
179
    $field_edit_path = 'admin/structure/types/manage/article/fields/body/field-settings';
180 181 182 183 184 185 186

    // Assert the cardinality other field cannot be empty when cardinality is
    // set to other.
    $edit = array(
      'field[container][cardinality]' => 'other',
      'field[container][cardinality_other]' => '',
    );
187
    $this->drupalPost($field_edit_path, $edit, t('Save field settings'));
188 189 190 191 192 193 194 195
    $this->assertText('Number of values is required.');

    // Assert the cardinality field is set to 'Other' when the value is greater
    // than 5.
    $edit = array(
      'field[container][cardinality]' => 'other',
      'field[container][cardinality_other]' => 16,
    );
196 197
    $this->drupalPost($field_edit_path, $edit, t('Save field settings'));
    $this->assertText('Updated field Body field settings.');
198 199 200 201 202 203 204 205 206 207
    $this->drupalGet($field_edit_path);
    $this->assertFieldByXPath("//select[@name='field[container][cardinality]']", 'other');
    $this->assertFieldByXPath("//input[@name='field[container][cardinality_other]']", 16);

    // Assert the cardinality other field is set back to 6 after changing the
    // cardinality to less than 6.
    $edit = array(
      'field[container][cardinality]' => 3,
      'field[container][cardinality_other]' => 16,
    );
208 209
    $this->drupalPost($field_edit_path, $edit, t('Save field settings'));
    $this->assertText('Updated field Body field settings.');
210 211 212 213 214
    $this->drupalGet($field_edit_path);
    $this->assertFieldByXPath("//select[@name='field[container][cardinality]']", 3);
    $this->assertFieldByXPath("//input[@name='field[container][cardinality_other]']", 6);
  }

215 216 217 218 219 220 221 222 223 224 225 226 227 228
  /**
   * Asserts field settings are as expected.
   *
   * @param $bundle
   *   The bundle name for the instance.
   * @param $field_name
   *   The field name for the instance.
   * @param $string
   *   The settings text.
   * @param $entity_type
   *   The entity type for the instance.
   */
  function assertFieldSettings($bundle, $field_name, $string = 'dummy test string', $entity_type = 'node') {
    // Reset the fields info.
229
    field_info_cache_clear();
230 231
    // Assert field settings.
    $field = field_info_field($field_name);
232
    $this->assertTrue($field['settings']['test_field_setting'] == $string, 'Field settings were found.');
233 234 235

    // Assert instance and widget settings.
    $instance = field_info_instance($entity_type, $field_name, $bundle);
236 237
    $this->assertTrue($instance['settings']['test_instance_setting'] == $string, 'Field instance settings were found.');
    $this->assertTrue($instance['widget']['settings']['test_widget_setting'] == $string, 'Field widget settings were found.');
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
  }

  /**
   * Tests that default value is correctly validated and saved.
   */
  function testDefaultValue() {
    // Create a test field and instance.
    $field_name = 'test';
    $field = array(
      'field_name' => $field_name,
      'type' => 'test_field'
    );
    field_create_field($field);
    $instance = array(
      'field_name' => $field_name,
      'entity_type' => 'node',
      'bundle' => $this->type,
    );
    field_create_instance($instance);

    $langcode = LANGUAGE_NOT_SPECIFIED;
    $admin_path = 'admin/structure/types/manage/' . $this->type . '/fields/' . $field_name;
    $element_id = "edit-$field_name-$langcode-0-value";
    $element_name = "{$field_name}[$langcode][0][value]";
    $this->drupalGet($admin_path);
263
    $this->assertFieldById($element_id, '', 'The default value widget was empty.');
264 265 266 267

    // Check that invalid default values are rejected.
    $edit = array($element_name => '-1');
    $this->drupalPost($admin_path, $edit, t('Save settings'));
268
    $this->assertText("$field_name does not accept the value -1", 'Form vaildation failed.');
269 270 271 272

    // Check that the default value is saved.
    $edit = array($element_name => '1');
    $this->drupalPost($admin_path, $edit, t('Save settings'));
273
    $this->assertText("Saved $field_name configuration", 'The form was successfully submitted.');
274
    $instance = field_info_instance('node', $field_name, $this->type);
275
    $this->assertEqual($instance['default_value'], array(array('value' => 1)), 'The default value was correctly saved.');
276 277 278

    // Check that the default value shows up in the form
    $this->drupalGet($admin_path);
279
    $this->assertFieldById($element_id, '1', 'The default value widget was displayed with the correct value.');
280 281 282 283

    // Check that the default value can be emptied.
    $edit = array($element_name => '');
    $this->drupalPost(NULL, $edit, t('Save settings'));
284
    $this->assertText("Saved $field_name configuration", 'The form was successfully submitted.');
285 286
    field_info_cache_clear();
    $instance = field_info_instance('node', $field_name, $this->type);
287
    $this->assertEqual($instance['default_value'], NULL, 'The default value was correctly saved.');
288 289 290 291 292 293 294

    // Change the widget to TestFieldWidgetNoDefault.
    $instance['widget']['type'] = 'test_field_widget_no_default';
    field_update_instance($instance);

    $this->drupalGet($admin_path);
    $this->assertNoFieldById($element_id, '', t('No default value was possible for widget that disables default value.'));
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
  }

  /**
   * Tests that deletion removes fields and instances as expected.
   */
  function testDeleteField() {
    // Create a new field.
    $bundle_path1 = 'admin/structure/types/manage/' . $this->type;
    $edit1 = array(
      'fields[_add_new_field][label]' => $this->field_label,
      'fields[_add_new_field][field_name]' => $this->field_name_input,
    );
    $this->fieldUIAddNewField($bundle_path1, $edit1);

    // Create an additional node type.
    $type_name2 = strtolower($this->randomName(8)) . '_test';
    $type2 = $this->drupalCreateContentType(array('name' => $type_name2, 'type' => $type_name2));
    $type_name2 = $type2->type;

    // Add an instance to the second node type.
    $bundle_path2 = 'admin/structure/types/manage/' . $type_name2;
    $edit2 = array(
      'fields[_add_existing_field][label]' => $this->field_label,
      'fields[_add_existing_field][field_name]' => $this->field_name,
    );
    $this->fieldUIAddExistingField($bundle_path2, $edit2);

    // Delete the first instance.
    $this->fieldUIDeleteField($bundle_path1, $this->field_name, $this->field_label, $this->type);

    // Reset the fields info.
326
    field_info_cache_clear();
327
    // Check that the field instance was deleted.
328
    $this->assertNull(field_info_instance('node', $this->field_name, $this->type), 'Field instance was deleted.');
329
    // Check that the field was not deleted
330
    $this->assertNotNull(field_info_field($this->field_name), 'Field was not deleted.');
331 332 333 334 335

    // Delete the second instance.
    $this->fieldUIDeleteField($bundle_path2, $this->field_name, $this->field_label, $type_name2);

    // Reset the fields info.
336
    field_info_cache_clear();
337
    // Check that the field instance was deleted.
338
    $this->assertNull(field_info_instance('node', $this->field_name, $type_name2), 'Field instance was deleted.');
339
    // Check that the field was deleted too.
340
    $this->assertNull(field_info_field($this->field_name), 'Field was deleted.');
341 342 343 344 345 346 347 348 349 350
  }

  /**
   * Tests that Field UI respects the 'no_ui' option in hook_field_info().
   */
  function testHiddenFields() {
    $bundle_path = 'admin/structure/types/manage/' . $this->type . '/fields/';

    // Check that the field type is not available in the 'add new field' row.
    $this->drupalGet($bundle_path);
351
    $this->assertFalse($this->xpath('//select[@id="edit-add-new-field-type"]//option[@value="hidden_test_field"]'), "The 'add new field' select respects field types 'no_ui' property.");
352 353 354 355 356 357 358 359 360 361 362 363

    // Create a field and an instance programmatically.
    $field_name = 'hidden_test_field';
    field_create_field(array('field_name' => $field_name, 'type' => $field_name));
    $instance = array(
      'field_name' => $field_name,
      'bundle' => $this->type,
      'entity_type' => 'node',
      'label' => t('Hidden field'),
      'widget' => array('type' => 'test_field_widget'),
    );
    field_create_instance($instance);
364
    $this->assertTrue(field_read_instance('node', $field_name, $this->type), format_string('An instance of the field %field was created programmatically.', array('%field' => $field_name)));
365 366 367 368

    // Check that the newly added instance appears on the 'Manage Fields'
    // screen.
    $this->drupalGet($bundle_path);
369
    $this->assertFieldByXPath('//table[@id="field-overview"]//td[1]', $instance['label'], 'Field was created and appears in the overview page.');
370

371
    // Check that the instance does not appear in the 're-use existing field' row
372 373 374
    // on other bundles.
    $bundle_path = 'admin/structure/types/manage/article/fields/';
    $this->drupalGet($bundle_path);
375
    $this->assertFalse($this->xpath('//select[@id="edit-add-existing-field-field-name"]//option[@value=:field_name]', array(':field_name' => $field_name)), "The 're-use existing field' select respects field types 'no_ui' property.");
376 377 378 379 380 381 382 383 384 385 386 387
  }

  /**
   * Tests renaming a bundle.
   */
  function testRenameBundle() {
    $type2 = strtolower($this->randomName(8)) . '_test';

    $options = array(
      'type' => $type2,
    );
    $this->drupalPost('admin/structure/types/manage/' . $this->type, $options, t('Save content type'));
388
    $this->manageFieldsPage($type2);
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
  }

  /**
   * Tests that a duplicate field name is caught by validation.
   */
  function testDuplicateFieldName() {
    // field_tags already exists, so we're expecting an error when trying to
    // create a new field with the same name.
    $edit = array(
      'fields[_add_new_field][field_name]' => 'tags',
      'fields[_add_new_field][label]' => $this->randomName(),
      'fields[_add_new_field][type]' => 'taxonomy_term_reference',
      'fields[_add_new_field][widget_type]' => 'options_select',
    );
    $url = 'admin/structure/types/manage/' . $this->type . '/fields';
    $this->drupalPost($url, $edit, t('Save'));

    $this->assertText(t('The machine-readable name is already in use. It must be unique.'));
    $this->assertUrl($url, array(), 'Stayed on the same page.');
  }
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452

  /**
   * Tests changing the widget used by a field.
   */
  function testWidgetChange() {
    $url_fields = 'admin/structure/types/manage/article/fields';
    $url_tags_widget = $url_fields . '/field_tags/widget-type';

    // Check that the field_tags field currently uses the 'options_select'
    // widget.
    $instance = field_info_instance('node', 'field_tags', 'article');
    $this->assertEqual($instance['widget']['type'], 'options_select');

    // Check that the "Manage fields" page shows the correct widget type.
    $this->drupalGet($url_fields);
    $link = current($this->xpath('//a[contains(@href, :href)]', array(':href' => $url_tags_widget)));
    $this->assertEqual((string) $link, 'Select list');

    // Go to the 'Widget type' form and check that the correct widget is
    // selected.
    $this->drupalGet($url_tags_widget);
    $this->assertFieldByXPath("//select[@name='widget_type']", 'options_select');

    // Change the widget type.
    $edit = array(
      'widget_type' => 'options_buttons',
    );
    $this->drupalPost(NULL, $edit, t('Continue'));

    // Check that the "Manage fields" page shows the correct widget type.
    $link = current($this->xpath('//a[contains(@href, :href)]', array(':href' => $url_tags_widget)));
    $this->assertEqual((string) $link, 'Check boxes/radio buttons');

    // Check that the field uses the newly set widget.
    field_cache_clear();
    $instance = field_info_instance('node', 'field_tags', 'article');
    $this->assertEqual($instance['widget']['type'], 'options_buttons');

    // Go to the 'Widget type' form and check that the correct widget is
    // selected.
    $this->drupalGet($url_tags_widget);
    $this->assertFieldByXPath("//select[@name='widget_type']", 'options_buttons');
  }

453
}