You are here

Home » API reference » Privatemsg 6.2 » privatemsg_service.test

class PrivatemsgServiceTestCase in Privatemsg 6.2

Tests for services integration.

@todo Rewrite this to use the provided test classes from services 3.x

Hierarchy

Expanded class hierarchy of PrivatemsgServiceTestCase

File

privatemsg_service/privatemsg_service.test, line 13
Privatemsg Services test

View source 
class PrivatemsgServiceTestCase extends DrupalWebTestCase {

  /**
   * getInfo() returns properties that are displayed in the test selection form.
   */
  public static function getInfo() {
    return array(
      'name' => 'Privatemsg Services functionality.',
      'description' => 'Ensure that the Privatemsg services integration functions properly.',
      'group' => 'Privatemsg',
      // Disable services tests for the moment until it is possible to specify
      // versionied dependencies.
      'dependencies' => array(
        'services',
        'services_keyauth',
      ),
    );
  }

  /**
   * setUp() performs any pre-requisite tasks that need to happen.
   */
  public function setUp() {

    // Must include every single module that PM Service module relies on.
    parent::setUp('privatemsg', 'services', 'services_keyauth', 'privatemsg_service');
    $this->fields = variable_get('privatemsg_service_thread_author_fields', array(
      'uid',
      'name',
    ));
  }

  /**
   * Test privatemsg.get service (get messages through services)
   */
  public function testPrivatemsgServiceGet() {

    // Setup 2 users.
    $author = $this
      ->drupalCreateUser(array(
      'write privatemsg',
      'administer services',
      'access administration pages',
    ));
    $recipient = $this
      ->drupalCreateUser(array(
      'administer services',
      'access administration pages',
      'get private messages from remote',
    ));

    // Send 1st message to recipient.
    $subject1 = 'My First Message';
    $body = $this
      ->randomName(20);
    privatemsg_new_thread(array(
      $recipient,
    ), $subject1, $body, array(
      'author' => $author,
    ));

    // Send 2nd message to recipient.
    $subject2 = 'My Second Message';
    $body = $this
      ->randomName(20);
    privatemsg_new_thread(array(
      $recipient,
    ), $subject2, $body, array(
      'author' => $author,
    ));

    // Send 3nd message to author.
    $subject3 = 'My third Message';
    $body = $this
      ->randomName(20);
    privatemsg_new_thread(array(
      $author,
    ), $subject3, $body, array(
      'author' => $author,
    ));
    $this
      ->drupalLogin($recipient);

    // Have recipient click on the "Call method" button to call the method.
    $this
      ->drupalPost('admin/build/services/browse/privatemsg.get', array(), t('Call method'));

    // Make sure the that the 1st messages is returned.
    $this
      ->assertRaw($subject1, t('Verify that the custom title of thread #1 was found'));

    // Make sure the that the 1st messages is returned.
    $this
      ->assertRaw($subject2, t('Verify that the custom title of thread #2 was found'));

    // Verify that ther is an participants array that just contains uid and name.
    $this
      ->assertRaw('[uid] => 3', t('Verify that correct participant uid is shown.'));
    $this
      ->assertRaw('[name] => ' . $author->name, t('Verify that correct participant name is shown.'));
    $this
      ->assertNoText('password', t('No participant password is shown.'));
    $this
      ->drupalLogin($author);

    // Have recipient click on the "Call method" button to call the method.
    $this
      ->drupalPost('admin/build/services/browse/privatemsg.get', array(), t('Call method'));
    $this
      ->assertText(t('Access denied'));
    $this
      ->assertNoText($subject3, t('Messages are not shown without permission.'));
  }

  /**
   * Test privatemsg.getThread service (get thread through service)
   */
  public function testPrivatemsgServiceGetThread() {

    // Setup 2 users
    $author = $this
      ->drupalCreateUser(array(
      'write privatemsg',
    ));
    $recipient = $this
      ->drupalCreateUser(array(
      'administer services',
      'access administration pages',
      'get private messages from remote',
    ));

    // Send 1 message to recipient
    $subject = 'My First Message';
    $body = $this
      ->randomName(20);
    $message = privatemsg_new_thread(array(
      $recipient,
    ), $subject, $body, array(
      'author' => $author,
    ));

    // Have recipient navigate to services browser page for privatemsg.get and call the method.
    $this
      ->drupalLogin($recipient);
    $this
      ->drupalGet('admin/build/services/browse/privatemsg.getThread');

    // Have recipient click on the "Call method" button.
    $edit = array(
      'arg[0]' => $message['message']['thread_id'],
    );
    $this
      ->drupalPost('admin/build/services/browse/privatemsg.getThread', $edit, t('Call method'));

    // Make sure the that 2 messages are returned.
    $this
      ->assertRaw('My First Message', t('Verify that the custom title of thread #1 was found'));
  }

  /**
   * Test privatemsg.unreadCount service (determines the number of unread messages)
   */
  public function testPrivatemsgServiceUnreadCount() {

    // Setup 2 users
    $author = $this
      ->drupalCreateUser(array(
      'write privatemsg',
    ));
    $recipient = $this
      ->drupalCreateUser(array(
      'administer services',
      'access administration pages',
      'get private messages from remote',
    ));

    // Send 2 messages to this user.
    $subject = $this
      ->randomName(20);
    $subject2 = $this
      ->randomName(20);
    $body = $this
      ->randomName(100);
    $body2 = $this
      ->randomName(100);
    $this
      ->pass("Send 2 messages to the recipient.");
    privatemsg_new_thread(array(
      $recipient,
    ), $subject, $body, array(
      'author' => $author,
    ));
    privatemsg_new_thread(array(
      $recipient,
    ), $subject2, $body2, array(
      'author' => $author,
    ));

    // Have recipient navigate to services browser page for privatemsg.unreadCount and call the method.
    $this
      ->drupalLogin($recipient);
    $this
      ->drupalGet('admin/build/services/browse/privatemsg.unreadCount');

    // Have recipient click on the "Call method" button.
    $this
      ->drupalPost('admin/build/services/browse/privatemsg.unreadCount', array(), t('Call method'));

    // Make sure the that 2 messages are returned.
    $this
      ->assertRaw('<h3>Result</h3><code><pre>2</pre></code>', t('Verify that the count of unread messages is "2".'));
  }

  /**
   * Test privatemsg.send service (create a new thread)
   */
  public function testPrivatemsgServiceSend() {

    // Setup 2 users.
    $author_permissions = array(
      'write privatemsg',
      'administer services',
      'access administration pages',
      'send private messages from remote',
    );
    $author = $this
      ->drupalCreateUser($author_permissions);
    $recipient = $this
      ->drupalCreateUser(array(
      'read privatemsg',
    ));

    // Have author navigate to services browser page for privatemsg.send and call the method.
    $this
      ->drupalLogin($author);
    $this
      ->drupalGet('admin/build/services/browse/privatemsg.send');

    // Author sends a message to recipient through services.
    $edit = array(
      'arg[0]' => $recipient->name,
      // Recipient name.
      'arg[1]' => 'Message Subject',
      // Message subject.
      'arg[2]' => 'Body of this messages',
    );
    $this
      ->drupalPost('admin/build/services/browse/privatemsg.send', $edit, t('Call method'));

    // Make sure the reply got sent out successfully.
    $this
      ->assertRaw('<h3>Result</h3><code><pre>1</pre></code>', t('Messages was successfully sent to recipient.'));
  }

  /**
   * Test privatemsg.send service (reply to a thread through services)
   */
  public function testPrivatemsgServiceReply() {

    // Setup 2 users.
    $author_permissions = array(
      'write privatemsg',
      'administer services',
      'access administration pages',
      'get private messages from remote',
    );
    $author = $this
      ->drupalCreateUser($author_permissions);
    $recipient_permissions = array(
      'write privatemsg',
      'administer services',
      'access administration pages',
      'get private messages from remote',
      'send private messages from remote',
    );
    $recipient = $this
      ->drupalCreateUser($recipient_permissions);

    // Author sends a message to recipient.
    $subject = 'My First Message';
    $body = $this
      ->randomName(20);
    $message = privatemsg_new_thread(array(
      $recipient,
    ), $subject, $body, array(
      'author' => $author,
    ));

    // Recipient logs in and navigates to the services admin page to send a message.
    $this
      ->drupalLogin($recipient);
    $this
      ->drupalGet('admin/build/services/browse/privatemsg.reply');

    // Recipient replies to the first thread sent by author.
    $edit = array(
      'arg[0]' => 'This is my reply body.',
      'arg[1]' => $message['message']['thread_id'],
    );
    $this
      ->drupalPost('admin/build/services/browse/privatemsg.reply', $edit, t('Call method'));

    // Make sure the reply got sent out successfully.
    $this
      ->assertRaw('<h3>Result</h3><code><pre>1</pre></code>', t('Reply was successfully sent by recipient.'));

    // Login the author and make sure he received the reply (testing through services call).
    $this
      ->drupalLogin($author);
    $this
      ->drupalGet('admin/build/services/browse/privatemsg.getThread');

    // Have recipient click on the "Call method" button.
    $edit = array(
      'arg[0]' => $message['message']['thread_id'],
    );
    $this
      ->drupalPost('admin/build/services/browse/privatemsg.getThread', $edit, t('Call method'));

    // Make sure the that the reply from the recipient is visible in thread #1.
    $this
      ->assertRaw('This is my reply', t('Verify that author received the reply from recipient.'));
  }

}

Members

Namesort descending Modifiers Type Description 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::$originalPrefix protected property The original database prefix, before it was changed for testing purposes.
DrupalTestCase::$results public property Current results of this test case.
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::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.
DrupalTestCase::errorHandler public function Handle errors during test runs.
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::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 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::$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 (<username>:<password>).
DrupalWebTestCase::$httpauth_method protected property HTTP authentication method
DrupalWebTestCase::$loggedInUser protected property The current user logged in using the internal browser.
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::$profile protected property The profile to install as a basis for testing.
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::$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 does not exist in the current page by the given 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::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's URL matches the given path.
DrupalWebTestCase::buildXPathQuery protected function Builds an XPath query.
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 "Refresh" 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::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 Internal helper function; Create a role with specified permissions.
DrupalWebTestCase::drupalCreateUser protected function Create a user with a given set of permissions. The permissions correspond to the names given on the privileges page.
DrupalWebTestCase::drupalGet protected function Retrieves a Drupal path or an absolute path.
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::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::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::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
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.
DrupalWebTestCase::resetAll protected function Reset all data structures after having enabled new modules.
DrupalWebTestCase::tearDown protected function Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix.
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
PrivatemsgServiceTestCase::getInfo public static function getInfo() returns properties that are displayed in the test selection form.
PrivatemsgServiceTestCase::setUp public function setUp() performs any pre-requisite tasks that need to happen. Overrides DrupalWebTestCase::setUp
PrivatemsgServiceTestCase::testPrivatemsgServiceGet public function Test privatemsg.get service (get messages through services)
PrivatemsgServiceTestCase::testPrivatemsgServiceGetThread public function Test privatemsg.getThread service (get thread through service)
PrivatemsgServiceTestCase::testPrivatemsgServiceReply public function Test privatemsg.send service (reply to a thread through services)
PrivatemsgServiceTestCase::testPrivatemsgServiceSend public function Test privatemsg.send service (create a new thread)
PrivatemsgServiceTestCase::testPrivatemsgServiceUnreadCount public function Test privatemsg.unreadCount service (determines the number of unread messages)