Feature/unit tests by dxL1nus · Pull Request #79 · codecheckers/ojs-codecheck

dxL1nus · 2025-12-18T18:17:02Z

closes #70
closes #40
closes #73
closes codecheckers/check-pub#35
closes #96

!IMPORTANT: This PR can only be safely merged after PR #63

This is the PR for the first unit tests for the ojs-codecheck plugin. The tests are mainly for the RetrieveReserveIdentifiers scripts and can act as a guideline/ template on how to write other unit tests for the remaining class files.

Run the tests with the following command from the PKP OJS root directory:

lib/pkp/lib/vendor/phpunit/phpunit/phpunit -c lib/pkp/tests/phpunit.xml plugins/generic/codecheck/tests/

Results:

find the test coverage in the following file:

/var/www/html/ojs-tests/lib/pkp/tests/results/index.html

…odecheckers#70

…rs#70

…codecheckers#70

nuest · 2026-01-19T08:48:36Z

@Subhanaliweb will include these changes in his upcoming PR with a full test suite.

- Add PHP unit tests for all classes (212 tests) * Constants, Submission, Settings, Workflow, Frontend, Migration * CodecheckPlugin with comprehensive hook testing * 185 tests pass locally, 27 skipped (require full OJS environment) - Add Cypress component tests (51 tests - all passing) * CodecheckManifestFiles (6 tests) * CodecheckMetadataForm (20 tests) * CodecheckRepositoryList (6 tests) * CodecheckReviewDisplay (7 tests) * CodecheckCertificateIdentifier (6 tests) * CodecheckDataAndSoftwareAvailability (6 tests) - Add test infrastructure * PHPUnit: bootstrap.php, PKPTestCase.php, phpunit.xml * Cypress: cypress.config.js, pkp-mock.js, component support files * GitHub Actions workflow for automated component testing - Update README with testing documentation * Local testing instructions * Docker/CI testing instructions * Component testing commands Total: 263 tests (212 PHP + 51 component)

subhanLabs · 2026-01-29T16:28:28Z

As discussed, I pulled this branch and applied my testing on top of the commits he made.

nuest · 2026-01-29T19:31:06Z

As discussed, I pulled this branch and applied my testing on top of the commits he made.

@Subhanaliweb Can you briefly confirm: 1. we can close this PR unmerged. 2. You will open a new PR with your combined test suites.

subhanLabs · 2026-01-29T21:17:38Z

I have appleid my commits of all other testing on this branch so we can merge this one, my other branches will no longer be needed.

nuest · 2026-01-30T06:23:19Z

Thanks for the clarification @Subhanaliweb.

@dxL1nus @Subhanaliweb Please explain why this PR is still a "Draft". Who is best suited to resolve the merge conflicts?

dxL1nus · 2026-02-01T13:59:11Z

Thanks for the clarification @Subhanaliweb.

@dxL1nus @Subhanaliweb Please explain why this PR is still a "Draft". Who is best suited to resolve the merge conflicts?

this needs to stay a draft for now as well. I have to dicuss with Subhan what to do with the methods from the CodecheckMetadataHandler, as I moved them a couple months ago to the CodecheckApiController, but in his workflow, they are still inside the CodecheckMetadataHandler

dxL1nus · 2026-03-02T11:30:05Z

@nuest
I removed every useless test and also created a file: runTests.sh, to be able to run tests locally without executing the very long command. It also has a flag with which the testers can specify, if they want PHPUnit to also create a test coverage report (in HTML format) or not.

See here for the full instructions on how to run tests.

nuest

Primary change: remove the erroneously committed cache files, ideally also from the history.

Other changes: new extensive test patterns that I do not understand the benefit of; these can stay if it allows us to move on, but I would appreciate the help to understand the reasoning.

nuest · 2026-03-05T13:09:45Z

@Subhanaliweb Please take a look at the unresolved comments above - they are related to test classes you created. Thanks!

- Removed ConstantsUnitTest.php (testing constants is not behavioral) - Removed SchemaUnitTest.php (schema tested by DAO tests) - Removed CodecheckSchemaMigrationUnitTest.php (migration meta-test)

- Removed meta-tests (method existence, constants, return types) - Kept only tests that verify actual behavior and logic - Fixed assertion issues in DAO tests

- Use CSS class selectors instead of placeholder text - Makes tests independent of translation mock

- Cypress doesn't support Vite 8 yet - Vite 5.4.0 is the latest compatible version

- Runs PHPUnit tests with full OJS environment (stable-3_5_0) - Runs Cypress component tests in parallel - Generates code coverage reports with Xdebug - Uploads artifacts (coverage, logs, screenshots) - Uses GitHub secrets for API credentials - Replaces old component-tests.yml with unified workflow - Tests run on push to main and pull requests

Closes: #36, closes: #74, closes: #75, closes: #76, closes: #77; :warning: This PR needs to be merged after #63 and #79 ⚠️ This feature let's users import CODECHECK metadata from an already existing `codecheck.yml` file in a codecheck repository, that is located on one of the following platforms with the example repository links: - `GitHub`: https://github.com/codecheckers/certificate-2025-029 - `Zenodo`: https://zenodo.org/records/14900193 - `OSF`: https://osf.io/ymc3t - `GitLab`: https://gitlab.com/cdchck/community-codechecks/2022-svaRetro-svaNUMT To import metadata, simply paste the link to the repository root folder and press `Load Metadata`. <img width="2108" height="175" alt="Image" src="https://github.com/user-attachments/assets/6de1f7f9-d0dc-4e0d-b114-ca2f806ecc14" /> When pressing the Info Button ℹ️ next to the Repositories Title, the user gets presented with a promt, that describes, how the Repository Functionality works along with the link to the documentation of the CODECHECK Register where all Repository Types are described again in more detail. <img width="698" height="579" alt="Image" src="https://github.com/user-attachments/assets/34b1b419-0ce9-4161-99f0-f7e9e6a1198e" />

dxL1nus and others added 14 commits November 14, 2025 13:55

Initial structure for unittests plus first tests for getRawIdentifier c…

a6aa31b

…odecheckers#70

Found command to run unittests codecheckers#70

332fb6d

Changed behavior of getRawIdentifier based on unittests codecheckers#70

d58b905

Added new unit-test for getRawIdentifier() codecheckers#70

457d032

Update README.md to include Guide on how to run Unit Tests codechecke…

d95b477

…rs#70

CertificateIdentifierList is now fully covered codecheckers#70

4760d88

Simplified setup of CertificateIdentifierList tests codecheckers#70

15fe422

Added Unit Tests for CertificateIdentifier codecheckers#70

aa09da4

Added further Unit tests for Codecheck Venues codecheckers#70

4c10b7d

Added some more UnitTests for the GitHub Api Parser codecheckers#70

88322fc

Added last UnitTests to reach 100% coverage codecheckers#70

ed35c9c

Merged main and adapted to latest version of RetrieveReserveIdentifier …

2895b1d

…codecheckers#70

Added unit test for Unique Array from factory method codecheckers#70

86b8ea9

Fixed Merge conflict in Readme Test Documentation codecheckers#70

5661235

dxL1nus requested a review from nuest December 18, 2025 18:17

dxL1nus self-assigned this Dec 18, 2025

dxL1nus added 2 commits December 18, 2025 19:19

Added test coverage file path to README codecheckers#70

d4fd9a1

Merged new commits to Unit Tests codecheckers#70

b2f1c80

dxL1nus mentioned this pull request Jan 8, 2026

Feature/import codecheck metadata #84

Merged

dxL1nus added 4 commits February 1, 2026 16:31

Updated most of the outdated tests codecheckers#70

a97db6d

Merge branch 'main' into feature/unit-tests

f85c1bf

Fixed remaining bug in CodecheckRegister unit tests codecheckers#70

a236329

Fixed Cypress Certificate Identifier tests codecheckers#35

1ac7d78

dxL1nus added 3 commits March 2, 2026 12:17

codecheckers#70, codecheckers#79 : Better README for how to run tests

b7e7640

codecheckers#70, codecheckers#79 : Fixed small bug in runTests.sh

87ea122

Small fix in README

d5c8c90

This was referenced Mar 2, 2026

Distinguish Read and Write Access with different roles to API routes #87

Closed

User error message when label retrieval fails #96

Closed

nuest requested changes Mar 5, 2026

View reviewed changes

dxL1nus added 6 commits March 5, 2026 11:33

codecheckers#96 users now get notified when label retrieval did not work

014025d

Removed the wrongly commited phpunit cache files codecheckers#79

09a8c07

codecheckers#79 added .phpunit.cache to the .gitignore

0a6955d

Removed unnecessary constants unit tests codecheckers#79

964a58b

Removed unnecessary comments in runTests.sh codecheckers#79

730f7d8

Correct URL for Codecheck API again

9d87f8f

nuest assigned subhanLabs Mar 5, 2026

dxL1nus and others added 9 commits March 24, 2026 10:01

Removed Bugs from main

bdc195a

Merge branch 'main' into feature/unit-tests

c21cc40

Merged main to feature/unit-tests codecheckers#79

aca638e

Remove meta-tests: constants, schema, and migration tests

3612abd

- Removed ConstantsUnitTest.php (testing constants is not behavioral) - Removed SchemaUnitTest.php (schema tested by DAO tests) - Removed CodecheckSchemaMigrationUnitTest.php (migration meta-test)

Refactor unit tests to focus on functional testing

60ec3ef

- Removed meta-tests (method existence, constants, return types) - Kept only tests that verify actual behavior and logic - Fixed assertion issues in DAO tests

Update PHPUnit configuration for coverage reports

1ed25a3

Fix CodecheckManifestFiles component tests

6cac915

- Use CSS class selectors instead of placeholder text - Makes tests independent of translation mock

Downgrade Vite to 5.4.0 for Cypress compatibility

61105be

- Cypress doesn't support Vite 8 yet - Vite 5.4.0 is the latest compatible version

dxL1nus requested a review from nuest March 27, 2026 09:50

This was referenced Apr 7, 2026

Feature/issue 72 yaml generation test #111

Merged

Add a UI test that ensures the YAML generated for the preview (JS) matches the YAML generated for download (PHP) #72

Closed

nuest approved these changes Apr 10, 2026

View reviewed changes

nuest merged commit 5c0ec66 into codecheckers:main Apr 10, 2026
2 checks passed

Uh oh!

Conversation

dxL1nus commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nuest commented Jan 19, 2026

Uh oh!

subhanLabs commented Jan 29, 2026

Uh oh!

nuest commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

subhanLabs commented Jan 29, 2026

Uh oh!

nuest commented Jan 30, 2026

Uh oh!

dxL1nus commented Feb 1, 2026

Uh oh!

dxL1nus commented Mar 2, 2026

Uh oh!

nuest left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nuest commented Mar 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dxL1nus commented Dec 18, 2025 •

edited

Loading

nuest commented Jan 29, 2026 •

edited

Loading