Add license info at Friendica PHP files
[friendica.git/.git] / tests / DatabaseTestTrait.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2020, Friendica
4  *
5  * @license GNU AGPL version 3 or any later version
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU Affero General Public License as
9  * published by the Free Software Foundation, either version 3 of the
10  * License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Affero General Public License for more details.
16  *
17  * You should have received a copy of the GNU Affero General Public License
18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
19  *
20  */
21
22 namespace Friendica\Test;
23
24 use Friendica\Database\Database;
25 use Friendica\Test\Util\Database\StaticDatabase;
26
27 /**
28  * Abstract class used by tests that need a database.
29  */
30 trait DatabaseTestTrait
31 {
32         protected function setUp()
33         {
34                 StaticDatabase::statConnect($_SERVER);
35                 // Rollbacks every DB usage (in case the test couldn't call tearDown)
36                 StaticDatabase::statRollback();
37                 // Start the first, outer transaction
38                 StaticDatabase::getGlobConnection()->beginTransaction();
39
40                 parent::setUp();
41         }
42
43         protected function tearDown()
44         {
45                 // Rollbacks every DB usage so we don't commit anything into the DB
46                 StaticDatabase::statRollback();
47
48                 parent::tearDown();
49         }
50
51         /**
52          * Loads a given DB fixture for this DB test
53          *
54          * @param string   $fixture The path to the fixture
55          * @param Database $dba     The DB connection
56          *
57          * @throws \Exception
58          */
59         protected function loadFixture(string $fixture, Database $dba)
60         {
61                 $data = include $fixture;
62
63                 foreach ($data as $tableName => $rows) {
64                         if (!is_array($rows)) {
65                                 $dba->p('TRUNCATE TABLE `' . $tableName . '``');
66                                 continue;
67                         }
68
69                         foreach ($rows as $row) {
70                                 $dba->insert($tableName, $row);
71                         }
72                 }
73         }
74 }