Improve backend test coverage, add CI workflow, and introduce testable design with mocking by TwilightVoyager777 · Pull Request #5909 · Stirling-Tools/Stirling-PDF

TwilightVoyager777 · 2026-03-10T19:57:33Z

Description of Changes

What was changed

This pull request improves the testing infrastructure and testability of the Stirling-PDF backend.

Key changes include:

Added multiple unit tests and white-box tests for backend components such as:
- RotationController
- SecretMasker
- GlobalExceptionHandler
- MobileScannerController
- LanguageService
Extended existing tests to cover edge cases and boundary conditions (e.g., rotation angles and validation logic).
Implemented FSM-based testing to improve coverage for certain features.
Introduced mocking and stubbing techniques to isolate dependencies and improve test reliability.
Added helper methods and small refactors to support testable design.
Added a GitHub Actions CI workflow to automatically build the backend and run core tests.
Cleaned up CI configuration by removing unused workflows.
Minor fixes and improvements including Gradle updates and small bug fixes discovered during testing.

Why the change was made

These changes were made to improve the test coverage, reliability, and maintainability of the backend system.

The work applies several software testing practices including:

White-box testing
FSM-based testing
Mocking and stubbing
Continuous Integration (CI)

By adding automated tests and CI validation, the project can detect regressions earlier and ensure that important backend components behave correctly.

Challenges encountered

Some components were originally tightly coupled, which made them difficult to test directly.
Mocking certain dependencies required careful configuration to avoid unintended side effects.
Configuring the CI workflow to run only the necessary backend tests required adjustments to the workflow setup.

Checklist

UI Changes (if applicable)

Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR)

Testing (if applicable)

I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details.

Extend RotationController tests to cover partition boundaries (0°) and negative angles, ensuring valid multiples of 90 succeed; update report with partitioning details.

Add SecretMasker tests(no side effects + false positives)

Feature B: FSM coverage tests for SecretMasker

Add white-box tests for GlobalExceptionHandler

…-PDF

CI: add targeted tests for GlobalExceptionHandler and SecretMasker

…stable design)

Add MobileScannerController validation helper and tests (mocking + te…

Remove unused GitHub Actions workflows (keep course-part4-ci.yml only)

Add LanguageService stubbing test (Member C)

Frooodle · 2026-03-10T20:07:43Z

Appreciate all the testing however you have made several changes to our GHAs which should not be done, please revert all GHA changes

Thanks again for the added test cases though! Certainly something we need more of

Frooodle · 2026-03-10T20:14:09Z

Once these have been restored will review more

TwilightVoyager777 · 2026-03-10T20:16:20Z

sure I will do that soon

balazs-szucs

Hi,

thanks for the PR left some comments for you.

balazs-szucs · 2026-03-10T20:24:03Z

.github/workflows/build.yml

So, this has caused many headaches in the past, I believe we prefer not to cache via gradle. Frooodle is working some docker caching parrallel to this I believe

balazs-szucs · 2026-03-10T20:24:23Z

.github/workflows/build.yml

SAme comment as above

balazs-szucs · 2026-03-10T20:25:09Z

.github/workflows/multiOSReleases.yml

Unnecesary (?)

balazs-szucs · 2026-03-10T20:26:32Z

build.gradle

    id "org.springdoc.openapi-gradle-plugin" version "1.9.0"
    id "io.swagger.swaggerhub" version "1.3.2"
    id "com.diffplug.spotless" version "8.1.0"
    id "com.github.jk1.dependency-license-report" version "3.0.1"
+    id "com.github.spotbugs" version "6.1.7" apply false


Non-existent version according to: https://mvnrepository.com/artifact/com.github.spotbugs/spotbugs
https://github.com/spotbugs/spotbugs/releases

balazs-szucs · 2026-03-10T20:27:12Z

build.gradle

+    spotbugs {
+        ignoreFailures = true
+        effort = "max"
+        reportLevel = "low"
+    }
+
+    tasks.withType(com.github.spotbugs.snom.SpotBugsTask).configureEach {
+        reports {
+            xml.required.set(true)
+            html.required.set(true)
+        }
+    }
+


Can you test this and add some hints, how this supposed to work?

balazs-szucs · 2026-03-10T20:46:09Z

app/core/src/test/java/stirling/software/SPDF/exception/GlobalExceptionHandlerTest.java

+        // title is set both as ProblemDetail.title and property "title"
+        assertEquals(pd.getTitle(), pd.getProperties().get("title"));


Is asserting (potentially) non-RFC complaint behaviour I believe, though I'll do some reasearching.

My intuition is that the ProblemDetail.title and property "title" shouldn't be both set. It's duplication

balazs-szucs · 2026-03-10T20:46:51Z

app/core/src/test/java/stirling/software/SPDF/exception/GlobalExceptionHandlerTest.java

+
+import jakarta.servlet.http.HttpServletRequest;
+
+class GlobalExceptionHandlerTest {


I feel like this quite light or? We obviously didn't have testing for this before the PR, but this can be great place to make more tests.

balazs-szucs · 2026-03-10T20:49:21Z

app/core/src/test/java/stirling/software/SPDF/controller/api/RotationControllerTest.java

@@ -58,6 +62,62 @@ public void testRotatePDF() throws IOException {
        assertEquals(200, response.getStatusCode().value());
    }

+    @Test
+    public void testRotatePDFZeroAngle() throws IOException {


is confusing.

Better test would be to: testRotatePDF_ShouldMaintainExistingRotation_WhenAngleIsZero

balazs-szucs · 2026-03-10T20:52:13Z

.github/workflows/build.yml

Do we need this?

balazs-szucs · 2026-03-10T20:52:40Z

.github/workflows/frontend-backend-licenses-update.yml

if we already here maybe bump to node 24? That is the latest, right?

TwilightVoyager777 and others added 30 commits January 29, 2026 15:14

extend RotationControllerTest by pengcheng xu

d0ec638

Extend RotationController tests to cover partition boundaries (0°) and negative angles, ensuring valid multiples of 90 succeed; update report with partitioning details.

test push

63594b2

added two testings

7340cd5

Add SecretMasker tests: no side effects and false positives

47fb7df

Merge pull request #1 from TwilightVoyager777/liujs-secretmasker-tests

b268187

Add SecretMasker tests(no side effects + false positives)

little fix by wang

4dc4ff7

little fix by wang

a73f8cb

little fix by liu

2e6e388

Add FSM coverage tests for Job lifecycle API by pengcheng xu

4d96100

Add FSM coverage tests for SecretMasker (Feature B)

bee993b

Merge pull request #2 from TwilightVoyager777/feature/fsm-secretmasker-b

ed808e9

Feature B: FSM coverage tests for SecretMasker

added another two tests

8288f58

Pengcheng Xu made Part 3. White Box Testing and Coverage.

9331df4

Add white-box tests for GlobalExceptionHandler

60edfcb

Merge pull request #3 from liujs123456/liujs-whitebox-exception-handler

3e0a140

Add white-box tests for GlobalExceptionHandler

update project part3

ed074a0

Merge branch 'main' of https://github.com/TwilightVoyager777/Stirling…

da0e7f1

…-PDF

Add course CI workflow for backend build and core tests

21d19cd

CI: add targeted tests for GlobalExceptionHandler and SecretMasker

fdcbce3

Merge pull request #4 from liujs123456/liujs-whitebox-exception-handler

09dd8ef

CI: add targeted tests for GlobalExceptionHandler and SecretMasker

added Dazhi testing to .yml file

fe771f8

1

f9c65fb

fix path for Dazhi

ed87ae7

Part 5. Testable Design. Mocking by pengcheng xu

36737e0

bug fixed by pengcheng xu

3801e67

Part 5. Finished by Dazhi Wang

8764a03

Add MobileScannerController validation helper and tests (mocking + te…

1d3769e

…stable design)

Merge pull request #5 from liujs123456/liu-memberC-mobilescanner-clean

efe8b04

Add MobileScannerController validation helper and tests (mocking + te…

Remove unused GitHub Actions workflows (keep course-part4-ci.yml only)

c42b29f

Merge pull request #6 from liujs123456/remove-extra-workflows

f1bc6e0

Remove unused GitHub Actions workflows (keep course-part4-ci.yml only)

liujs123456 and others added 7 commits February 27, 2026 00:37

Fix MobileScannerController mocking test by stubbing feature flag

f5ecc04

add Bad testable design pengcheng xu

05c9556

bug fix

38bde3c

Add LanguageService stubbing test (Member C)

0360913

Merge pull request #7 from liujs123456/liu-memberC-stubbing

1ed819d

Add LanguageService stubbing test (Member C)

added stubbing by Dazhi Wang

de393b4

gradle update

6286cef

TwilightVoyager777 requested review from ConnorYoh, EthanHealy01, Frooodle, Ludy87, jbrunton96 and reecebrowne as code owners March 10, 2026 19:57

dosubot bot added the size:XXL This PR changes 1000+ lines ignoring generated files. label Mar 10, 2026

add github action back

0a3062c

balazs-szucs reviewed Mar 10, 2026

View reviewed changes

		// title is set both as ProblemDetail.title and property "title"
		assertEquals(pd.getTitle(), pd.getProperties().get("title"));


		import jakarta.servlet.http.HttpServletRequest;

		class GlobalExceptionHandlerTest {

Conversation

TwilightVoyager777 commented Mar 10, 2026

Description of Changes

What was changed

Why the change was made

Challenges encountered

Checklist

General

Documentation

Translations (if applicable)

UI Changes (if applicable)

Testing (if applicable)

Uh oh!

Frooodle commented Mar 10, 2026

Uh oh!

Frooodle commented Mar 10, 2026

Uh oh!

TwilightVoyager777 commented Mar 10, 2026

Uh oh!

balazs-szucs left a comment

Choose a reason for hiding this comment

Uh oh!

balazs-szucs Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

balazs-szucs Mar 10, 2026 •

edited

Loading