VarnishTest::getConfigFile() - Code Metrics - Inspection of "refactor http abstraction" - FriendsOfSymfony/FOSHttpCache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#312)

by David

created 2016-10-15 11:59 UTC

VarnishTest::getConfigFile() A

↳ Parent: VarnishTest

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.1481

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	4
cts	6
cp	0.6667
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	0
crap	2.1481

<?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\Http\HttpDispatcher;
use FOS\HttpCache\ProxyClient\Varnish;
use FOS\HttpCache\Test\Proxy\VarnishProxy;

/**
 * Starts and clears the Varnish proxy between tests.
 *
 * You can define constants in your phpunit to control how this test behaves.
 *
 * Note that the WEB_SERVER_HOSTNAME must also match with what you have in your
 * .vcl file.
 *
 * To define constants in the phpunit file, use this syntax:
 * <php>
 *     <const name="VARNISH_FILE" value="./tests/Functional/Fixtures/varnish-3/fos.vcl" />
 * </php>
 *
 * VARNISH_FILE         Varnish configuration file (required if not passed to setUp)
 * VARNISH_BINARY       executable for Varnish. this can also be the full path
 *                      to the file if the binary is not automatically found
 *                      (default varnishd)
 * VARNISH_PORT         port Varnish listens on (default 6181)
 * VARNISH_MGMT_PORT    Varnish management port (default 6182)
 * VARNISH_CACHE_DIR    directory to use for cache
 *                      (default sys_get_temp_dir() + '/foshttpcache-varnish')
 * WEB_SERVER_HOSTNAME  hostname/IP your application can be reached at (required)
 *
 * If you want to test with Varnish 3, you need to define an environment
 * variable with the varnish version:
 * <php>
 *     <env name="VARNISH_VERSION" value="3" />
 * </php>
 */
trait VarnishTest
{
    /**
     * @var VarnishProxy
     */
    protected $proxy;

    /**
     * @var Varnish
     */
    protected $proxyClient;

    /**
     * Start Varnish and discard any cached content.
     */
    protected function setUp()
    {
        $this->getProxy()->clear();
    }

    /**
     * Stop Varnish.
     */
    protected function tearDown()
    {
        $this->getProxy()->stop();
    }

    /**
     * The default implementation looks at the constant VARNISH_FILE.
     *
     * @throws \Exception
     *
     * @return string the path to the varnish server configuration file to use with this test
     */
    protected function getConfigFile()
    {
        if (!defined('VARNISH_FILE')) {
            throw new \Exception(
                'Specify the varnish configuration file path in phpunit.xml or override getConfigFile()'
            );
        }

        return VARNISH_FILE;
    }

    /**
     * Get Varnish binary.
     *
     * @return string
     */
    protected function getBinary()
    {
        return defined('VARNISH_BINARY') ? VARNISH_BINARY : null;
    }

    /**
     * Get Varnish port.
     *
     * @return int
     */
    protected function getCachingProxyPort()
    {
        return defined('VARNISH_PORT') ? VARNISH_PORT : 6181;
    }

    /**
     * Get Varnish management port.
     *
     * @return int
     */
    protected function getVarnishMgmtPort()
    {
        return defined('VARNISH_MGMT_PORT') ? VARNISH_MGMT_PORT : null;
    }

    /**
     * Get Varnish cache directory.
     *
     * @return string
     */
    protected function getCacheDir()
    {
        return defined('VARNISH_CACHE_DIR') ? VARNISH_CACHE_DIR : null;
    }

    /**
     * Defaults to 4.
     *
     * @return int
     */
    protected function getVarnishVersion()
    {
        return getenv('VARNISH_VERSION') ?: '4.0';
    }

    /**
     * {@inheritdoc}
     */
    protected function getProxy()
    {
        if (null === $this->proxy) {
            $this->proxy = new VarnishProxy($this->getConfigFile());
            if ($this->getBinary()) {
                $this->proxy->setBinary($this->getBinary());
            }

            if ($this->getCachingProxyPort()) {
                $this->proxy->setPort($this->getCachingProxyPort());
            }

            if ($this->getVarnishMgmtPort()) {
                $this->proxy->setManagementPort($this->getVarnishMgmtPort());
            }

            if ($this->getCacheDir()) {
                $this->proxy->setCacheDir($this->getCacheDir());
            }
        }

        return $this->proxy;
    }

    /**
     * Get Varnish proxy client.
     *
     * @return Varnish
     */
    protected function getProxyClient()

    {
        if (null === $this->proxyClient) {
            $httpDispatcher = new HttpDispatcher(
                ['http://127.0.0.1:'.$this->getCachingProxyPort()],
                $this->getHostName().':'.$this->getCachingProxyPort()
            );
            $this->proxyClient = new Varnish($httpDispatcher);
        }

        return $this->proxyClient;
    }

    /**
     * Get the hostname where your application can be reached.
     *
     * @throws \Exception
     *
     * @return string
     */
    protected function getHostName()
    {
        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'
            );
        }

        return WEB_SERVER_HOSTNAME;
    }
}


1			<?php
2
3			/*
4			* This file is part of the FOSHttpCache package.
5			*
6			* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace FOS\HttpCache\Test;
13
14			use FOS\HttpCache\ProxyClient\Http\HttpDispatcher;
15			use FOS\HttpCache\ProxyClient\Varnish;
16			use FOS\HttpCache\Test\Proxy\VarnishProxy;
17
18			/**
19			* Starts and clears the Varnish proxy between tests.
20			*
21			* You can define constants in your phpunit to control how this test behaves.
22			*
23			* Note that the WEB_SERVER_HOSTNAME must also match with what you have in your
24			* .vcl file.
25			*
26			* To define constants in the phpunit file, use this syntax:
27			* <php>
28			* <const name="VARNISH_FILE" value="./tests/Functional/Fixtures/varnish-3/fos.vcl" />
29			* </php>
30			*
31			* VARNISH_FILE Varnish configuration file (required if not passed to setUp)
32			* VARNISH_BINARY executable for Varnish. this can also be the full path
33			* to the file if the binary is not automatically found
34			* (default varnishd)
35			* VARNISH_PORT port Varnish listens on (default 6181)
36			* VARNISH_MGMT_PORT Varnish management port (default 6182)
37			* VARNISH_CACHE_DIR directory to use for cache
38			* (default sys_get_temp_dir() + '/foshttpcache-varnish')
39			* WEB_SERVER_HOSTNAME hostname/IP your application can be reached at (required)
40			*
41			* If you want to test with Varnish 3, you need to define an environment
42			* variable with the varnish version:
43			* <php>
44			* <env name="VARNISH_VERSION" value="3" />
45			* </php>
46			*/
47			trait VarnishTest
48			{
49			/**
50			* @var VarnishProxy
51			*/
52			protected $proxy;
53
54			/**
55			* @var Varnish
56			*/
57			protected $proxyClient;
58
59			/**
60			* Start Varnish and discard any cached content.
61			*/
62	23		protected function setUp()
63	1		{
64	23		$this->getProxy()->clear();
65	23		}
66
67			/**
68			* Stop Varnish.
69			*/
70	23		protected function tearDown()
71			{
72	23		$this->getProxy()->stop();
73	23		}
74
75			/**
76			* The default implementation looks at the constant VARNISH_FILE.
77			*
78			* @throws \Exception
79			*
80			* @return string the path to the varnish server configuration file to use with this test
81			*/
82	10		protected function getConfigFile()
83			{
84	10		if (!defined('VARNISH_FILE')) {
85			throw new \Exception(
86			'Specify the varnish configuration file path in phpunit.xml or override getConfigFile()'
87			);
88	1		}
89
90	10		return VARNISH_FILE;
91			}
92
93			/**
94			* Get Varnish binary.
95			*
96			* @return string
97			*/
98	23		protected function getBinary()
99			{
100	23		return defined('VARNISH_BINARY') ? VARNISH_BINARY : null;
101			}
102
103			/**
104			* Get Varnish port.
105			*
106			* @return int
107			*/
108	23		protected function getCachingProxyPort()
109			{
110	23		return defined('VARNISH_PORT') ? VARNISH_PORT : 6181;
111			}
112
113			/**
114			* Get Varnish management port.
115			*
116			* @return int
117			*/
118	23		protected function getVarnishMgmtPort()
119			{
120	23		return defined('VARNISH_MGMT_PORT') ? VARNISH_MGMT_PORT : null;
121			}
122
123			/**
124			* Get Varnish cache directory.
125			*
126			* @return string
127			*/
128	23		protected function getCacheDir()
129			{
130	23		return defined('VARNISH_CACHE_DIR') ? VARNISH_CACHE_DIR : null;
131			}
132
133			/**
134			* Defaults to 4.
135			*
136			* @return int
137			*/
138	13		protected function getVarnishVersion()
139			{
140	13		return getenv('VARNISH_VERSION') ?: '4.0';
141			}
142
143			/**
144			* {@inheritdoc}
145			*/
146	23		protected function getProxy()
147			{
148	23		if (null === $this->proxy) {
149	23		$this->proxy = new VarnishProxy($this->getConfigFile());
150	23		if ($this->getBinary()) {
151			$this->proxy->setBinary($this->getBinary());
152			}
153
154	23		if ($this->getCachingProxyPort()) {
155	23		$this->proxy->setPort($this->getCachingProxyPort());
156	23		}
157
158	23		if ($this->getVarnishMgmtPort()) {
159			$this->proxy->setManagementPort($this->getVarnishMgmtPort());
160			}
161
162	23		if ($this->getCacheDir()) {
163			$this->proxy->setCacheDir($this->getCacheDir());
164			}
165	23		}
166
167	23		return $this->proxy;
168			}
169
170			/**
171			* Get Varnish proxy client.
172			*
173			* @return Varnish
174			*/
175	10	View Code Duplication	protected function getProxyClient()
			0 ignored issues – show Duplication introduced 2016-10-07 09:27 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
176			{
177	10		if (null === $this->proxyClient) {
178	10		$httpDispatcher = new HttpDispatcher(
179	10		['http://127.0.0.1:'.$this->getCachingProxyPort()],
180	10		$this->getHostName().':'.$this->getCachingProxyPort()
181	10		);
182	10		$this->proxyClient = new Varnish($httpDispatcher);
183	10		}
184
185	10		return $this->proxyClient;
186			}
187
188			/**
189			* Get the hostname where your application can be reached.
190			*
191			* @throws \Exception
192			*
193			* @return string
194			*/
195	23		protected function getHostName()
196			{
197	23		if (!defined('WEB_SERVER_HOSTNAME')) {
198			throw new \Exception(
199			'To use this test, you need to define the WEB_SERVER_HOSTNAME constant in your phpunit.xml'
200			);
201			}
202
203	23		return WEB_SERVER_HOSTNAME;
204			}
205			}
206

FriendsOfSymfony / FOSHttpCache

Pull Request — master (#312)

VarnishTest::getConfigFile() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like