mirror of
https://github.com/silverstripe/silverstripe-environmentcheck
synced 2024-06-28 15:39:47 +02:00
Compare commits
3 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
9881c03c22 | ||
|
e8517ebfb0 | ||
|
28ca036345 |
29
.upgrade.yml
Normal file
29
.upgrade.yml
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
mappings:
|
||||||
|
EnvironmentCheck: SilverStripe\EnvironmentCheck\EnvironmentCheck
|
||||||
|
EnvironmentChecker: SilverStripe\EnvironmentCheck\EnvironmentChecker
|
||||||
|
EnvironmentCheckSuite: SilverStripe\EnvironmentCheck\EnvironmentCheckSuite
|
||||||
|
EnvironmentCheckSuiteResult: SilverStripe\EnvironmentCheck\EnvironmentCheckSuiteResult
|
||||||
|
DatabaseCheck: SilverStripe\EnvironmentCheck\Checks\DatabaseCheck
|
||||||
|
ExternalURLCheck: SilverStripe\EnvironmentCheck\Checks\ExternalURLCheck
|
||||||
|
FileAccessibilityAndValidationCheck: SilverStripe\EnvironmentCheck\Checks\FileAccessibilityAndValidationCheck
|
||||||
|
FileAgeCheck: SilverStripe\EnvironmentCheck\Checks\FileAgeCheck
|
||||||
|
FileWriteableCheck: SilverStripe\EnvironmentCheck\Checks\FileWriteableCheck
|
||||||
|
HasClassCheck: SilverStripe\EnvironmentCheck\Checks\HasClassCheck
|
||||||
|
HasFunctionCheck: SilverStripe\EnvironmentCheck\Checks\HasFunctionCheck
|
||||||
|
SMTPConnectCheck: SilverStripe\EnvironmentCheck\Checks\SMTPConnectCheck
|
||||||
|
SolrIndexCheck: SilverStripe\EnvironmentCheck\Checks\SolrIndexCheck
|
||||||
|
URLCheck: SilverStripe\EnvironmentCheck\Checks\URLCheck
|
||||||
|
DevCheckController: SilverStripe\EnvironmentCheck\Controllers\DevCheckController
|
||||||
|
DevHealthController: SilverStripe\EnvironmentCheck\Controllers\DevHealthController
|
||||||
|
EnvironmentCheckerTest: SilverStripe\EnvironmentCheck\Tests\EnvironmentCheckerTest
|
||||||
|
EnvironmentCheckerTest_CheckNoErrors: SilverStripe\EnvironmentCheck\Tests\EnvironmentCheckerTest_CheckNoErrors
|
||||||
|
EnvironmentCheckerTest_CheckWarnings: SilverStripe\EnvironmentCheck\Tests\EnvironmentCheckerTest_CheckWarnings
|
||||||
|
EnvironmentCheckerTest_CheckErrors: SilverStripe\EnvironmentCheck\Tests\EnvironmentCheckerTest_CheckErrors
|
||||||
|
DatabaseCheckTest: SilverStripe\EnvironmentCheck\Tests\Checks\DatabaseCheckTest
|
||||||
|
ExternalURLCheckTest: SilverStripe\EnvironmentCheck\Tests\Checks\ExternalURLCheckTest
|
||||||
|
FileWritableCheckTest: SilverStripe\EnvironmentCheck\Tests\Checks\FileWritableCheckTest
|
||||||
|
HasClassCheckTest: SilverStripe\EnvironmentCheck\Tests\Checks\HasClassCheckTest
|
||||||
|
HasFunctionCheckTest: SilverStripe\EnvironmentCheck\Tests\Checks\HasFunctionCheckTest
|
||||||
|
URLCheckTest: SilverStripe\EnvironmentCheck\Tests\Checks\URLCheckTest
|
||||||
|
DevCheckControllerTest: SilverStripe\EnvironmentCheck\Tests\Controllers\DevCheckControllerTest
|
||||||
|
DevHealthControllerTest: SilverStripe\EnvironmentCheck\Tests\Controllers\DevHealthControllerTest
|
11
README.md
11
README.md
|
@ -9,6 +9,13 @@ This module adds an API for running environment checks to your API.
|
||||||
* `dev/check` - An admin-only URL that performs a more comprehensive set of checks. This could be tied to a deployment system, for example.
|
* `dev/check` - An admin-only URL that performs a more comprehensive set of checks. This could be tied to a deployment system, for example.
|
||||||
* `dev/check/<suite>` - Check a specific suite (admin only)
|
* `dev/check/<suite>` - Check a specific suite (admin only)
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
* Silverstripe 4.x
|
||||||
|
* PHP 7.3
|
||||||
|
|
||||||
|
For Silverstripe 3.x support, please use a `1.x` tagged release.
|
||||||
|
|
||||||
## Aren't these just unit tests?
|
## Aren't these just unit tests?
|
||||||
|
|
||||||
Almost, but not really. Environment checks differ from unit tests in two important ways:
|
Almost, but not really. Environment checks differ from unit tests in two important ways:
|
||||||
|
@ -19,9 +26,11 @@ Almost, but not really. Environment checks differ from unit tests in two importa
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
composer require silverstripe/environmentcheck
|
$ composer require silverstripe/environmentcheck
|
||||||
```
|
```
|
||||||
|
|
||||||
|
You'll also need to run `/dev/build`.
|
||||||
|
|
||||||
### Activating Directly
|
### Activating Directly
|
||||||
|
|
||||||
Register checks in your own `_config.php` - see the `_config.php` in this module for some defaults. Don't forget to
|
Register checks in your own `_config.php` - see the `_config.php` in this module for some defaults. Don't forget to
|
||||||
|
|
|
@ -20,14 +20,14 @@
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php": "^8.1",
|
"php": "^7.4 || ^8.0",
|
||||||
"silverstripe/framework": "^5",
|
"silverstripe/framework": "^4.10",
|
||||||
"silverstripe/versioned": "^2",
|
"silverstripe/versioned": "^1.0",
|
||||||
"guzzlehttp/guzzle": "^7"
|
"guzzlehttp/guzzle": "^6.3.3 || ^7"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"phpunit/phpunit": "^9.5",
|
"phpunit/phpunit": "^9.5",
|
||||||
"squizlabs/php_codesniffer": "^3"
|
"squizlabs/php_codesniffer": "^3.0"
|
||||||
},
|
},
|
||||||
"extra": [],
|
"extra": [],
|
||||||
"autoload": {
|
"autoload": {
|
||||||
|
|
|
@ -43,7 +43,7 @@ class SolrIndexCheck implements EnvironmentCheck
|
||||||
if (!empty($brokenCores)) {
|
if (!empty($brokenCores)) {
|
||||||
return [
|
return [
|
||||||
EnvironmentCheck::ERROR,
|
EnvironmentCheck::ERROR,
|
||||||
'The following indexes are unavailable: ' . implode($brokenCores ?? '', ', ')
|
'The following indexes are unavailable: ' . implode(', ', $brokenCores)
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -11,6 +11,7 @@ use SilverStripe\Control\HTTPResponse_Exception;
|
||||||
use SilverStripe\Control\RequestHandler;
|
use SilverStripe\Control\RequestHandler;
|
||||||
use SilverStripe\Core\Environment;
|
use SilverStripe\Core\Environment;
|
||||||
use SilverStripe\Core\Injector\Injector;
|
use SilverStripe\Core\Injector\Injector;
|
||||||
|
use SilverStripe\Dev\Deprecation;
|
||||||
use SilverStripe\Security\Member;
|
use SilverStripe\Security\Member;
|
||||||
use SilverStripe\Security\Permission;
|
use SilverStripe\Security\Permission;
|
||||||
use SilverStripe\Security\Security;
|
use SilverStripe\Security\Security;
|
||||||
|
@ -273,4 +274,64 @@ class EnvironmentChecker extends RequestHandler
|
||||||
|
|
||||||
return $this;
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated 2.0.0 Use config API instead
|
||||||
|
* @param string $from
|
||||||
|
*/
|
||||||
|
public static function set_from_email_address($from)
|
||||||
|
{
|
||||||
|
Deprecation::notice('2.0.0', 'Use config API instead');
|
||||||
|
static::config()->set('from_email_address', $from);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated 2.0.0 Use config API instead
|
||||||
|
* @return null|string
|
||||||
|
*/
|
||||||
|
public static function get_from_email_address()
|
||||||
|
{
|
||||||
|
Deprecation::notice('2.0.0', 'Use config API instead');
|
||||||
|
return static::config()->get('from_email_address');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated 2.0.0 Use config API instead
|
||||||
|
* @param string $to
|
||||||
|
*/
|
||||||
|
public static function set_to_email_address($to)
|
||||||
|
{
|
||||||
|
Deprecation::notice('2.0.0', 'Use config API instead');
|
||||||
|
static::config()->set('to_email_address', $to);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated 2.0.0 Use config API instead
|
||||||
|
* @return null|string
|
||||||
|
*/
|
||||||
|
public static function get_to_email_address()
|
||||||
|
{
|
||||||
|
Deprecation::notice('2.0.0', 'Use config API instead');
|
||||||
|
return static::config()->get('to_email_address');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated 2.0.0 Use config API instead
|
||||||
|
* @param bool $results
|
||||||
|
*/
|
||||||
|
public static function set_email_results($results)
|
||||||
|
{
|
||||||
|
Deprecation::notice('2.0.0', 'Use config API instead');
|
||||||
|
static::config()->set('email_results', $results);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated 2.0.0 Use config API instead
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public static function get_email_results()
|
||||||
|
{
|
||||||
|
Deprecation::notice('2.0.0', 'Use config API instead');
|
||||||
|
return static::config()->get('email_results');
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue
Block a user