feat: setup check implementation by guilhermercarvalho · Pull Request #7070 · LibreSign/libresign

guilhermercarvalho · 2026-03-04T02:18:54Z

Related Issue

Issue Number: #6590

Pull Request Type

Feature

Pull request checklist

Did you explain or provide a way of how can we test your code ?
If your pull request is related to frontend modifications provide a print of before and after screen
Did you provide a general summary of your changes ?
Try to limit your pull request to one type, submit multiple pull requests if needed
I implemented tests that cover my contribution

Summary of Changes

This PR refactors the old ConfigureCheckService.php into six specialized classes that implement Nextcloud's ISetupCheck interface. This improves the admin experience by showing detailed setup checks directly in the Nextcloud administration overview and makes them available via occ setupchecks.

The following checks were created:

Check Name	Priority	Category	Logic Source
`JavaSetupCheck`	must-have	system	`ConfigureCheckService::checkJava()`
`JSignPdfSetupCheck`	must-have	system	`ConfigureCheckService::checkJSignPdf()`
`PDFtkSetupCheck`	must-have	system	`ConfigureCheckService::checkPdftk()`
`CertificateEngineSetupCheck`	must-have	security	`ConfigureCheckService::checkCertificate()`
`PopplerSetupCheck`	nice-to-have	system	`ConfigureCheckService::checkPoppler()`
`ImagickSetupCheck`	nice-to-have	system	`ConfigureCheckService::checkImagick()`

Screenshots

All checks are registered in Application.php and the old ConfigureCheckService has been marked as deprecated with a @deprecated annotation pointing to the new classes.

How to Test

Via the web interface:
- Go to Administration settings → Overview.
- Scroll down to the "Setup checks" section.
- Verify that all six checks appear with appropriate statuses (error, warning, info, success) based on your system configuration.
Via CLI:
```
occ setupchecks:check
```
You should see the results for all LibreSign checks.

Run unit tests:

composer test:unit -- --filter SetupCheck

All tests should pass.

Adds trait with verifyResourceIntegrity and getErrorAndTipFromVerify methods used by multiple setup checks. Related issue: LibreSign#6590 Type: Feature Checklist: - [x] Add verifyResourceIntegrity method - [x] Add getErrorAndTipFromVerify method with translated messages - [x] Declare required properties (signSetupService, urlGenerator, appManager, logger) - [x] Use IL10N for all user-facing strings Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>

Adds ExecMock, FileSystemMock, SetupCheckFunctions to mock system calls, and updates bootstrap.php to load them. Related issue: LibreSign#6590 Type: Test Checklist: - [x] Create ExecMock class - [x] Create FileSystemMock class - [x] Create SetupCheckFunctions with file_exists and exec overrides - [x] Update bootstrap.php to include new files Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>

Adds JavaSetupCheck to verify Java installation, path, version and encoding. Related issue: LibreSign#6590 Type: Feature Checklist: - [x] Implement ISetupCheck interface - [x] Use SetupCheckUtils trait - [x] Verify Java path exists - [x] Check Java version matches required version - [x] Check native.encoding for UTF-8 - [x] Return SetupResult with appropriate severity and translated messages - [x] Add unit tests covering all scenarios Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>

Adds JSignPdfSetupCheck to verify JSignPdf binary, integrity, Java dependency and version. Related issue: LibreSign#6590 Type: Feature Checklist: - [x] Implement ISetupCheck interface - [x] Use SetupCheckUtils trait - [x] Verify JSignPdf path is configured and exists - [x] Verify Java is available - [x] Check JSignPdf version against required version - [x] Return SetupResult with appropriate severity and translated messages - [x] Add unit tests covering all scenarios Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>

Adds PDFtkSetupCheck to verify PDFtk binary, integrity, Java dependency and version. Related issue: LibreSign#6590 Type: Feature Checklist: - [x] Implement ISetupCheck interface - [x] Use SetupCheckUtils trait - [x] Verify PDFtk path is configured and exists - [x] Verify Java is available - [x] Check PDFtk version matches required version - [x] Return SetupResult with appropriate severity and translated messages - [x] Add unit tests covering all scenarios Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>

Adds PopplerSetupCheck to verify pdfsig and pdfinfo utilities (optional). Related issue: LibreSign#6590 Type: Feature Checklist: - [x] Implement ISetupCheck interface - [x] Check pdfsig installation and version - [x] Check pdfinfo installation and version - [x] Return info severity when missing (optional check) - [x] Return success when both tools are working - [x] Add unit tests covering all scenarios Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>

Adds ImagickSetupCheck to verify imagick PHP extension (optional). Related issue: LibreSign#6590 Type: Feature Checklist: - [x] Implement ISetupCheck interface - [x] Check if imagick extension is loaded - [x] Return info severity when not loaded (optional check) - [x] Return success when loaded - [x] Add unit tests covering both states Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>

Adds CertificateEngineSetupCheck to process certificate engine configuration results. Related issue: LibreSign#6590 Type: Feature Checklist: - [x] Implement ISetupCheck interface - [x] Use CertificateEngineFactory to get current engine - [x] Process ConfigureCheckHelper results from engine - [x] Convert to SetupResult with aggregated messages and tips - [x] Handle engine not defined (error) - [x] Add unit tests covering success, warning, error, and mixed results Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>

Registers all six setup check classes in Application.php. Related issue: LibreSign#6590 Type: Feature Checklist: - [x] Add registerSetupCheck for JavaSetupCheck - [x] Add registerSetupCheck for JSignPdfSetupCheck - [x] Add registerSetupCheck for PDFtkSetupCheck - [x] Add registerSetupCheck for PopplerSetupCheck - [x] Add registerSetupCheck for ImagickSetupCheck - [x] Add registerSetupCheck for CertificateEngineSetupCheck Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>

@deprecated

Adds @deprecated annotation to ConfigureCheckService pointing to the new individual setup checks. Related issue: LibreSign#6590 Type: Maintenance Checklist: - [x] Add @deprecated tag with version 13.0.4 - [x] Mention replacement classes (JavaSetupCheck, JSignPdfSetupCheck, etc.) Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>

vitormattos

Run the command at LibreSign folder inside container:
composer cs:fix
Some files have a wrong indent pattern.

vitormattos · 2026-03-04T19:34:53Z

lib/Service/Install/ConfigureCheckService.php

+/**
+* @deprecated 13.0.4 Use the individual SetupCheck classes instead
+*             (JavaSetupCheck, JSignPdfSetupCheck, etc.).
+*/


Why this, and why not solve?

vitormattos · 2026-03-04T19:45:27Z

tests/php/Unit/SetupCheck/JavaSetupCheckTest.php

+use OCA\Libresign\Service\Install\InstallService;
+use OCA\Libresign\SetupCheck\JavaSetupCheck;
+use OCA\Libresign\SetupCheck\FileSystemMock;
+use OCA\Libresign\SetupCheck\ExecMock;


I think that by this way, moving the mock to be an external file of test class, isn't good. Maybe would be best to move the mock files to a new namespace before the row 8 with the mocks.

github-project-automation bot moved this to 0. Needs triage in Roadmap Mar 4, 2026

github-project-automation bot added this to Roadmap Mar 4, 2026

guilhermercarvalho added 10 commits March 3, 2026 23:21

guilhermercarvalho force-pushed the feat/6590-setup-check-implementation branch from 3015ad8 to 2b31973 Compare March 4, 2026 02:22

guilhermercarvalho changed the title ~~Feat/6590 setup check implementation~~ feat: setup check implementation Mar 4, 2026

vitormattos requested changes Mar 4, 2026

View reviewed changes

github-project-automation bot moved this from 0. Needs triage to 1. to do in Roadmap Mar 4, 2026

vitormattos reviewed Mar 4, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: setup check implementation#7070

feat: setup check implementation#7070
guilhermercarvalho wants to merge 10 commits intoLibreSign:mainfrom
guilhermercarvalho:feat/6590-setup-check-implementation

guilhermercarvalho commented Mar 4, 2026

Uh oh!

vitormattos left a comment

Uh oh!

vitormattos Mar 4, 2026

Uh oh!

vitormattos Mar 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

guilhermercarvalho commented Mar 4, 2026

Related Issue

Pull Request Type

Pull request checklist

Summary of Changes

How to Test

Uh oh!

vitormattos left a comment

Choose a reason for hiding this comment

Uh oh!

vitormattos Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

vitormattos Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants