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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
/**
* Abstract database handler for integration tests
*/
namespace Magento\TestFramework\Db;
abstract class AbstractDb
{
/**
* DB host name
*
* @var string
*/
protected $_host = '';
/**
* DB credentials -- user name
*
* @var string
*/
protected $_user = '';
/**
* DB credentials -- password
*
* @var string
*/
protected $_password = '';
/**
* DB name
*
* @var string
*/
protected $_schema = '';
/**
* Path to a temporary directory in the file system
*
* @var string
*/
protected $_varPath = '';
/**
* @var \Magento\Framework\Shell
*/
protected $_shell;
/**
* Set initial essential parameters
*
* @param string $host
* @param string $user
* @param string $password
* @param string $schema
* @param string $varPath
* @param \Magento\Framework\Shell $shell
*/
public function __construct($host, $user, $password, $schema, $varPath, \Magento\Framework\Shell $shell)
{
$this->_host = $host;
$this->_user = $user;
$this->_password = $password;
$this->_schema = $schema;
$this->_varPath = $varPath;
$this->_shell = $shell;
}
/**
* Remove all DB objects
*/
abstract public function cleanup();
/**
* Get filename for setup db dump
*
* @return string
*/
abstract protected function getSetupDbDumpFilename();
/**
* Is dump exists
*
* @return bool
*/
abstract public function isDbDumpExists();
/**
* Store setup db dump
*/
abstract public function storeDbDump();
/**
* Restore db from setup db dump
*/
abstract public function restoreFromDbDump();
/**
* @return string
*/
abstract public function getVendorName();
/**
* @return string
*/
public function getSchema()
{
return $this->_schema;
}
/**
* @return string
*/
public function getHost()
{
return $this->_host;
}
/**
* @return string
*/
public function getUser()
{
return $this->_user;
}
/**
* @return string
*/
public function getPassword()
{
return $this->_password;
}
/**
* Create file with sql script content.
* Utility method that is used in children classes
*
* @param string $file
* @param string $content
* @return int
*/
protected function _createScript($file, $content)
{
return file_put_contents($file, $content);
}
/**
* @throws \LogicException
*/
protected function assertVarPathWritable()
{
if (!is_dir($this->_varPath) || !is_writable($this->_varPath)) {
throw new \LogicException("The specified '{$this->_varPath}' is not a directory or not writable.");
}
}
}