AggregatorTestCase

  1. drupal
    1. 8
    2. 7

Hierarchy

Functions & methods

NameDescription
AggregatorTestCase::createFeedCreate an aggregator feed (simulate form submission on admin/config/services/aggregator/add/feed).
AggregatorTestCase::createSampleNodes
AggregatorTestCase::deleteFeedDelete an aggregator feed.
AggregatorTestCase::getAtomSample
AggregatorTestCase::getCategoriesPull categories from aggregator_category table.
AggregatorTestCase::getDefaultFeedItemCountReturn the count of the randomly created feed array.
AggregatorTestCase::getEmptyOpmlCreate a valid but empty OPML file.
AggregatorTestCase::getFeedCategoriesPull feed categories from aggregator_category_feed table.
AggregatorTestCase::getFeedEditArrayReturn a randomly generated feed edit array.
AggregatorTestCase::getInvalidOpmlCreate an invalid OPML file.
AggregatorTestCase::getRSS091Sample
AggregatorTestCase::getValidOpmlCreate a valid OPML file from an array of feeds.
AggregatorTestCase::removeFeedItemsConfirm item removal from a feed.
AggregatorTestCase::setUpGenerates a random database prefix, runs the install scripts on the prefixed database and enable the specified modules. After installation many caches are flushed and the internal browser is setup so that the page requests will run on the new prefix.… Overrides DrupalWebTestCase::setUp
AggregatorTestCase::uniqueFeedCheck if the feed name and url is unique.
AggregatorTestCase::updateAndRemoveAdd and remove feed items and ensure that the count is zero.
AggregatorTestCase::updateFeedItemsUpdate feed items (simulate click to admin/config/services/aggregator/update/$fid).
DrupalTestCase::assertInternal helper: stores the assert.
DrupalTestCase::assertEqualCheck to see if two values are equal.
DrupalTestCase::assertFalseCheck to see if a value is false (an empty string, 0, NULL, or FALSE).
DrupalTestCase::assertIdenticalCheck to see if two values are identical.
DrupalTestCase::assertNotEqualCheck to see if two values are not equal.
DrupalTestCase::assertNotIdenticalCheck to see if two values are not identical.
DrupalTestCase::assertNotNullCheck to see if a value is not NULL.
DrupalTestCase::assertNullCheck to see if a value is NULL.
DrupalTestCase::assertTrueCheck to see if a value is not false (not an empty string, 0, NULL, or FALSE).
DrupalTestCase::deleteAssertDelete an assertion record by message ID.
DrupalTestCase::errorFire an error assertion.
DrupalTestCase::errorHandlerHandle errors during test runs.
DrupalTestCase::exceptionHandlerHandle exceptions.
DrupalTestCase::failFire an assertion that is always negative.
DrupalTestCase::generatePermutationsConverts a list of possible parameters into a stack of permutations.
DrupalTestCase::getAssertionCallCycles through backtrace until the first non-assertion method is found.
DrupalTestCase::insertAssertStore an assertion from outside the testing context.
DrupalTestCase::passFire an assertion that is always positive.
DrupalTestCase::randomNameGenerates a random string containing letters and numbers.
DrupalTestCase::randomStringGenerates a random string of ASCII characters of codes 32 to 126.
DrupalTestCase::runRun all tests in this class.
DrupalTestCase::verboseLogs verbose message in a text file.
DrupalWebTestCase::assertFieldAsserts that a field exists with the given name or id.
DrupalWebTestCase::assertFieldByIdAsserts that a field exists in the current page with the given id and value.
DrupalWebTestCase::assertFieldByNameAsserts that a field exists in the current page with the given name and value.
DrupalWebTestCase::assertFieldByXPathAsserts that a field exists in the current page by the given XPath.
DrupalWebTestCase::assertFieldCheckedAsserts that a checkbox field in the current page is checked.
DrupalWebTestCase::assertLinkPass if a link with the specified label is found, and optional with the specified index.
DrupalWebTestCase::assertLinkByHrefPass if a link containing a given href (part) is found.
DrupalWebTestCase::assertMailAsserts that the most recently sent e-mail message has the given value.
DrupalWebTestCase::assertMailPatternAsserts that the most recently sent e-mail message has the pattern in it.
DrupalWebTestCase::assertMailStringAsserts that the most recently sent e-mail message has the string in it.
DrupalWebTestCase::assertNoDuplicateIdsAsserts that each HTML ID is used for just a single element.
DrupalWebTestCase::assertNoFieldAsserts that a field does not exist with the given name or id.
DrupalWebTestCase::assertNoFieldByIdAsserts that a field does not exist with the given id and value.
DrupalWebTestCase::assertNoFieldByNameAsserts that a field does not exist with the given name and value.
DrupalWebTestCase::assertNoFieldByXPathAsserts that a field does not exist in the current page by the given XPath.
DrupalWebTestCase::assertNoFieldCheckedAsserts that a checkbox field in the current page is not checked.
DrupalWebTestCase::assertNoLinkPass if a link with the specified label is not found.
DrupalWebTestCase::assertNoLinkByHrefPass if a link containing a given href (part) is not found.
DrupalWebTestCase::assertNoOptionSelectedAsserts that a select option in the current page is not checked.
DrupalWebTestCase::assertNoPatternWill trigger a pass if the perl regex pattern is not present in raw content.
DrupalWebTestCase::assertNoRawPass 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::assertNoResponseAsserts the page did not return the specified response code.
DrupalWebTestCase::assertNoTextPass 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::assertNoTitlePass if the page title is not the given string.
DrupalWebTestCase::assertNoUniqueTextPass if the text is found MORE THAN ONCE on the text version of the page.
DrupalWebTestCase::assertOptionSelectedAsserts that a select option in the current page is checked.
DrupalWebTestCase::assertPatternWill trigger a pass if the Perl regex pattern is found in the raw content.
DrupalWebTestCase::assertRawPass if the raw text IS found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
DrupalWebTestCase::assertResponseAsserts the page responds with the specified response code.
DrupalWebTestCase::assertTextPass 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::assertTextHelperHelper for assertText and assertNoText.
DrupalWebTestCase::assertTitlePass if the page title is the given string.
DrupalWebTestCase::assertUniqueTextPass if the text is found ONLY ONCE on the text version of the page.
DrupalWebTestCase::assertUniqueTextHelperHelper for assertUniqueText and assertNoUniqueText.
DrupalWebTestCase::assertUrlPass if the internal browser's URL matches the given path.
DrupalWebTestCase::buildXPathQueryBuilds an XPath query.
DrupalWebTestCase::checkForMetaRefreshCheck for meta refresh tag and if found call drupalGet() recursively. This function looks for the http-equiv attribute to be set to "Refresh" and is case-sensitive.
DrupalWebTestCase::checkPermissionsCheck to make sure that the array of permissions are valid.
DrupalWebTestCase::clickLinkFollows a link by name.
DrupalWebTestCase::constructFieldXpathHelper function: construct an XPath for the given set of attributes and value.
DrupalWebTestCase::cronRunRuns cron in the Drupal installed by Simpletest.
DrupalWebTestCase::curlCloseClose the cURL handler and unset the handler.
DrupalWebTestCase::curlExecInitializes and executes a cURL request.
DrupalWebTestCase::curlHeaderCallbackReads headers and registers errors received from the tested site.
DrupalWebTestCase::curlInitializeInitializes the cURL connection.
DrupalWebTestCase::drupalCompareFilesCompare two files based on size and file name.
DrupalWebTestCase::drupalCreateContentTypeCreates a custom content type based on default settings.
DrupalWebTestCase::drupalCreateNodeCreates a node based on default settings.
DrupalWebTestCase::drupalCreateRoleInternal helper function; Create a role with specified permissions.
DrupalWebTestCase::drupalCreateUserCreate a user with a given set of permissions. The permissions correspond to the names given on the privileges page.
DrupalWebTestCase::drupalGetRetrieves a Drupal path or an absolute path.
DrupalWebTestCase::drupalGetAJAXRetrieve a Drupal path or an absolute path and JSON decode the result.
DrupalWebTestCase::drupalGetContentGets the current raw HTML of requested page.
DrupalWebTestCase::drupalGetHeaderGets 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::drupalGetHeadersGets 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::drupalGetMailsGets an array containing all e-mails sent during this test case.
DrupalWebTestCase::drupalGetNodeByTitleGet a node from the database based on its title.
DrupalWebTestCase::drupalGetSettingsGets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::drupalGetTestFilesGet a list files that can be used in tests.
DrupalWebTestCase::drupalGetTokenGenerate a token for the currently logged in user.
DrupalWebTestCase::drupalHeadRetrieves only the headers for a Drupal path or an absolute path.
DrupalWebTestCase::drupalLoginLog in a user with the internal browser.
DrupalWebTestCase::drupalLogout
DrupalWebTestCase::drupalPostExecute a POST request on a Drupal page. It will be done as usual POST request with SimpleBrowser.
DrupalWebTestCase::drupalPostAJAXExecute an Ajax submission.
DrupalWebTestCase::drupalSetContentSets 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::drupalSetSettingsSets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::getAbsoluteUrlTakes a path and returns an absolute path.
DrupalWebTestCase::getAllOptionsGet all option elements, including nested options, in a select.
DrupalWebTestCase::getSelectedItemGet the selected value from a select field.
DrupalWebTestCase::getUrlGet the current url from the cURL handler.
DrupalWebTestCase::handleFormHandle 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::parseParse content returned from curlExec using DOM and SimpleXML.
DrupalWebTestCase::preloadRegistryPreload the registry from the testing site.
DrupalWebTestCase::refreshVariablesRefresh the in-memory set of variables. Useful after a page request is made that changes a variable in a different thread.
DrupalWebTestCase::resetAllReset all data structures after having enabled new modules.
DrupalWebTestCase::tearDownDelete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix.
DrupalWebTestCase::verboseEmailOutputs to verbose the most recent $count emails sent.
DrupalWebTestCase::xpathPerform 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::__constructConstructor for DrupalWebTestCase. Overrides DrupalTestCase::__construct

Properties

NameDescription
DrupalTestCase::$assertionsAssertions thrown in that test case.
DrupalTestCase::$databasePrefixThe database prefix of this test run.
DrupalTestCase::$originalFileDirectoryThe original file directory, before it was changed for testing purposes.
DrupalTestCase::$resultsCurrent results of this test case.
DrupalTestCase::$skipClassesThis class is skipped when looking for the source of an assertion.
DrupalTestCase::$testIdThe test run ID.
DrupalTestCase::$timeLimitTime limit for the test.
DrupalWebTestCase::$additionalCurlOptionsAdditional cURL options.
DrupalWebTestCase::$contentThe content of the page currently loaded in the internal browser.
DrupalWebTestCase::$cookieFileThe current cookie file used by cURL.
DrupalWebTestCase::$curlHandleThe handle of the current cURL connection.
DrupalWebTestCase::$drupalSettingsThe value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser.
DrupalWebTestCase::$elementsThe parsed version of the page.
DrupalWebTestCase::$generatedTestFilesWhether the files were copied to the test files directory.
DrupalWebTestCase::$headersThe headers of the page currently loaded in the internal browser.
DrupalWebTestCase::$httpauth_credentialsHTTP authentication credentials (<username>:<password>).
DrupalWebTestCase::$httpauth_methodHTTP authentication method
DrupalWebTestCase::$loggedInUserThe current user logged in using the internal browser.
DrupalWebTestCase::$originalShutdownCallbacksThe original shutdown handlers array, before it was cleaned for testing purposes.
DrupalWebTestCase::$originalUserThe original user, before it was changed to a clean uid = 1 for testing purposes.
DrupalWebTestCase::$plainTextContentThe content of the page currently loaded in the internal browser (plain text version).
DrupalWebTestCase::$profileThe profile to install as a basis for testing.
DrupalWebTestCase::$redirect_countThe number of redirects followed during the handling of a request.
DrupalWebTestCase::$session_idThe current session ID, if available.
DrupalWebTestCase::$session_nameThe current session name, if available.
DrupalWebTestCase::$urlThe URL currently loaded in the internal browser.

modules/aggregator/aggregator.test, line 8

View source
<?php
class AggregatorTestCase extends DrupalWebTestCase {
  function setUp() {
    parent::setUp('aggregator', 'aggregator_test');
    $web_user = $this->drupalCreateUser(array('administer news feeds', 'access news feeds', 'create article content'));
    $this->drupalLogin($web_user);
  }

  /**
   * Create an aggregator feed (simulate form submission on admin/config/services/aggregator/add/feed).
   *
   * @param $feed_url
   *   If given, feed will be created with this URL, otherwise /rss.xml will be used.
   * @return $feed
   *   Full feed object if possible.
   *
   * @see getFeedEditArray()
   */
  function createFeed($feed_url = NULL) {
    $edit = $this->getFeedEditArray($feed_url);
    $this->drupalPost('admin/config/services/aggregator/add/feed', $edit, t('Save'));
    $this->assertRaw(t('The feed %name has been added.', array('%name' => $edit['title'])), t('The feed !name has been added.', array('!name' => $edit['title'])));

    $feed = db_query("SELECT *  FROM {aggregator_feed} WHERE title = :title AND url = :url", array(':title' => $edit['title'], ':url' => $edit['url']))->fetch();
    $this->assertTrue(!empty($feed), t('The feed found in database.'));
    return $feed;
  }

  /**
   * Delete an aggregator feed.
   *
   * @param $feed
   *   Feed object representing the feed.
   */
  function deleteFeed($feed) {
    $this->drupalPost('admin/config/services/aggregator/edit/feed/' . $feed->fid, array(), t('Delete'));
    $this->assertRaw(t('The feed %title has been deleted.', array('%title' => $feed->title)), t('Feed deleted successfully.'));
  }

  /**
   * Return a randomly generated feed edit array.
   *
   * @param $feed_url
   *   If given, feed will be created with this URL, otherwise /rss.xml will be used.
   * @return
   *   A feed array.
   */
  function getFeedEditArray($feed_url = NULL) {
    $feed_name = $this->randomName(10);
    if (!$feed_url) {
      $feed_url = url('rss.xml', array(
        'query' => array('feed' => $feed_name), 
        'absolute' => TRUE,
      ));
    }
    $edit = array(
      'title' => $feed_name, 
      'url' => $feed_url, 
      'refresh' => '900',
    );
    return $edit;
  }

  /**
   * Return the count of the randomly created feed array.
   *
   * @return
   *   Number of feed items on default feed created by createFeed().
   */
  function getDefaultFeedItemCount() {
    // Our tests are based off of rss.xml, so let's find out how many elements should be related.
    $feed_count = db_query_range('SELECT COUNT(*) FROM {node} n WHERE n.promote = 1 AND n.status = 1', 0, variable_get('feed_default_items', 10))->fetchField();
    return $feed_count > 10 ? 10 : $feed_count;
  }

  /**
   * Update feed items (simulate click to admin/config/services/aggregator/update/$fid).
   *
   * @param $feed
   *   Feed object representing the feed.
   * @param $expected_count
   *   Expected number of feed items.
   */
  function updateFeedItems(&$feed, $expected_count) {
    // First, let's ensure we can get to the rss xml.
    $this->drupalGet($feed->url);
    $this->assertResponse(200, t('!url is reachable.', array('!url' => $feed->url)));

    // Refresh the feed (simulated link click).
    $this->drupalGet('admin/config/services/aggregator/update/' . $feed->fid);

    // Ensure we have the right number of items.
    $result = db_query('SELECT iid FROM {aggregator_item} WHERE fid = :fid', array(':fid' => $feed->fid));
    $items = array();
    $feed->items = array();
    foreach ($result as $item) {
      $feed->items[] = $item->iid;
    }
    $feed->item_count = count($feed->items);
    $this->assertEqual($expected_count, $feed->item_count, t('Total items in feed equal to the total items in database (!val1 != !val2)', array('!val1' => $expected_count, '!val2' => $feed->item_count)));
  }

  /**
   * Confirm item removal from a feed.
   *
   * @param $feed
   *   Feed object representing the feed.
   */
  function removeFeedItems($feed) {
    $this->drupalPost('admin/config/services/aggregator/remove/' . $feed->fid, array(), t('Remove items'));
    $this->assertRaw(t('The news items from %title have been removed.', array('%title' => $feed->title)), t('Feed items removed.'));
  }

  /**
   * Add and remove feed items and ensure that the count is zero.
   *
   * @param $feed
   *   Feed object representing the feed.
   * @param $expected_count
   *   Expected number of feed items.
   */
  function updateAndRemove($feed, $expected_count) {
    $this->updateFeedItems($feed, $expected_count);
    $count = db_query('SELECT COUNT(*) FROM {aggregator_item} WHERE fid = :fid', array(':fid' => $feed->fid))->fetchField();
    $this->assertTrue($count);
    $this->removeFeedItems($feed);
    $count = db_query('SELECT COUNT(*) FROM {aggregator_item} WHERE fid = :fid', array(':fid' => $feed->fid))->fetchField();
    $this->assertTrue($count == 0);
  }

  /**
   * Pull feed categories from aggregator_category_feed table.
   *
   * @param $feed
   *   Feed object representing the feed.
   */
  function getFeedCategories($feed) {
    // add the categories to the feed so we can use them
    $result = db_query('SELECT cid FROM {aggregator_category_feed} WHERE fid = :fid', array(':fid' => $feed->fid));
    foreach ($result as $category) {
      $feed->categories[] = $category->cid;
    }
  }

  /**
   * Pull categories from aggregator_category table.
   */
  function getCategories() {
    $categories = array();
    $result = db_query('SELECT * FROM {aggregator_category}');
    foreach ($result as $category) {
      $categories[$category->cid] = $category;
    }
    return $categories;
  }


  /**
   * Check if the feed name and url is unique.
   *
   * @param $feed_name
   *   String containing the feed name to check.
   * @param $feed_url
   *   String containing the feed url to check.
   * @return
   *   TRUE if feed is unique.
   */
  function uniqueFeed($feed_name, $feed_url) {
    $result = db_query("SELECT COUNT(*) FROM {aggregator_feed} WHERE title = :title AND url = :url", array(':title' => $feed_name, ':url' => $feed_url))->fetchField();
    return (1 == $result);
  }

  /**
   * Create a valid OPML file from an array of feeds.
   *
   * @param $feeds
   *   An array of feeds.
   * @return
   *   Path to valid OPML file.
   */
  function getValidOpml($feeds) {
    // Properly escape URLs so that XML parsers don't choke on them.
    foreach ($feeds as &$feed) {
      $feed['url'] = htmlspecialchars($feed['url']);
    }
    /**
     * Does not have an XML declaration, must pass the parser.
     */
    $opml = <<<EOF
<opml version="1.0">
  <head></head>
  <body>
    <!-- First feed to be imported. -->
    <outline text="{$feeds[0]['title']}" xmlurl="{$feeds[0]['url']}" />

    <!-- Second feed. Test string delimitation and attribute order. -->
    <outline xmlurl='{$feeds[1]['url']}' text='{$feeds[1]['title']}'/>

    <!-- Test for duplicate URL and title. -->
    <outline xmlurl="{$feeds[0]['url']}" text="Duplicate URL"/>
    <outline xmlurl="http://duplicate.title" text="{$feeds[1]['title']}"/>

    <!-- Test that feeds are only added with required attributes. -->
    <outline text="{$feeds[2]['title']}" />
    <outline xmlurl="{$feeds[2]['url']}" />
  </body>
</opml>
EOF;

    $path = 'public://valid-opml.xml';
    return file_unmanaged_save_data($opml, $path);
  }

  /**
   * Create an invalid OPML file.
   *
   * @return
   *   Path to invalid OPML file.
   */
  function getInvalidOpml() {
    $opml = <<<EOF
<opml>
  <invalid>
</opml>
EOF;

    $path = 'public://invalid-opml.xml';
    return file_unmanaged_save_data($opml, $path);
  }

  /**
   * Create a valid but empty OPML file.
   *
   * @return
   *   Path to empty OPML file.
   */
  function getEmptyOpml() {
    $opml = <<<EOF
<?xml version="1.0" encoding="utf-8"?>
<opml version="1.0">
  <head></head>
  <body>
    <outline text="Sample text" />
    <outline text="Sample text" url="Sample URL" />
  </body>
</opml>
EOF;

    $path = 'public://empty-opml.xml';
    return file_unmanaged_save_data($opml, $path);
  }

  function getRSS091Sample() {
    return $GLOBALS['base_url'] . '/' . drupal_get_path('module', 'aggregator') . '/tests/aggregator_test_rss091.xml';
  }

  function getAtomSample() {
    // The content of this sample ATOM feed is based directly off of the
    // example provided in RFC 4287.
    return $GLOBALS['base_url'] . '/' . drupal_get_path('module', 'aggregator') . '/tests/aggregator_test_atom.xml';
  }

  function createSampleNodes() {
    $langcode = LANGUAGE_NONE;
    // Post 5 articles.
    for ($i = 0; $i < 5; $i++) {
      $edit = array();
      $edit['title'] = $this->randomName();
      $edit["body[$langcode][0][value]"] = $this->randomName();
      $this->drupalPost('node/add/article', $edit, t('Save'));
    }
  }
}
?>