Preparing functional tests for litespeed integration

Author: Toflar

.travis.yml

@@ -67,6 +67,8 @@ before_script:
   - if [ "$VARNISH_MODULES_VERSION" != "" ]; then sh ./tests/install-varnish-modules.sh; fi
   # Install NGINX
   - sh ./tests/install-nginx.sh
+  # Install OpenLiteSpeed
+  - sh ./tests/install-open-litespeed.sh
 
 script:
   - composer validate --strict --no-check-lock

src/Test/LiteSpeedTest.php

@@ -0,0 +1,120 @@
+<?php
+
+/*
+ * This file is part of the FOSHttpCache package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\HttpCache\Test;
+
+use FOS\HttpCache\ProxyClient\HttpDispatcher;
+use FOS\HttpCache\ProxyClient\LiteSpeed;
+use FOS\HttpCache\Test\Proxy\LiteSpeedProxy;
+
+// TODO: update docs in case anything is configurable
+/**
+ * Starts and clears the LiteSpeed proxy between tests.
+ */
+trait LiteSpeedTest
+{
+    /**
+     * @var LiteSpeed
+     */
+    protected $proxyClient;
+
+    /**
+     * @var LiteSpeedProxy
+     */
+    protected $proxy;
+
+    protected function setUp()
+    {
+        $this->getProxy()->clear();
+    }
+
+    protected function tearDown()
+    {
+        $this->getProxy()->stop();
+    }
+
+    /**
+     * Defaults to "lswsctrl".
+     *
+     * @return string
+     */
+    protected function getBinary()
+    {
+        return defined('LITESPEED_BINARY') ? LITESPEED_BINARY : null;
+    }
+
+    /**
+     * Defaults to 80.
+     *
+     * @return int
+     */
+    protected function getCachingProxyPort()
+    {
+        return defined('LITESPEED_PORT') ? LITESPEED_PORT : 80;
+    }
+
+    /**
+     * Get the hostname where your application can be reached.
+     *
+     * @throws \Exception
+     *
+     * @return string
+     */
+    protected function getHostName()
+    {
+        // @codeCoverageIgnoreStart
+        if (!defined('WEB_SERVER_HOSTNAME')) {
+            throw new \Exception(
+                'To use this test, you need to define the WEB_SERVER_HOSTNAME constant in your phpunit.xml'
+            );
+        }
+        // @codeCoverageIgnoreEnd
+
+        return WEB_SERVER_HOSTNAME;
+    }
+
+    /**
+     * @return LiteSpeedProxy
+     */
+    protected function getProxy()
+    {
+        if (null === $this->proxy) {
+            $this->proxy = new LiteSpeedProxy();
+            $this->proxy->setPort($this->getCachingProxyPort());
+
+            if ($this->getBinary()) {
+                $this->proxy->setBinary($this->getBinary());
+            }
+        }
+
+        return $this->proxy;
+    }
+
+    /**
+     * Get proxy client.
+     *
+     * @return LiteSpeed
+     */
+    protected function getProxyClient($purgeLocation = '')
+    {
+        if (null === $this->proxyClient) {
+            $httpDispatcher = new HttpDispatcher(
+                ['http://127.0.0.1']
+            );
+
+            $this->proxyClient = new LiteSpeed($httpDispatcher, [
+                'document_root' => '/usr/local/lsws/DEFAULT/html',
+            ]);
+        }
+
+        return $this->proxyClient;
+    }
+}

src/Test/LiteSpeedTestCase.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the FOSHttpCache package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\HttpCache\Test;
+
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Abstract test that collects traits necessary for running tests against
+ * LiteSpeed.
+ */
+abstract class LiteSpeedTestCase extends TestCase
+{
+    use CacheAssertions;
+    use HttpCaller;
+    use LiteSpeedTest;
+}

src/Test/Proxy/LiteSpeedProxy.php

@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of the FOSHttpCache package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\HttpCache\Test\Proxy;
+
+class LiteSpeedProxy extends AbstractProxy
+{
+    protected $binary = 'lswsctrl';
+
+    protected $port = 80;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function start()
+    {
+        $this->runCommand(
+            $this->getBinary(),
+            [
+                'start',
+            ]
+        );
+
+        $this->waitFor($this->getIp(), $this->getPort(), 2000);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function stop()
+    {
+        $this->runCommand(
+            $this->getBinary(),
+            [
+                'stop',
+            ]
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function clear()
+    {
+        $this->stop();
+        $this->start();
+    }
+}

tests/Functional/ProxyClient/LiteSpeedProxyClientTest.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the FOSHttpCache package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\HttpCache\Tests\Functional\ProxyClient;
+
+use FOS\HttpCache\Test\LiteSpeedTestCase;
+
+/**
+ * @group webserver
+ * @group litespeed
+ */
+class LiteSpeedProxyClientTest extends LiteSpeedTestCase
+{
+    use PurgeAssertions;
+
+    public function testPurge()
+    {
+        $this->assertPurge($this->getProxyClient());
+    }
+
+    public function testPurgeContentType()
+    {
+        $this->assertPurgeContentType($this->getProxyClient());
+    }
+
+    public function testPurgeHost()
+    {
+        $this->assertPurgeHost($this->getProxyClient(), 'http://localhost:6181');
+    }
+}

tests/install-openlitespeed.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+wget https://openlitespeed.org/packages/openlitespeed-1.4.42.tgz
+tar -zxvf openlitespeed-1.4.42.tgz
+cd openlitespeed
+./install.sh