class ForumTestCase

Provides automated tests for the Forum module.

Hierarchy

Expanded class hierarchy of ForumTestCase

File

modules/forum/forum.test, line 11

View source
class ForumTestCase extends DrupalWebTestCase {
    
    /**
     * A user with various administrative privileges.
     */
    protected $admin_user;
    
    /**
     * A user that can create forum topics and edit its own topics.
     */
    protected $edit_own_topics_user;
    
    /**
     * A user that can create, edit, and delete forum topics.
     */
    protected $edit_any_topics_user;
    
    /**
     * A user with no special privileges.
     */
    protected $web_user;
    
    /**
     * An array representing a container.
     */
    protected $container;
    
    /**
     * An array representing a forum.
     */
    protected $forum;
    
    /**
     * An array representing a root forum.
     */
    protected $root_forum;
    
    /**
     * An array of forum topic node IDs.
     */
    protected $nids;
    
    /**
     * A forum to delete.
     */
    protected $delete_forum;
    public static function getInfo() {
        return array(
            'name' => 'Forum functionality',
            'description' => 'Create, view, edit, delete, and change forum entries and verify its consistency in the database.',
            'group' => 'Forum',
        );
    }
    function setUp() {
        parent::setUp('taxonomy', 'comment', 'forum');
        // Create users.
        $this->admin_user = $this->drupalCreateUser(array(
            'access administration pages',
            'administer modules',
            'administer blocks',
            'administer forums',
            'administer menu',
            'administer taxonomy',
            'create forum content',
        ));
        $this->edit_any_topics_user = $this->drupalCreateUser(array(
            'access administration pages',
            'create forum content',
            'edit any forum content',
            'delete any forum content',
        ));
        $this->edit_own_topics_user = $this->drupalCreateUser(array(
            'create forum content',
            'edit own forum content',
            'delete own forum content',
        ));
        $this->web_user = $this->drupalCreateUser(array());
    }
    
    /**
     * Tests disabling and re-enabling the Forum module.
     */
    function testEnableForumField() {
        $this->drupalLogin($this->admin_user);
        // Disable the Forum module.
        $edit = array();
        $edit['modules[Core][forum][enable]'] = FALSE;
        $this->drupalPost('admin/modules', $edit, t('Save configuration'));
        $this->assertText(t('The configuration options have been saved.'), 'Modules status has been updated.');
        module_list(TRUE);
        $this->assertFalse(module_exists('forum'), 'Forum module is not enabled.');
        // Attempt to re-enable the Forum module and ensure it does not try to
        // recreate the taxonomy_forums field.
        $edit = array();
        $edit['modules[Core][forum][enable]'] = 'forum';
        $this->drupalPost('admin/modules', $edit, t('Save configuration'));
        $this->assertText(t('The configuration options have been saved.'), 'Modules status has been updated.');
        module_list(TRUE);
        $this->assertTrue(module_exists('forum'), 'Forum module is enabled.');
    }
    
    /**
     * Tests forum functionality through the admin and user interfaces.
     */
    function testForum() {
        
        //Check that the basic forum install creates a default forum topic
        $this->drupalGet("/forum");
        // Look for the "General discussion" default forum
        $this->assertText(t("General discussion"), "Found the default forum at the /forum listing");
        // Do the admin tests.
        $this->doAdminTests($this->admin_user);
        // Generate topics to populate the active forum block.
        $this->generateForumTopics($this->forum);
        // Login an unprivileged user to view the forum topics and generate an
        // active forum topics list.
        $this->drupalLogin($this->web_user);
        // Verify that this user is shown a message that they may not post content.
        $this->drupalGet('forum/' . $this->forum['tid']);
        $this->assertText(t('You are not allowed to post new content in the forum'), "Authenticated user without permission to post forum content is shown message in local tasks to that effect.");
        $this->viewForumTopics($this->nids);
        // Log in, and do basic tests for a user with permission to edit any forum
        // content.
        $this->doBasicTests($this->edit_any_topics_user, TRUE);
        // Create a forum node authored by this user.
        $any_topics_user_node = $this->createForumTopic($this->forum, FALSE);
        // Log in, and do basic tests for a user with permission to edit only its
        // own forum content.
        $this->doBasicTests($this->edit_own_topics_user, FALSE);
        // Create a forum node authored by this user.
        $own_topics_user_node = $this->createForumTopic($this->forum, FALSE);
        // Verify that this user cannot edit forum content authored by another user.
        $this->verifyForums($this->edit_any_topics_user, $any_topics_user_node, FALSE, 403);
        // Verify that this user is shown a local task to add new forum content.
        $this->drupalGet('forum');
        $this->assertLink(t('Add new Forum topic'));
        $this->drupalGet('forum/' . $this->forum['tid']);
        $this->assertLink(t('Add new Forum topic'));
        // Login a user with permission to edit any forum content.
        $this->drupalLogin($this->edit_any_topics_user);
        // Verify that this user can edit forum content authored by another user.
        $this->verifyForums($this->edit_own_topics_user, $own_topics_user_node, TRUE);
        // Verify the topic and post counts on the forum page.
        $this->drupalGet('forum');
        // Verify row for testing forum.
        $forum_arg = array(
            ':forum' => 'forum-list-' . $this->forum['tid'],
        );
        // Topics cell contains number of topics and number of unread topics.
        $xpath = $this->buildXPathQuery('//tr[@id=:forum]//td[@class="topics"]', $forum_arg);
        $topics = $this->xpath($xpath);
        $topics = trim($topics[0]);
        $this->assertEqual($topics, '6', 'Number of topics found.');
        // Verify the number of unread topics.
        $unread_topics = _forum_topics_unread($this->forum['tid'], $this->edit_any_topics_user->uid);
        $unread_topics = format_plural($unread_topics, '1 new', '@count new');
        $xpath = $this->buildXPathQuery('//tr[@id=:forum]//td[@class="topics"]//a', $forum_arg);
        $this->assertFieldByXPath($xpath, $unread_topics, 'Number of unread topics found.');
        // Verify total number of posts in forum.
        $xpath = $this->buildXPathQuery('//tr[@id=:forum]//td[@class="posts"]', $forum_arg);
        $this->assertFieldByXPath($xpath, '6', 'Number of posts found.');
        // Test loading multiple forum nodes on the front page.
        $this->drupalLogin($this->drupalCreateUser(array(
            'administer content types',
            'create forum content',
        )));
        $this->drupalPost('admin/structure/types/manage/forum', array(
            'node_options[promote]' => 'promote',
        ), t('Save content type'));
        $this->createForumTopic($this->forum, FALSE);
        $this->createForumTopic($this->forum, FALSE);
        $this->drupalGet('node');
        // Test adding a comment to a forum topic.
        $node = $this->createForumTopic($this->forum, FALSE);
        $edit = array();
        $edit['comment_body[' . LANGUAGE_NONE . '][0][value]'] = $this->randomName();
        $this->drupalPost("node/{$node->nid}", $edit, t('Save'));
        $this->assertResponse(200);
        // Test editing a forum topic that has a comment.
        $this->drupalLogin($this->edit_any_topics_user);
        $this->drupalGet('forum/' . $this->forum['tid']);
        $this->drupalPost("node/{$node->nid}/edit", array(), t('Save'));
        $this->assertResponse(200);
        // Make sure constructing a forum node programmatically produces no notices.
        $node = new stdClass();
        $node->type = 'forum';
        $node->title = 'Test forum notices';
        $node->uid = 1;
        $node->taxonomy_forums[LANGUAGE_NONE][0]['tid'] = $this->root_forum['tid'];
        node_save($node);
        // Verify that adding taxonomy_forums reference field to another content
        // type does not trigger any errors.
        // Create new content type.
        $type_name = 'test_' . strtolower($this->randomName());
        $type = $this->drupalCreateContentType(array(
            'name' => $type_name,
            'type' => $type_name,
        ));
        // Create field instance on the bundle.
        $vocabulary = taxonomy_vocabulary_load(variable_get('forum_nav_vocabulary', 0));
        $instance = array(
            'field_name' => 'taxonomy_forums',
            'entity_type' => 'node',
            'label' => $vocabulary->name,
            'bundle' => $type->type,
            'required' => FALSE,
            'widget' => array(
                'type' => 'options_select',
            ),
            'display' => array(
                'default' => array(
                    'type' => 'taxonomy_term_reference_link',
                    'weight' => 10,
                ),
                'teaser' => array(
                    'type' => 'taxonomy_term_reference_link',
                    'weight' => 10,
                ),
            ),
        );
        field_create_instance($instance);
        // Create node and access node detail page.
        $settings = array(
            'type' => $type->type,
            'title' => $type_name,
            'taxonomy_forums' => array(
                LANGUAGE_NONE => array(),
            ),
        );
        $node1 = $this->drupalCreateNode($settings);
        $this->drupalGet('node/' . $node1->nid);
        $this->assertResponse(200);
        // Remove the field instance.
        field_delete_instance($instance);
    }
    
    /**
     * Tests that forum nodes can't be added without a parent.
     *
     * Verifies that forum nodes are not created without choosing "forum" from the
     * select list.
     */
    function testAddOrphanTopic() {
        // Must remove forum topics to test creating orphan topics.
        $vid = variable_get('forum_nav_vocabulary');
        $tree = taxonomy_get_tree($vid);
        foreach ($tree as $term) {
            taxonomy_term_delete($term->tid);
        }
        // Create an orphan forum item.
        $this->drupalLogin($this->admin_user);
        $this->drupalPost('node/add/forum', array(
            'title' => $this->randomName(10),
            'body[' . LANGUAGE_NONE . '][0][value]' => $this->randomName(120),
        ), t('Save'));
        $nid_count = db_query('SELECT COUNT(nid) FROM {node}')->fetchField();
        $this->assertEqual(0, $nid_count, 'A forum node was not created when missing a forum vocabulary.');
        // Reset the defaults for future tests.
        module_enable(array(
            'forum',
        ));
    }
    
    /**
     * Runs admin tests on the admin user.
     *
     * @param object $user
     *   The logged in user.
     */
    private function doAdminTests($user) {
        // Login the user.
        $this->drupalLogin($user);
        // Enable the active forum block.
        $edit = array();
        $edit['blocks[forum_active][region]'] = 'sidebar_second';
        $this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
        $this->assertResponse(200);
        $this->assertText(t('The block settings have been updated.'), 'Active forum topics forum block was enabled');
        // Enable the new forum block.
        $edit = array();
        $edit['blocks[forum_new][region]'] = 'sidebar_second';
        $this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
        $this->assertResponse(200);
        $this->assertText(t('The block settings have been updated.'), '[New forum topics] Forum block was enabled');
        // Retrieve forum menu id.
        $mlid = db_query_range("SELECT mlid FROM {menu_links} WHERE link_path = 'forum' AND menu_name = 'navigation' AND module = 'system' ORDER BY mlid ASC", 0, 1)->fetchField();
        // Add forum to navigation menu.
        $edit = array();
        $this->drupalPost('admin/structure/menu/manage/navigation', $edit, t('Save configuration'));
        $this->assertResponse(200);
        // Edit forum taxonomy.
        // Restoration of the settings fails and causes subsequent tests to fail.
        $this->container = $this->editForumTaxonomy();
        // Create forum container.
        $this->container = $this->createForum('container');
        // Verify "edit container" link exists and functions correctly.
        $this->drupalGet('admin/structure/forum');
        $this->clickLink('edit container');
        $this->assertRaw('Edit container', 'Followed the link to edit the container');
        // Create forum inside the forum container.
        $this->forum = $this->createForum('forum', $this->container['tid']);
        // Verify the "edit forum" link exists and functions correctly.
        $this->drupalGet('admin/structure/forum');
        $this->clickLink('edit forum');
        $this->assertRaw('Edit forum', 'Followed the link to edit the forum');
        // Navigate back to forum structure page.
        $this->drupalGet('admin/structure/forum');
        // Create second forum in container.
        $this->delete_forum = $this->createForum('forum', $this->container['tid']);
        // Save forum overview.
        $this->drupalPost('admin/structure/forum/', array(), t('Save'));
        $this->assertRaw(t('The configuration options have been saved.'));
        // Delete this second forum.
        $this->deleteForum($this->delete_forum['tid']);
        // Create forum at the top (root) level.
        $this->root_forum = $this->createForum('forum');
        // Test vocabulary form alterations.
        $this->drupalGet('admin/structure/taxonomy/forums/edit');
        $this->assertFieldByName('op', t('Save'), 'Save button found.');
        $this->assertNoFieldByName('op', t('Delete'), 'Delete button not found.');
        // Test term edit form alterations.
        $this->drupalGet('taxonomy/term/' . $this->container['tid'] . '/edit');
        // Test parent field been hidden by forum module.
        $this->assertNoField('parent[]', 'Parent field not found.');
        // Test tags vocabulary form is not affected.
        $this->drupalGet('admin/structure/taxonomy/tags/edit');
        $this->assertFieldByName('op', t('Save'), 'Save button found.');
        $this->assertFieldByName('op', t('Delete'), 'Delete button found.');
        // Test tags vocabulary term form is not affected.
        $this->drupalGet('admin/structure/taxonomy/tags/add');
        $this->assertField('parent[]', 'Parent field found.');
        // Test relations fieldset exists.
        $relations_fieldset = $this->xpath("//fieldset[@id='edit-relations']");
        $this->assertTrue(isset($relations_fieldset[0]), 'Relations fieldset element found.');
    }
    
    /**
     * Edits the forum taxonomy.
     */
    function editForumTaxonomy() {
        // Backup forum taxonomy.
        $vid = variable_get('forum_nav_vocabulary', '');
        $original_settings = taxonomy_vocabulary_load($vid);
        // Generate a random name/description.
        $title = $this->randomName(10);
        $description = $this->randomName(100);
        $edit = array(
            'name' => $title,
            'description' => $description,
            'machine_name' => drupal_strtolower(drupal_substr($this->randomName(), 3, 9)),
        );
        // Edit the vocabulary.
        $this->drupalPost('admin/structure/taxonomy/' . $original_settings->machine_name . '/edit', $edit, t('Save'));
        $this->assertResponse(200);
        $this->assertRaw(t('Updated vocabulary %name.', array(
            '%name' => $title,
        )), 'Vocabulary was edited');
        // Grab the newly edited vocabulary.
        entity_get_controller('taxonomy_vocabulary')->resetCache();
        $current_settings = taxonomy_vocabulary_load($vid);
        // Make sure we actually edited the vocabulary properly.
        $this->assertEqual($current_settings->name, $title, 'The name was updated');
        $this->assertEqual($current_settings->description, $description, 'The description was updated');
        // Restore the original vocabulary.
        taxonomy_vocabulary_save($original_settings);
        drupal_static_reset('taxonomy_vocabulary_load');
        $current_settings = taxonomy_vocabulary_load($vid);
        $this->assertEqual($current_settings->name, $original_settings->name, 'The original vocabulary settings were restored');
    }
    
    /**
     * Creates a forum container or a forum.
     *
     * @param $type
     *   The forum type (forum container or forum).
     * @param $parent
     *   The forum parent. This defaults to 0, indicating a root forum.
     *   another forum).
     *
     * @return
     *   The created taxonomy term data.
     */
    function createForum($type, $parent = 0) {
        // Generate a random name/description.
        $name = $this->randomName(10);
        $description = $this->randomName(100);
        $edit = array(
            'name' => $name,
            'description' => $description,
            'parent[0]' => $parent,
            'weight' => '0',
        );
        // Create forum.
        $this->drupalPost('admin/structure/forum/add/' . $type, $edit, t('Save'));
        $this->assertResponse(200);
        $type = $type == 'container' ? 'forum container' : 'forum';
        $this->assertRaw(t('Created new @type %term.', array(
            '%term' => $name,
            '@type' => t($type),
        )), format_string('@type was created', array(
            '@type' => ucfirst($type),
        )));
        // Verify forum.
        $term = db_query("SELECT * FROM {taxonomy_term_data} t WHERE t.vid = :vid AND t.name = :name AND t.description = :desc", array(
            ':vid' => variable_get('forum_nav_vocabulary', ''),
            ':name' => $name,
            ':desc' => $description,
        ))->fetchAssoc();
        $this->assertTrue(!empty($term), 'The ' . $type . ' exists in the database');
        // Verify forum hierarchy.
        $tid = $term['tid'];
        $parent_tid = db_query("SELECT t.parent FROM {taxonomy_term_hierarchy} t WHERE t.tid = :tid", array(
            ':tid' => $tid,
        ))->fetchField();
        $this->assertTrue($parent == $parent_tid, 'The ' . $type . ' is linked to its container');
        return $term;
    }
    
    /**
     * Deletes a forum.
     *
     * @param $tid
     *   The forum ID.
     */
    function deleteForum($tid) {
        // Delete the forum.
        $this->drupalPost('admin/structure/forum/edit/forum/' . $tid, array(), t('Delete'));
        $this->drupalPost(NULL, array(), t('Delete'));
        // Assert that the forum no longer exists.
        $this->drupalGet('forum/' . $tid);
        $this->assertResponse(404, 'The forum was not found');
        // Assert that the associated term has been removed from the
        // forum_containers variable.
        $containers = variable_get('forum_containers', array());
        $this->assertFalse(in_array($tid, $containers), 'The forum_containers variable has been updated.');
    }
    
    /**
     * Runs basic tests on the indicated user.
     *
     * @param $user
     *   The logged in user.
     * @param $admin
     *   User has 'access administration pages' privilege.
     */
    private function doBasicTests($user, $admin) {
        // Login the user.
        $this->drupalLogin($user);
        // Attempt to create forum topic under a container.
        $this->createForumTopic($this->container, TRUE);
        // Create forum node.
        $node = $this->createForumTopic($this->forum, FALSE);
        // Verify the user has access to all the forum nodes.
        $this->verifyForums($user, $node, $admin);
    }
    
    /**
     * Creates forum topic.
     *
     * @param array $forum
     *   A forum array.
     * @param boolean $container
     *   TRUE if $forum is a container; FALSE otherwise.
     *
     * @return object
     *   The created topic node.
     */
    function createForumTopic($forum, $container = FALSE) {
        // Generate a random subject/body.
        $title = $this->randomName(20);
        $body = $this->randomName(200);
        $langcode = LANGUAGE_NONE;
        $edit = array(
            "title" => $title,
            "body[{$langcode}][0][value]" => $body,
        );
        $tid = $forum['tid'];
        // Create the forum topic, preselecting the forum ID via a URL parameter.
        $this->drupalPost('node/add/forum/' . $tid, $edit, t('Save'));
        $type = t('Forum topic');
        if ($container) {
            $this->assertNoRaw(t('@type %title has been created.', array(
                '@type' => $type,
                '%title' => $title,
            )), 'Forum topic was not created');
            $this->assertRaw(t('The item %title is a forum container, not a forum.', array(
                '%title' => $forum['name'],
            )), 'Error message was shown');
            return;
        }
        else {
            $this->assertRaw(t('@type %title has been created.', array(
                '@type' => $type,
                '%title' => $title,
            )), 'Forum topic was created');
            $this->assertNoRaw(t('The item %title is a forum container, not a forum.', array(
                '%title' => $forum['name'],
            )), 'No error message was shown');
        }
        // Retrieve node object, ensure that the topic was created and in the proper forum.
        $node = $this->drupalGetNodeByTitle($title);
        $this->assertTrue($node != NULL, format_string('Node @title was loaded', array(
            '@title' => $title,
        )));
        $this->assertEqual($node->taxonomy_forums[LANGUAGE_NONE][0]['tid'], $tid, 'Saved forum topic was in the expected forum');
        // View forum topic.
        $this->drupalGet('node/' . $node->nid);
        $this->assertRaw($title, 'Subject was found');
        $this->assertRaw($body, 'Body was found');
        return $node;
    }
    
    /**
     * Verifies that the logged in user has access to a forum nodes.
     *
     * @param $node_user
     *   The user who creates the node.
     * @param $node
     *   The node being checked.
     * @param $admin
     *   Boolean to indicate whether the user can 'access administration pages'.
     * @param $response
     *   The exptected HTTP response code.
     */
    private function verifyForums($node_user, $node, $admin, $response = 200) {
        $response2 = $admin ? 200 : 403;
        // View forum help node.
        $this->drupalGet('admin/help/forum');
        $this->assertResponse($response2);
        if ($response2 == 200) {
            $this->assertTitle(t('Forum | Drupal'), 'Forum help title was displayed');
            $this->assertText(t('Forum'), 'Forum help node was displayed');
        }
        // Verify the forum blocks were displayed.
        $this->drupalGet('');
        $this->assertResponse(200);
        $this->assertText(t('New forum topics'), '[New forum topics] Forum block was displayed');
        // View forum container page.
        $this->verifyForumView($this->container);
        // View forum page.
        $this->verifyForumView($this->forum, $this->container);
        // View root forum page.
        $this->verifyForumView($this->root_forum);
        // View forum node.
        $this->drupalGet('node/' . $node->nid);
        $this->assertResponse(200);
        $this->assertTitle($node->title . ' | Drupal', 'Forum node was displayed');
        $breadcrumb = array(
            l(t('Home'), NULL),
            l(t('Forums'), 'forum'),
            l($this->container['name'], 'forum/' . $this->container['tid']),
            l($this->forum['name'], 'forum/' . $this->forum['tid']),
        );
        $this->assertRaw(theme('breadcrumb', array(
            'breadcrumb' => $breadcrumb,
        )), 'Breadcrumbs were displayed');
        // View forum edit node.
        $this->drupalGet('node/' . $node->nid . '/edit');
        $this->assertResponse($response);
        if ($response == 200) {
            $this->assertTitle('Edit Forum topic ' . $node->title . ' | Drupal', 'Forum edit node was displayed');
        }
        if ($response == 200) {
            // Edit forum node (including moving it to another forum).
            $edit = array();
            $langcode = LANGUAGE_NONE;
            $edit["title"] = 'node/' . $node->nid;
            $edit["body[{$langcode}][0][value]"] = $this->randomName(256);
            // Assume the topic is initially associated with $forum.
            $edit["taxonomy_forums[{$langcode}]"] = $this->root_forum['tid'];
            $edit['shadow'] = TRUE;
            $this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
            $this->assertRaw(t('Forum topic %title has been updated.', array(
                '%title' => $edit["title"],
            )), 'Forum node was edited');
            // Verify topic was moved to a different forum.
            $forum_tid = db_query("SELECT tid FROM {forum} WHERE nid = :nid AND vid = :vid", array(
                ':nid' => $node->nid,
                ':vid' => $node->vid,
            ))
                ->fetchField();
            $this->assertTrue($forum_tid == $this->root_forum['tid'], 'The forum topic is linked to a different forum');
            // Delete forum node.
            $this->drupalPost('node/' . $node->nid . '/delete', array(), t('Delete'));
            $this->assertResponse($response);
            $this->assertRaw(t('Forum topic %title has been deleted.', array(
                '%title' => $edit['title'],
            )), 'Forum node was deleted');
        }
    }
    
    /**
     * Verifies display of forum page.
     *
     * @param $forum
     *   A row from the taxonomy_term_data table in an array.
     * @param $parent
     *   (optional) An array representing the forum's parent.
     */
    private function verifyForumView($forum, $parent = NULL) {
        // View forum page.
        $this->drupalGet('forum/' . $forum['tid']);
        $this->assertResponse(200);
        $this->assertTitle($forum['name'] . ' | Drupal', 'Forum name was displayed');
        $breadcrumb = array(
            l(t('Home'), NULL),
            l(t('Forums'), 'forum'),
        );
        if (isset($parent)) {
            $breadcrumb[] = l($parent['name'], 'forum/' . $parent['tid']);
        }
        $this->assertRaw(theme('breadcrumb', array(
            'breadcrumb' => $breadcrumb,
        )), 'Breadcrumbs were displayed');
    }
    
    /**
     * Generates forum topics to test the display of an active forum block.
     *
     * @param array $forum
     *   The foorum array (a row from taxonomy_term_data table).
     */
    private function generateForumTopics($forum) {
        $this->nids = array();
        for ($i = 0; $i < 5; $i++) {
            $node = $this->createForumTopic($this->forum, FALSE);
            $this->nids[] = $node->nid;
        }
    }
    
    /**
     * Views forum topics to test the display of an active forum block.
     *
     * @todo The logic here is completely incorrect, since the active forum topics
     *   block is determined by comments on the node, not by views.
     * @todo DIE
     *
     * @param $nids
     *   An array of forum node IDs.
     */
    private function viewForumTopics($nids) {
        for ($i = 0; $i < 2; $i++) {
            foreach ($nids as $nid) {
                $this->drupalGet('node/' . $nid);
                $this->drupalGet('node/' . $nid);
                $this->drupalGet('node/' . $nid);
            }
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DrupalTestCase::$assertions protected property Assertions thrown in that test case.
DrupalTestCase::$databasePrefix protected property The database prefix of this test run.
DrupalTestCase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
DrupalTestCase::$originalLanguage protected property The original language.
DrupalTestCase::$originalLanguageDefault protected property The original default language.
DrupalTestCase::$originalTheme protected property The original theme.
DrupalTestCase::$originalThemeKey protected property The original theme key.
DrupalTestCase::$originalThemePath protected property The original theme path.
DrupalTestCase::$results public property Current results of this test case.
DrupalTestCase::$setup protected property Flag to indicate whether the test has been set up.
DrupalTestCase::$setupDatabasePrefix protected property
DrupalTestCase::$setupEnvironment protected property
DrupalTestCase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
DrupalTestCase::$testId protected property The test run ID.
DrupalTestCase::$timeLimit protected property Time limit for the test.
DrupalTestCase::$useSetupInstallationCache public property Whether to cache the installation part of the setUp() method.
DrupalTestCase::$useSetupModulesCache public property Whether to cache the modules installation part of the setUp() method.
DrupalTestCase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
DrupalTestCase::assert protected function Internal helper: stores the assert.
DrupalTestCase::assertEqual protected function Check to see if two values are equal.
DrupalTestCase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
DrupalTestCase::assertIdentical protected function Check to see if two values are identical.
DrupalTestCase::assertNotEqual protected function Check to see if two values are not equal.
DrupalTestCase::assertNotIdentical protected function Check to see if two values are not identical.
DrupalTestCase::assertNotNull protected function Check to see if a value is not NULL.
DrupalTestCase::assertNull protected function Check to see if a value is NULL.
DrupalTestCase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
DrupalTestCase::deleteAssert public static function Delete an assertion record by message ID.
DrupalTestCase::error protected function Fire an error assertion. 1
DrupalTestCase::errorHandler public function Handle errors during test runs. 1
DrupalTestCase::exceptionHandler protected function Handle exceptions.
DrupalTestCase::fail protected function Fire an assertion that is always negative.
DrupalTestCase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
DrupalTestCase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
DrupalTestCase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
DrupalTestCase::insertAssert public static function Store an assertion from outside the testing context.
DrupalTestCase::pass protected function Fire an assertion that is always positive.
DrupalTestCase::randomName public static function Generates a random string containing letters and numbers.
DrupalTestCase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
DrupalTestCase::run public function Run all tests in this class.
DrupalTestCase::verbose protected function Logs a verbose message in a text file.
DrupalWebTestCase::$additionalCurlOptions protected property Additional cURL options.
DrupalWebTestCase::$content protected property The content of the page currently loaded in the internal browser.
DrupalWebTestCase::$cookieFile protected property The current cookie file used by cURL.
DrupalWebTestCase::$cookies protected property The cookies of the page currently loaded in the internal browser.
DrupalWebTestCase::$curlHandle protected property The handle of the current cURL connection.
DrupalWebTestCase::$drupalSettings protected property The value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser.
DrupalWebTestCase::$elements protected property The parsed version of the page.
DrupalWebTestCase::$generatedTestFiles protected property Whether the files were copied to the test files directory.
DrupalWebTestCase::$headers protected property The headers of the page currently loaded in the internal browser.
DrupalWebTestCase::$httpauth_credentials protected property HTTP authentication credentials (&lt;username&gt;:&lt;password&gt;).
DrupalWebTestCase::$httpauth_method protected property HTTP authentication method
DrupalWebTestCase::$loggedInUser protected property The current user logged in using the internal browser.
DrupalWebTestCase::$originalCleanUrl protected property The original clean_url variable value.
DrupalWebTestCase::$originalLanguageUrl protected property The original language URL.
DrupalWebTestCase::$originalProfile protected property The original active installation profile.
DrupalWebTestCase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing purposes.
DrupalWebTestCase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing purposes.
DrupalWebTestCase::$plainTextContent protected property The content of the page currently loaded in the internal browser (plain text version).
DrupalWebTestCase::$private_files_directory protected property The private files directory created for testing purposes.
DrupalWebTestCase::$profile protected property The profile to install as a basis for testing. 20
DrupalWebTestCase::$public_files_directory protected property The public files directory created for testing purposes.
DrupalWebTestCase::$redirect_count protected property The number of redirects followed during the handling of a request.
DrupalWebTestCase::$session_id protected property The current session ID, if available.
DrupalWebTestCase::$session_name protected property The current session name, if available.
DrupalWebTestCase::$temp_files_directory protected property The temporary files directory created for testing purposes.
DrupalWebTestCase::$url protected property The URL currently loaded in the internal browser.
DrupalWebTestCase::assertField protected function Asserts that a field exists with the given name or ID.
DrupalWebTestCase::assertFieldById protected function Asserts that a field exists in the current page with the given ID and value.
DrupalWebTestCase::assertFieldByName protected function Asserts that a field exists in the current page with the given name and value.
DrupalWebTestCase::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
DrupalWebTestCase::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
DrupalWebTestCase::assertLink protected function Pass if a link with the specified label is found, and optional with the
specified index.
DrupalWebTestCase::assertLinkByHref protected function Pass if a link containing a given href (part) is found.
DrupalWebTestCase::assertMail protected function Asserts that the most recently sent e-mail message has the given value.
DrupalWebTestCase::assertMailPattern protected function Asserts that the most recently sent e-mail message has the pattern in it.
DrupalWebTestCase::assertMailString protected function Asserts that the most recently sent e-mail message has the string in it.
DrupalWebTestCase::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
DrupalWebTestCase::assertNoField protected function Asserts that a field does not exist with the given name or ID.
DrupalWebTestCase::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
DrupalWebTestCase::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
DrupalWebTestCase::assertNoFieldByXPath protected function Asserts that a field doesn&#039;t exist or its value doesn&#039;t match, by XPath.
DrupalWebTestCase::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
DrupalWebTestCase::assertNoLink protected function Pass if a link with the specified label is not found.
DrupalWebTestCase::assertNoLinkByHref protected function Pass if a link containing a given href (part) is not found.
DrupalWebTestCase::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
DrupalWebTestCase::assertNoPattern protected function Will trigger a pass if the perl regex pattern is not present in raw content.
DrupalWebTestCase::assertNoRaw protected function Pass if the raw text is NOT found on the loaded page, fail otherwise. Raw text
refers to the raw HTML that the page generated.
DrupalWebTestCase::assertNoResponse protected function Asserts the page did not return the specified response code.
DrupalWebTestCase::assertNoText protected function Pass if the text is NOT found on the text version of the page. The text version
is the equivalent of what a user would see when viewing through a web browser.
In other words the HTML has been filtered out of the contents.
DrupalWebTestCase::assertNoTitle protected function Pass if the page title is not the given string.
DrupalWebTestCase::assertNoUniqueText protected function Pass if the text is found MORE THAN ONCE on the text version of the page.
DrupalWebTestCase::assertOptionSelected protected function Asserts that a select option in the current page is checked.
DrupalWebTestCase::assertPattern protected function Will trigger a pass if the Perl regex pattern is found in the raw content.
DrupalWebTestCase::assertRaw protected function Pass if the raw text IS found on the loaded page, fail otherwise. Raw text
refers to the raw HTML that the page generated.
DrupalWebTestCase::assertResponse protected function Asserts the page responds with the specified response code.
DrupalWebTestCase::assertText protected function Pass if the text IS found on the text version of the page. The text version
is the equivalent of what a user would see when viewing through a web browser.
In other words the HTML has been filtered out of the contents.
DrupalWebTestCase::assertTextHelper protected function Helper for assertText and assertNoText.
DrupalWebTestCase::assertThemeOutput protected function Asserts themed output.
DrupalWebTestCase::assertTitle protected function Pass if the page title is the given string.
DrupalWebTestCase::assertUniqueText protected function Pass if the text is found ONLY ONCE on the text version of the page.
DrupalWebTestCase::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
DrupalWebTestCase::assertUrl protected function Pass if the internal browser&#039;s URL matches the given path.
DrupalWebTestCase::buildXPathQuery protected function Builds an XPath query.
DrupalWebTestCase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
DrupalWebTestCase::checkForMetaRefresh protected function Check for meta refresh tag and if found call drupalGet() recursively. This
function looks for the http-equiv attribute to be set to &quot;Refresh&quot;
and is case-sensitive.
DrupalWebTestCase::checkPermissions protected function Check to make sure that the array of permissions are valid.
DrupalWebTestCase::clickLink protected function Follows a link by name.
DrupalWebTestCase::constructFieldXpath protected function Helper function: construct an XPath for the given set of attributes and value.
DrupalWebTestCase::copySetupCache protected function Copy the setup cache from/to another table and files directory.
DrupalWebTestCase::cronRun protected function Runs cron in the Drupal installed by Simpletest.
DrupalWebTestCase::curlClose protected function Close the cURL handler and unset the handler.
DrupalWebTestCase::curlExec protected function Initializes and executes a cURL request.
DrupalWebTestCase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
DrupalWebTestCase::curlInitialize protected function Initializes the cURL connection.
DrupalWebTestCase::drupalCompareFiles protected function Compare two files based on size and file name.
DrupalWebTestCase::drupalCreateContentType protected function Creates a custom content type based on default settings.
DrupalWebTestCase::drupalCreateNode protected function Creates a node based on default settings.
DrupalWebTestCase::drupalCreateRole protected function Creates a role with specified permissions.
DrupalWebTestCase::drupalCreateUser protected function Create a user with a given set of permissions.
DrupalWebTestCase::drupalGet protected function Retrieves a Drupal path or an absolute path.
DrupalWebTestCase::drupalGetAJAX protected function Retrieve a Drupal path or an absolute path and JSON decode the result.
DrupalWebTestCase::drupalGetContent protected function Gets the current raw HTML of requested page.
DrupalWebTestCase::drupalGetHeader protected function Gets the value of an HTTP response header. If multiple requests were
required to retrieve the page, only the headers from the last request will
be checked by default. However, if TRUE is passed as the second argument,
all requests will be processed…
DrupalWebTestCase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page. Normally we are only
interested in the headers returned by the last request. However, if a page
is redirected or HTTP authentication is in use, multiple requests will be
required to retrieve the…
DrupalWebTestCase::drupalGetMails protected function Gets an array containing all e-mails sent during this test case.
DrupalWebTestCase::drupalGetNodeByTitle function Get a node from the database based on its title.
DrupalWebTestCase::drupalGetSettings protected function Gets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::drupalGetTestFiles protected function Get a list files that can be used in tests.
DrupalWebTestCase::drupalGetToken protected function Generate a token for the currently logged in user.
DrupalWebTestCase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
DrupalWebTestCase::drupalLogin protected function Log in a user with the internal browser.
DrupalWebTestCase::drupalLogout protected function
DrupalWebTestCase::drupalPost protected function Execute a POST request on a Drupal page.
It will be done as usual POST request with SimpleBrowser.
DrupalWebTestCase::drupalPostAJAX protected function Execute an Ajax submission.
DrupalWebTestCase::drupalSetContent protected function Sets the raw HTML content. This can be useful when a page has been fetched
outside of the internal browser and assertions need to be made on the
returned page.
DrupalWebTestCase::drupalSetSettings protected function Sets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
DrupalWebTestCase::getAllOptions protected function Get all option elements, including nested options, in a select.
DrupalWebTestCase::getSelectedItem protected function Get the selected value from a select field.
DrupalWebTestCase::getSetupCacheKey protected function Returns the cache key used for the setup caching.
DrupalWebTestCase::getUrl protected function Get the current URL from the cURL handler.
DrupalWebTestCase::handleForm protected function Handle form input related to drupalPost(). Ensure that the specified fields
exist and attempt to create POST data in the correct manner for the particular
field type.
DrupalWebTestCase::loadSetupCache protected function Copies the cached tables and files for a cached installation setup.
DrupalWebTestCase::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
DrupalWebTestCase::preloadRegistry protected function Preload the registry from the testing site.
DrupalWebTestCase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
DrupalWebTestCase::prepareEnvironment protected function Prepares the current environment for running the test.
DrupalWebTestCase::recursiveDirectoryCopy protected function Recursively copy one directory to another.
DrupalWebTestCase::refreshVariables protected function Refresh the in-memory set of variables. Useful after a page request is made
that changes a variable in a different thread.
1
DrupalWebTestCase::resetAll protected function Reset all data structures after having enabled new modules.
DrupalWebTestCase::storeSetupCache protected function Store the installation setup to a cache.
DrupalWebTestCase::tearDown protected function Delete created files and temporary files directory, delete the tables created by setUp(),
and reset the database prefix.
7
DrupalWebTestCase::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
DrupalWebTestCase::xpath protected function Perform an xpath search on the contents of the internal browser. The search
is relative to the root element (HTML tag normally) of the page.
DrupalWebTestCase::__construct function Constructor for DrupalWebTestCase. Overrides DrupalTestCase::__construct 1
ForumTestCase::$admin_user protected property A user with various administrative privileges.
ForumTestCase::$container protected property An array representing a container.
ForumTestCase::$delete_forum protected property A forum to delete.
ForumTestCase::$edit_any_topics_user protected property A user that can create, edit, and delete forum topics.
ForumTestCase::$edit_own_topics_user protected property A user that can create forum topics and edit its own topics.
ForumTestCase::$forum protected property An array representing a forum.
ForumTestCase::$nids protected property An array of forum topic node IDs.
ForumTestCase::$root_forum protected property An array representing a root forum.
ForumTestCase::$web_user protected property A user with no special privileges.
ForumTestCase::createForum function Creates a forum container or a forum.
ForumTestCase::createForumTopic function Creates forum topic.
ForumTestCase::deleteForum function Deletes a forum.
ForumTestCase::doAdminTests private function Runs admin tests on the admin user.
ForumTestCase::doBasicTests private function Runs basic tests on the indicated user.
ForumTestCase::editForumTaxonomy function Edits the forum taxonomy.
ForumTestCase::generateForumTopics private function Generates forum topics to test the display of an active forum block.
ForumTestCase::getInfo public static function
ForumTestCase::setUp function Sets up a Drupal site for running functional and integration tests. Overrides DrupalWebTestCase::setUp
ForumTestCase::testAddOrphanTopic function Tests that forum nodes can&#039;t be added without a parent.
ForumTestCase::testEnableForumField function Tests disabling and re-enabling the Forum module.
ForumTestCase::testForum function Tests forum functionality through the admin and user interfaces.
ForumTestCase::verifyForums private function Verifies that the logged in user has access to a forum nodes.
ForumTestCase::verifyForumView private function Verifies display of forum page.
ForumTestCase::viewForumTopics private function Views forum topics to test the display of an active forum block.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.