Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests\field\Functional;
Chris@0: 
Chris@0: use Drupal\Core\Entity\EntityInterface;
Chris@0: use Drupal\Core\Language\LanguageInterface;
Chris@0: use Drupal\Tests\BrowserTestBase;
Chris@0: 
Chris@0: /**
Chris@0:  * Parent class for Field API tests.
Chris@0:  */
Chris@0: abstract class FieldTestBase extends BrowserTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * Generate random values for a field_test field.
Chris@0:    *
Chris@0:    * @param $cardinality
Chris@0:    *   Number of values to generate.
Chris@0:    * @return
Chris@0:    *   An array of random values, in the format expected for field values.
Chris@0:    */
Chris@0:   public function _generateTestFieldValues($cardinality) {
Chris@0:     $values = [];
Chris@0:     for ($i = 0; $i < $cardinality; $i++) {
Chris@0:       // field_test fields treat 0 as 'empty value'.
Chris@0:       $values[$i]['value'] = mt_rand(1, 127);
Chris@0:     }
Chris@0:     return $values;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Assert that a field has the expected values in an entity.
Chris@0:    *
Chris@0:    * This function only checks a single column in the field values.
Chris@0:    *
Chris@12:    * @param \Drupal\Core\Entity\EntityInterface $entity
Chris@0:    *   The entity to test.
Chris@0:    * @param $field_name
Chris@0:    *   The name of the field to test
Chris@0:    * @param $expected_values
Chris@0:    *   The array of expected values.
Chris@0:    * @param $langcode
Chris@0:    *   (Optional) The language code for the values. Defaults to
Chris@0:    *   \Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT.
Chris@0:    * @param $column
Chris@0:    *   (Optional) The name of the column to check. Defaults to 'value'.
Chris@0:    */
Chris@0:   public function assertFieldValues(EntityInterface $entity, $field_name, $expected_values, $langcode = LanguageInterface::LANGCODE_DEFAULT, $column = 'value') {
Chris@0:     // Re-load the entity to make sure we have the latest changes.
Chris@0:     $storage = $this->container->get('entity_type.manager')
Chris@0:       ->getStorage($entity->getEntityTypeId());
Chris@0:     $storage->resetCache([$entity->id()]);
Chris@0:     $e = $storage->load($entity->id());
Chris@0: 
Chris@0:     $field = $values = $e->getTranslation($langcode)->$field_name;
Chris@0:     // Filter out empty values so that they don't mess with the assertions.
Chris@0:     $field->filterEmptyItems();
Chris@0:     $values = $field->getValue();
Chris@0:     $this->assertEqual(count($values), count($expected_values), 'Expected number of values were saved.');
Chris@0:     foreach ($expected_values as $key => $value) {
Chris@0:       $this->assertEqual($values[$key][$column], $value, format_string('Value @value was saved correctly.', ['@value' => $value]));
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0: }