test.php

<?php

/*
 * This software is the property of its authors.
 * See the copyright.txt file for more details.
 *
 */

class unitTestEnvironmentException extends safeException {}
class unitTestRequiredException extends safeException {}

function runSetupTests () {

  $result = (object) array();

  $flushResult = function () use ($result) {
    if (isset($_SERVER['setupTest_result']))
      file_put_contents($_SERVER['setupTest_result'], json_encode($result) . "\n");
  };

  $flushResult();

  $timestamp = microtime(true);
  echo 'Listing files ..';
  $files = array();

  $setupTest_excludePath = array();
  if (isset($_SERVER['setupTest_excludePath'])) {
    $addPaths = function ($paths) use (&$setupTest_excludePath, &$addPaths) {
      if (is_array($paths) || is_object($paths))
        foreach ($paths as $path)
          $addPaths($path);
      else
        $setupTest_excludePath[] = rtrim(str_replace(array('\\', '/'), array('/', '/'), $paths), '/') . '/';
    };
    $addPaths($_SERVER['setupTest_excludePath']);
  }

  $isExcluded = function ($file) use ($setupTest_excludePath) {
    $sFile = str_replace(array('\\', '/'), array('/', '/'), $file);
    foreach ($setupTest_excludePath as $excludePath)
      if (substr($sFile, 0, strlen($excludePath)) == $excludePath)
        return true;
    return false;
  };

  foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($_SERVER['basePath'])) as $file) {

    if (microtime(true) > $timestamp + 1) {
      $timestamp = microtime(true);
      echo '.';
    }

    if ($isExcluded($file))
      continue;

    if (in_array($file->getExtension(), array('php'))) {
      $fileContent = file_get_contents($file);
      if (preg_match('/(?si)function\s*setuptest/', $fileContent) == 0)
        continue;
      $files[] = $file;
    }

  }

  echo ' ' . count($files) . "\n";

  usort($files, function ($lhs, $rhs) {
    return filemtime($rhs) - filemtime($lhs);
  });

  echo 'Including files ..';
  $i = 0;

  // php include can overwrite variable values so we need to isolate include in a function
  $includeFile = function ($file) {
    ob_start();
    include_once (string) $file;
    ob_end_clean();
  };

  foreach ($files as $file) {
    if (microtime(true) > $timestamp + 1) {
      $timestamp = microtime(true);
      echo '.';
    }
    if (in_array(realpath($file), get_included_files()))
      continue;
    $i++;
    $includeFile($file);
  }
  echo ' ' . $i . "\n";

  $tests = array();

  echo 'Listing tests ..';
  $functions = get_defined_functions();
  foreach (array_merge($functions['internal'], $functions['user']) as $function) {
    if (microtime(true) > $timestamp + 1) {
      $timestamp = microtime(true);
      echo '.';
    }
    if (substr(strtolower($function), 0, 9) == 'setuptest')
      $tests[] = $function;
  }

  foreach (get_declared_classes() as $class) {
    foreach (get_class_methods($class) as $method) {
      if (microtime(true) > $timestamp + 1) {
        $timestamp = microtime(true);
        echo '.';
      }
      $reflector = new ReflectionMethod($class, $method);
      if ($reflector->getDeclaringClass()->getName() != $class)
        continue;
      if (substr(strtolower($method), 0, 9) == 'setuptest')
        $tests[] = array($class, $method);
    }
  }

  echo ' ' . count($tests) . "\n";

  $result->tests = (object) array(
    'count' => count($tests),
    'all' => array(),
    'successes' => array(),
    'failures' => array(),
    'errors' => array(),
  );

  usort($tests, function ($lhs, $rhs) {
    $lhsReflection = is_string($lhs) ? new ReflectionFunction($lhs) : new ReflectionMethod($lhs[0], $lhs[1]);
    $rhsReflection = is_string($rhs) ? new ReflectionFunction($rhs) : new ReflectionMethod($rhs[0], $rhs[1]);
    return filemtime($rhsReflection->getFileName()) - filemtime($lhsReflection->getFileName());
  });

  echo "\nRunning " . count($tests) . " tests:\n";

  foreach ($tests as $key => $test) {
    $id = (is_string($test) ? $test : $test[0] . '::' . $test[1]) . '()';
    $result->tests->all[$id] = (object) array('status' => 'unknown');
  }

  $flushResult();

  do {
    $unhandledCount = count($tests);
    foreach ($tests as $key => $test) {
      $id = (is_string($test) ? $test : $test[0] . '::' . $test[1]) . '()';
      echo '  ' . $id;
      try {
        call_user_func($test);
        echo ": success";
        $result->tests->all[$id]->status = 'success';
        $result->tests->successes[] = $id;
        isSetupTestRun($test, true);
      } catch (Exception $e) {
        echo ": failure - " . $e->getMessage();
        $result->tests->all[$id]->status = 'failure';
        $result->tests->all[$id]->report = error_report($e);
        $result->tests->all[$id]->message = $e->getMessage();
        $result->tests->all[$id]->trace = (string) $e;
        $result->tests->failures[] = $id;
        isSetupTestRun($test, false);
      }
      unset($tests[$key]);
      echo "\n";
      $flushResult();
    }
  } while (count($tests) > 0 && count($tests) < $unhandledCount);

  $flushResult();

  echo "\nResults: \n";
  echo "  Total:   " . $result->tests->count . "\n";
  echo "  Success: " . count($result->tests->successes) . "\n";
  echo "  Failure: " . count($result->tests->failures) . "\n";
  echo "  Errors:  " . count($result->tests->errors) . "\n";

  if (count($result->tests->successes) != $result->tests->count)
    echo "\nTests completed with failures, errors or skipped tests !\n\n";
  else
    echo "\nEverything completed successfully !\n\n";

  echo "Done\n";

}

function isSetupTestRun ($test, $set = null) {
  static $runedTests = array();
  $id = (is_string($test) ? $test : $test[0] . '::' . $test[1]) . '()';
  if (isset($set))
    $runedTests[$id] = $set;
  return isset($runedTests[$id]) ? $runedTests[$id] : null;
}

function runUnitTests () {

  $result = (object) array();

  $flushResult = function () use ($result) {
    if (isset($_SERVER['unitTest_result']))
      file_put_contents($_SERVER['unitTest_result'], json_encode($result) . "\n");
  };

  $flushResult();

  $timestamp = microtime(true);
  echo 'Listing files ..';
  $files = array();

  $unitTest_excludePath = array();
  if (isset($_SERVER['unitTest_excludePath'])) {
    $addPaths = function ($paths) use (&$unitTest_excludePath, &$addPaths) {
      if (is_array($paths) || is_object($paths))
        foreach ($paths as $path)
          $addPaths($path);
      else
        $unitTest_excludePath[] = rtrim(str_replace(array('\\', '/'), array('/', '/'), $paths), '/') . '/';
    };
    $addPaths($_SERVER['unitTest_excludePath']);
  }

  $isExcluded = function ($file) use ($unitTest_excludePath) {
    $sFile = str_replace(array('\\', '/'), array('/', '/'), $file);
    foreach ($unitTest_excludePath as $excludePath)
      if (substr($sFile, 0, strlen($excludePath)) == $excludePath)
        return true;
    return false;
  };

  foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($_SERVER['basePath'])) as $file) {

    if (microtime(true) > $timestamp + 1) {
      $timestamp = microtime(true);
      echo '.';
    }

    if ($isExcluded($file))
      continue;

    if (in_array($file->getExtension(), array('php'))) {
      $fileContent = file_get_contents($file);
      if (preg_match('/(?si)function\s*unittest/', $fileContent) == 0)
        continue;
      $files[] = $file;
    }

  }

  echo ' ' . count($files) . "\n";

  usort($files, function ($lhs, $rhs) {
    return filemtime($rhs) - filemtime($lhs);
  });

  echo 'Including files ..';
  $i = 0;

  // php include can overwrite variable values so we need to isolate include in a function
  $includeFile = function ($file) {
    ob_start();
    include_once (string) $file;
    ob_end_clean();
  };

  foreach ($files as $file) {
    if (microtime(true) > $timestamp + 1) {
      $timestamp = microtime(true);
      echo '.';
    }
    if (in_array(realpath($file), get_included_files()))
      continue;
    $i++;
    $includeFile($file);
  }
  echo ' ' . $i . "\n";

  $tests = array();

  echo 'Listing tests ..';
  $functions = get_defined_functions();
  foreach (array_merge($functions['internal'], $functions['user']) as $function) {
    if (microtime(true) > $timestamp + 1) {
      $timestamp = microtime(true);
      echo '.';
    }
    if (substr(strtolower($function), 0, 8) == 'unittest')
      $tests[] = $function;
  }

  foreach (get_declared_classes() as $class) {
    foreach (get_class_methods($class) as $method) {
      if (microtime(true) > $timestamp + 1) {
        $timestamp = microtime(true);
        echo '.';
      }
      $reflector = new ReflectionMethod($class, $method);
      if ($reflector->getDeclaringClass()->getName() != $class)
        continue;
      if (substr(strtolower($method), 0, 8) == 'unittest' && !in_array("$class::$method", array(
        'unitTest_webBrowser::unitTestElement',
        'unitTest_element::unitTestElement',
        'unitTest_webContext::unitTestElement',
        'unitTest_webBrowser::unitTestElements',
        'unitTest_element::unitTestElements',
        'unitTest_webContext::unitTestElements',
      )))
        $tests[] = array($class, $method);
    }
  }

  echo ' ' . count($tests) . "\n";

  $result->tests = (object) array(
    'count' => count($tests),
    'all' => array(),
    'successes' => array(),
    'failures' => array(),
    'errors' => array(),
  );

  usort($tests, function ($lhs, $rhs) {
    $lhsReflection = is_string($lhs) ? new ReflectionFunction($lhs) : new ReflectionMethod($lhs[0], $lhs[1]);
    $rhsReflection = is_string($rhs) ? new ReflectionFunction($rhs) : new ReflectionMethod($rhs[0], $rhs[1]);
    return filemtime($rhsReflection->getFileName()) - filemtime($lhsReflection->getFileName());
  });

  echo "\nRunning " . count($tests) . " tests:\n";

  foreach ($tests as $key => $test) {
    $id = (is_string($test) ? $test : $test[0] . '::' . $test[1]) . '()';
    $result->tests->all[$id] = (object) array('status' => 'unknown');
  }

  $flushResult();

  do {
    $unhandledCount = count($tests);
    foreach ($tests as $key => $test) {
      $id = (is_string($test) ? $test : $test[0] . '::' . $test[1]) . '()';
      echo '  ' . $id;
      try {
        call_user_func($test);
        echo ": success";
        $result->tests->all[$id]->status = 'success';
        $result->tests->successes[] = $id;
        isUnitTestRun($test, true);
      } catch (unitTestRequiredException $e) {
        echo ": delayed";
        $tests[] = $test;
      } catch (unitTestEnvironmentException $e) {
        echo ": error";
        $result->tests->all[$id]->status = 'error';
        $result->tests->all[$id]->report = error_report($e);
        $result->tests->all[$id]->message = $e->getMessage();
        $result->tests->all[$id]->trace = (string) $e;
        $result->tests->errors[] = $id;
        isUnitTestRun($test, false);
      } catch (Exception $e) {
        echo ": failure - " . $e->getMessage();
        $result->tests->all[$id]->status = 'failure';
        $result->tests->all[$id]->report = error_report($e);
        $result->tests->all[$id]->message = $e->getMessage();
        $result->tests->all[$id]->trace = (string) $e;
        $result->tests->failures[] = $id;
        isUnitTestRun($test, false);
      }
      unset($tests[$key]);
      echo "\n";
      $flushResult();
    }
  } while (count($tests) > 0 && count($tests) < $unhandledCount);

  $flushResult();

  echo "\nResults: \n";
  echo "  Total:   " . $result->tests->count . "\n";
  echo "  Success: " . count($result->tests->successes) . "\n";
  echo "  Failure: " . count($result->tests->failures) . "\n";
  echo "  Errors:  " . count($result->tests->errors) . "\n";

  if (count($result->tests->successes) != $result->tests->count)
    echo "\nTests completed with failures, errors or skipped tests !\n\n";
  else
    echo "\nEverything completed successfully !\n\n";

  echo "Done\n";

}

function isUnitTestRun ($test, $set = null) {
  static $runedTests = array();
  $id = (is_string($test) ? $test : $test[0] . '::' . $test[1]) . '()';
  if (isset($set))
    $runedTests[$id] = $set;
  return isset($runedTests[$id]) ? $runedTests[$id] : null;
}

function requireUnitTest () {
  $test = func_get_args();
  $id = (is_string($test) ? $test : $test[0] . '::' . $test[1]) . '()';
  if (!isUnitTestRun($test))
    throw new unitTestRequiredException("Unit test $id required");
}

function webBrowser () {
  static $browser;
  if (!isset($browser)) {
    assertTrue(isset($_SERVER['unitTest_wdUrl']));
    $browser = new unitTest_webBrowser($_SERVER['unitTest_wdUrl']);
  }
  return $browser;
}

class unitTest_webContext {

  protected $browser;
  protected $context;

  function __get ($name) {
    return $this->element($name);
  }

  function __set ($name, $value) {
    assertTrue(false);
  }

  function element ($name) {
    $element = $this->_element($name);
    version_assert and assertTrue($element instanceof unitTest_element);
    version_assert and $i = 0;
    while ($element->hasAttribute('data-alias-this')) {
      version_assert and $i++;
      version_assert and assertTrue($i < 64, 'Infinite loop detected');
      $element = $element->query('//*[@data-mangle="' . $element->attribute('data-alias-this')->value . '"]')->one();
    }
    return $element;
  }

  function _element ($name) {
    version_assert and assertTrue(preg_match('/(?i)^[a-z0-9_\-\[\]]+$/', $name) > 0, "'$name' is not a valid name");

    $this->browser->synchronize();

    if (false) {
    while (true) {
      $elements = $allElements->query('self::*[@data-element="' . $name . '"]');
      if (count($elements) == 0) {
        $allElements = $allElements->query('./*[descendant-or-self::*/@data-element]');
        if (count($allElements) == 0)
          break;
        continue;
      }
      return $elements;
    }
    }

    // temporary optimization
    $elements = $this->query('//*[@data-element="' . $name . '" or @name="' . $name . '"]');
    if (count($elements) == 1)
      return $elements->one();


    if (true) {

    $allElements = $this->query('./*');
    while (true) {
      $elements = $allElements->query('self::*[@data-element="' . $name . '" or @name="' . $name . '"]');
      if (count($elements) == 0) {
        $allElements = $allElements->query('./*[descendant-or-self::*/@data-element or descendant-or-self::*/@name]');
        if (count($allElements) == 0)
          break;
        continue;
      }
      version_assert and assertTrue(count($elements) === 1, 'found ' . count($elements) . " elements, 1 expected");
      return $elements->one();
    }

    }


    assertTrue(false, "Undefined " . get_called_class() . "->$name");
  }

  function hasElement ($name) {
    version_assert and assertTrue(preg_match('/(?i)^[a-z0-9_\-\[\]]+$/', $name) > 0, "'$name' is not a valid name");

    $this->browser->synchronize();

    if (false) {
    while (true) {
      $elements = $allElements->query('self::*[@data-element="' . $name . '"]');
      if (count($elements) == 0) {
        $allElements = $allElements->query('./*[descendant-or-self::*/@data-element]');
        if (count($allElements) == 0)
          break;
        continue;
      }
      return true;
    }
    }

    // temporary optimization
    $elements = $this->query('//*[@data-element="' . $name . '" or @name="' . $name . '"]');
    if (count($elements) == 1)
      return true;


    if (true) {

    $allElements = $this->query('./*');
    while (true) {
      $elements = $allElements->query('self::*[@data-element="' . $name . '" or @name="' . $name . '"]');
      if (count($elements) == 0) {
        $allElements = $allElements->query('./*[descendant-or-self::*/@data-element or descendant-or-self::*/@name]');
        if (count($allElements) == 0)
          break;
        continue;
      }
      return true;
    }

    }


    return false;
  }

  function query ($query) {
    $using = 'cssSelector';
    if (in_array($query, array('.', '..')) || preg_match('/\/|\@|\:\:|\.\./', $query))
      $using = 'xpath';
    $results = $this->context->findElements(call_user_func(array('WebDriverBy', $using), $query));
    $wrappedResults = new unitTest_elements();
    foreach ($results as $result)
      $wrappedResults[] = new unitTest_element($this->browser, $result);
    return $wrappedResults;
  }

  function queryOne ($query) {
    $results = $this->query($query);
    assertTrue(count($results) == 1, 'found ' . count($results) . ' results (1 expected)');
    return $results[0];
  }

  function waitForQuery ($query) {
    $t = microtime(true);
    // todo: is 30 seconds too much ? or not enough ? or wait in some different way ?
    while (microtime(true) < $t + 30) {
      $results = $this->query($query);
      if (count($results) > 0)
        return;
      foreach ($results as $result)
        return;
      usleep(100000);
    }
    throw new Exception("Timeout waiting for query");
  }

  function unitTestElement ($id) {
    $results = $this->query("[data-unit-test-element=$id]");
    if (count($results) == 0)
      $results = $this->query("[unit-test-element=$id]");
    assertTrue(count($results) == 1, 'found ' . count($results) . ' results (1 expected)');
    return $results[0];
  }

  function unitTestElements ($id) {
    $results = $this->query("[data-unit-test-element=$id]");
    if (count($results) == 0)
      $results = $this->query("[unit-test-element=$id]");
    //having empty list should not be an issue
    //assertTrue(count($results) > 0, 'found ' . count($results) . ' results (more then 0 expected)');
    return $results;
  }

  function waitForUnitTestElements ($id) {
    $this->waitForQuery("[data-unit-test-element=$id], [unit-test-element=$id]");
  }

  function click () {
    $context = $this->context;
    $this->_ensureVisible(function () use ($context) {
      $context->click();
    });
    assertTrue(!$this->browser->hasError(), 'Error in page: ' . $this->browser->errorMessage());
    return $this;
  }

  function execute ($script, $arguments = array()) {
    foreach ($arguments as $key => $value)
      if (is_object($value) && $value instanceof unitTest_element)
        $arguments[$key] = (object) array('ELEMENT' => $value->context->getID());
    // hack: double quotes bug
    $script = " var arguments_BaU4UfAZJ7iYW2VmMwpDtpXK = arguments; return eval('(function () { "
      . "arguments = arguments_BaU4UfAZJ7iYW2VmMwpDtpXK; ' + unescape('" . rawurlencode($script) . "') + '})()');";
    return $this->browser->context->executeScript($script, $arguments);
  }

  function exists () {
    try {
      $this->_get_tag();
      return true;
    } catch (ObsoleteElementWebDriverError $e) {
      return false;
    }
    assertTrue(false);
  }

}

class unitTest_webBrowser extends unitTest_webContext {

  private $driver;

  function __construct ($url) {
    try {
      $this->driver = new WebDriver($url, array(WebDriverCapabilityType::BROWSER_NAME => 'firefox'));
      $this->context = $this->driver;
    } catch (WebDriverException $e) {
      throw new unitTestEnvironmentException("Could not open a browser session", 0, $e);
    } catch (WebDriverCurlException $e) {
      throw new unitTestEnvironmentException("Could not open a browser session", 0, $e);
    }
    $this->browser = $this;
  }

  function __destruct () {
    if (isset($this->context))
      $this->context->close();
  }

  function redirect ($url) {
    if (strpos($url, '://') == false) {
      enforce('unitTestEnvironmentException', isset($_SERVER['baseUrl']), "baseUrl not set");
      $url = $_SERVER['baseUrl'] . (substr($url, 0, 1) == '/' ? substr($url, 1) : $url);
    }
    $this->context->get($url);
    assertTrue(!$this->hasError(), 'Error in page: ' . $this->errorMessage());
  }

  function url () {
    return $this->context->getCurrentURL();
  }

  function synchronize () {
    $t = microtime(true);
    $waiter = new WebDriverWait($this->driver);
    $self = $this;
    $waiter->until(function () use ($self) {
      return $self->execute('return typeof(waitForBrowser) == \'undefined\' || !waitForBrowser;');
    }, 'Browser synchronization timeout');
  }

  function close () {
    $this->context->close();
  }

  function source () {
    return $this->context->getPageSource();
  }

  function hasError () {
    return strpos($this->source(), 'error-hmnb9a525V77pG545SXkqmfW') !== false;
  }

  function errorMessage () {
    if (!$this->hasError())
      return 'no error';
    $result = preg_match('/error-hmnb9a525V77pG545SXkqmfW\:\s*"((\\\\"|[^\"])+)"/', $this->source(), $match);
    return $result > 0 ? $match[1] : 'unknown error';
  }

}

class unitTest_elements extends ArrayObject {

  function query ($query) {
    $results = new unitTest_elements();
    foreach ($this as $queryElement)
      foreach ($queryElement->query($query) as $resultElement)
        $results[] = $resultElement;
    return $results;
  }

  function __call ($name, $arguments) {
    assertTrue(count($this) == 1);
    return call_user_func_array(array($this[0], $name), $arguments);
  }

  function __set ($name, $value) {
    assertTrue(count($this) == 1);
    $this[0]->$name = $value;
  }

  function __get ($name) {
    assertTrue(count($this) == 1);
    return $this[0]->$name;
  }

  function one () {
    assertTrue(count($this) == 1, 'found ' . count($this) . ' elements (1 expected)');
    return $this[0];
  }

  function any () {
    return $this[0];
  }

}

class unitTest_element extends unitTest_webContext {

  private $info;

  function __construct ($browser, $context) {
    $this->browser = $browser;
    $this->context = $context;
    $this->info = (object) array();
  }

  function __set ($name, $value) {
    $this->{'_set_' . $name}($value);
  }

  function __get ($name) {

    if (method_exists($this, '_get_' . $name))
      return $this->{'_get_' . $name}();

    return parent::__get($name);
  }

  function _get_tag () {
    return $this->context->getTagName();
  }

  function _get_text () {
    return $this->context->getText();
  }

  function _set_value ($value) {
    $context = $this->context;
    $self = $this;
    $browser = $this->browser;
    $this->_ensureVisible(function () use ($self, $browser, $context, $value) {
      $browser->execute('arguments[0].value = "";', array($self));
      $context->sendKeys($value);
    });
  }

  function _get_value () {
    return $this->context->getAttribute('value');
  }

  function _get_displayed () {
    return $this->context->isDisplayed();
  }

  function hasAttribute ($name) {
    return $this->context->getAttribute($name) !== null;
  }

  function attribute ($name) {
    return new unitTest_attribute($this->context->getAttribute($name));
  }

  function select () {
    assertTrue($this->_get_tag() == 'option');
    $select = $this->queryOne('..');
    assertTrue($select->_get_tag() == 'select');
    $option = $this;
    $select->_ensureVisible(function () use ($option) {
      $option->click();
    });
  }

  function _ensureVisible ($f) {
    assertTrue(is_callable($f));
    if ($this->displayed) {
      $f();
      return;
    }
    $state = (object) array(
      'display' => $this->context->getCSSValue('display'),
      'visibility' => $this->context->getCSSValue('visibility'),
      'hiddenInput' => $this->_get_tag() == 'input' && $this->attribute('type')->value == 'hidden',
    );

    try {
      if ($state->display == 'none' || $state->visibility == 'hidden')
        $this->browser->execute('arguments[0].style.display = "block"; arguments[0].style.visibility = "visible";',
          array($this));
      if ($state->hiddenInput)
        $this->browser->execute('arguments[0].type = "text";', array($this));
      // todo: rewrite
      if ($this->_get_tag() != 'html')
        $parentCollection = $this->query('..');
      if (!isset($parentCollection) || count($parentCollection) == 0)
        $f();
      else
        $parentCollection->one()->_ensureVisible($f);
      $e = null;
    } catch (Exception $e) {}
    // finally {
    // we don't care if the elements disappear in the meantime, we only want to make sure
    // to hide set their visibility state as it was if they still exist
    if ($this->exists()) {
      if ($state->display == 'none' || $state->visibility == 'hidden')
        $this->browser->execute('arguments[0].style.display = ' . json_encode($state->display)
          . '; arguments[0].style.visibility = ' . json_encode($state->visibility) . ';', array($this));
       if ($state->hiddenInput)
        $this->browser->execute('arguments[0].type = "hidden";', array($this));
    }
    // }
    if (isset($e))
      throw $e;
  }

  function moveTo () {
    $this->browser->context->moveto(array('element' => $this->context->getID()));
  }

}

class unitTest_attribute {

  public $value;

  function __construct ($value) {
    $this->value = $value;
  }

  function __toString () {
    try {
      return $this->value;
    } catch (Exception $e) {
      // __toString is not allowed to throw an exception
      return (string) $e;
    }
  }

}