diff --git a/eck.info b/eck.info index 4ccf7a5..a2b67ea 100644 --- a/eck.info +++ b/eck.info @@ -17,3 +17,11 @@ files[] = includes/translation.handler.eck.inc ; Inline entity form integration files[] = includes/eck.inline_entity_form.inc + +; Simpletest. +test_dependencies[] = entityreference +files[] = tests/EckTestHelper.test +files[] = tests/EckCrudTest.test +files[] = tests/EckEntityTranslationTest.test +; @todo +;files[] = tests/EckPermissions.php diff --git a/tests/EckCrudTest.test b/tests/EckCrudTest.test new file mode 100644 index 0000000..cabea04 --- /dev/null +++ b/tests/EckCrudTest.test @@ -0,0 +1,113 @@ + 'ECK CRUD test', + 'description' => 'Test the basic CRUD operations.', + 'group' => 'eck', + 'dependencies' => array('ctools', 'entity'), + ); + } + + /** + * {@inheritdoc} + */ + protected function setUp(array $modules = array()) { + $modules[] = 'eck'; + + parent::setUp($modules); + + // Log in as user 1. + $this->loginUser1(); + } + + /** + * Confirm that entity types can be created, bundles created, etc. + */ + public function testProcess() { + // Make sure the main Entity Types list page is present. + $this->drupalGet('admin/structure'); + $this->assertResponse(200); + $this->assertLink('Entity types'); + $this->assertLinkByHref('admin/structure/entity-type'); + + // Load the "Entity types" list page. + $this->drupalGet('admin/structure/entity-type'); + $this->assertResponse(200); + $this->assertLink('Add entity type'); + $this->assertText('Entity types'); + $this->assertText('Entity type'); + $this->assertText('Operations'); + // @todo It would be useful to have a "no records" message when there are no entity types. + + // Create a test entity type. + $this->createEntityType(); + + // Confirm the various tabs that should exist. + $this->drupalGet('admin/structure/entity-type/test_entity'); + $this->assertResponse(200); + $this->assertLink('Edit'); + $this->assertLinkByHref(url('admin/structure/entity-type/test_entity/edit')); + $this->assertLink('Delete'); + $this->assertLinkByHref(url('admin/structure/entity-type/test_entity/delete')); + $this->assertLink('Manage properties'); + $this->assertLinkByHref(url('admin/structure/entity-type/test_entity/properties')); + $this->assertLink('Bundle List'); + $this->assertLinkByHref(url('admin/structure/entity-type/test_entity')); + $this->assertLink('Add bundle'); + $this->assertLinkByHref(url('admin/structure/entity-type/test_entity/add')); + $this->assertLink('Test entity'); + $this->assertLinkByHref(url('admin/structure/entity-type/test_entity/test_entity')); + $this->assertLink('delete'); + $this->assertLinkByHref(url('admin/structure/entity-type/test_entity/test_entity/delete')); + + // Load the bundle admin page. + $this->drupalGet('admin/structure/entity-type/test_entity/test_entity'); + $this->assertResponse(200); + $this->assertLink('Delete'); + $this->assertLinkByHref(url('admin/structure/entity-type/test_entity/test_entity/delete')); + $this->assertLink('Edit'); + $this->assertLinkByHref(url('admin/structure/entity-type/test_entity/test_entity/edit')); + $this->assertLink('Manage fields'); + $this->assertLinkByHref(url('admin/structure/entity-type/test_entity/test_entity/fields')); + $this->assertLink('Manage display'); + $this->assertLinkByHref(url('admin/structure/entity-type/test_entity/test_entity/display')); + $this->assertLink('Entity List'); + $this->assertLinkByHref(url('admin/structure/entity-type/test_entity/test_entity')); + $this->assertLink('Add Test entity'); + $this->assertLinkByHref(url('admin/structure/entity-type/test_entity/test_entity/add')); + // @todo It would be useful to have a "no records" message when there are no entities for a given bundle. + + // @todo Confirm creating a bundle. + // @todo Confirm adding fields, etc. + // @todo Confirm entity object CRUD. + // @todo Confirm deleting a bundle. + + // Confirm deleting an entity type. + $this->drupalGet('admin/structure/entity-type/test_entity/delete'); + $this->assertResponse(200); + $this->assertText('All of the data (entities and bundles) from this entity type will be deleted. This action cannot be undone.'); + $this->drupalPost(NULL, array(), t('Delete')); + $this->assertResponse(200); + $this->assertText('The entity type Test entity has been deleted.'); + // @todo It would be useful to have a "no records" message when there are no bundles. + + // @todo Confirm "Manage properties" functionality. + } + + // @todo Confirm creating a bundle at the same time as an entity type works. + // @todo Confirm each of the default_properties works as intended. +} diff --git a/tests/EckEntityTranslationTest.test b/tests/EckEntityTranslationTest.test new file mode 100644 index 0000000..f7dadca --- /dev/null +++ b/tests/EckEntityTranslationTest.test @@ -0,0 +1,171 @@ + 'ECK translation test', + 'description' => 'Test translations on an ECK object, including when it is attached to another entity using EntityReference.', + 'group' => 'eck', + 'dependencies' => array( + 'ctools', + 'entity', + 'entity_translation', + 'entityreference', + ), + ); + } + + /** + * {@inheritdoc} + */ + protected function setUp(array $modules = array()) { + $modules[] = 'eck'; + $modules[] = 'entity_translation'; + $modules[] = 'entityreference'; + + parent::setUp($modules); + + // Log in as user 1. + $this->loginUser1(); + + // Create multiple languages. + $this->setupLocales(); + } + + /** + * Test translating an entity type. + */ + public function testTranslations() { + $entity_type = 'test_entity'; + $bundle = $entity_type; + $languages = array( + 'fr' => 'French', + 'es' => 'Spanish', + ); + + // Create a test entity type. + $this->createEntityType(); + + // Enable translation for this entity type. + $this->enableEntityTypeTranslation($entity_type); + + // Add a field. + $this->addField(); + + // Create a test entity. + $title = $this->randomSentence(4); + $field_body = $this->randomSentence(NULL, TRUE); + $args = array( + 'title' => $title, + 'field_body[en][0][value]' => 'English: ' . $field_body, + ); + $this->verbose($args); + $entity_id = $this->createEntity($entity_type, $bundle, $args); + + // Confirm the translation functionality is available. + $this->drupalGet("{$entity_type}/{$bundle}/{$entity_id}"); + $this->assertResponse(200); + $this->assertLink(t('Translate')); + $this->assertLinkByHref("{$entity_type}/{$bundle}/{$entity_id}/translate"); + $this->drupalGet("{$entity_type}/{$bundle}/{$entity_id}/translate"); + $this->assertResponse(200); + $this->assertText(strip_tags(t('Translations of %label', array('%label' => $title)))); + + // Translate the entity into the other languages. + foreach ($languages as $langcode => $language) { + $this->drupalGet("{$langcode}/{$entity_type}/{$bundle}/{$entity_id}/edit/add/en/{$langcode}"); + $this->assertResponse(200); + $args = array( + "field_body[{$langcode}][0][value]" => $language . ': ' . $field_body, + ); + $this->drupalPost(NULL, $args, t('Save')); + $this->assertResponse(200); + } + + // Test the entity when it's loaded from each language prefix. + foreach ($languages as $langcode => $language) { + $this->drupalGet("{$langcode}/{$entity_type}/{$bundle}/{$entity_id}"); + $this->assertResponse(200); + $this->assertText($title); + $this->assertText($language . ': ' . $field_body); + } + // The English version didn't have a URL prefix. + $this->drupalGet("{$entity_type}/{$bundle}/{$entity_id}"); + $this->assertResponse(200); + $this->assertText($title); + $this->assertText('English: ' . $field_body); + + // Make the content type translatable. + $this->enableContentTypeTranslation(); + + // Add a reference field to a content type. This field is not translatable + // as the individual entities themselves will be translated. + $this->addReferenceFieldToNode(); + + // Create a node that has a reference field which points to the ECK object. + $body = $this->randomSentence(NULL, TRUE); + $args = array( + 'language' => 'en', + 'body' => array( + 'en' => array( + array('value' => 'English: ' . $body), + ), + ), + 'field_reference' => array( + 'und' => array( + array('target_id' => $entity_id), + ), + ), + ); + $node = $this->drupalCreateNode($args); + $this->verbose($node); + $this->drupalGet('node/' . $node->nid); + $this->assertText('English: ' . $body); + $this->assertText('English: ' . $field_body); + + // Open the node edit form to see what it's like. + $this->drupalGet('node/' . $node->nid . '/edit'); + + // Translate the node. + $this->drupalGet('node/' . $node->nid . '/translate'); + $this->assertResponse(200); + foreach ($languages as $langcode => $language) { + $this->drupalGet("{$langcode}/node/{$node->nid}/edit/add/en/{$langcode}"); + $this->assertResponse(200); + $args = array( + "body[{$langcode}][0][value]" => $language . ': ' . $body, + ); + $this->drupalPost(NULL, $args, t('Save')); + $this->assertResponse(200); + } + + // Check each language to make sure both the body field and the ECK body + // field are present. + foreach ($languages as $langcode => $language) { + $this->drupalGet("{$langcode}/node/{$node->nid}"); + $this->assertResponse(200); + $this->assertText($language . ': ' . $body); + $this->assertText($language . ': ' . $field_body); + } + // The English version didn't have a URL prefix. + $this->drupalGet("node/{$node->nid}"); + $this->assertResponse(200); + $this->assertText('English: ' . $body); + $this->assertText('English: ' . $field_body); + } + +} diff --git a/tests/EckTestHelper.test b/tests/EckTestHelper.test new file mode 100644 index 0000000..185a80a --- /dev/null +++ b/tests/EckTestHelper.test @@ -0,0 +1,378 @@ +pass_raw = $password; + + // Update the stored password. + require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc'); + $account->pass = user_hash_password(trim($account->pass_raw)); + drupal_write_record('users', $account, 'uid'); + entity_get_controller('user')->resetCache(array($account->uid)); + + $this->drupalLogin($account); + } + + /** + * {@inheritdoc} + */ + protected function verbose($message, $title = NULL) { + // Handle arrays, objects, etc. + if (!is_string($message)) { + $message = "
\n" . print_r($message, TRUE) . "\n
\n"; + } + + // Optional title to go before the output. + if (!empty($title)) { + $title = '

' . check_plain($title) . "

\n"; + } + + parent::verbose($title . $message); + } + + /** + * Create an entity type. + * + * @param array $args + * Any arguments to be passed to the form. Key elements include: + * - 'entity_type_label' + * - 'entity_type_name' + * - 'bundle_label' - If not present, a bundle with the same name as the + * entity type will be created. + * - 'bundle_name' - If not present, a bundle with the same name as the + * entity type will be created. + */ + private function createEntityType(array $args = array()) { + // Load the 'add type' form, confirm it is what was expected. + $this->drupalGet('admin/structure/entity-type/add'); + $this->assertResponse(200); + $this->assertFieldByName('entity_type_label'); + $this->assertFieldByName('entity_type_name'); + $this->assertFieldByName('bundle_label'); + $this->assertFieldByName('bundle_name'); + $this->assertFieldByName('default_properties[title]'); + $this->assertFieldByName('default_properties[uid]'); + $this->assertFieldByName('default_properties[created]'); + $this->assertFieldByName('default_properties[changed]'); + $this->assertFieldByName('default_properties[language]'); + + // Default values. + $edit = $args + array( + 'entity_type_label' => 'Test entity', + 'entity_type_name' => 'test_entity', + 'bundle_label' => '', + 'bundle_name' => '', + 'default_properties[title]' => TRUE, + 'default_properties[uid]' => TRUE, + 'default_properties[created]' => TRUE, + 'default_properties[changed]' => TRUE, + 'default_properties[language]' => TRUE, + ); + $this->drupalPost(NULL, $edit, t('Save')); + $this->assertResponse(200); + + // Confirm the submission worked. + $this->assertText(strip_tags(t('The entity type %entity_type has been created.', array('%entity_type' => $edit['entity_type_label'])))); + $this->assertEqual($this->getUrl(), url('admin/structure/entity-type/' . $edit['entity_type_name'], array('absolute' => TRUE))); + $this->assertLinkByHref(url('admin/structure/entity-type/' . $edit['entity_type_name'])); + $this->assertLink('delete'); + $this->assertLinkByHref(url('admin/structure/entity-type/' . $edit['entity_type_name'] . '/delete')); + + // @todo Bug: Upon creating a new entity type the visitor should see the "bundle list" page, instead the "entity types" list page is shown. + } + + /** + * Add a field to a given entity type. + * + * @param string $entity_type + * The machine name of the entity type for this entity object; defaults to + * 'test_entity'. + * @param string $bundle + * The machine name of the bundle for this entity object; defaults to + * 'test_entity'. + */ + private function addField($entity_type = 'test_entity', $bundle = 'test_entity') { + $this->drupalGet("admin/structure/entity-type/{$entity_type}/{$bundle}/fields"); + $this->assertResponse(200); + + $edit = array( + 'fields[_add_new_field][label]' => 'Body', + 'fields[_add_new_field][weight]' => 1, + 'fields[_add_new_field][field_name]' => 'body', + 'fields[_add_new_field][type]' => 'text_long', + 'fields[_add_new_field][widget_type]' => 'text_textarea', + ); + $this->drupalPost(NULL, $edit, t('Save')); + $this->assertResponse(200); + $this->assertText('has no field settings'); + $this->drupalPost(NULL, array(), t('Save field settings')); + $this->assertResponse(200); + $this->assertText('Updated field Body field settings.'); + $edit = array( + 'field[translatable]' => TRUE, + ); + $this->drupalPost(NULL, $edit, t('Save settings')); + $this->assertResponse(200); + $this->assertText('Saved Body configuration'); + } + + /** + * Create a test entity object. + * + * @param string $entity_type + * The machine name of the entity type for this entity object; defaults to + * 'test_entity'. + * @param string $bundle + * The machine name of the bundle for this entity object; defaults to + * 'test_entity'. + * @param array $args + * Any arguments to be passed to the form. Key elements include. + * - title: Will be dynamically generated if not present. + * + * @return object + * The entity that was created. + */ + private function createEntity($entity_type = 'test_entity', $bundle = 'test_entity', array $args = array()) { + // Gotta have a title value. + $args += array( + 'title' => $this->randomSentence(3), + ); + $this->verbose(entity_get_info($entity_type)); + + // Load the entity form. + $this->drupalGet("admin/structure/entity-type/{$entity_type}/{$bundle}/add"); + $this->assertResponse(200); + + // Make sure all of the values have fields. + foreach ($args as $field_name => $value) { + $this->assertFieldByName($field_name); + } + + // Save the entity. + $this->drupalPost(NULL, $args, t('Save')); + $this->assertResponse(200); + + // Make sure the entity saved correctly. + $this->assertText($args['title']); + + // Return the entity ID. + return $this->getEntityIdFromPath(); + } + + /** + * Generate a random string with multiple words of random lengths. + * + * @param int $word_count + * How many words to have in the sentence; if not a positive, whole number + * a random number of words will be generated (between three and fifty). + * @param bool $proper + * Proper English, so the first letter will be uppercase and the sentence + * will end in a period; defaults to FALSE. + * + * @return string + * The final sentences. + */ + public function randomSentence($word_count = NULL, $proper = FALSE) { + $word_count = intval($word_count); + if (empty($word_count) || $word_count < 1) { + $word_count = intval(rand(3, 50)); + } + $words = array(); + for ($ctr = 0; $ctr < $word_count; $ctr++) { + $words[] = strtolower(parent::randomName(intval(rand(3, 8)))); + } + $sentence = implode(' ', $words); + if ($proper) { + $sentence = ucfirst($sentence) . '.'; + } + return $sentence; + } + + /** + * Set up a basic starting point for the locales. + * + * This assumes the Locale module is enabled. This also must be done before + * other user accounts are logged in. + * + * @param array $locales + * A list of locales to be enabled, in langcode format. + */ + public function setupLocales(array $locales = array()) { + // If no locales were requested, add Spanish and French. + if (empty($locales)) { + $locales[] = 'es'; + $locales[] = 'fr'; + } + + // Identify the site's default language. + $default_language = language_default('language'); + + // Add the locales. + foreach ($locales as $langcode) { + // Don't create the default language, it's already present. + if ($langcode != $default_language) { + $this->addSiteLanguage($langcode); + } + } + + // Enable URL language detection and selection. + $this->drupalGet('admin/config/regional/language/configure'); + $this->assertResponse(200); + $edit = array( + 'language[enabled][locale-url]' => TRUE, + 'language_content[enabled][locale-url]' => TRUE, + ); + $this->drupalPost(NULL, $edit, t('Save settings')); + $this->assertResponse(200); + } + + /** + * Add a locale to the site. + * + * @param string $langcode + * The language code to be enabled. + */ + public function addSiteLanguage($langcode) { + // Load the language-add page. + $this->drupalGet('admin/config/regional/language/add'); + $this->assertResponse(200, 'Loaded the language-add admin page.'); + + // Submit the language-add form. + $args = array( + 'langcode' => $langcode, + ); + $this->drupalPost(NULL, $args, t('Add language')); + $this->assertResponse(200); + + // Verify that the browser was returned to the main languages admin page. + $this->assertEqual($this->getUrl(), url('admin/config/regional/language', array('absolute' => TRUE)), 'Redirected back to the main languages admin page.'); + + // Clear the language list cache so it can be reloaded. + drupal_static_reset('language_list'); + + // Get all language definitions. + $languages = language_list(); + $language = $languages[$langcode]->name; + $this->assertText(strip_tags(t('The language %language has been created and can now be used. More information is available on the help screen.', array('%language' => t($language), '@locale-help' => url('admin/help/locale')))), 'A new language has been added.'); + } + + /** + * Extract an entity ID from its path. + * + * @param string $path + * The path to examine; defaults to the current path. + * + * @return int + * The ID of the requested entity path. + */ + private function getEntityIdFromPath($path = NULL) { + if (empty($path)) { + $path = $this->getUrl(); + } + + // The ID will be the last portion of the URL. + $parts = explode('/', $path); + return array_pop($parts); + } + + /** + * Enable Entity Translation for a given entity type. + */ + private function enableEntityTypeTranslation($entity_type) { + $this->drupalGet('admin/config/regional/entity_translation'); + $this->assertResponse(200); + $edit = array( + "entity_translation_entity_types[{$entity_type}]" => $entity_type, + ); + $this->drupalPost(NULL, $edit, t('Save configuration')); + $this->assertResponse(200); + $this->assertText(t('The configuration options have been saved.')); + } + + /** + * Add a reference field to a content type that points to an ECK entity type. + * + * @param string $entity_type + * The entity type to add the reference field to; defaults to "test_entity". + */ + private function addReferenceFieldToNode($entity_type = 'test_entity') { + $this->drupalGet('admin/structure/types/manage/page/fields'); + $this->assertResponse(200); + + $edit = array( + 'fields[_add_new_field][label]' => 'Reference', + 'fields[_add_new_field][weight]' => 1, + 'fields[_add_new_field][field_name]' => 'reference', + 'fields[_add_new_field][type]' => 'entityreference', + 'fields[_add_new_field][widget_type]' => 'entityreference_autocomplete', + ); + foreach ($edit as $field_name => $value) { + $this->assertFieldByName($field_name); + } + $this->drupalPost(NULL, $edit, t('Save')); + $this->assertResponse(200); + $this->assertText('The entity type that can be referenced through this field.'); + $edit = array( + 'field[settings][target_type]' => $entity_type, + ); + $this->drupalPost(NULL, $edit, t('Save field settings')); + $this->assertResponse(200); + $this->assertText('Updated field Reference field settings.'); + $edit = array( + 'field[cardinality]' => -1, + ); + $this->drupalPost(NULL, $edit, t('Save settings')); + $this->assertResponse(200); + $this->assertText('Saved Reference configuration.'); + + // Configure the display settings to output a rendered entity. + $this->drupalGet('admin/structure/types/manage/page/display'); + $this->assertResponse(200); + $this->assertText(t('Here, you can define which fields are shown and hidden when Basic page content is displayed in each view mode, and define how the fields are displayed in each view mode.')); + $edit = array( + 'fields[field_reference][type]' => 'entityreference_entity_view', + ); + $this->drupalPost(NULL, $edit, t('Save')); + $this->assertResponse(200); + $this->assertText(t('Your settings have been saved.')); + } + + /** + * Enable Entity Translation for a content type. + */ + private function enableContentTypeTranslation() { + $this->drupalGet('admin/structure/types/manage/page'); + $this->assertResponse(200); + $edit = array( + 'language_content_type' => ENTITY_TRANSLATION_ENABLED, + ); + $this->drupalPost(NULL, $edit, t('Save content type')); + $this->assertResponse(200); + $this->assertText(strip_tags(t('The content type %name has been updated.', array('%name' => 'Basic page')))); + + $this->drupalGet('admin/structure/types/manage/page/fields/body'); + $this->assertResponse(200); + $edit = array( + 'field[translatable]' => TRUE, + ); + $this->drupalPost(NULL, $edit, t('Save settings')); + $this->assertResponse(200); + $this->assertText(strip_tags(t('Saved %label configuration.', array('%label' => 'Body')))); + } + +}