--- /dev/null
+<?php
+
+namespace Drupal\metatag\Tests;
+
+use Drupal\Core\Cache\Cache;
+use Drupal\simpletest\WebTestBase;
+
+/**
+ * Base class for ensuring that the Metatag field works correctly.
+ */
+abstract class MetatagFieldTestBase extends WebTestBase {
+
+ /**
+ * Profile to use.
+ *
+ * @var string
+ */
+ protected $profile = 'testing';
+
+ /**
+ * Modules to enable.
+ *
+ * @var array
+ */
+ public static $modules = [
+ // Needed for token handling.
+ 'token',
+
+ // Needed for the field UI testing.
+ 'field_ui',
+
+ // Needed to verify that nothing is broken for unsupported entities.
+ 'contact',
+
+ // The base module.
+ 'metatag',
+
+ // Some extra custom logic for testing Metatag.
+ 'metatag_test_tag',
+
+ // Manages the entity type that is being tested.
+ 'entity_test',
+ ];
+
+ /**
+ * Admin user
+ *
+ * @var \Drupal\Core\Session\AccountInterface
+ */
+ protected $adminUser;
+
+ /**
+ * Basic permissions that all of the entity tests will need.
+ *
+ * @var array
+ */
+ protected $base_perms = [
+ 'access administration pages',
+ 'administer meta tags',
+ ];
+
+ /**
+ * Additional permissions needed for this entity type.
+ *
+ * @var array
+ */
+ protected $entity_perms = [];
+
+ /**
+ * The entity type that is being tested.
+ *
+ * @var string
+ */
+ protected $entity_type = '';
+
+ /**
+ * The formal name for this entity type.
+ *
+ * @var string
+ */
+ protected $entity_label = '';
+
+ /**
+ * The entity bundle that is being tested.
+ *
+ * @var string
+ */
+ protected $entity_bundle = '';
+
+ /**
+ * The path to add an object for this entity type.
+ *
+ * @var string
+ */
+ protected $entity_add_path = '';
+
+ /**
+ * The path to access the field admin for this entity bundle.
+ */
+ protected $entity_field_admin_path = '';
+
+ /**
+ * Whether or not this entity type supports default meta tag values.
+ *
+ * @var bool
+ */
+ protected $entity_supports_defaults = TRUE;
+
+ /**
+ * The label used on the entity form for the 'save' action.
+ *
+ * @var string
+ */
+ protected $entity_save_button_label = 'Save';
+
+ /**
+ * The name of the primary title or name field for this entity.
+ *
+ * @var string
+ */
+ protected $entity_title_field = 'title';
+
+ /**
+ * {@inheritDoc}
+ */
+ protected function setUp() {
+ parent::setUp();
+
+ // Any additional configuration that's neede for this entity type.
+ $this->setUpEntityType();
+
+ // Merge the base permissions with the custom ones for the entity type and
+ // create a user with these permissions.
+ $all_perms = array_merge($this->base_perms, $this->entity_perms);
+ $this->adminUser = $this->drupalCreateUser($all_perms);
+ $this->drupalLogin($this->adminUser);
+ }
+
+ /**
+ * Any additional configuration that's needed for this entity type.
+ */
+ protected function setUpEntityType() {}
+
+ /**
+ * A list of default values to add to the entity being created. If left empty
+ * it will default to "{$entity_title_field}[0][value]" => $title.
+ *
+ * @return array
+ */
+ protected function entity_default_values() {}
+
+ /**
+ * Add a Metatag field to this entity type.
+ */
+ protected function addField() {
+ // Add a metatag field to the entity type test_entity.
+ $this->drupalGet($this->entity_field_admin_path . '/add-field');
+ $this->assertResponse(200);
+ $edit = [
+ 'label' => 'Metatag',
+ 'field_name' => 'metatag',
+ 'new_storage_type' => 'metatag',
+ ];
+ $this->drupalPostForm(NULL, $edit, t('Save and continue'));
+ $this->drupalPostForm(NULL, [], t('Save field settings'));
+
+ // Clear all settings.
+ $this->container->get('entity.manager')->clearCachedFieldDefinitions();
+ }
+
+ /**
+ * Confirm that the global default values work correctly when there are no
+ * entity or bundle defaults available.
+ */
+ public function testGlobalDefaultsInheritance() {
+ // First we set global defaults.
+ $this->drupalGet('admin/config/search/metatag/global');
+ $this->assertResponse(200);
+ $global_values = [
+ 'metatag_test' => 'Global description',
+ ];
+ $this->drupalPostForm(NULL, $global_values, 'Save');
+ $this->assertText('Saved the Global Metatag defaults.');
+
+ // Add the field to this entity type.
+ $this->addField();
+
+ // Now when we create an entity, global defaults are used to fill the form
+ // fields.
+ $this->drupalGet($this->entity_add_path);
+ $this->assertResponse(200);
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test'], t('The metatag_test field has the global default as the field default does not define it.'));
+ }
+
+ /**
+ * Confirm that the entity default values work correctly.
+ */
+ public function testEntityDefaultsInheritance() {
+ // This test doesn't make sense if the entity doesn't support defaults.
+ if (!$this->entity_supports_defaults) {
+ return;
+ }
+
+ // Set a global default.
+ $this->drupalGet('admin/config/search/metatag/global');
+ $this->assertResponse(200);
+ $global_values = [
+ 'metatag_test' => 'Global description',
+ ];
+ $this->drupalPostForm(NULL, $global_values, 'Save');
+ $this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t('Global')])));
+
+ // Set an entity default.
+ $this->drupalGet('admin/config/search/metatag/' . $this->entity_type);
+ $this->assertResponse(200);
+ $entity_values = [
+ 'metatag_test' => 'Entity description',
+ ];
+ $this->drupalPostForm(NULL, $entity_values, 'Save');
+ $this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t($this->entity_label)])));
+
+ // Add the field to this entity type.
+ $this->addField();
+
+ // Load the entity form for this entity type.
+ $this->drupalGet($this->entity_add_path);
+ $this->assertResponse(200);
+ $this->assertNoText('Fatal error');
+
+ // Allow the fields to be customized if needed.
+ $title = 'Barfoo';
+ $edit = $this->entity_default_values();
+ if (empty($edit)) {
+ $edit = [
+ $this->entity_title_field . '[0][value]' => $title,
+ ];
+ }
+
+ // If this entity type supports defaults then verify the global default is
+ // not present but that the entity default *is* present.
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $entity_values['metatag_test']);
+ $this->assertNoFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
+ }
+
+ /**
+ * Confirm that the default values for an entity bundle will work correctly
+ * when there is no field for overriding the defaults.
+ */
+ // @todo
+ // public function testBundleDefaultsInheritance() {
+ // }
+
+ /**
+ * Confirm a field can be added to the entity bundle.
+ */
+ public function testFieldCanBeAdded() {
+ $this->drupalGet($this->entity_field_admin_path . '/add-field');
+ $this->assertResponse(200);
+ $this->assertRaw('<option value="metatag">' . t('Meta tags') . '</option>');
+ }
+
+ /**
+ * Confirm a field can be added to the entity bundle.
+ */
+ public function testEntityFieldsAvailable() {
+ // Add a field to the entity type.
+ $this->addField();
+
+ // Load the entity's form.
+ $this->drupalGet($this->entity_add_path);
+ $this->assertResponse(200);
+ $this->assertNoText('Fatal error');
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test]');
+ }
+
+ /**
+ * Confirm that the default values load correctly for an entity created before
+ * the custom field is added.
+ */
+ public function testEntityFieldValuesOldEntity() {
+ // Set a global default.
+ $this->drupalGet('admin/config/search/metatag/global');
+ $this->assertResponse(200);
+ $global_values = [
+ 'metatag_test' => 'Global description',
+ ];
+ $this->drupalPostForm(NULL, $global_values, 'Save');
+ $this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t('Global')])));
+
+ // Set an entity default if it's supported by the entity type.
+ if ($this->entity_supports_defaults) {
+ $this->drupalGet('admin/config/search/metatag/' . $this->entity_type);
+ $this->assertResponse(200);
+ $entity_values = [
+ 'metatag_test' => 'Entity description',
+ ];
+ $this->drupalPostForm(NULL, $entity_values, 'Save');
+ $this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t($this->entity_label)])));
+ }
+
+ // Load the entity form for this entity type.
+ $title = 'Barfoo';
+ $this->drupalGet($this->entity_add_path);
+ $this->assertResponse(200);
+ $this->assertNoText('Fatal error');
+
+ // Allow the fields to be customized if needed.
+ $edit = $this->entity_default_values();
+ if (empty($edit)) {
+ $edit = [
+ $this->entity_title_field . '[0][value]' => $title,
+ ];
+ }
+
+ // Create a new entity object.
+ $this->drupalPostForm(NULL, $edit, t($this->entity_save_button_label));
+ $entities = entity_load_multiple_by_properties($this->entity_type, [
+ $this->entity_title_field => $title,
+ ]);
+ $this->assertEqual(1, count($entities), 'Entity was saved');
+ $entity = reset($entities);
+
+ // @todo Confirm the values output correctly.
+
+ // Add a field to the entity type.
+ $this->addField();
+
+ // Open the 'edit' form for the entity.
+ $this->drupalGet($entity->toUrl('edit-form'));
+ $this->assertResponse(200);
+
+ // If this entity type supports defaults then verify the global default is
+ // not present but that the entity default *is* present.
+ if ($this->entity_supports_defaults) {
+ $this->assertNoFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $entity_values['metatag_test']);
+ }
+ else {
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
+ }
+
+ // @todo Confirm the values output correctly.
+ }
+
+ /**
+ * Confirm that the default values load correctly for an entity created after
+ * the custom field is added.
+ */
+ public function testEntityFieldValuesNewEntity() {
+ // Set a global default.
+ $this->drupalGet('admin/config/search/metatag/global');
+ $this->assertResponse(200);
+ $global_values = [
+ 'metatag_test' => 'Global description',
+ ];
+ $this->drupalPostForm(NULL, $global_values, 'Save');
+ $this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t('Global')])));
+
+ // Set an entity default if it's supported by the entity type.
+ if ($this->entity_supports_defaults) {
+ $this->drupalGet('admin/config/search/metatag/' . $this->entity_type);
+ $this->assertResponse(200);
+ $entity_values = [
+ 'metatag_test' => 'Entity description',
+ ];
+ $this->drupalPostForm(NULL, $entity_values, 'Save');
+ $this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t($this->entity_label)])));
+ }
+
+ // Add a field to the entity type.
+ $this->addField();
+
+ // Load the entity form for this entity type.
+ $title = 'Barfoo';
+ $this->drupalGet($this->entity_add_path);
+ $this->assertResponse(200);
+ $this->assertNoText('Fatal error');
+
+ // If this entity type supports defaults then verify the global default is
+ // not present but that the entity default *is* present.
+ if ($this->entity_supports_defaults) {
+ $this->assertNoFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $entity_values['metatag_test']);
+ }
+ else {
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
+ }
+
+ // Allow the fields to be customized if needed.
+ $edit = $this->entity_default_values();
+ if (empty($edit)) {
+ $edit = [
+ $this->entity_title_field . '[0][value]' => $title,
+ ];
+ }
+
+ // Create a new entity object.
+ $this->drupalPostForm(NULL, $edit, t($this->entity_save_button_label));
+ $entities = entity_load_multiple_by_properties($this->entity_type, [
+ $this->entity_title_field => $title,
+ ]);
+ $this->assertEqual(1, count($entities), 'Entity was saved');
+ $entity = reset($entities);
+
+ // @todo Confirm the values output correctly.
+
+ // Open the 'edit' form for the entity.
+ $this->drupalGet($entity->toUrl('edit-form'));
+ $this->assertResponse(200);
+
+ // If this entity type supports defaults then verify the global default is
+ // not present but that the entity default *is* present.
+ if ($this->entity_supports_defaults) {
+ $this->assertNoFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $entity_values['metatag_test']);
+ }
+ else {
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
+ }
+
+ // @todo Confirm the values output correctly.
+ }
+
+ /**
+ * Tests adding and editing values on a given entity type.
+ */
+ public function tofix_testEntityField() {
+ // Add a field to the entity type.
+ $this->addField();
+
+ // Create a test entity.
+ $this->drupalGet($this->entity_add_path);
+ $this->assertResponse(200);
+ $this->assertNoText('Fatal error');
+ $edit = $this->entity_default_values($title) + [
+ 'field_metatag[0][basic][metatag_test]' => 'Kilimanjaro',
+ ];
+ $this->drupalPostForm(NULL, $edit, t('Save'));
+ $entities = entity_load_multiple_by_properties('entity_test', [
+ $this->entity_title_field => 'Barfoo',
+ ]);
+ $this->assertEqual(1, count($entities), 'Entity was saved');
+ $entity = reset($entities);
+
+ // Make sure tags that have a field value but no default value still show
+ // up.
+ $this->drupalGet($entity->toUrl());
+ $this->assertResponse(200);
+ $elements = $this->cssSelect('meta[name=metatag_test]');
+ $this->assertTrue(count($elements) === 1, 'Found keywords metatag_test from defaults');
+ $this->assertEqual((string) $elements[0]['content'], 'Kilimanjaro', 'Field value for metatag_test found when no default set.');
+
+ // @TODO: This should not be required, but metatags does not invalidate
+ // cache upon setting globals.
+ Cache::invalidateTags(['entity_test:' . $entity->id()]);
+
+ // Update the Global defaults and test them.
+ $this->drupalGet('admin/config/search/metatag/global');
+ $this->assertResponse(200);
+ $values = [
+ 'metatag_test' => 'Purple monkey dishwasher',
+ ];
+ $this->drupalPostForm(NULL, $values, 'Save');
+ $this->assertText('Saved the Global Metatag defaults.');
+ $this->drupalGet($entity->toUrl());
+ $this->assertResponse(200);
+ $elements = $this->cssSelect('meta[name=metatag_test]');
+ $this->assertTrue(count($elements) === 1, 'Found test metatag from defaults');
+ $this->verbose('<pre>' . print_r($elements, TRUE) . '</pre>');
+ $this->assertEqual((string) $elements[0]['content'], $values['metatag_test']);//, 'Default metatag_test value found.');
+ }
+
+}
projects / yaffs-website / blobdiff