Skip to content

Commit f70031d

Browse files
schmenglerschmengler
committed
Prepare integration test for varnish purging with mock webserver
1 parent 79ca81c commit f70031d

File tree

7 files changed

+216
-10
lines changed

7 files changed

+216
-10
lines changed

‎.travis.yml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ addons:
1313
language: php
1414
matrix:
1515
include:
16+
- php: 7.2
17+
env:
18+
- MAGENTO_VERSION=2.2
19+
- TEST_SUITE=unit
20+
- php: 7.3
21+
env:
22+
- MAGENTO_VERSION=2.3-develop
23+
- TEST_SUITE=unit
1624
- php: 7.2
1725
env:
1826
- MAGENTO_VERSION=2.2
@@ -33,14 +41,6 @@ matrix:
3341
env:
3442
- MAGENTO_VERSION=2.3-develop
3543
- TEST_SUITE=integration
36-
- php: 7.2
37-
env:
38-
- MAGENTO_VERSION=2.2
39-
- TEST_SUITE=unit
40-
- php: 7.3
41-
env:
42-
- MAGENTO_VERSION=2.3-develop
43-
- TEST_SUITE=unit
4444
env:
4545
global:
4646
- COMPOSER_BIN_DIR=~/bin

‎.travis/before_script.sh‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ cd magento2
2525
composer config minimum-stability dev
2626
composer config repositories.travis_to_test git https://github.com/$TRAVIS_REPO_SLUG.git
2727
#TODO make it work with tags as well:
28+
29+
php .travis/merge-dev.php vendor/$COMPOSER_PACKAGE_NAME/tests/composer.json composer.json
2830
composer require ${COMPOSER_PACKAGE_NAME}:dev-${TRAVIS_BRANCH}\#{$TRAVIS_COMMIT}
2931

3032
# prepare for test suite

‎.travis/merge-dev.php‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php
2+
/*
3+
* Merge autoload-dev and require-dev from one composer.json into another one
4+
*
5+
* This is used to install the module within a Magento 2 installation, but with its dev dependencies
6+
*/
7+
declare(strict_types=1);
8+
9+
$fromFile = $argv[1];
10+
$toFile = $argv[2];
11+
12+
$fromJson = json_decode(file_get_contents($fromFile), true);
13+
$toJson = json_decode(file_get_contents($toFile), true);
14+
15+
foreach ($fromJson['autoload-dev']['psr-4'] ?? [] as $key => $value) {
16+
$pathPrefix = dirname($fromFile) . DIRECTORY_SEPARATOR;
17+
$fromJson['autoload-dev']['psr-4'][$key] = $pathPrefix . $value;
18+
}
19+
20+
$toJson['require-dev'] = array_merge_recursive($toJson['require-dev'] ?? [], $fromJson['require-dev']);
21+
$toJson['autoload-dev'] = array_merge_recursive($toJson['autoload-dev'] ?? [], $fromJson['autoload-dev']);
22+
23+
file_put_contents($toFile, json_encode($toJson, JSON_PRETTY_PRINT));

‎composer.json‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,13 @@
2525
"src/registration.php"
2626
],
2727
"psr-4": {
28-
"IntegerNet\\AsyncVarnish\\": ["src/", "tests/src/"]
28+
"IntegerNet\\AsyncVarnish\\": "src/"
29+
}
30+
},
31+
"autoload-dev": {
32+
"psr-4": {
33+
"IntegerNet\\AsyncVarnish\\Test\\": "tests/",
34+
"IntegerNet\\AsyncVarnish\\": "tests/src/"
2935
}
3036
},
3137
"repositories": [
@@ -35,6 +41,7 @@
3541
}
3642
],
3743
"require-dev": {
38-
"magento/magento-coding-standard": "@dev"
44+
"magento/magento-coding-standard": "@dev",
45+
"react/http": "0.8.5"
3946
}
4047
}

‎tests/Integration/PurgeCacheTest.php‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
<?php
2+
declare(strict_types=1);
3+
4+
namespace IntegerNet\AsyncVarnish\Test\Integration;
5+
6+
use Magento\CacheInvalidate\Model\PurgeCache;
7+
use Magento\Framework\App\DeploymentConfig;
8+
use Magento\TestFramework\Helper\Bootstrap;
9+
use Magento\TestFramework\ObjectManager;
10+
use PHPUnit\Framework\TestCase;
11+
use Symfony\Component\Process\PhpExecutableFinder;
12+
use Symfony\Component\Process\Process;
13+
14+
/**
15+
* @magentoAppIsolation enabled
16+
*/
17+
class PurgeCacheTest extends TestCase
18+
{
19+
/**
20+
* Full path to varnish mock server
21+
*/
22+
private const MOCK_SERVER_DIR = __DIR__ . '/VarnishMock';
23+
/**
24+
* Request log, as written by VarnishMock/server.php
25+
*/
26+
private const REQUEST_LOG_FILE = self::MOCK_SERVER_DIR . '/.requests.log';
27+
/**
28+
* Mock server port as used in VarnishMock/server.php
29+
*/
30+
private const MOCK_SERVER_PORT = '8082';
31+
/**
32+
* @var Process
33+
*/
34+
private $mockServerProcess;
35+
/**
36+
* @var PurgeCache
37+
*/
38+
private $purgeCache;
39+
40+
protected function setUp()
41+
{
42+
$this->startMockServer();
43+
$this->createRequestLog();
44+
45+
$this->configureVarnishHost();
46+
$this->purgeCache = Bootstrap::getObjectManager()->get(PurgeCache::class);
47+
}
48+
49+
private function configureVarnishHost()
50+
{
51+
/** @var ObjectManager $objectManager */
52+
$objectManager = Bootstrap::getObjectManager();
53+
$deploymentConfig = new DeploymentConfig(
54+
$objectManager->get(DeploymentConfig\Reader::class),
55+
['http_cache_hosts' => [['host' => '127.0.0.1', 'port' => self::MOCK_SERVER_PORT]]]
56+
);
57+
$objectManager->addSharedInstance(
58+
$deploymentConfig,
59+
DeploymentConfig::class
60+
);
61+
}
62+
63+
protected function tearDown()
64+
{
65+
$this->stopMockServer();
66+
}
67+
68+
public function testWebserver()
69+
{
70+
$this->assertEquals("OK\n", \file_get_contents('http://127.0.0.1:' . self::MOCK_SERVER_PORT . '/'));
71+
}
72+
73+
public function testPurgeRequestIsSentToVarnish()
74+
{
75+
$tagsPattern = 'XXX|YYY|ZZZZ';
76+
$result = $this->purgeCache->sendPurgeRequest($tagsPattern);
77+
$this->assertTrue($result);
78+
$this->assertEquals(
79+
[
80+
[
81+
'method' => 'PURGE',
82+
'headers' => ['Host' => ['127.0.0.1'], 'X-Magento-Tags-Pattern' => [$tagsPattern]],
83+
],
84+
],
85+
$this->getRequestsFromLog()
86+
);
87+
}
88+
89+
private function startMockServer(): void
90+
{
91+
$objectManager = Bootstrap::getObjectManager();
92+
/** @var PhpExecutableFinder $phpExecutableFinder */
93+
$phpExecutableFinder = $objectManager->get(PhpExecutableFinder::class);
94+
$mockServerCmd = $phpExecutableFinder->find() . ' ' . self::MOCK_SERVER_DIR . '/server.php';
95+
//the following needs Symfony Process >= 4.2.0
96+
// $this->mockServerProcess = Process::fromShellCommandline($mockServerCmd);
97+
//so we use the old way to instantiate Process from string:
98+
$this->mockServerProcess = new Process($mockServerCmd);
99+
$this->mockServerProcess->start();
100+
//the following needs Symfony Process >= 4.2.0
101+
// $this->mockServerProcess->waitUntil(
102+
// function($output) {
103+
// return $output === 'Started';
104+
// }
105+
// );
106+
// so we wait a second instead:
107+
sleep(1);
108+
}
109+
110+
private function stopMockServer(): void
111+
{
112+
// issue: this only kills the parent shell script, not the PHP process (Symfony Process 4.1)
113+
// $this->mockServerProcess->stop();
114+
// so we implemented a kill switch in the server:
115+
$ch = \curl_init('http://127.0.0.1:8082/?kill=1');
116+
\curl_exec($ch);
117+
}
118+
119+
private function createRequestLog(): void
120+
{
121+
\file_put_contents(self::REQUEST_LOG_FILE, '');
122+
\chmod(self::REQUEST_LOG_FILE, 0666);
123+
}
124+
125+
private function getRequestsFromLog(): array
126+
{
127+
$requests = \array_map(
128+
function (string $line): array {
129+
return \json_decode($line, true);
130+
},
131+
\file(self::REQUEST_LOG_FILE)
132+
);
133+
return $requests;
134+
}
135+
}

‎tests/Integration/VarnishMock/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/.requests.log

‎tests/Integration/VarnishMock/server.php‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<?php
2+
declare(strict_types=1);
3+
$autoloadFiles = [__DIR__ . '/../../../vendor/autoload.php', __DIR__ . '/../../../../../autoload.php'];
4+
foreach ($autoloadFiles as $autoloadFile) {
5+
if (stream_resolve_include_path($autoloadFile)) {
6+
require $autoloadFile;
7+
break;
8+
}
9+
}
10+
$loop = \React\EventLoop\Factory::create();
11+
12+
$server = new \React\Http\Server(function (\Psr\Http\Message\ServerRequestInterface $request) {
13+
if ($request->getQueryParams()['kill'] ?? false) {
14+
exit;
15+
}
16+
$requestJson = \json_encode(
17+
[
18+
'method' => $request->getMethod(),
19+
'headers' => $request->getHeaders()
20+
]
21+
);
22+
\file_put_contents(__DIR__ . '/.requests.log', $requestJson . "\n", FILE_APPEND);
23+
24+
return new \React\Http\Response(
25+
200,
26+
array(
27+
'Content-Type' => 'text/plain'
28+
),
29+
"OK\n"
30+
);
31+
});
32+
33+
$socket = new \React\Socket\Server(8082, $loop);
34+
$server->listen($socket);
35+
36+
echo "Started";
37+
38+
$loop->run();

0 commit comments

Comments
 (0)