GitHub - beyondcode/laravel-self-diagnosis: Perform Self-Diagnosis Tests On Your...
source link: https://github.com/beyondcode/laravel-self-diagnosis
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
README.md
Perform Self-Diagnosis Tests On Your Laravel Application
This package allows you to run self-diagnosis tests on your Laravel application. It comes with multiple checks out of the box and allows you to add custom checks yourself.
Here is an example output of the command:
Included checks
- Is the APP_KEY set?
- Are your composer dependencies up to date?
- Do you have the correct PHP version installed?
- Do you have the correct PHP extensions installed?
- Can a connection to the database be established?
- Do the
storage
andbootstrap/cache
directories have the correct permissions? - Does the
.env
file exist? - Are there environment variables that exist in
.env.example
but not in.env
? - Are there any migrations that need to be run?
- Is the storage directory linked?
Development environment checks
- Is the configuration not cached?
- Are the routes not cached?
Production environment checks
- Is the configuration cached?
- Are the routes cached?
- Is the xdebug extension disabled?
- Is APP_DEBUG set to false?
Installation
You can install the package via composer:
composer require beyondcode/laravel-self-diagnosis
If you're using Laravel 5.5+ the SelfDiagnosisServiceProvider
will be automatically registered for you.
Usage
Just call the artisan command to start the checks:
php artisan self-diagnosis
Customization
You can publish the configuration file, that contains all available checks using:
php artisan vendor:publish --provider=BeyondCode\\SelfDiagnosis\\SelfDiagnosisServiceProvider
This will publish a self-diagnosis.php
file in your config
folder. This file contains all the checks that will be performed on your application.
<?php return [ /* * List of all the environment names that are considered as "production". */ 'productionEnvironments' => [ 'prod', 'production', ], /* * Common checks that will be performed on all environments. */ 'checks' => [ \BeyondCode\SelfDiagnosis\Checks\AppKeyIsSet::class, \BeyondCode\SelfDiagnosis\Checks\ComposerIsUpToDate::class, \BeyondCode\SelfDiagnosis\Checks\CorrectPhpVersionIsInstalled::class, \BeyondCode\SelfDiagnosis\Checks\DatabaseCanBeAccessed::class, \BeyondCode\SelfDiagnosis\Checks\MigrationsAreUpToDate::class, \BeyondCode\SelfDiagnosis\Checks\PhpExtensionsAreInstalled::class, \BeyondCode\SelfDiagnosis\Checks\EnvFileExists::class, \BeyondCode\SelfDiagnosis\Checks\ExampleEnvironmentVariablesAreSet::class, \BeyondCode\SelfDiagnosis\Checks\DirectoriesHaveCorrectPermissions::class, \BeyondCode\SelfDiagnosis\Checks\StorageDirectoryIsLinked::class, ], /* * Production environment specific checks. */ 'production' => [ \BeyondCode\SelfDiagnosis\Checks\Production\ConfigurationIsCached::class, \BeyondCode\SelfDiagnosis\Checks\Production\RoutesAreCached::class, \BeyondCode\SelfDiagnosis\Checks\Production\XDebugIsNotEnabled::class, \BeyondCode\SelfDiagnosis\Checks\Production\DebugModeIsNotEnabled::class, ], /* * Development environment specific checks. */ 'development' => [ \BeyondCode\SelfDiagnosis\Checks\Development\ConfigurationIsNotCached::class, \BeyondCode\SelfDiagnosis\Checks\Development\RoutesAreNotCached::class, ], ];
Custom Checks
You can create custom checks, by implementing the BeyondCode\SelfDiagnosis\Checks\Check
interface and adding the class to the config file.
Like this:
<?php use BeyondCode\SelfDiagnosis\Checks\Check; class MyCustomCheck implements Check { /** * The name of the check. * * @return string */ public function name(): string { return 'My custom check.'; } /** * Perform the actual verification of this check. * * @return bool */ public function check(): bool { return true; } /** * The error message to display in case the check does not pass. * * @return string */ public function message() : string { return 'This is the error message that users see if "check" returns false.'; } }
Example Output
Testing
composer test
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK