tonyair
/
silverstripe-externallinks
mirror of https://github.com/silverstripe/silverstripe-externallinks.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update unit tests to be rid of Phockito 

This odd dependency is causing inclusion issues to do with namespacing and
the ability to work well with the framework (according to the dependency's
readme). The usage of the tool in this case adds no value, as it's
performing purely stub type work, rather than mock work. So instead we can
use an actual stub (simply return test values depending on input) and have
everything work well.

After removing the Phockito dependency it was found that the tests that
would skip when it isn't present were actually in a failing state. So they
had to be repaired too, mostly through the use of fixing the poor code
that was causing them to fail (as opposed to being bad tests). This is
both configuration and proceedural work.
This commit is contained in:
Dylan Wagstaff 2017-11-27 15:14:16 +13:00
parent ed7d91becb
commit 98dac9b314
10 changed files with 97 additions and 120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_config/injector.yml
View File

@ -2,7 +2,7 @@
Name: externallinksdependencies
---
SilverStripe\Core\Injector\Injector:
LinkChecker: SilverStripe\ExternalLinks\Tasks\CurlLinkChecker
SilverStripe\ExternalLinks\Tasks\LinkChecker: SilverStripe\ExternalLinks\Tasks\CurlLinkChecker
Psr\SimpleCache\CacheInterface.CurlLinkChecker:
factory: SilverStripe\Core\Cache\CacheFactory
constructor:

8
_config/routes.yml
View File

@ -1,7 +1,7 @@
---
Name: externallink
After: framework/routes
Name: externallinkroutes
Before: '#adminroutes'
---
Director:
SilverStripe\Control\Director:
rules:
'admin/externallinks//$Action': 'CMSExternalLinksController'
'admin/externallinks//$Action': SilverStripe\ExternalLinks\Controllers\CMSExternalLinksController

9
src/Controllers/CMSExternalLinks.php → src/Controllers/CMSExternalLinksController.php
View File

@ -12,7 +12,10 @@ use Symbiote\QueuedJobs\Services\QueuedJobService;
class CMSExternalLinksController extends Controller
{
private static $allowed_actions = array('getJobStatus', 'start');
private static $allowed_actions = [
'getJobStatus',
'start'
];
/**
* Respond to Ajax requests for info on a running job
@ -32,12 +35,12 @@ class CMSExternalLinksController extends Controller
// Format status
$track = BrokenExternalPageTrackStatus::get_latest();
if ($track) {
return json_encode(array(
return json_encode([
'TrackID' => $track->ID,
'Status' => $track->Status,
'Completed' => $track->getCompletedPages(),
'Total' => $track->getTotalPages()
));
]);
}
}

15
src/Model/BrokenExternalLink.php
View File

@ -69,16 +69,17 @@ class BrokenExternalLink extends DataObject
public function getHTTPCodeDescription()
{
$code = $this->HTTPCode;
if (empty($code)) {
try {
$response = HTTPResponse::create('', $code);
// Assume that $code = 0 means there was no response
$description = _t(__CLASS__ . '.NOTAVAILABLE', 'Server Not Available');
} elseif (($descriptions = Config::inst()->get(HTTPResponse::class, 'status_codes'))
&& isset($descriptions[$code])
) {
$description = $descriptions[$code];
} else {
$description = $code ?
$response->getStatusDescription() :
_t(__CLASS__ . '.NOTAVAILABLE', 'Server Not Available');
} catch (InvalidArgumentException $e) {
$description = _t(__CLASS__ . '.UNKNOWNRESPONSE', 'Unknown Response Code');
}
return sprintf("%d (%s)", $code, $description);
}
}

25
src/Reports/BrokenExternalLinksReport.php
View File

@ -2,12 +2,13 @@
namespace SilverStripe\ExternalLinks\Reports;
use SilverStripe\Core\Convert;
use SilverStripe\ExternalLinks\Model\BrokenExternalPageTrackStatus;
use SilverStripe\ORM\ArrayList;
use SilverStripe\View\Requirements;
use SilverStripe\ExternalLinks\Model\BrokenExternalPageTrackStatus;
use SilverStripe\Core\Convert;
use SilverStripe\View\HTML;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Reports\Report;
use SilverStripe\View\Requirements;
/**
* Content side-report listing pages with external broken links
@ -72,7 +73,7 @@ class BrokenExternalLinksReport extends Report
if ($track) {
return $track->BrokenLinks();
}
return new ArrayList();
return ArrayList::create();
}
public function getCMSFields()
@ -81,17 +82,19 @@ class BrokenExternalLinksReport extends Report
$fields = parent::getCMSFields();
$reportResultSpan = '</ br></ br><h3 id="ReportHolder"></h3>';
$reportResult = new LiteralField('ResultTitle', $reportResultSpan);
$reportResult = LiteralField::create('ResultTitle', $reportResultSpan);
$fields->push($reportResult);
$button = '<button id="externalLinksReport" type="button">%s</button>';
$runReportButton = new LiteralField(
'runReport',
sprintf(
$button,
$button = HTML::createTag(
'button',
[
'id' => 'externalLinksReport',
'type' => 'button',
'class' => 'btn btn-primary'
],
_t(__CLASS__ . '.RUNREPORT', 'Create new report')
)
);
$runReportButton = LiteralField::create('runReport', $button);
$fields->push($runReportButton);
return $fields;

24
src/Tasks/CheckExternalLinksTask.php
View File

@ -2,27 +2,23 @@
namespace SilverStripe\ExternalLinks\Tasks;
use DOMNode;
use SilverStripe\Dev\Debug;
use SilverStripe\ExternalLinks\Model\BrokenExternalPageTrack;
use SilverStripe\ExternalLinks\Model\BrokenExternalLink;
use SilverStripe\Core\Config\Config;
use SilverStripe\ExternalLinks\Model\BrokenExternalPageTrack;
use SilverStripe\ExternalLinks\Model\BrokenExternalPageTrackStatus;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ORM\DB;
use SilverStripe\Dev\BuildTask;
use SilverStripe\Core\Config\Config;
use SilverStripe\ORM\DB;
use SilverStripe\Dev\Debug;
use DOMNode;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ExternalLinks\Tasks\LinkChecker;
class CheckExternalLinksTask extends BuildTask
{
private static $dependencies = array(
'LinkChecker' => '%$LinkChecker'
);
private static $dependencies = [
'LinkChecker' => '%$' . LinkChecker::class
];
/**
* @var bool

1
src/Tasks/CurlLinkChecker.php
View File

@ -3,6 +3,7 @@
namespace SilverStripe\ExternalLinks\Tasks;
use Psr\SimpleCache\CacheInterface;
use SilverStripe\Core\Injector\Injector;
/**
* Check links using curl

75
tests/ExternalLinksTest.php
View File

@ -2,16 +2,16 @@
namespace SilverStripe\ExternalLinks\Tests;
use SilverStripe\ExternalLinks\Tasks\LinkChecker;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ExternalLinks\Tasks\CheckExternalLinksTask;
use SilverStripe\ExternalLinks\Model\BrokenExternalPageTrackStatus;
use SilverStripe\i18n\i18n;
use SilverStripe\Reports\Report;
use SilverStripe\ExternalLinks\Reports\BrokenExternalLinksReport;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\ExternalLinks\Model\BrokenExternalPageTrackStatus;
use SilverStripe\ExternalLinks\Tasks\CheckExternalLinksTask;
use SilverStripe\ExternalLinks\Tests\ExternalLinksTestPage;
use Phockito;
use SilverStripe\i18n\i18n;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ExternalLinks\Tasks\LinkChecker;
use SilverStripe\ExternalLinks\Tests\Stubs\PretendLinkChecker;
use SilverStripe\Reports\Report;
use SilverStripe\Dev\SapphireTest;
class ExternalLinksTest extends SapphireTest
{
@ -22,67 +22,12 @@ class ExternalLinksTest extends SapphireTest
ExternalLinksTestPage::class
);
public function setUpOnce()
{
if (class_exists(Phockito::class)) {
Phockito::include_hamcrest(false);
}
parent::setUpOnce();
}
protected function setUp()
{
parent::setUp();
// Check dependencies
if (!class_exists(Phockito::class)) {
$this->skipTest = true;
return $this->markTestSkipped("These tests need the Phockito module installed to run");
}
// Mock link checker
$checker = Phockito::mock(LinkChecker::class);
Phockito::when($checker)
->checkLink('http://www.working.com')
->return(200);
Phockito::when($checker)
->checkLink('http://www.broken.com/url/thing') // 404 on working site
->return(404);
Phockito::when($checker)
->checkLink('http://www.broken.com') // 403 on working site
->return(403);
Phockito::when($checker)
->checkLink('http://www.nodomain.com') // no ping
->return(0);
Phockito::when($checker)
->checkLink('/internal/link')
->return(null);
Phockito::when($checker)
->checkLink('[sitetree_link,id=9999]')
->return(null);
Phockito::when($checker)
->checkLink('home')
->return(null);
Phockito::when($checker)
->checkLink('broken-internal')
->return(null);
Phockito::when($checker)
->checkLink('[sitetree_link,id=1]')
->return(null);
Phockito::when($checker)
->checkLink(Hamcrest_Matchers::anything()) // anything else is 404
->return(404);
// Stub link checker
$checker = new PretendLinkChecker;
Injector::inst()->registerService($checker, LinkChecker::class);
}

28
tests/Stubs/PretendLinkChecker.php Normal file
View File

@ -0,0 +1,28 @@
<?php
namespace SilverStripe\ExternalLinks\Tests\Stubs;
use SilverStripe\ExternalLinks\Tasks\LinkChecker;
class PretendLinkChecker implements LinkChecker
{
public function checkLink($href)
{
switch ($href) {
case 'http://www.working.com':
return 200;
case 'http://www.broken.com':
return 403;
case 'http://www.nodomain.com':
return 0;
case '/internal/link':
case '[sitetree_link,id=9999]':
case 'home':
case 'broken-internal':
case '[sitetree_link,id=1]':
return null;
case 'http://www.broken.com/url/thing':
default:
return 404;
}
}
}