<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed'); /** * CodeIgniter * * An open source application development framework for PHP 5.2.4 or newer * * NOTICE OF LICENSE * * Licensed under the Open Software License version 3.0 * * This source file is subject to the Open Software License (OSL 3.0) that is * bundled with this package in the files license.txt / license.rst. It is * also available through the world wide web at this URL: * http://opensource.org/licenses/OSL-3.0 * If you did not receive a copy of the license and are unable to obtain it * through the world wide web, please send an email to * licensing@ellislab.com so we can send you a copy immediately. * * @package CodeIgniter * @author EllisLab Dev Team * @copyright Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/) * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0) * @link http://codeigniter.com * @since Version 1.3.1 * @filesource */ // ------------------------------------------------------------------------ /** * Unit Testing Class * * Simple testing class * * @package CodeIgniter * @subpackage Libraries * @category UnitTesting * @author EllisLab Dev Team * @link http://codeigniter.com/user_guide/libraries/unit_testing.html */ class CI_Unit_test { public $active = TRUE; public $results = array(); public $strict = FALSE; protected $_template = NULL; protected $_template_rows = NULL; protected $_test_items_visible = array(); public function __construct() { // These are the default items visible when a test is run. $this->_test_items_visible = array ( 'test_name', 'test_datatype', 'res_datatype', 'result', 'file', 'line', 'notes' ); log_message('debug', "Unit Testing Class Initialized"); } // -------------------------------------------------------------------- /** * Run the tests * * Runs the supplied tests * * @param array * @return void */ public function set_test_items($items = array()) { if ( ! empty($items) AND is_array($items)) { $this->_test_items_visible = $items; } } // -------------------------------------------------------------------- /** * Run the tests * * Runs the supplied tests * * @param mixed * @param mixed * @param string * @return string */ public function run($test, $expected = TRUE, $test_name = 'undefined', $notes = '') { if ($this->active == FALSE) { return FALSE; } if (in_array($expected, array('is_object', 'is_string', 'is_bool', 'is_true', 'is_false', 'is_int', 'is_numeric', 'is_float', 'is_double', 'is_array', 'is_null'), TRUE)) { $expected = str_replace('is_float', 'is_double', $expected); $result = ($expected($test)) ? TRUE : FALSE; $extype = str_replace(array('true', 'false'), 'bool', str_replace('is_', '', $expected)); } else { $result = ($this->strict == TRUE) ? ($test === $expected) : ($test == $expected); $extype = gettype($expected); } $back = $this->_backtrace(); $report[] = array ( 'test_name' => $test_name, 'test_datatype' => gettype($test), 'res_datatype' => $extype, 'result' => ($result === TRUE) ? 'passed' : 'failed', 'file' => $back['file'], 'line' => $back['line'], 'notes' => $notes ); $this->results[] = $report; return($this->report($this->result($report))); } // -------------------------------------------------------------------- /** * Generate a report * * Displays a table with the test data * * @return string */ public function report($result = array()) { if (count($result) === 0) { $result = $this->result(); } $CI =& get_instance(); $CI->load->language('unit_test'); $this->_parse_template(); $r = ''; foreach ($result as $res) { $table = ''; foreach ($res as $key => $val) { if ($key == $CI->lang->line('ut_result')) { if ($val == $CI->lang->line('ut_passed')) { $val = '<span style="color: #0C0;">'.$val.'</span>'; } elseif ($val == $CI->lang->line('ut_failed')) { $val = '<span style="color: #C00;">'.$val.'</span>'; } } $table .= str_replace(array('{item}', '{result}'), array($key, $val), $this->_template_rows); } $r .= str_replace('{rows}', $table, $this->_template); } return $r; } // -------------------------------------------------------------------- /** * Use strict comparison * * Causes the evaluation to use === rather than == * * @param bool * @return null */ public function use_strict($state = TRUE) { $this->strict = (bool) $state; } // -------------------------------------------------------------------- /** * Make Unit testing active * * Enables/disables unit testing * * @param bool * @return null */ public function active($state = TRUE) { $this->active = (bool) $state; } // -------------------------------------------------------------------- /** * Result Array * * Returns the raw result data * * @return array */ public function result($results = array()) { $CI =& get_instance(); $CI->load->language('unit_test'); if (count($results) === 0) { $results = $this->results; } $retval = array(); foreach ($results as $result) { $temp = array(); foreach ($result as $key => $val) { if ( ! in_array($key, $this->_test_items_visible)) { continue; } if (is_array($val)) { foreach ($val as $k => $v) { if (FALSE !== ($line = $CI->lang->line(strtolower('ut_'.$v)))) { $v = $line; } $temp[$CI->lang->line('ut_'.$k)] = $v; } } else { if (FALSE !== ($line = $CI->lang->line(strtolower('ut_'.$val)))) { $val = $line; } $temp[$CI->lang->line('ut_'.$key)] = $val; } } $retval[] = $temp; } return $retval; } // -------------------------------------------------------------------- /** * Set the template * * This lets us set the template to be used to display results * * @param string * @return void */ public function set_template($template) { $this->_template = $template; } // -------------------------------------------------------------------- /** * Generate a backtrace * * This lets us show file names and line numbers * * @return array */ protected function _backtrace() { if (function_exists('debug_backtrace')) { $back = debug_backtrace(); return array( 'file' => (isset($back[1]['file']) ? $back[1]['file'] : ''), 'line' => (isset($back[1]['line']) ? $back[1]['line'] : '') ); } return array('file' => 'Unknown', 'line' => 'Unknown'); } // -------------------------------------------------------------------- /** * Get Default Template * * @return string */ protected function _default_template() { $this->_template = "\n".'<table style="width:100%; font-size:small; margin:10px 0; border-collapse:collapse; border:1px solid #CCC;">{rows}'."\n".'</table>'; $this->_template_rows = "\n\t<tr>\n\t\t".'<th style="text-align: left; border-bottom:1px solid #CCC;">{item}</th>' . "\n\t\t".'<td style="border-bottom:1px solid #CCC;">{result}</td>'."\n\t</tr>"; } // -------------------------------------------------------------------- /** * Parse Template * * Harvests the data within the template {pseudo-variables} * * @return void */ protected function _parse_template() { if ( ! is_null($this->_template_rows)) { return; } if (is_null($this->_template) OR ! preg_match("/\{rows\}(.*?)\{\/rows\}/si", $this->_template, $match)) { $this->_default_template(); return; } $this->_template_rows = $match[1]; $this->_template = str_replace($match[0], '{rows}', $this->_template); } } // END Unit_test Class /** * Helper functions to test boolean true/false * * @return bool */ function is_true($test) { return (is_bool($test) AND $test === TRUE) ? TRUE : FALSE; } function is_false($test) { return (is_bool($test) AND $test === FALSE) ? TRUE : FALSE; } /* End of file Unit_test.php */ /* Location: ./system/libraries/Unit_test.php */