www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/field/tests/src/Kernel/Migrate/d7/MigrateFieldFormatterSettingsTest.php

   1 <?php
   2
   3 namespace Drupal\Tests\field\Kernel\Migrate\d7;
   4
   5 use Drupal\comment\Entity\CommentType;
   6 use Drupal\Core\Database\Database;
   7 use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
   8 use Drupal\Core\Entity\Entity\EntityViewDisplay;
   9 use Drupal\taxonomy\Entity\Vocabulary;
  10 use Drupal\Tests\migrate_drupal\Kernel\d7\MigrateDrupal7TestBase;
  11 use Drupal\node\Entity\NodeType;
  12
  13 /**
  14  * Tests migration of D7 field formatter settings.
  15  *
  16  * @group field
  17  */
  18 class MigrateFieldFormatterSettingsTest extends MigrateDrupal7TestBase {
  19
  20   public static $modules = [
  21     'comment',
  22     'datetime',
  23     'file',
  24     'image',
  25     'link',
  26     'node',
  27     'taxonomy',
  28     'telephone',
  29     'text',
  30   ];
  31
  32   /**
  33    * {@inheritdoc}
  34    */
  35   protected function setUp() {
  36     parent::setUp();
  37
  38     $this->installEntitySchema('node');
  39     $this->installEntitySchema('comment');
  40     $this->installEntitySchema('taxonomy_term');
  41
  42     CommentType::create([
  43       'id' => 'comment_node_page',
  44       'label' => $this->randomMachineName(),
  45     ])->save();
  46     CommentType::create([
  47       'id' => 'comment_node_article',
  48       'label' => $this->randomMachineName(),
  49     ])->save();
  50     CommentType::create([
  51       'id' => 'comment_node_blog',
  52       'label' => $this->randomMachineName(),
  53     ])->save();
  54     CommentType::create([
  55       'id' => 'comment_node_book',
  56       'label' => $this->randomMachineName(),
  57     ])->save();
  58     CommentType::create([
  59       'id' => 'comment_forum',
  60       'label' => $this->randomMachineName(),
  61     ])->save();
  62     CommentType::create([
  63       'id' => 'comment_node_test_content_type',
  64       'label' => $this->randomMachineName(),
  65     ])->save();
  66
  67     NodeType::create([
  68       'type' => 'page',
  69       'label' => $this->randomMachineName(),
  70     ])->save();
  71     NodeType::create([
  72       'type' => 'article',
  73       'label' => $this->randomMachineName(),
  74     ])->save();
  75     NodeType::create([
  76       'type' => 'blog',
  77       'label' => $this->randomMachineName(),
  78     ])->save();
  79     NodeType::create([
  80       'type' => 'book',
  81       'label' => $this->randomMachineName(),
  82     ])->save();
  83     NodeType::create([
  84       'type' => 'forum',
  85       'label' => $this->randomMachineName(),
  86     ])->save();
  87     NodeType::create([
  88       'type' => 'test_content_type',
  89       'label' => $this->randomMachineName(),
  90     ])->save();
  91
  92     Vocabulary::create(['vid' => 'test_vocabulary'])->save();
  93
  94     // Give one unfortunate field instance invalid display settings to ensure
  95     // that the migration provides an empty array as a default (thus avoiding
  96     // an "unsupported operand types" fatal).
  97     Database::getConnection('default', 'migrate')
  98       ->update('field_config_instance')
  99       ->fields([
 100         'data' => serialize([
 101           'label' => 'Body',
 102           'widget' =>
 103              [
 104               'type' => 'text_textarea_with_summary',
 105               'settings' =>
 106                  [
 107                   'rows' => 20,
 108                   'summary_rows' => 5,
 109                 ],
 110               'weight' => -4,
 111               'module' => 'text',
 112             ],
 113           'settings' =>
 114              [
 115               'display_summary' => TRUE,
 116               'text_processing' => 1,
 117               'user_register_form' => FALSE,
 118             ],
 119           'display' =>
 120              [
 121               'default' =>
 122                  [
 123                   'label' => 'hidden',
 124                   'type' => 'text_default',
 125                   'settings' => [],
 126                   'module' => 'text',
 127                   'weight' => 0,
 128                 ],
 129               'teaser' =>
 130                  [
 131                   'label' => 'hidden',
 132                   'type' => 'text_summary_or_trimmed',
 133                   // settings is always expected to be an array. Making it NULL
 134                   // causes a fatal.
 135                   'settings' => NULL,
 136                   'module' => 'text',
 137                   'weight' => 0,
 138                 ],
 139             ],
 140           'required' => FALSE,
 141           'description' => '',
 142         ]),
 143       ])
 144       ->condition('entity_type', 'node')
 145       ->condition('bundle', 'article')
 146       ->condition('field_name', 'body')
 147       ->execute();
 148
 149     $this->executeMigrations([
 150       'd7_field',
 151       'd7_field_instance',
 152       'd7_view_modes',
 153       'd7_field_formatter_settings',
 154     ]);
 155   }
 156
 157   /**
 158    * Asserts various aspects of a view display.
 159    *
 160    * @param string $id
 161    *   The view display ID.
 162    */
 163   protected function assertEntity($id) {
 164     $display = EntityViewDisplay::load($id);
 165     $this->assertTrue($display instanceof EntityViewDisplayInterface);
 166   }
 167
 168   /**
 169    * Asserts various aspects of a particular component of a view display.
 170    *
 171    * @param string $display_id
 172    *   The view display ID.
 173    * @param string $component_id
 174    *   The component ID.
 175    * @param string $type
 176    *   The expected component type (formatter plugin ID).
 177    * @param string $label
 178    *   The expected label of the component.
 179    * @param int $weight
 180    *   The expected weight of the component.
 181    */
 182   protected function assertComponent($display_id, $component_id, $type, $label, $weight) {
 183     $component = EntityViewDisplay::load($display_id)->getComponent($component_id);
 184     $this->assertTrue(is_array($component));
 185     $this->assertIdentical($type, $component['type']);
 186     $this->assertIdentical($label, $component['label']);
 187     $this->assertIdentical($weight, $component['weight']);
 188   }
 189
 190   /**
 191    * Asserts that a particular component is NOT included in a display.
 192    *
 193    * @param string $display_id
 194    *   The display ID.
 195    * @param string $component_id
 196    *   The component ID.
 197    */
 198   protected function assertComponentNotExists($display_id, $component_id) {
 199     $component = EntityViewDisplay::load($display_id)->getComponent($component_id);
 200     $this->assertTrue(is_null($component));
 201   }
 202
 203   /**
 204    * Tests migration of D7 field formatter settings.
 205    */
 206   public function testMigration() {
 207     $this->assertEntity('comment.comment_node_article.default');
 208     $this->assertComponent('comment.comment_node_article.default', 'comment_body', 'text_default', 'hidden', 0);
 209
 210     $this->assertEntity('comment.comment_node_blog.default');
 211     $this->assertComponent('comment.comment_node_blog.default', 'comment_body', 'text_default', 'hidden', 0);
 212
 213     $this->assertEntity('comment.comment_node_book.default');
 214     $this->assertComponent('comment.comment_node_book.default', 'comment_body', 'text_default', 'hidden', 0);
 215
 216     $this->assertEntity('comment.comment_forum.default');
 217     $this->assertComponent('comment.comment_forum.default', 'comment_body', 'text_default', 'hidden', 0);
 218
 219     $this->assertEntity('comment.comment_node_page.default');
 220     $this->assertComponent('comment.comment_node_page.default', 'comment_body', 'text_default', 'hidden', 0);
 221
 222     $this->assertEntity('comment.comment_node_test_content_type.default');
 223     $this->assertComponent('comment.comment_node_test_content_type.default', 'comment_body', 'text_default', 'hidden', 0);
 224     $this->assertComponent('comment.comment_node_test_content_type.default', 'field_integer', 'number_integer', 'above', 1);
 225
 226     $this->assertEntity('node.article.default');
 227     $this->assertComponent('node.article.default', 'body', 'text_default', 'hidden', 0);
 228     $this->assertComponent('node.article.default', 'field_tags', 'entity_reference_label', 'above', 10);
 229     $this->assertComponent('node.article.default', 'field_image', 'image', 'hidden', -1);
 230     $this->assertComponent('node.article.default', 'field_text_plain', 'string', 'above', 11);
 231     $this->assertComponent('node.article.default', 'field_text_filtered', 'text_default', 'above', 12);
 232     $this->assertComponent('node.article.default', 'field_text_long_plain', 'basic_string', 'above', 14);
 233     $this->assertComponent('node.article.default', 'field_text_long_filtered', 'text_default', 'above', 15);
 234     $this->assertComponent('node.article.default', 'field_text_sum_filtered', 'text_default', 'above', 18);
 235
 236     $this->assertEntity('node.article.teaser');
 237     $this->assertComponent('node.article.teaser', 'body', 'text_summary_or_trimmed', 'hidden', 0);
 238     $this->assertComponent('node.article.teaser', 'field_tags', 'entity_reference_label', 'above', 10);
 239     $this->assertComponent('node.article.teaser', 'field_image', 'image', 'hidden', -1);
 240
 241     $this->assertEntity('node.blog.default');
 242     $this->assertComponent('node.blog.default', 'body', 'text_default', 'hidden', 0);
 243
 244     $this->assertEntity('node.blog.teaser');
 245     $this->assertComponent('node.blog.teaser', 'body', 'text_summary_or_trimmed', 'hidden', 0);
 246
 247     $this->assertEntity('node.book.default');
 248     $this->assertComponent('node.book.default', 'body', 'text_default', 'hidden', 0);
 249
 250     $this->assertEntity('node.book.teaser');
 251     $this->assertComponent('node.book.teaser', 'body', 'text_summary_or_trimmed', 'hidden', 0);
 252
 253     $this->assertEntity('node.forum.default');
 254     $this->assertComponent('node.forum.default', 'body', 'text_default', 'hidden', 11);
 255     $this->assertComponent('node.forum.default', 'taxonomy_forums', 'entity_reference_label', 'above', 10);
 256
 257     $this->assertEntity('node.forum.teaser');
 258     $this->assertComponent('node.forum.teaser', 'body', 'text_summary_or_trimmed', 'hidden', 11);
 259     $this->assertComponent('node.forum.teaser', 'taxonomy_forums', 'entity_reference_label', 'above', 10);
 260
 261     $this->assertEntity('node.page.default');
 262     $this->assertComponent('node.page.default', 'body', 'text_default', 'hidden', 0);
 263     $this->assertComponent('node.page.default', 'field_text_plain', 'string', 'above', 1);
 264     $this->assertComponent('node.page.default', 'field_text_filtered', 'text_default', 'above', 2);
 265     $this->assertComponent('node.page.default', 'field_text_long_plain', 'basic_string', 'above', 4);
 266     $this->assertComponent('node.page.default', 'field_text_long_filtered', 'text_default', 'above', 5);
 267     $this->assertComponent('node.page.default', 'field_text_sum_filtered', 'text_default', 'above', 8);
 268
 269     $this->assertEntity('node.page.teaser');
 270     $this->assertComponent('node.page.teaser', 'body', 'text_summary_or_trimmed', 'hidden', 0);
 271
 272     $this->assertEntity('node.test_content_type.default');
 273     $this->assertComponent('node.test_content_type.default', 'field_boolean', 'list_default', 'above', 0);
 274     $this->assertComponent('node.test_content_type.default', 'field_email', 'email_mailto', 'above', 1);
 275     // Phone formatters are not mapped and should default to basic_string.
 276     $this->assertComponent('node.test_content_type.default', 'field_phone', 'basic_string', 'above', 2);
 277     $this->assertComponent('node.test_content_type.default', 'field_date', 'datetime_default', 'above', 3);
 278     $this->assertComponent('node.test_content_type.default', 'field_date_with_end_time', 'datetime_default', 'above', 4);
 279     $this->assertComponent('node.test_content_type.default', 'field_file', 'file_default', 'above', 5);
 280     $this->assertComponent('node.test_content_type.default', 'field_float', 'number_decimal', 'above', 6);
 281     $this->assertComponent('node.test_content_type.default', 'field_images', 'image', 'above', 7);
 282     $this->assertComponent('node.test_content_type.default', 'field_integer', 'number_integer', 'above', 8);
 283     $this->assertComponent('node.test_content_type.default', 'field_link', 'link', 'above', 9);
 284     $this->assertComponent('node.test_content_type.default', 'field_text_list', 'list_default', 'above', 10);
 285     $this->assertComponent('node.test_content_type.default', 'field_integer_list', 'list_default', 'above', 11);
 286     $this->assertComponent('node.test_content_type.default', 'field_long_text', 'text_default', 'above', 12);
 287     $this->assertComponent('node.test_content_type.default', 'field_node_entityreference', 'entity_reference_label', 'above', 15);
 288     $this->assertComponent('node.test_content_type.default', 'field_user_entityreference', 'entity_reference_label', 'above', 16);
 289     $this->assertComponent('node.test_content_type.default', 'field_term_entityreference', 'entity_reference_label', 'above', 17);
 290     $this->assertComponentNotExists('node.test_content_type.default', 'field_term_reference');
 291     $this->assertComponentNotExists('node.test_content_type.default', 'field_text');
 292
 293     $this->assertEntity('user.user.default');
 294     $this->assertComponent('user.user.default', 'field_file', 'file_default', 'above', 0);
 295   }
 296
 297 }