Prevented entity "Not Found" events from being logged

- Added testing to cover, which was more hassle than thought
  since Laravel did not have built in log test helpers, so:
- Added Log testing helper.

Related to #2110
This commit is contained in:
Dan Brown 2020-05-23 11:26:48 +01:00
parent bf4a3b73f8
commit 19bfc8ad37
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
5 changed files with 55 additions and 6 deletions

View File

@ -77,6 +77,13 @@ return [
'driver' => 'monolog', 'driver' => 'monolog',
'handler' => NullHandler::class, 'handler' => NullHandler::class,
], ],
// Testing channel
// Uses a shared testing instance during tests
// so that logs can be checked against.
'testing' => [
'driver' => 'testing',
],
], ],
]; ];

View File

@ -9,7 +9,6 @@ use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler; use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Illuminate\Http\JsonResponse; use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request; use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Illuminate\Validation\ValidationException; use Illuminate\Validation\ValidationException;
use Symfony\Component\HttpKernel\Exception\HttpException; use Symfony\Component\HttpKernel\Exception\HttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
@ -26,6 +25,7 @@ class Handler extends ExceptionHandler
HttpException::class, HttpException::class,
ModelNotFoundException::class, ModelNotFoundException::class,
ValidationException::class, ValidationException::class,
NotFoundException::class,
]; ];
/** /**

View File

@ -3,6 +3,7 @@
<description>The coding standard for BookStack.</description> <description>The coding standard for BookStack.</description>
<file>app</file> <file>app</file>
<exclude-pattern>*/migrations/*</exclude-pattern> <exclude-pattern>*/migrations/*</exclude-pattern>
<exclude-pattern>*/tests/*</exclude-pattern>
<arg value="np"/> <arg value="np"/>
<rule ref="PSR2"/> <rule ref="PSR2"/>
</ruleset> </ruleset>

View File

@ -1,5 +1,8 @@
<?php namespace Tests; <?php namespace Tests;
use BookStack\Entities\Book;
use Illuminate\Support\Facades\Log;
class ErrorTest extends TestCase class ErrorTest extends TestCase
{ {
@ -18,4 +21,21 @@ class ErrorTest extends TestCase
$notFound->assertDontSeeText('Log in'); $notFound->assertDontSeeText('Log in');
$notFound->assertSeeText('tester'); $notFound->assertSeeText('tester');
} }
public function test_item_not_found_does_not_get_logged_to_file()
{
$this->actingAs($this->getViewer());
$handler = $this->withTestLogger();
$book = Book::query()->first();
// Ensure we're seeing errors
Log::error('cat');
$this->assertTrue($handler->hasErrorThatContains('cat'));
$this->get('/books/arandomnotfouindbook');
$this->get($book->getUrl('/chapter/arandomnotfouindchapter'));
$this->get($book->getUrl('/chapter/arandomnotfouindpages'));
$this->assertCount(1, $handler->getRecords());
}
} }

View File

@ -16,7 +16,10 @@ use BookStack\Entities\Repos\PageRepo;
use BookStack\Settings\SettingService; use BookStack\Settings\SettingService;
use BookStack\Uploads\HttpFetcher; use BookStack\Uploads\HttpFetcher;
use Illuminate\Support\Env; use Illuminate\Support\Env;
use Illuminate\Support\Facades\Log;
use Mockery; use Mockery;
use Monolog\Handler\TestHandler;
use Monolog\Logger;
use Throwable; use Throwable;
trait SharedTestHelpers trait SharedTestHelpers
@ -69,14 +72,14 @@ trait SharedTestHelpers
} }
/** /**
* Get an instance of a user with 'viewer' permissions * Get an instance of a user with 'viewer' permissions.
* @param $attributes
* @return mixed
*/ */
protected function getViewer($attributes = []) protected function getViewer(array $attributes = []): User
{ {
$user = Role::getRole('viewer')->users()->first(); $user = Role::getRole('viewer')->users()->first();
if (!empty($attributes)) $user->forceFill($attributes)->save(); if (!empty($attributes)) {
$user->forceFill($attributes)->save();
}
return $user; return $user;
} }
@ -277,4 +280,22 @@ trait SharedTestHelpers
$this->assertStringStartsWith('You do not have permission to access', $error); $this->assertStringStartsWith('You do not have permission to access', $error);
} }
/**
* Set a test handler as the logging interface for the application.
* Allows capture of logs for checking against during tests.
*/
protected function withTestLogger(): TestHandler
{
$monolog = new Logger('testing');
$testHandler = new TestHandler();
$monolog->pushHandler($testHandler);
Log::extend('testing', function() use ($monolog) {
return $monolog;
});
Log::setDefaultDriver('testing');
return $testHandler;
}
} }