Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pkp/pkp-lib#10306 unit tests for queue jobs #758

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/pkp
Submodule pkp updated 66 files
+441 −1 api/v1/reviews/PKPReviewController.php
+0 −1 api/v1/submissions/PKPSubmissionController.php
+15 −7 classes/announcement/Announcement.php
+0 −1 classes/context/SubEditorsDAO.php
+30 −54 classes/core/EntityDAO.php
+7 −0 classes/core/PKPApplication.php
+30 −9 classes/core/PKPContainer.php
+21 −0 classes/core/PKPString.php
+76 −66 classes/core/SettingsBuilder.php
+127 −0 classes/core/traits/EntityUpdate.php
+0 −1 classes/decision/DecisionType.php
+1 −1 classes/mail/mailables/AnnouncementNotify.php
+1 −1 classes/mail/mailables/EditorialReminder.php
+2 −2 classes/notification/NotificationManagerDelegate.php
+39 −29 classes/notification/PKPNotificationManager.php
+2 −2 classes/notification/PKPNotificationOperationManager.php
+0 −1 classes/notification/managerDelegate/AnnouncementNotificationManager.php
+0 −1 classes/notification/managerDelegate/EditorAssignmentNotificationManager.php
+0 −1 classes/notification/managerDelegate/EditorDecisionNotificationManager.php
+0 −1 classes/notification/managerDelegate/EditorialReportNotificationManager.php
+3 −4 classes/notification/managerDelegate/PKPApproveSubmissionNotificationManager.php
+1 −6 classes/notification/managerDelegate/PKPEditingProductionStatusNotificationManager.php
+4 −4 classes/notification/managerDelegate/SubmissionNotificationManager.php
+0 −1 classes/observers/listeners/AssignEditors.php
+0 −1 classes/query/Repository.php
+2 −2 classes/services/PKPSchemaService.php
+0 −1 classes/submission/action/EditorAction.php
+0 −1 classes/submission/reviewer/form/PKPReviewerReviewStep3Form.php
+1 −0 composer.json
+547 −424 composer.lock
+0 −1 controllers/grid/queries/QueriesGridHandler.php
+0 −1 controllers/grid/queries/QueryNotesGridHandler.php
+0 −1 controllers/grid/users/reviewer/form/EditReviewForm.php
+0 −2 controllers/grid/users/stageParticipant/form/PKPStageParticipantNotifyForm.php
+1 −1 cypress/tests/integration/NativeXmlImportExportSubmission.cy.js
+0 −1 jobs/email/EditorialReminder.php
+0 −1 jobs/email/ReviewReminder.php
+0 −1 jobs/invitations/RemoveExpiredInvitationsJob.php
+4 −1 jobs/notifications/NewAnnouncementNotifyUsers.php
+0 −1 jobs/notifications/StatisticsReportMail.php
+3 −0 locale/en/api.po
+9 −0 locale/en/editor.po
+44 −12 templates/controllers/grid/users/reviewer/readReview.tpl
+132 −0 templates/controllers/grid/users/reviewer/reviewDownload.tpl
+67 −8 tests/PKPTestCase.php
+77 −0 tests/jobs/bulk/BulkEmailSenderTest.php
+100 −0 tests/jobs/doi/DepositContextTest.php
+179 −0 tests/jobs/doi/DepositSubmissionTest.php
+215 −0 tests/jobs/email/EditorialReminderTest.php
+55 −0 tests/jobs/invitations/RemoveExpiredInvitationsJobTest.php
+109 −0 tests/jobs/metadata/BatchMetadataChangedJobTest.php
+109 −0 tests/jobs/metadata/MetadataChangedJobTest.php
+162 −0 tests/jobs/notifications/NewAnnouncementNotifyUsersTest.php
+169 −0 tests/jobs/notifications/StatisticsReportMailTest.php
+92 −0 tests/jobs/notifications/StatisticsReportNotifyTest.php
+131 −0 tests/jobs/statistics/ArchiveUsageStatsLogFileTest.php
+66 −0 tests/jobs/statistics/CompileContextMetricsTest.php
+79 −0 tests/jobs/statistics/CompileMonthlyMetricsTest.php
+66 −0 tests/jobs/statistics/CompileSubmissionMetricsTest.php
+66 −0 tests/jobs/statistics/RemoveDoubleClicksTest.php
+67 −0 tests/jobs/submissions/RemoveSubmissionFileFromSearchIndexJobTest.php
+67 −0 tests/jobs/submissions/RemoveSubmissionFromSearchIndexJobTest.php
+ tests/jobs/submissions/UpdateSubmissionSearchJobTest.php
+1 −1 tests/phpunit.xml
+88 −0 tests/support/DoiRegistrationAgency.php
+52 −44 xml/oai2.xsl
1 change: 0 additions & 1 deletion tests/jobs/.gitkeep

This file was deleted.

88 changes: 88 additions & 0 deletions tests/jobs/statistics/CompileCounterSubmissionDailyMetricsTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<?php

/**
* @file tests/jobs/statistics/CompileCounterSubmissionDailyMetricsTest.php
*
* Copyright (c) 2024 Simon Fraser University
* Copyright (c) 2024 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @brief Tests for compile counter submission daily metrics job.
*/

namespace APP\tests\jobs\statistics;

use APP\jobs\statistics\CompileCounterSubmissionDailyMetrics;
use Mockery;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;
use PKP\db\DAORegistry;
use PKP\tests\PKPTestCase;

#[RunTestsInSeparateProcesses]
#[CoversClass(CompileCounterSubmissionDailyMetrics::class)]
class CompileCounterSubmissionDailyMetricsTest extends PKPTestCase
{
/**
* base64_encoded serializion from OPS 3.4.0
*/
protected string $serializedJobData = <<<END
O:56:"APP\jobs\statistics\CompileCounterSubmissionDailyMetrics":3:{s:9:"\0*\0loadId";s:25:"usage_events_20240130.log";s:10:"connection";s:8:"database";s:5:"queue";s:5:"queue";}
END;

/**
* Test job is a proper instance
*/
public function testUnserializationGetProperDepositIssueJobInstance(): void
{
$this->assertInstanceOf(
CompileCounterSubmissionDailyMetrics::class,
unserialize($this->serializedJobData)
);
}

/**
* Ensure that a serialized job can be unserialized and executed
*/
public function testRunSerializedJob(): void
{
/** @var CompileCounterSubmissionDailyMetrics $compileCounterSubmissionDailyMetricsJob */
$compileCounterSubmissionDailyMetricsJob = unserialize($this->serializedJobData);

$temporaryTotalsDAOMock = Mockery::mock(\APP\statistics\TemporaryTotalsDAO::class)
->makePartial()
->shouldReceive([
'deleteCounterSubmissionDailyByLoadId' => null,
'compileCounterSubmissionDailyMetrics' => null,
])
->withAnyArgs()
->getMock();

DAORegistry::registerDAO('TemporaryTotalsDAO', $temporaryTotalsDAOMock);

$temporaryItemInvestigationsDAOMock = Mockery::mock(\APP\statistics\TemporaryItemInvestigationsDAO::class)
->makePartial()
->shouldReceive([
'compileCounterSubmissionDailyMetrics' => null,
])
->withAnyArgs()
->getMock();

DAORegistry::registerDAO('TemporaryItemInvestigationsDAO', $temporaryItemInvestigationsDAOMock);

$temporaryItemRequestsDAOMock = Mockery::mock(\APP\statistics\TemporaryItemRequestsDAO::class)
->makePartial()
->shouldReceive([
'compileCounterSubmissionDailyMetrics' => null,
])
->withAnyArgs()
->getMock();

DAORegistry::registerDAO('TemporaryItemRequestsDAO', $temporaryItemRequestsDAOMock);


$compileCounterSubmissionDailyMetricsJob->handle();

$this->expectNotToPerformAssertions();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<?php

/**
* @file tests/jobs/statistics/CompileCounterSubmissionInstitutionDailyMetricsTest.php
*
* Copyright (c) 2024 Simon Fraser University
* Copyright (c) 2024 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @brief Tests for compile counter submission institution daily metrics job.
*/

namespace APP\tests\jobs\statistics;

use APP\jobs\statistics\CompileCounterSubmissionInstitutionDailyMetrics;
use Mockery;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;
use PKP\db\DAORegistry;
use PKP\tests\PKPTestCase;

#[RunTestsInSeparateProcesses]
#[CoversClass(CompileCounterSubmissionInstitutionDailyMetrics::class)]
class CompileCounterSubmissionInstitutionDailyMetricsTest extends PKPTestCase
{
/**
* base64_encoded serializion from OPS 3.4.0
*/
protected string $serializedJobData = <<<END
O:67:"APP\jobs\statistics\CompileCounterSubmissionInstitutionDailyMetrics":3:{s:9:"\0*\0loadId";s:25:"usage_events_20240130.log";s:10:"connection";s:8:"database";s:5:"queue";s:5:"queue";}
END;

/**
* Test job is a proper instance
*/
public function testUnserializationGetProperDepositIssueJobInstance(): void
{
$this->assertInstanceOf(
CompileCounterSubmissionInstitutionDailyMetrics::class,
unserialize($this->serializedJobData)
);
}

/**
* Ensure that a serialized job can be unserialized and executed
*/
public function testRunSerializedJob(): void
{
/** @var CompileCounterSubmissionInstitutionDailyMetrics $compileCounterSubmissionInstitutionDailyMetricsJob */
$compileCounterSubmissionInstitutionDailyMetricsJob = unserialize($this->serializedJobData);

$temporaryTotalsDAOMock = Mockery::mock(\APP\statistics\TemporaryTotalsDAO::class)
->makePartial()
->shouldReceive([
'deleteCounterSubmissionInstitutionDailyByLoadId' => null,
'compileCounterSubmissionDailyMetrics' => null,
])
->withAnyArgs()
->getMock();

DAORegistry::registerDAO('TemporaryTotalsDAO', $temporaryTotalsDAOMock);

$temporaryItemInvestigationsDAOMock = Mockery::mock(\APP\statistics\TemporaryItemInvestigationsDAO::class)
->makePartial()
->shouldReceive([
'compileCounterSubmissionInstitutionDailyMetrics' => null,
])
->withAnyArgs()
->getMock();

DAORegistry::registerDAO('TemporaryItemInvestigationsDAO', $temporaryItemInvestigationsDAOMock);

$temporaryItemRequestsDAOMock = Mockery::mock(\APP\statistics\TemporaryItemRequestsDAO::class)
->makePartial()
->shouldReceive([
'compileCounterSubmissionInstitutionDailyMetrics' => null,
])
->withAnyArgs()
->getMock();

DAORegistry::registerDAO('TemporaryItemRequestsDAO', $temporaryItemRequestsDAOMock);


$compileCounterSubmissionInstitutionDailyMetricsJob->handle();

$this->expectNotToPerformAssertions();
}
}
77 changes: 77 additions & 0 deletions tests/jobs/statistics/CompileSubmissionGeoDailyMetricsTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<?php

/**
* @file tests/jobs/statistics/CompileSubmissionGeoDailyMetricsTest.php
*
* Copyright (c) 2024 Simon Fraser University
* Copyright (c) 2024 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @brief Tests for compile submission geo daily metrics job.
*/

namespace APP\tests\jobs\statistics;

use APP\jobs\statistics\CompileSubmissionGeoDailyMetrics;
use Mockery;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;
use PKP\db\DAORegistry;
use PKP\tests\PKPTestCase;

#[RunTestsInSeparateProcesses]
#[CoversClass(CompileSubmissionGeoDailyMetrics::class)]
class CompileSubmissionGeoDailyMetricsTest extends PKPTestCase
{
/**
* base64_encoded serializion from OPS 3.4.0
*/
protected string $serializedJobData = <<<END
O:52:"APP\jobs\statistics\CompileSubmissionGeoDailyMetrics":3:{s:9:"\0*\0loadId";s:25:"usage_events_20240130.log";s:10:"connection";s:8:"database";s:5:"queue";s:5:"queue";}
END;

/**
* Test job is a proper instance
*/
public function testUnserializationGetProperDepositIssueJobInstance(): void
{
$this->assertInstanceOf(
CompileSubmissionGeoDailyMetrics::class,
unserialize($this->serializedJobData)
);
}

/**
* Ensure that a serialized job can be unserialized and executed
*/
public function testRunSerializedJob(): void
{
/** @var CompileSubmissionGeoDailyMetrics $compileSubmissionGeoDailyMetricsJob */
$compileSubmissionGeoDailyMetricsJob = unserialize($this->serializedJobData);

$temporaryTotalsDAOMock = Mockery::mock(\APP\statistics\TemporaryTotalsDAO::class)
->makePartial()
->shouldReceive([
'deleteSubmissionGeoDailyByLoadId' => null,
'compileSubmissionGeoDailyMetrics' => null,
])
->withAnyArgs()
->getMock();

DAORegistry::registerDAO('TemporaryTotalsDAO', $temporaryTotalsDAOMock);

$temporaryItemInvestigationsDAOMock = Mockery::mock(\APP\statistics\TemporaryItemInvestigationsDAO::class)
->makePartial()
->shouldReceive([
'compileSubmissionGeoDailyMetrics' => null,
])
->withAnyArgs()
->getMock();

DAORegistry::registerDAO('TemporaryItemInvestigationsDAO', $temporaryItemInvestigationsDAOMock);

$compileSubmissionGeoDailyMetricsJob->handle();

$this->expectNotToPerformAssertions();
}
}
66 changes: 66 additions & 0 deletions tests/jobs/statistics/CompileUniqueInvestigationsTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<?php

/**
* @file tests/jobs/statistics/CompileUniqueInvestigationsTest.php
*
* Copyright (c) 2024 Simon Fraser University
* Copyright (c) 2024 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @brief Tests for compile unique investigations job.
*/

namespace APP\tests\jobs\statistics;

use APP\jobs\statistics\CompileUniqueInvestigations;
use Mockery;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;
use PKP\db\DAORegistry;
use PKP\tests\PKPTestCase;

#[RunTestsInSeparateProcesses]
#[CoversClass(CompileUniqueInvestigations::class)]
class CompileUniqueInvestigationsTest extends PKPTestCase
{
/**
* base64_encoded serializion from OPS 3.4.0
*/
protected string $serializedJobData = <<<END
O:47:"APP\jobs\statistics\CompileUniqueInvestigations":3:{s:9:"\0*\0loadId";s:25:"usage_events_20240130.log";s:10:"connection";s:8:"database";s:5:"queue";s:5:"queue";}
END;

/**
* Test job is a proper instance
*/
public function testUnserializationGetProperDepositIssueJobInstance(): void
{
$this->assertInstanceOf(
CompileUniqueInvestigations::class,
unserialize($this->serializedJobData)
);
}

/**
* Ensure that a serialized job can be unserialized and executed
*/
public function testRunSerializedJob(): void
{
/** @var CompileUniqueInvestigations $compileUniqueInvestigationsJob */
$compileUniqueInvestigationsJob = unserialize($this->serializedJobData);

$temporaryItemInvestigationsDAOMock = Mockery::mock(\APP\statistics\TemporaryItemInvestigationsDAO::class)
->makePartial()
->shouldReceive([
'compileUniqueClicks' => null,
])
->withAnyArgs()
->getMock();

DAORegistry::registerDAO('TemporaryItemInvestigationsDAO', $temporaryItemInvestigationsDAOMock);

$compileUniqueInvestigationsJob->handle();

$this->expectNotToPerformAssertions();
}
}
66 changes: 66 additions & 0 deletions tests/jobs/statistics/CompileUniqueRequestsTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<?php

/**
* @file tests/jobs/statistics/CompileUniqueRequestsTest.php
*
* Copyright (c) 2024 Simon Fraser University
* Copyright (c) 2024 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @brief Tests for compile unique requests job.
*/

namespace APP\tests\jobs\statistics;

use APP\jobs\statistics\CompileUniqueRequests;
use Mockery;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;
use PKP\db\DAORegistry;
use PKP\tests\PKPTestCase;

#[RunTestsInSeparateProcesses]
#[CoversClass(CompileUniqueRequests::class)]
class CompileUniqueRequestsTest extends PKPTestCase
{
/**
* base64_encoded serializion from OPS 3.4.0
*/
protected string $serializedJobData = <<<END
O:41:"APP\jobs\statistics\CompileUniqueRequests":3:{s:9:"\0*\0loadId";s:25:"usage_events_20240130.log";s:10:"connection";s:8:"database";s:5:"queue";s:5:"queue";}
END;

/**
* Test job is a proper instance
*/
public function testUnserializationGetProperDepositIssueJobInstance(): void
{
$this->assertInstanceOf(
CompileUniqueRequests::class,
unserialize($this->serializedJobData)
);
}

/**
* Ensure that a serialized job can be unserialized and executed
*/
public function testRunSerializedJob(): void
{
/** @var CompileUniqueRequests $compileUniqueRequestsJob */
$compileUniqueRequestsJob = unserialize($this->serializedJobData);

$temporaryItemRequestsDAOMock = Mockery::mock(\APP\statistics\TemporaryItemRequestsDAO::class)
->makePartial()
->shouldReceive([
'compileUniqueClicks' => null,
])
->withAnyArgs()
->getMock();

DAORegistry::registerDAO('TemporaryItemRequestsDAO', $temporaryItemRequestsDAOMock);

$compileUniqueRequestsJob->handle();

$this->expectNotToPerformAssertions();
}
}
Loading