Skip to content

Fix for #2568 #2586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
akrabat merged 17 commits into from
Feb 22, 2019
Merged

Fix for #2568 #2586

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
a7c9da8
add improved cache file writability detection in Router
l0gicgate Feb 20, 2019
349109a
add supporting tests
l0gicgate Feb 20, 2019
cda57b8
add mock router cache file and directory
Feb 20, 2019
34aa7d7
add writable cache file
Feb 20, 2019
6a35031
remove RouterCache directory from tests folder
l0gicgate Feb 20, 2019
ea2c6f1
refactor Router to use isCacheFileWritable()
l0gicgate Feb 20, 2019
0d7b020
refactor tests to use isCacheFileWritable() stub
l0gicgate Feb 20, 2019
5938faf
fix code style error
l0gicgate Feb 20, 2019
ec0ae20
fix code style error in Router
l0gicgate Feb 20, 2019
762f452
fix logic based on further examination of FastRoute cachedDispatcher
l0gicgate Feb 20, 2019
40b6fac
rename $cacheFile to $cacheDir for isCacheDirWritable() method
l0gicgate Feb 20, 2019
33e94ed
remove Router::isCacheFileReadable() and Router::isCacheDirWritable()
l0gicgate Feb 20, 2019
645418e
modify tests for changes to Router
l0gicgate Feb 20, 2019
d4dcb79
fix code style error
l0gicgate Feb 20, 2019
c86ac97
fix code style errors
l0gicgate Feb 20, 2019
7bf8823
change variable assignment for $cacheFile in Router
l0gicgate Feb 21, 2019
b4e7bbf
Rename HeaderFunctions.php to PhpFunctionOverrides.php
akrabat Feb 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions Slim/Router.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,16 +131,22 @@ public function getBasePath()
public function setCacheFile($cacheFile)
{
if (!is_string($cacheFile) && $cacheFile !== false) {
throw new InvalidArgumentException('Router cacheFile must be a string or false');
throw new InvalidArgumentException('Router cache file must be a string or false');
}

$this->cacheFile = $cacheFile;

if ($cacheFile !== false && !is_writable(dirname($cacheFile))) {
throw new RuntimeException('Router cacheFile directory must be writable');
if ($cacheFile && file_exists($cacheFile) && !is_readable($cacheFile)) {
throw new RuntimeException(
sprintf('Router cache file `%s` is not readable', $cacheFile)
);
}

if ($cacheFile && !file_exists($cacheFile) && !is_writable(dirname($cacheFile))) {
throw new RuntimeException(
sprintf('Router cache file directory `%s` is not writable', dirname($cacheFile))
);
}

$this->cacheFile = $cacheFile;
return $this;
}

Expand Down
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
},
"autoload-dev": {
"files": [
"tests/Assets/HeaderFunctions.php"
"tests/Assets/PhpFunctionOverrides.php"
]
},
"scripts": {
Expand Down
28 changes: 28 additions & 0 deletions tests/Assets/HeaderFunctions.php → tests/Assets/PhpFunctionOverrides.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,31 @@ function header($string, $replace = true, $statusCode = null)
]
);
}

Copy link
Member

@akrabat akrabat Feb 21, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should rename this file now that it containers functions other than header functions. Maybe PhpFunctions.php?

/**
* Is a file descriptor writable
*
* @param $file
* @return bool
*/
function is_readable($file)
{
if (stripos($file, 'non-readable.cache') !== false) {
return false;
}
return true;
}

/**
* Is a path writable
*
* @param $path
* @return bool
*/
function is_writable($path)
{
if (stripos($path, 'non-writable-directory') !== false) {
return false;
}
return true;
}
40 changes: 33 additions & 7 deletions tests/RouterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,31 @@
* @copyright Copyright (c) 2011-2017 Josh Lockhart
* @license https://github.com/slimphp/Slim/blob/3.x/LICENSE.md (MIT License)
*/

namespace Slim\Tests;

use Slim\Container;
use Slim\Router;

class RouterTest extends \PHPUnit_Framework_TestCase
{
/** @var Router */
protected $router;

/** @var string */
protected $cacheFile;

public function setUp()
{
$this->router = new Router;
}

public function tearDown()
{
if (file_exists($this->cacheFile)) {
unlink($this->cacheFile);
}
}

public function testMap()
{
$methods = ['GET'];
Expand Down Expand Up @@ -333,24 +343,40 @@ public function testSettingInvalidCacheFileValue()
{
$this->setExpectedException(
'\InvalidArgumentException',
'Router cacheFile must be a string'
'Router cache file must be a string'
);
$this->router->setCacheFile(['invalid']);
}

/**
* Test if cacheFile is not a writable directory
* Test cache file exists but is not writable
*/
public function testSettingInvalidCacheFileNotExisting()
public function testCacheFileExistsAndIsNotReadable()
{
$this->cacheFile = __DIR__ . '/non-readable.cache';
file_put_contents($this->cacheFile, '<?php return []; ?>');

$this->setExpectedException(
'\RuntimeException',
'Router cacheFile directory must be writable'
sprintf('Router cache file `%s` is not readable', $this->cacheFile)
);

$this->router->setCacheFile(
dirname(__FILE__) . uniqid(microtime(true)) . '/' . uniqid(microtime(true))
$this->router->setCacheFile($this->cacheFile);
}

/**
* Test cache file does not exist and directory is not writable
*/
public function testCacheFileDoesNotExistsAndDirectoryIsNotWritable()
{
$cacheFile = __DIR__ . '/non-writable-directory/router.cache';

$this->setExpectedException(
'\RuntimeException',
sprintf('Router cache file directory `%s` is not writable', dirname($cacheFile))
);

$this->router->setCacheFile($cacheFile);
}

/**
Expand Down