Repository navigation
Expand file tree
/
Copy pathBootstrap.php
More file actions
248 lines (216 loc) · 8.62 KB
/
Copy pathBootstrap.php
File metadata and controls
248 lines (216 loc) · 8.62 KB
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<?php
namespace Codeception\Command;
use Codeception\Lib\Generator\Helper;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Yaml\Yaml;
use Symfony\Component\Console\Question\Question;
/**
* Creates default config, tests directory and sample suites for current project. Use this command to start building a test suite.
*
* By default it will create 3 suites **acceptance**, **functional**, and **unit**.
*
* * `codecept bootstrap` - creates `tests` dir and `codeception.yml` in current dir.
* * `codecept bootstrap --empty` - creates `tests` dir without suites
* * `codecept bootstrap --namespace Frontend` - creates tests, and use `Frontend` namespace for actor classes and helpers.
* * `codecept bootstrap --actor Wizard` - sets actor as Wizard, to have `TestWizard` actor in tests.
* * `codecept bootstrap path/to/the/project` - provide different path to a project, where tests should be placed
*
*/
class Bootstrap extends Command
{
// defaults
protected $namespace = '';
protected $actorSuffix = 'Tester';
protected $supportDir = 'tests/_support';
protected $logDir = 'tests/_output';
protected $dataDir = 'tests/_data';
protected $envsDir = 'tests/_envs';
protected function configure()
{
$this->setDefinition(
[
new InputArgument('path', InputArgument::OPTIONAL, 'custom installation path', '.'),
new InputOption('namespace', 'ns', InputOption::VALUE_OPTIONAL, 'Namespace to add for actor classes and helpers'),
new InputOption('actor', 'a', InputOption::VALUE_OPTIONAL, 'Custom actor instead of Tester'),
new InputOption('empty', 'e', InputOption::VALUE_NONE, 'Don\'t create standard suites')
]
);
}
public function getDescription()
{
return "Creates default test suites and generates all requires files";
}
public function execute(InputInterface $input, OutputInterface $output)
{
if ($input->getOption('namespace')) {
$this->namespace = trim($input->getOption('namespace'), '\\') . '\\';
}
if ($input->getOption('actor')) {
$this->actorSuffix = $input->getOption('actor');
}
$path = $input->getArgument('path');
if (!is_dir($path)) {
$output->writeln("<error>\nDirectory '$path' does not exist\n</error>");
return;
}
$realpath = realpath($path);
chdir($path);
if (file_exists('codeception.yml')) {
$output->writeln("<error>\nProject is already initialized in '$path'\n</error>");
return;
}
$output->writeln(
"<fg=white;bg=magenta> Initializing Codeception in " . $realpath . " </fg=white;bg=magenta>\n"
);
$this->createGlobalConfig();
$output->writeln("File codeception.yml created <- global configuration");
$this->createDirs();
if (!$input->getOption('empty')) {
$this->createUnitSuite();
$output->writeln("tests/unit created <- unit tests");
$output->writeln("tests/unit.suite.yml written <- unit tests suite configuration");
$this->createFunctionalSuite();
$output->writeln("tests/functional created <- functional tests");
$output->writeln("tests/functional.suite.yml written <- functional tests suite configuration");
$this->createAcceptanceSuite();
$output->writeln("tests/acceptance created <- acceptance tests");
$output->writeln("tests/acceptance.suite.yml written <- acceptance tests suite configuration");
}
if (file_exists('.gitignore')) {
file_put_contents('tests/_output/.gitignore', '');
file_put_contents('.gitignore', file_get_contents('.gitignore') . "\ntests/_output/*");
$output->writeln("tests/_output was added to .gitignore");
}
$output->writeln(" --- ");
$this->ignoreFolderContent('tests/_output');
file_put_contents('tests/_bootstrap.php', "<?php\n// This is global bootstrap for autoloading\n");
$output->writeln("tests/_bootstrap.php written <- global bootstrap file");
$output->writeln("<info>Building initial {$this->actorSuffix} classes</info>");
$this->getApplication()->find('build')->run(
new ArrayInput(['command' => 'build']),
$output
);
$output->writeln("<info>\nBootstrap is done. Check out " . $realpath . "/tests directory</info>");
}
public function createGlobalConfig()
{
$basicConfig = [
'actor' => $this->actorSuffix,
'paths' => [
'tests' => 'tests',
'log' => $this->logDir,
'data' => $this->dataDir,
'support' => $this->supportDir,
'envs' => $this->envsDir,
],
'settings' => [
'bootstrap' => '_bootstrap.php',
'colors' => (strtoupper(substr(PHP_OS, 0, 3)) != 'WIN'),
'memory_limit' => '1024M'
],
'extensions' => [
'enabled' => ['Codeception\Extension\RunFailed']
],
'modules' => [
'config' => [
'Db' => [
'dsn' => '',
'user' => '',
'password' => '',
'dump' => 'tests/_data/dump.sql'
]
]
]
];
$str = Yaml::dump($basicConfig, 4);
if ($this->namespace) {
$namespace = rtrim($this->namespace, '\\');
$str = "namespace: $namespace\n" . $str;
}
file_put_contents('codeception.yml', $str);
}
protected function createFunctionalSuite($actor = 'Functional')
{
$suiteConfig = <<<EOF
# Codeception Test Suite Configuration
#
# Suite for functional (integration) tests
# Emulate web requests and make application process them
# Include one of framework modules (Symfony2, Yii2, Laravel5) to use it
class_name: $actor{$this->actorSuffix}
modules:
enabled:
# add framework module here
- \\{$this->namespace}Helper\Functional
EOF;
$this->createSuite('functional', $actor, $suiteConfig);
}
protected function createAcceptanceSuite($actor = 'Acceptance')
{
$suiteConfig = <<<EOF
# Codeception Test Suite Configuration
#
# Suite for acceptance tests.
# Perform tests in browser using the WebDriver or PhpBrowser.
# If you need both WebDriver and PHPBrowser tests - create a separate suite.
class_name: $actor{$this->actorSuffix}
modules:
enabled:
- PhpBrowser:
url: http://localhost/myapp
- \\{$this->namespace}Helper\Acceptance
EOF;
$this->createSuite('acceptance', $actor, $suiteConfig);
}
protected function createUnitSuite($actor = 'Unit')
{
$suiteConfig = <<<EOF
# Codeception Test Suite Configuration
#
# Suite for unit (internal) tests.
class_name: $actor{$this->actorSuffix}
modules:
enabled:
- Asserts
- \\{$this->namespace}Helper\Unit
EOF;
$this->createSuite('unit', $actor, $suiteConfig);
}
protected function createSuite($suite, $actor, $config)
{
@mkdir("tests/$suite");
file_put_contents(
"tests/$suite/_bootstrap.php",
"<?php\n// Here you can initialize variables that will be available to your tests\n"
);
@mkdir($this->supportDir . DIRECTORY_SEPARATOR . "Helper");
file_put_contents(
$this->supportDir . DIRECTORY_SEPARATOR . "Helper" . DIRECTORY_SEPARATOR . "$actor.php",
(new Helper($actor, rtrim($this->namespace, '\\')))->produce()
);
file_put_contents("tests/$suite.suite.yml", $config);
}
protected function ignoreFolderContent($path)
{
if (file_exists('.gitignore')) {
file_put_contents("{$path}/.gitignore", "*\n!.gitignore");
}
}
protected function createDirs()
{
@mkdir('tests');
@mkdir($this->logDir);
@mkdir($this->dataDir);
@mkdir($this->supportDir);
@mkdir($this->envsDir);
file_put_contents(
$this->dataDir . '/dump.sql',
'/* Replace this file with actual dump of your database */'
);
}
}