Skip to content

Commit 085d8cf

Browse files
solveratsolverat
committed
add more tester
1 parent c7cf0c9 commit 085d8cf

12 files changed

+1006
-21
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Pimcore Codeception Framework
22

33
This Packages allows you to create fast and simple testing environments.
4-
It's also used by all pimcore Bundles created by [DACHCOM.DIGITAL](https://github.com/dachcom-digital).
4+
It's also used by all pimcore Bundles created by [DACHCOM.DIGITAL](https://github.com/dachcom-digital?q=pimcore-).
55

66
## Configuration
77
All test files needs to be stored in `/tests`.

‎src/_bootstrap.php

+3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
define('PIMCORE_KERNEL_CLASS', '\Dachcom\Codeception\App\TestAppKernel');
1515
define('PIMCORE_TEST', true);
1616

17+
# we need the real asset directory to also test asset protection via acceptance tests!
18+
define('PIMCORE_ASSET_DIRECTORY', PIMCORE_PROJECT_ROOT . '/web/var/assets');
19+
1720
Bootstrap::setProjectRoot();
1821
Bootstrap::bootstrap();
1922

‎src/_support/Helper/Browser/PhpBrowser.php

+240
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,20 @@
77
use Codeception\Exception\ModuleException;
88
use Dachcom\Codeception\Helper\PimcoreCore;
99
use Dachcom\Codeception\Helper\PimcoreUser;
10+
use Dachcom\Codeception\Util\SystemHelper;
11+
use Pimcore\Model\AbstractModel;
12+
use Pimcore\Model\Document\Email;
1013
use Pimcore\Model\User;
14+
use Symfony\Bundle\SwiftmailerBundle\DataCollector\MessageDataCollector;
1115
use Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface;
1216
use Symfony\Component\HttpFoundation\Session\Session;
17+
use Symfony\Component\HttpKernel\DataCollector\RequestDataCollector;
18+
use Symfony\Component\HttpKernel\Kernel;
19+
use Symfony\Component\HttpKernel\Profiler\Profile;
20+
use Symfony\Component\HttpKernel\Profiler\Profiler;
1321
use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
1422
use Symfony\Component\BrowserKit\Cookie;
23+
use Symfony\Component\Security\Core\User\UserInterface;
1524

1625
class PhpBrowser extends Module implements Lib\Interfaces\DependsOnModule
1726
{
@@ -65,6 +74,146 @@ public function amOnPageInEditMode(string $page)
6574
$this->pimcoreCore->amOnPage(sprintf('%s?pimcore_editmode=true', $page));
6675
}
6776

77+
/**
78+
* Actor Function to see if Link is a download file
79+
*
80+
* @param AbstractModel $element
81+
* @param string $link
82+
*/
83+
public function seeDownloadLink(AbstractModel $element, string $link)
84+
{
85+
$this->pimcoreCore->_loadPage('HEAD', $link);
86+
$response = $this->pimcoreCore->client->getInternalResponse();
87+
$headers = $response->getHeaders();
88+
89+
$symfonyVersion = Kernel::MAJOR_VERSION;
90+
$contentDisposition = sprintf('attachment; filename=%s', ($symfonyVersion >= 4 ? $element->getKey() : sprintf('"%s"', $element->getKey())));
91+
92+
$this->assertEquals(200, $response->getStatus());
93+
$this->assertEquals($contentDisposition, $headers['content-disposition'][0]);
94+
$this->assertEquals($element->getMimetype(), $headers['content-type'][0]);
95+
}
96+
97+
/**
98+
* Actor Function to see if Link is a download file
99+
*
100+
* @param string $fileName
101+
* @param string $link
102+
*/
103+
public function seeDownloadLinkZip(string $fileName, string $link)
104+
{
105+
$this->pimcoreCore->_loadPage('HEAD', $link);
106+
$response = $this->pimcoreCore->client->getInternalResponse();
107+
$headers = $response->getHeaders();
108+
109+
$symfonyVersion = Kernel::MAJOR_VERSION;
110+
$contentDisposition = sprintf('attachment; filename=%s', ($symfonyVersion >= 4 ? $fileName : sprintf('"%s"', $fileName)));
111+
112+
$this->assertEquals(200, $response->getStatus());
113+
$this->assertEquals($contentDisposition, $headers['content-disposition'][0]);
114+
$this->assertEquals('application/zip', $headers['content-type'][0]);
115+
}
116+
117+
/**
118+
* Actor Function to see a page generated by a static route definition.
119+
*
120+
* @param string $routeName
121+
* @param array $args
122+
*/
123+
public function amOnStaticRoute(string $routeName, array $args)
124+
{
125+
$path = $this->pimcoreCore->getContainer()->get('router')->generate($routeName, $args, false);
126+
$this->pimcoreCore->amOnPage($path);
127+
}
128+
129+
/**
130+
* Actor Function to see a editable on current page.
131+
*
132+
* @param string $name
133+
* @param string $type
134+
* @param array $options
135+
* @param null $data
136+
* @param null $selector
137+
*/
138+
public function seeAEditableConfiguration(string $name, string $type, array $options, $data = null, $selector = null)
139+
{
140+
$this->pimcoreCore->see(SystemHelper::generateEditableConfiguration($name, $type, $options, $data), $selector);
141+
}
142+
143+
/**
144+
* Actor Function to see if given email has been with specified address
145+
* Only works with PhpBrowser (Symfony Client)
146+
*
147+
* @param string $recipient
148+
* @param Email $email
149+
*/
150+
public function seeEmailIsSentTo(string $recipient, Email $email)
151+
{
152+
$collectedMessages = $this->getCollectedEmails($email);
153+
154+
$recipients = [];
155+
foreach ($collectedMessages as $message) {
156+
if ($email->getSubject() !== $message->getSubject()) {
157+
continue;
158+
}
159+
$recipients = array_merge($recipients, $message->getTo());
160+
}
161+
162+
$this->assertContains($recipient, array_keys($recipients));
163+
164+
}
165+
166+
/**
167+
* Actor Function to see if given email has been sent
168+
*
169+
* @param Email $email
170+
* @param string $property
171+
* @param string $value
172+
*/
173+
public function seeSentEmailHasPropertyValue(Email $email, string $property, string $value)
174+
{
175+
$collectedMessages = $this->getCollectedEmails($email);
176+
177+
$getter = 'get' . ucfirst($property);
178+
foreach ($collectedMessages as $message) {
179+
$getterData = $message->$getter();
180+
if (is_array($getterData)) {
181+
$this->assertContains($value, array_keys($getterData));
182+
} else {
183+
$this->assertEquals($value, $getterData);
184+
}
185+
}
186+
}
187+
188+
/**
189+
* Actor Function to login in FrontEnd
190+
*
191+
* @param UserInterface $user
192+
* @param string $firewallName
193+
*/
194+
public function amLoggedInAsFrontendUser(UserInterface $user, string $firewallName)
195+
{
196+
if (!$user instanceof UserInterface) {
197+
$this->debug(sprintf('[PIMCORE BUNDLE MODULE] user needs to be a instance of %s.', UserInterface::class));
198+
return;
199+
}
200+
201+
/** @var Session $session */
202+
$session = $this->pimcoreCore->getContainer()->get('session');
203+
204+
$token = new UsernamePasswordToken($user, $firewallName, $user->getRoles());
205+
$this->pimcoreCore->getContainer()->get('security.token_storage')->setToken($token);
206+
207+
$session->set('_security_' . $firewallName, serialize($token));
208+
$session->save();
209+
210+
$cookie = new Cookie($session->getName(), $session->getId());
211+
212+
$this->pimcoreCore->client->getCookieJar()->clear();
213+
$this->pimcoreCore->client->getCookieJar()->set($cookie);
214+
215+
}
216+
68217
/**
69218
* Actor Function to login into Pimcore Backend
70219
*
@@ -126,4 +275,95 @@ public function sendTokenAjaxPostRequest(string $url, array $params = [])
126275
$params['csrfToken'] = self::PIMCORE_ADMIN_CSRF_TOKEN_NAME;
127276
$this->pimcoreCore->sendAjaxPostRequest($url, $params);
128277
}
278+
279+
/**
280+
* @param Email $email
281+
*
282+
* @return array
283+
*/
284+
protected function getCollectedEmails(Email $email)
285+
{
286+
$this->assertInstanceOf(Email::class, $email);
287+
288+
/** @var Profiler $profiler */
289+
$profiler = $this->pimcoreCore->_getContainer()->get('profiler');
290+
291+
$tokens = $profiler->find('', '', 1, 'POST', '', '');
292+
if (count($tokens) === 0) {
293+
throw new \RuntimeException('No profile found. Is the profiler data collector enabled?');
294+
}
295+
296+
$token = $tokens[0]['token'];
297+
/** @var Profile $profile */
298+
$profile = $profiler->loadProfile($token);
299+
300+
if (!$profile instanceof Profile) {
301+
throw new \RuntimeException(sprintf('Profile with token "%s" not found.', $token));
302+
}
303+
304+
/** @var MessageDataCollector $mailCollector */
305+
$mailCollector = $profile->getCollector('swiftmailer');
306+
307+
$this->assertGreaterThan(0, $mailCollector->getMessageCount());
308+
309+
$collectedMessages = $mailCollector->getMessages();
310+
311+
$emails = [];
312+
/** @var \Pimcore\Mail $message */
313+
foreach ($collectedMessages as $message) {
314+
if ($email->getProperty('test_identifier') !== $message->getDocument()->getProperty('test_identifier')) {
315+
continue;
316+
}
317+
$emails[] = $message;
318+
}
319+
320+
return $emails;
321+
322+
}
323+
324+
/**
325+
* Actor Function to see if last executed request is in given path
326+
*
327+
* @param string $expectedPath
328+
*/
329+
public function seeLastRequestIsInPath(string $expectedPath)
330+
{
331+
$requestUri = $this->pimcoreCore->client->getInternalRequest()->getUri();
332+
$requestServer = $this->pimcoreCore->client->getInternalRequest()->getServer();
333+
334+
$expectedUri = sprintf('http://%s%s', $requestServer['HTTP_HOST'], $expectedPath);
335+
336+
$this->assertEquals($expectedUri, $requestUri);
337+
}
338+
339+
/**
340+
* Actor Function to check if last _fragment request has given properties in request attributes.
341+
*
342+
* @param array $properties
343+
*/
344+
public function seePropertiesInLastFragmentRequest(array $properties = [])
345+
{
346+
/** @var Profiler $profiler */
347+
$profiler = $this->pimcoreCore->_getContainer()->get('profiler');
348+
349+
$tokens = $profiler->find('', '_fragment', 1, 'GET', '', '');
350+
if (count($tokens) === 0) {
351+
throw new \RuntimeException('No profile found. Is the profiler data collector enabled?');
352+
}
353+
354+
$token = $tokens[0]['token'];
355+
/** @var Profile $profile */
356+
$profile = $profiler->loadProfile($token);
357+
358+
if (!$profile instanceof Profile) {
359+
throw new \RuntimeException(sprintf('Profile with token "%s" not found.', $token));
360+
}
361+
362+
/** @var RequestDataCollector $requestCollector */
363+
$requestCollector = $profile->getCollector('request');
364+
365+
foreach ($properties as $property) {
366+
$this->assertTrue($requestCollector->getRequestAttributes()->has($property), sprintf('"%s" not found in request collector.', $property));
367+
}
368+
}
129369
}

‎src/_support/Helper/Browser/WebDriver.php

+43
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
namespace Dachcom\Codeception\Helper\Browser;
44

55
use Codeception\Module;
6+
use Dachcom\Codeception\Util\FileGeneratorHelper;
7+
use Dachcom\Codeception\Util\SystemHelper;
68

79
class WebDriver extends Module\WebDriver
810
{
@@ -15,4 +17,45 @@ public function amOnPageInEditMode(string $page)
1517
{
1618
$this->amOnPage(sprintf('%s?pimcore_editmode=true', $page));
1719
}
20+
21+
/**
22+
* @param null $path
23+
*/
24+
public function setDownloadPathForWebDriver($path = null)
25+
{
26+
if (is_null($path)) {
27+
$path = FileGeneratorHelper::getDownloadPath();
28+
}
29+
30+
$url = $this->webDriver->getCommandExecutor()->getAddressOfRemoteServer();
31+
$uri = '/session/' . $this->webDriver->getSessionID() . '/chromium/send_command';
32+
$body = [
33+
'cmd' => 'Page.setDownloadBehavior',
34+
'params' => ['behavior' => 'allow', 'downloadPath' => $path]
35+
];
36+
37+
$client = new \GuzzleHttp\Client();
38+
$response = $client->post($url . $uri, ['body' => json_encode($body)]);
39+
40+
try {
41+
$responseData = json_decode($response->getBody()->getContents(), true);
42+
} catch (\Exception $e) {
43+
$responseData = [];
44+
}
45+
46+
$this->assertArrayHasKey('status', $responseData);
47+
$this->assertEquals(0, $responseData['status']);
48+
}
49+
50+
/**
51+
* @param string $name
52+
* @param string $type
53+
* @param array $options
54+
* @param null $data
55+
* @param null $selector
56+
*/
57+
public function seeAEditableConfiguration(string $name, string $type, array $options, $data = null, $selector = null)
58+
{
59+
$this->see(SystemHelper::generateEditableConfiguration($name, $type, $options, $data), $selector);
60+
}
1861
}

0 commit comments

Comments
 (0)