#10306 unit tests for queue jobs (#10340)

* #10306 unit tests for queue jobs

* #10306 added unit test for job RemoveExpiredInvitationsJob

* #10306 added not to perform assertion on void return type method

* #10306 fixed test class namespace

* #10306 updated user repository class import path

* #10306 added mock support

* #10306 removed direct mocking of job class

* #10306 fixed jobs data for OMP

* #10306 updated job data for OPS

* #10306 updated job data for OJS

* #10306 update context dao determining based on application name

* #10306 removed unnecessary request param from createNotification method

* #10306 addressed warnings and notification table backup/restore

* #10306 fixed id issue for NewAnnouncementNotifyUsers job

* #10306 added skip for ReviewReminder job test for OPS

* #10306 fixed query repository notification create issue with request param

* #10306 fixed issue with dummy file and added router name on request mock

* #10306 updated announcement notify test to consider eloquent storage

Author: touhidurabir

api/v1/submissions/PKPSubmissionController.php

@@ -1166,7 +1166,6 @@ public function versionPublication(Request $illuminateRequest): JsonResponse
         $notificationSubscriptionSettingsDao = DAORegistry::getDAO('NotificationSubscriptionSettingsDAO');
         foreach ($usersIterator as $user) {
             $notification = $notificationManager->createNotification(
-                $request,
                 $user->getId(),
                 Notification::NOTIFICATION_TYPE_SUBMISSION_NEW_VERSION,
                 $submission->getData('contextId'),

classes/context/SubEditorsDAO.php

@@ -233,7 +233,6 @@ public function assignEditors(Submission $submission, Context $context): Collect
         // Send a notification to assigned users
         foreach ($assignments as $assignment) {
             $notificationManager->createNotification(
-                Application::get()->getRequest(),
                 $assignment->userId,
                 Notification::NOTIFICATION_TYPE_SUBMISSION_SUBMITTED,
                 $submission->getData('contextId'),

classes/core/PKPApplication.php

@@ -317,6 +317,13 @@ public function getUUID(): string
      */
     public function getHttpClient(): Client
     {
+        if (PKPContainer::getInstance()->runningUnitTests()) {
+            $client = Registry::get(\PKP\tests\PKPTestCase::MOCKED_GUZZLE_CLIENT_NAME);
+            if ($client) {
+                return $client;
+            }
+        }
+        
         $application = Application::get();
         $userAgent = $application->getName() . '/';
         if (static::isInstalled() && !static::isUpgrading()) {

classes/core/PKPContainer.php

@@ -40,6 +40,11 @@
 
 class PKPContainer extends Container
 {
+    /**
+     * Define if the app currently runing the unit test
+     */
+    private bool $isRunningUnitTest = false;
+
     /**
      * The base path of the application, needed for base_path helper
      */
@@ -538,15 +543,6 @@ protected function settingProxyForStreamContext(): void
         libxml_set_streams_context($context);
     }
 
-    /**
-     * Override Laravel method; always false.
-     * Prevents the undefined method error when the Log Manager tries to determine the driver
-     */
-    public function runningUnitTests(): bool
-    {
-        return false;
-    }
-
     /**
      * Determine if the application is currently down for maintenance.
      */
@@ -590,6 +586,31 @@ public function environment(string ...$environments): string|bool
 
         return $this->get('config')['app']['env'];
     }
+
+    /**
+     * Override Laravel method; always false.
+     * Prevents the undefined method error when the Log Manager tries to determine the driver
+     */
+    public function runningUnitTests(): bool
+    {
+        return $this->isRunningUnitTest;
+    }
+
+    /**
+     * Set the app running unit test
+     */
+    public function setRunningUnitTests(): void
+    {
+        $this->isRunningUnitTest = true;
+    }
+
+    /**
+     * Unset the app running unit test
+     */
+    public function unsetRunningUnitTests(): void
+    {
+        $this->isRunningUnitTest = false;
+    }
 }
 
 if (!PKP_STRICT_MODE) {

classes/decision/DecisionType.php

@@ -523,7 +523,6 @@ protected function createReviewRound(Submission $submission, int $stageId, ?int
         if ($count == 0) {
             $notificationMgr = new NotificationManager();
             $notificationMgr->createNotification(
-                Application::get()->getRequest(),
                 null,
                 Notification::NOTIFICATION_TYPE_REVIEW_ROUND_STATUS,
                 $submission->getData('contextId'),

classes/mail/mailables/AnnouncementNotify.php

@@ -89,7 +89,7 @@ public function setData(?string $locale = null): void
                     $this->context->getData('urlPath'),
                     'announcement',
                     'view',
-                    $this->announcement->getAttribute('announcementId')
+                    [$this->announcement->getAttribute('announcementId')]
                 ),
             ]
         );

classes/mail/mailables/EditorialReminder.php

@@ -74,7 +74,7 @@ public function setOutstandingTasks(array $outstanding, array $submissions, int
                 $this->context->getPath(),
                 'workflow',
                 'access',
-                $submission->getId()
+                [$submission->getId()]
             );
 
             $outstandingTasks[] = '

classes/notification/NotificationManagerDelegate.php

@@ -56,10 +56,10 @@ public function updateNotification(PKPRequest $request, ?array $userIds, int $as
      *
      * @copydoc PKPNotificationOperationManager::createNotification()
      */
-    public function createNotification(PKPRequest $request, ?int $userId = null, ?int $notificationType = null, ?int $contextId = Application::SITE_CONTEXT_ID, ?int $assocType = null, ?int $assocId = null, int $level = Notification::NOTIFICATION_LEVEL_NORMAL, ?array $params = null): ?Notification
+    public function createNotification(?int $userId = null, ?int $notificationType = null, ?int $contextId = Application::SITE_CONTEXT_ID, ?int $assocType = null, ?int $assocId = null, int $level = Notification::NOTIFICATION_LEVEL_NORMAL, ?array $params = null): ?Notification
     {
         assert($notificationType == $this->getNotificationType() || $this->multipleTypesUpdate());
-        return parent::createNotification($request, $userId, $notificationType, $contextId, $assocType, $assocId, $level, $params);
+        return parent::createNotification($userId, $notificationType, $contextId, $assocType, $assocId, $level, $params);
     }
 
     /**

classes/notification/PKPNotificationOperationManager.php

@@ -140,7 +140,7 @@ public function getParamsForCurrentLocale(array $params): array
     /**
      * Create a new notification with the specified arguments and insert into DB
      */
-    public function createNotification(PKPRequest $request, ?int $userId = null, ?int $notificationType = null, ?int $contextId = Application::SITE_CONTEXT_ID, ?int $assocType = null, ?int $assocId = null, int $level = Notification::NOTIFICATION_LEVEL_NORMAL, ?array $params = null): ?Notification
+    public function createNotification(?int $userId = null, ?int $notificationType = null, ?int $contextId = Application::SITE_CONTEXT_ID, ?int $assocType = null, ?int $assocId = null, int $level = Notification::NOTIFICATION_LEVEL_NORMAL, ?array $params = null): ?Notification
     {
         if ($userId && in_array($notificationType, $this->getUserBlockedNotifications($userId, $contextId))) {
             return null;
@@ -228,7 +228,7 @@ public function formatToGeneralNotification(PKPRequest $request, array $notifica
      */
     public function formatToInPlaceNotification(PKPRequest $request, array $notifications): array
     {
-        $formattedNotificationsData = null;
+        $formattedNotificationsData = [];
 
         $templateMgr = TemplateManager::getManager($request);
         foreach ($notifications as $notification) {

classes/notification/managerDelegate/AnnouncementNotificationManager.php

@@ -96,7 +96,6 @@ public function getStyleClass($notification): string
     public function notify(User $user): ?Notification
     {
         return parent::createNotification(
-            Application::get()->getRequest(),
             $user->getId(),
             Notification::NOTIFICATION_TYPE_NEW_ANNOUNCEMENT,
             $this->_announcement->getAttribute('assocId'),