aboutsummaryrefslogtreecommitdiffstats
path: root/tests/unit/UnitTestCase.php
blob: afdaf1c9a9112bcf86ecb21914716876fead5397 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<?php
/* Copyright (c) 2016 Hubzilla
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

namespace Zotlabs\Tests\Unit;

use PHPUnit\Framework\TestCase;

/*
 * Make sure global constants and the global App object is available to the
 * tests.
 */
require_once __DIR__ . '/../../boot.php';
require_once('include/dba/dba_driver.php');

/**
 * @brief Base class for our Unit Tests.
 *
 * Empty class at the moment, but you should extend this class for unit test
 * cases, so we could and for sure we will need to implement basic behaviour
 * for all of our unit tests.
 *
 * @author Klaus Weidenbach
 */
class UnitTestCase extends TestCase {
	private bool $in_transaction = false;

	public static function setUpBeforeClass() : void {
		if ( !\DBA::$dba ) {
			\DBA::dba_factory(
				getenv('HZ_TEST_DB_HOST'),
				getenv('HZ_TEST_DB_PORT', ''),
				getenv('HZ_TEST_DB_USER'),
				getenv('HZ_TEST_DB_PASS'),
				getenv('HZ_TEST_DB_DATABASE'),
				getenv('HZ_TEST_DB_TYPE'),
				getenv('HZ_TEST_DB_CHARSET'),
				false);

			if ( !\DBA::$dba->connected ) {
				throw new \Exception(
					"Unable to connect to db! Error is: "
					. \DBA::$dba->db->errorInfo());
			}
		}
	}

	protected function setUp() : void {
		if ( \DBA::$dba->connected ) {
			// Create a transaction, so that any actions taken by the
			// tests does not change the actual contents of the database.
			$this->in_transaction = \DBA::$dba->db->beginTransaction();
		}
	}

	protected function tearDown() : void {
		if ( \DBA::$dba->connected && $this->in_transaction ) {
			// Roll back the transaction, restoring the db to the
			// state it was before the test was run.
			if ( \DBA::$dba->db->rollBack() ) {
				$this->in_transaction = false;
			} else {
				throw new \Exception(
					"Transaction rollback failed! Error is: "
					. \DBA::$dba->db->errorInfo());
			}
		}
	}
}