325 lines
9.6 KiB
PHP
325 lines
9.6 KiB
PHP
<?php
|
|
|
|
namespace MailPoet\Test\Cron;
|
|
|
|
use Codeception\Stub;
|
|
use AspectMock\Test as Mock;
|
|
use MailPoet\Cron\CronHelper;
|
|
use MailPoet\Cron\DaemonHttpRunner;
|
|
use MailPoet\Models\Setting;
|
|
use MailPoet\WP\Functions as WPFunctions;
|
|
|
|
class CronHelperTest extends \MailPoetTest {
|
|
function _before() {
|
|
parent::_before();
|
|
Setting::setValue('db_version', MAILPOET_VERSION);
|
|
// Disable cron trigger to not run tasks like migration when pinging the daemon
|
|
Setting::setValue('cron_trigger', array(
|
|
'method' => 'none'
|
|
));
|
|
Setting::setValue('sender', array(
|
|
'name' => 'John Doe',
|
|
'address' => 'john.doe@example.com'
|
|
));
|
|
}
|
|
|
|
function testItDefinesConstants() {
|
|
expect(CronHelper::DAEMON_EXECUTION_LIMIT)->equals(20);
|
|
expect(CronHelper::DAEMON_EXECUTION_TIMEOUT)->equals(35);
|
|
expect(CronHelper::DAEMON_REQUEST_TIMEOUT)->equals(5);
|
|
expect(CronHelper::DAEMON_SETTING)->equals('cron_daemon');
|
|
}
|
|
|
|
function testItCreatesDaemon() {
|
|
$token = 'create_token';
|
|
$time = time();
|
|
CronHelper::createDaemon($token);
|
|
$daemon = Setting::getValue(CronHelper::DAEMON_SETTING);
|
|
expect($daemon)->equals(
|
|
array(
|
|
'token' => $token,
|
|
'status' => CronHelper::DAEMON_STATUS_ACTIVE,
|
|
'updated_at' => $time,
|
|
'run_accessed_at' => null,
|
|
'run_started_at' => null,
|
|
'run_completed_at' => null,
|
|
'last_error' => null,
|
|
)
|
|
);
|
|
}
|
|
|
|
function testItRestartsDaemon() {
|
|
$token = 'restart_token';
|
|
$time = time();
|
|
CronHelper::restartDaemon($token);
|
|
$daemon = Setting::getValue(CronHelper::DAEMON_SETTING);
|
|
expect($daemon)->equals(
|
|
array(
|
|
'token' => $token,
|
|
'status' => CronHelper::DAEMON_STATUS_ACTIVE,
|
|
'updated_at' => $time,
|
|
'run_accessed_at' => null,
|
|
'run_started_at' => null,
|
|
'run_completed_at' => null,
|
|
'last_error' => null,
|
|
)
|
|
);
|
|
}
|
|
|
|
function testItLoadsDaemon() {
|
|
$daemon = $this->getDeamonTestData();
|
|
Setting::setValue(
|
|
CronHelper::DAEMON_SETTING,
|
|
$daemon
|
|
);
|
|
expect(CronHelper::getDaemon())->equals($daemon);
|
|
}
|
|
|
|
function testItSavesDaemon() {
|
|
// when saving daemon, 'updated_at' value should change
|
|
$daemon = $this->getDeamonTestData();
|
|
Setting::setValue(
|
|
CronHelper::DAEMON_SETTING,
|
|
$daemon
|
|
);
|
|
$time = time();
|
|
CronHelper::saveDaemon($daemon);
|
|
$daemon['updated_at'] = $time;
|
|
expect(CronHelper::getDaemon())->equals($daemon);
|
|
}
|
|
|
|
function testItUpdatesDaemonAccessedAt() {
|
|
$daemon = $this->getDeamonTestData();
|
|
Setting::setValue(
|
|
CronHelper::DAEMON_SETTING,
|
|
$daemon
|
|
);
|
|
$time = time();
|
|
Mock::double('MailPoet\Cron\CronHelper', ['queryCronUrl' => []]);
|
|
CronHelper::accessDaemon('some_token');
|
|
$updated_daemon = CronHelper::getDaemon();
|
|
expect($updated_daemon['run_accessed_at'])->greaterOrEquals($time);
|
|
expect($updated_daemon['run_accessed_at'])->lessThan($time + 2);
|
|
}
|
|
|
|
function testItThrowsAnExceptionIfAccessingNonExistingDaemon() {
|
|
try {
|
|
CronHelper::accessDaemon('some_token');
|
|
$this->fail('An exception should have been thrown.');
|
|
} catch (\LogicException $e) {
|
|
expect($e->getMessage())->equals('Daemon does not exist.');
|
|
}
|
|
}
|
|
|
|
function testItDetectsNotAccessibleDaemon() {
|
|
$time = time();
|
|
$run_start_values = [null, $time - 20];
|
|
foreach($run_start_values as $run_start) {
|
|
$daemon = $this->getDeamonTestData();
|
|
$daemon['run_accessed_at'] = $time - 10;
|
|
$daemon['run_started_at'] = $run_start;
|
|
Setting::setValue(
|
|
CronHelper::DAEMON_SETTING,
|
|
$daemon
|
|
);
|
|
expect(CronHelper::isDaemonAccessible())->false();
|
|
}
|
|
}
|
|
|
|
function testItDetectsAccessibleDaemon() {
|
|
$time = time();
|
|
$daemon = $this->getDeamonTestData();
|
|
$daemon['run_accessed_at'] = $time - 5;
|
|
$daemon['run_started_at'] = $time - 4;
|
|
Setting::setValue(
|
|
CronHelper::DAEMON_SETTING,
|
|
$daemon
|
|
);
|
|
expect(CronHelper::isDaemonAccessible())->true();
|
|
}
|
|
|
|
function testItDetectsUnknownStateOfTheDaemon() {
|
|
$time = time();
|
|
$test_inputs = [
|
|
[
|
|
'run_access' => null,
|
|
'run_start' => null,
|
|
],
|
|
[
|
|
'run_access' => $time - 4,
|
|
'run_start' => null,
|
|
],
|
|
[
|
|
'run_access' => $time - 4,
|
|
'run_start' => $time - 10,
|
|
],
|
|
null,
|
|
];
|
|
foreach($test_inputs as $test_input) {
|
|
$daemon = $this->getDeamonTestData();
|
|
$daemon['run_accessed_at'] = $test_input['run_access'];
|
|
$daemon['run_started_at'] = $test_input['run_start'];
|
|
Setting::setValue(
|
|
CronHelper::DAEMON_SETTING,
|
|
$daemon
|
|
);
|
|
expect(CronHelper::isDaemonAccessible())->null();
|
|
}
|
|
}
|
|
|
|
function testItDeactivatesDaemon() {
|
|
$daemon = $this->getDeamonTestData();
|
|
Setting::setValue(
|
|
CronHelper::DAEMON_SETTING,
|
|
$daemon
|
|
);
|
|
|
|
CronHelper::deactivateDaemon($daemon);
|
|
$daemon = CronHelper::getDaemon();
|
|
expect($daemon['status'])->equals(CronHelper::DAEMON_STATUS_INACTIVE);
|
|
}
|
|
|
|
function testItSavesLastError() {
|
|
$daemon = $this->getDeamonTestData();
|
|
Setting::setValue(
|
|
CronHelper::DAEMON_SETTING,
|
|
$daemon
|
|
);
|
|
|
|
CronHelper::saveDaemonLastError('error');
|
|
$daemon = CronHelper::getDaemon();
|
|
expect($daemon['last_error'])->equals('error');
|
|
}
|
|
|
|
|
|
function testItSavesRunCompletedAt() {
|
|
$daemon = $this->getDeamonTestData();
|
|
Setting::setValue(
|
|
CronHelper::DAEMON_SETTING,
|
|
$daemon
|
|
);
|
|
|
|
CronHelper::saveDaemonRunCompleted(123);
|
|
$daemon = CronHelper::getDaemon();
|
|
expect($daemon['run_completed_at'])->equals(123);
|
|
}
|
|
|
|
function testItCreatesRandomToken() {
|
|
// random token is a string of 5 characters
|
|
$token1 = CronHelper::createToken();
|
|
$token2 = CronHelper::createToken();
|
|
expect($token1)->notEquals($token2);
|
|
expect(is_string($token1))->true();
|
|
expect(strlen($token1))->equals(5);
|
|
}
|
|
|
|
function testItGetsSiteUrl() {
|
|
// 1. do nothing when the url does not contain port
|
|
$site_url = 'http://example.com';
|
|
expect(CronHelper::getSiteUrl($site_url))->equals($site_url);
|
|
|
|
if(getenv('WP_TEST_ENABLE_NETWORK_TESTS') !== 'true') return;
|
|
|
|
// 2. when url contains valid port, try connecting to it
|
|
$site_url = 'http://example.com:80';
|
|
expect(CronHelper::getSiteUrl($site_url))->equals($site_url);
|
|
|
|
// 3. when url contains invalid port, try connecting to it. when connection fails,
|
|
// another attempt will be made to connect to the standard port derived from URL schema
|
|
$site_url = 'http://example.com:8080';
|
|
expect(CronHelper::getSiteUrl($site_url))->equals('http://example.com');
|
|
|
|
// 4. when connection can't be established, exception should be thrown
|
|
$site_url = 'https://invalid:80';
|
|
try {
|
|
CronHelper::getSiteUrl($site_url);
|
|
self::fail('Site URL is unreachable exception not thrown.');
|
|
} catch(\Exception $e) {
|
|
expect($e->getMessage())->equals('Site URL is unreachable.');
|
|
}
|
|
}
|
|
|
|
function testItGetsSubsiteUrlOnMultisiteEnvironment() {
|
|
if((boolean)getenv('MULTISITE') === true) {
|
|
expect(CronHelper::getSiteUrl())->contains(getenv('WP_TEST_MULTISITE_SLUG'));
|
|
}
|
|
}
|
|
|
|
function testItEnforcesExecutionLimit() {
|
|
$time = microtime(true);
|
|
expect(CronHelper::enforceExecutionLimit($time))->null();
|
|
try {
|
|
CronHelper::enforceExecutionLimit($time - CronHelper::DAEMON_EXECUTION_LIMIT);
|
|
self::fail('Execution limit exception not thrown.');
|
|
} catch(\Exception $e) {
|
|
expect($e->getMessage())->equals('Maximum execution time has been reached.');
|
|
}
|
|
}
|
|
|
|
function testItAllowsSettingCustomCronUrl() {
|
|
$filter = function($url) {
|
|
expect($url)->contains('&endpoint=cron');
|
|
return 'http://custom_cron_url';
|
|
};
|
|
add_filter('mailpoet_cron_request_url', $filter);
|
|
expect(CronHelper::getCronUrl('sample_action'))->equals('http://custom_cron_url');
|
|
remove_filter('mailpoet_cron_request_url', $filter);
|
|
}
|
|
|
|
function testItAllowsSettingCustomCronRequestArguments() {
|
|
$request_args = array(
|
|
'blocking' => 'custom_blocking',
|
|
'sslverify' => 'custom_ssl_verify',
|
|
'timeout' => 'custom_timeout',
|
|
'user-agent' => 'custom_user_agent'
|
|
);
|
|
$filter = function($args) use ($request_args) {
|
|
expect($args)->notEmpty();
|
|
return $request_args;
|
|
};
|
|
$wp_remote_get_args = [];
|
|
$wp = Stub::make(new WPFunctions, [
|
|
'wpRemotePost' => function() use (&$wp_remote_get_args) {
|
|
return $wp_remote_get_args = func_get_args();
|
|
}
|
|
]);
|
|
$wp->addFilter('mailpoet_cron_request_args', $filter);
|
|
CronHelper::queryCronUrl('test', $wp);
|
|
expect($wp_remote_get_args[1])->equals($request_args);
|
|
|
|
$wp->removeFilter('mailpoet_cron_request_args', $filter);
|
|
}
|
|
|
|
function testItReturnsErrorMessageAsPingResponseWhenCronUrlCannotBeAccessed() {
|
|
Mock::double('MailPoet\Cron\CronHelper', array(
|
|
'getSiteUrl' => false
|
|
));
|
|
expect(CronHelper::pingDaemon())->equals('A valid URL was not provided.');
|
|
}
|
|
|
|
function testItPingsDaemon() {
|
|
if(getenv('WP_TEST_ENABLE_NETWORK_TESTS') !== 'true') return;
|
|
// raw response is returned
|
|
expect(CronHelper::pingDaemon())->equals(DaemonHttpRunner::PING_SUCCESS_RESPONSE);
|
|
// response is validated
|
|
expect(CronHelper::pingDaemon(true))->true();
|
|
}
|
|
|
|
function _after() {
|
|
Mock::clean();
|
|
\ORM::raw_execute('TRUNCATE ' . Setting::$_table);
|
|
}
|
|
|
|
private function getDeamonTestData() {
|
|
return [
|
|
'token' => 'some_token',
|
|
'status' => CronHelper::DAEMON_STATUS_ACTIVE,
|
|
'updated_at' => 12345678,
|
|
'run_accessed_at' => null,
|
|
'run_started_at' => null,
|
|
'run_completed_at' => null,
|
|
'last_error' => null,
|
|
];
|
|
}
|
|
}
|