<?php
// $Id: simpletest.test,v 1.1.2.1 2008-08-06 01:41:06 boombatower Exp $

class SimpleTestTestCase extends DrupalWebTestCase {
  protected $results;

  /**
   * Implementation of getInfo().
   */
  function getInfo() {
    return array(
      'name' => t('SimpleTest functionality'),
      'description' => t('Test SimpleTest\'s web interface: check that the intended tests were
                          run and ensure that test reports display the intended results. Also
                          test SimpleTest\'s internal browser and API\'s both explicitly and
                          implicitly.'),
      'group' => t('SimpleTest')
    );
  }

  /**
   * Implementation of setUp().
   */
  function setUp() {
    if (!$this->inCURL()) {
      parent::setUp('simpletest');

      // Create and login user
      $admin_user = $this->drupalCreateUser(array('administer unit tests'));
      $this->drupalLogin($admin_user);
    }
    else {
      parent::setUp();
    }
  }

  /**
   * Test the internal browsers functionality.
   */
  function testInternalBrowser() {
    global $conf;
    if (!$this->inCURL()) {
      $this->drupalGet('node');
      $this->assertTitle(variable_get('site_name', 'Drupal'), t('Site title matches.'));
      // Make sure that we are locked out of the installer when prefixing
      // using the user-agent header. This is an important security check.
      global $base_url;

      $this->drupalGet($base_url . '/install.php', array('external' => TRUE));
      $this->assertResponse(403, 'Cannot access install.php with a "simpletest" user-agent header.');
    }
  }

  /**
   * Make sure that tests selected through the web interface are run and
   * that the results are displayed correctly.
   */
  function testWebTestRunner() {
    $this->pass = t('SimpleTest pass.');
    $this->fail = t('SimpleTest fail.');
    $this->valid_permission = 'access content';
    $this->invalid_permission = 'invalid permission';

    if ($this->inCURL()) {
      // Only run following code if this test is running itself through a CURL request.
      $this->stubTest();
    }
    else {
      // Run this test from web interface.
      $this->drupalGet('admin/build/testing');

      $edit = array();
      $edit['SimpleTestTestCase'] = TRUE;
      $this->drupalPost(NULL, $edit, t('Run tests'));

      $this->getTestResults();

      $this->confirmStubTestResults();
    }
  }

  /**
   * Test to be run and the results confirmed.
   */
  function stubTest() {
    $this->pass($this->pass);
    $this->fail($this->fail);

    $this->drupalCreateUser(array($this->valid_permission));
    $this->drupalCreateUser(array($this->invalid_permission));
  }

  /**
   * Confirm that the stub test produced the desired results.
   */
  function confirmStubTestResults() {
    $this->assertAssertion($this->pass, 'Other', 'Pass');
    $this->assertAssertion($this->fail, 'Other', 'Fail');

    $this->assertAssertion(t('Created permissions: @perms', array('@perms' => $this->valid_permission)), 'Role', 'Pass');
    $this->assertAssertion(t('Invalid permission %permission.', array('%permission' => $this->invalid_permission)), 'Role', 'Fail');
  }

  /**
   * Assert that an assertion with the specified values is displayed
   * in the test results.
   *
   * @param string $message Assertion message.
   * @param string $type Assertion type.
   * @param string $status Assertion status.
   * @return Assertion result.
   */
  function assertAssertion($message, $type, $status) {
    $message = trim(strip_tags($message));
    $found = FALSE;
    foreach ($this->results['assertions'] as $assertion) {
      if ($assertion['message'] == $message &&
          $assertion['type'] == $type &&
          $assertion['status'] == $status) {
        $found = TRUE;
        break;
      }
    }
    return $this->assertTrue($found, t('Found assertion {"@message", "@type", "@status"}.', array('@message' => $message, '@type' => $type, '@status' => $status)));
  }

  /**
   * Get the results from a test and store them in the class array $results.
   */
  function getTestResults() {
    $results = array();

    if ($this->parse()) {
      if ($fieldset = $this->getResultFieldSet()) {
        // Code assumes this is the only test in group.
        $results['summary'] = $this->asText($fieldset->div);
        $results['name'] = $this->asText($fieldset->fieldset->legend);

        $results['assertions'] = array();
        $tbody = $fieldset->fieldset->table->tbody;
        foreach ($tbody->tr as $row) {
          $assertion = array();
          $assertion['message'] = $this->asText($row->td[0]);
          $assertion['type'] = $this->asText($row->td[1]);
          $ok_url = (url('misc/watchdog-ok.png') == 'misc/watchdog-ok.png') ? 'misc/watchdog-ok.png' : (base_path() . 'misc/watchdog-ok.png');
          $assertion['status'] = ($row->td[5]->img['src'] == $ok_url) ? 'Pass' : 'Fail';
          $results['assertions'][] = $assertion;
        }
      }
    }
    $this->results = $results;
  }

  /**
   * Get the fieldset containing the results for group this test is in.
   *
   * @return fieldset containing the results for group this test is in.
   */
  function getResultFieldSet() {
    $fieldsets = $this->elements->xpath('//fieldset');
    $info = $this->getInfo();
    foreach ($fieldsets as $fieldset) {
      if ($fieldset->legend == $info['group']) {
        return $fieldset;
      }
    }
    return FALSE;
  }

  /**
   * Extract the text contained by the element.
   *
   * @param $element
   *   Element to extract text from.
   * @return
   *   Extracted text.
   */
  function asText(SimpleXMLElement $element) {
    if (!is_object($element)) {
      return $this->fail('The element is not an element.');
    }
    return trim(strip_tags($element->asXML()));
  }

  /**
   * Check if the test is being run from inside a CURL request.
   *
   * @return The test is being run from inside a CURL request.
   */
  function inCURL() {
    return preg_match("/^simpletest\d+/", $_SERVER['HTTP_USER_AGENT']);
  }
}