ScheduledTaskHelperTest.php

<?php
 
import('lib.pkp.tests.PKPTestCase');
import('lib.pkp.classes.scheduledTask.ScheduledTask');
 
class ScheduledTaskHelperTest extends PKPTestCase {
 
   function testNotifyExecutionResultError($taskId, $taskName, $message) {
      $taskResult = false;
      $expectedSubject = __(SCHEDULED_TASK_MESSAGE_TYPE_ERROR);
      $this->_setReportErrorOnly('On');
      $expectedTestResult = null; // Will send email (it's null because we mocked Mail::send()).
 
      $helper = $this->_getHelper($expectedSubject, $message);
 
      // Exercise the system.
      $actualResult = $helper->notifyExecutionResult($taskId, $taskName, $taskResult, $message);
      $this->assertEquals($expectedTestResult, $actualResult);
 
      // Now set report error only to off and we should get the same result.
      $this->_setReportErrorOnly('Off');
      $actualResult = $helper->notifyExecutionResult($taskId, $taskName, $taskResult, $message);
      $this->assertEquals($expectedTestResult, $actualResult);
   }
 
   function testNotifyExecutionResultSuccess($taskId, $taskName, $message) {
      $taskResult = true;
      $expectedSubject = __(SCHEDULED_TASK_MESSAGE_TYPE_COMPLETED);
      $this->_setReportErrorOnly('On');
      $expectedTestResult = false; // Will NOT send email.
 
      $helper = $this->_getHelper($expectedSubject, $message);
 
      // Exercise the system.
      $actualResult = $helper->notifyExecutionResult($taskId, $taskName, $taskResult, $message);
      $this->assertEquals($expectedTestResult, $actualResult);
 
      // Now change the report setting, so success emails will also be sent.
      $this->_setReportErrorOnly('Off');
      $expectedTestResult = null; // Will send email.
      $actualResult = $helper->notifyExecutionResult($taskId, $taskName, $taskResult, $message);
      $this->assertEquals($expectedTestResult, $actualResult);
   }
 
   function notifyExecutionResultTestsDataProvider() {
      return array(array('someTaskId', 'TaskName', 'Any message'));
   }
 
 
   //
   // Private helper methods.
   //
   private function _getHelper($expectedSubject, $message) {
      $helperMock = $this->getMockBuilder(ScheduledTaskHelper::class)
         ->setMethods(array('getMail', 'getMessage'))
         ->setConstructorArgs(array('some@email.com', 'Contact name'))
         ->getMock();
      $helperMock->expects($this->any())
            ->method('getMessage')
            ->will($this->returnValue($message));
 
      // Helper will use the Mail::send() method. Mock it.
      import('lib.pkp.classes.mail.Mail');
      $mailMock = $this->getMockBuilder(Mail::class)
         ->setMethods(array('send', 'setBody', 'setSubject'))
         ->getMock();
 
      $mailMock->expects($this->any())
             ->method('send');
 
      $mailMock->expects($this->any())
             ->method('setBody')
             ->with($this->equalTo($message));
 
      $mailMock->expects($this->any())
             ->method('setSubject')
             ->with($this->stringContains($expectedSubject));
 
      // Inject mail dependency.
      $helperMock->expects($this->any())
               ->method('getMail')
               ->will($this->returnValue($mailMock));
 
      return $helperMock;
   }
 
   private function _setReportErrorOnly($state) {
      $configData =& Config::getData();
      $configData['general']['scheduled_tasks_report_error_only'] = $state;
   }
}