tests/PHPUnit/Extensions/Database/AbstractTester.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Mike Lively <m@digitalsandwich.com>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.2.0
  45  */
  46
  47 require_once 'PHPUnit/Framework.php';
  48 require_once 'PHPUnit/Util/Filter.php';
  49
  50 require_once 'PHPUnit/Extensions/Database/ITester.php';
  51
  52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  53
  54 /**
  55  * Can be used as a foundation for new DatabaseTesters.
  56  *
  57  * @category   Testing
  58  * @package    PHPUnit
  59  * @author     Mike Lively <m@digitalsandwich.com>
  60  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  61  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  62  * @version    Release: 3.3.17
  63  * @link       http://www.phpunit.de/
  64  * @since      Class available since Release 3.2.0
  65  */
  66 abstract class PHPUnit_Extensions_Database_AbstractTester implements PHPUnit_Extensions_Database_ITester
  67 {
  68
  69     /**
  70      * @var PHPUnit_Extensions_Database_Operation_IDatabaseOperation
  71      */
  72     protected $setUpOperation;
  73
  74     /**
  75      * @var PHPUnit_Extensions_Database_Operation_IDatabaseOperation
  76      */
  77     protected $tearDownOperation;
  78
  79     /**
  80      * @var PHPUnit_Extensions_Database_DataSet_IDataSet
  81      */
  82     protected $dataSet;
  83
  84     /**
  85      * @var string
  86      */
  87     protected $schema;
  88
  89     /**
  90      * Creates a new database tester.
  91      *
  92      * @param PHPUnit_Extensions_Database_DB_IDatabaseConnection $databaseConnection
  93      */
  94     public function __construct()
  95     {
  96         $this->setUpOperation = PHPUnit_Extensions_Database_Operation_Factory::CLEAN_INSERT();
  97         $this->tearDownOperation = PHPUnit_Extensions_Database_Operation_Factory::NONE();
  98     }
  99
 100     /**
 101      * Closes the specified connection.
 102      *
 103      * @param PHPUnit_Extensions_Database_DB_IDatabaseConnection $connection
 104      */
 105     public function closeConnection(PHPUnit_Extensions_Database_DB_IDatabaseConnection $connection)
 106     {
 107         $connection->close();
 108     }
 109
 110     /**
 111      * Returns the test dataset.
 112      *
 113      * @return PHPUnit_Extensions_Database_DataSet_IDataSet
 114      */
 115     public function getDataSet()
 116     {
 117         return $this->dataSet;
 118     }
 119
 120     /**
 121      * TestCases must call this method inside setUp().
 122      */
 123     public function onSetUp()
 124     {
 125         $this->getSetUpOperation()->execute($this->getConnection(), $this->getDataSet());
 126     }
 127
 128     /**
 129      * TestCases must call this method inside tearDown().
 130      */
 131     public function onTearDown()
 132     {
 133         $this->getTearDownOperation()->execute($this->getConnection(), $this->getDataSet());
 134     }
 135
 136     /**
 137      * Sets the test dataset to use.
 138      *
 139      * @param PHPUnit_Extensions_Database_DataSet_IDataSet $dataSet
 140      */
 141     public function setDataSet(PHPUnit_Extensions_Database_DataSet_IDataSet $dataSet)
 142     {
 143         $this->dataSet = $dataSet;
 144     }
 145
 146     /**
 147      * Sets the schema value.
 148      *
 149      * @param string $schema
 150      */
 151     public function setSchema($schema)
 152     {
 153         $this->schema = $schema;
 154     }
 155
 156     /**
 157      * Sets the DatabaseOperation to call when starting the test.
 158      *
 159      * @param PHPUnit_Extensions_Database_Operation_DatabaseOperation $setUpOperation
 160      */
 161     public function setSetUpOperation(PHPUnit_Extensions_Database_Operation_IDatabaseOperation $setUpOperation)
 162     {
 163         $this->setUpOperation = $setUpOperation;
 164     }
 165
 166     /**
 167      * Sets the DatabaseOperation to call when ending the test.
 168      *
 169      * @param PHPUnit_Extensions_Database_Operation_DatabaseOperation $tearDownOperation
 170      */
 171     public function setTearDownOperation(PHPUnit_Extensions_Database_Operation_IDatabaseOperation $tearDownOperation)
 172     {
 173         $this->tearDownOperation = $tearDownOperation;
 174     }
 175
 176     /**
 177      * Returns the schema value
 178      *
 179      * @return string
 180      */
 181     protected function getSchema()
 182     {
 183         return $this->schema;
 184     }
 185
 186     /**
 187      * Returns the database operation that will be called when starting the test.
 188      *
 189      * @return PHPUnit_Extensions_Database_Operation_DatabaseOperation
 190      */
 191     protected function getSetUpOperation()
 192     {
 193         return $this->setUpOperation;
 194     }
 195
 196     /**
 197      * Returns the database operation that will be called when ending the test.
 198      *
 199      * @return PHPUnit_Extensions_Database_Operation_DatabaseOperation
 200      */
 201     protected function getTearDownOperation()
 202     {
 203         return $this->tearDownOperation;
 204     }
 205 }
 206 ?>