Repository navigation
Expand file tree
/
Copy pathApi.php
More file actions
111 lines (89 loc) · 3.26 KB
/
Copy pathApi.php
File metadata and controls
111 lines (89 loc) · 3.26 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
<?php
declare(strict_types=1);
namespace Codeception\Template;
use Codeception\InitTemplate;
use Codeception\Module\PhpBrowser;
use Codeception\Util\Template;
use Symfony\Component\Yaml\Yaml;
class Api extends InitTemplate
{
protected string $configTemplate = <<<EOF
# suite config
suites:
Api:
actor: ApiTester
path: .
modules:
enabled:
- REST:
url: {{url}}
depends: PhpBrowser
step_decorators:
- \Codeception\Step\AsJson
paths:
tests: {{baseDir}}
output: {{baseDir}}/_output
data: {{baseDir}}/Support/Data
support: {{baseDir}}/Support
settings:
shuffle: false
lint: true
EOF;
protected string $firstTest = <<<EOF
<?php
namespace {{namespace}};
use {{support_namespace}}\ApiTester;
class ApiCest
{
public function tryApi(ApiTester \$I)
{
\$I->sendGet('/');
\$I->seeResponseCodeIs(200);
\$I->seeResponseIsJson();
}
}
EOF;
public function setup(): void
{
$this->checkInstalled();
$this->say("Let's prepare Codeception for REST API testing");
$this->say('');
$dir = $this->ask("Where tests will be stored?", 'tests');
$url = $this->ask("Start url for tests", "http://localhost/api");
if (!class_exists('\\Codeception\\Module\\REST') || !class_exists(PhpBrowser::class)) {
$this->addModulesToComposer(['REST', 'PhpBrowser']);
}
$this->createDirectoryFor($outputDir = $dir . DIRECTORY_SEPARATOR . '_output');
$this->createDirectoryFor($supportDir = $dir . DIRECTORY_SEPARATOR . 'Support');
$this->createEmptyDirectory($supportDir . DIRECTORY_SEPARATOR . 'Data');
$this->createDirectoryFor($supportDir . DIRECTORY_SEPARATOR . '_generated');
$this->gitIgnore($outputDir);
$this->gitIgnore($supportDir . DIRECTORY_SEPARATOR . '_generated');
$this->sayInfo("Created test directories inside at {$dir}");
$configFile = (new Template($this->configTemplate))
->place('url', $url)
->place('baseDir', $dir)
->produce();
$namespace = rtrim($this->namespace, '\\');
$configFile = "namespace: $namespace\nsupport_namespace: {$this->supportNamespace}\n" . $configFile;
$this->createFile('codeception.yml', $configFile);
$this->createActor('ApiTester', $supportDir, Yaml::parse($configFile)['suites']['api']);
$this->sayInfo("Created global config codeception.yml inside the root directory");
$this->createFile(
$dir . DIRECTORY_SEPARATOR . 'ApiCest.php',
(new Template($this->firstTest))
->place('namespace', $this->namespace)
->place('support_namespace', $this->supportNamespace)
->produce()
);
$this->sayInfo("Created a demo test ApiCest.php");
$this->say();
$this->saySuccess("INSTALLATION COMPLETE");
$this->say();
$this->say("<bold>Next steps:</bold>");
$this->say("1. Edit <bold>{$dir}/ApiCest.php</bold> to write first API tests");
$this->say("2. Run tests using: <comment>codecept run</comment>");
$this->say();
$this->say("<bold>Happy testing!</bold>");
}
}