feat(freestyle): Allow multiple report configurations in Freestyle pr… #461
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ojects This change addresses the limitation where Freestyle projects could only have a single "Publish report files" post-build action. Modifications: - ReportRecorder.java: - Introduced an inner class `ReportConfig` to encapsulate `name`, `provider`, and `displayType` for a single report. - ReportRecorder now holds a `List<ReportConfig>` to manage multiple report configurations. - The `perform` method iterates through these configurations, processing each report (scanning and publishing). - `readResolve` is implemented for backward compatibility, migrating old single-report job configurations to the new list format. - config.jelly (for ReportRecorder): - Updated to use `<f:repeatableProperty field="reportConfigs">`, enabling you to add and configure multiple reports in the job UI. - Unit Tests: - Added `testReadResolve_migratesOldConfiguration` to ensure smooth migration of existing job configurations. - Added `testPerform_processesAllReportConfigs` to verify that multiple configured reports are processed correctly by the `perform` method. This allows you to define multiple instances of report file configurations (JSON, XML, CSV, YAML) in your Freestyle projects, similar to what is possible in Pipeline projects.
This commit addresses compilation errors that arose after refactoring ReportRecorder to support multiple report configurations. Fixes: - ReportRecorder.java: - Reintroduced deprecated @DataBoundSetter methods for `setName`, `setProvider`, and `setDisplayType`. These methods adapt single-report configurations to the new list-based `reportConfigs` structure by operating on the first element of the list. This ensures backward compatibility for pipeline steps using ReportRecorder. - Corrected the instantiation of `ReportResult` in the `perform` method. The `finalResult` variable is now initialized with `new ReportResult(run, new Report())` to provide a valid, empty result if no reports are processed, resolving a constructor argument mismatch. These changes allow the project to compile successfully while retaining the functionality for multiple report configurations in Freestyle projects and ensuring continued operation for pipeline steps.
… resolve the test compilation errors you were seeing due to the missing `org.mockito` package.
This commit addresses test compilation failures by: 1. Changing the visibility of the `scan` method in `ReportRecorder.java` from private to package-private. This allows Mockito to spy on the method from test classes in the same package. 2. Correcting the usage of `DisplayType` in `ReportRecorderTest.java`. The test was attempting to use a non-existent `DisplayType.PIE` constant. This has been changed to use `DisplayType.RELATIVE` (with the corresponding string "relative" in setup), which is a valid enum constant.
Updates mockito-core dependency from 4.11.0 to 5.12.0. This is an attempt to resolve JVM crashes during test execution on JDK 21, as newer Mockito versions generally offer better compatibility with recent JDKs.
Replaces mockito-core with mockito-inline (version 5.12.0). This change aims to resolve JVM crashes during Surefire test execution by using Mockito's inline mock maker, which can be more robust on modern JDKs and with complex classloader/module setups.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…ojects
This change addresses the limitation where Freestyle projects could only have a single "Publish report files" post-build action.
Modifications:
ReportConfigto encapsulatename,provider, anddisplayTypefor a single report.List<ReportConfig>to manage multiple report configurations.performmethod iterates through these configurations, processing each report (scanning and publishing).readResolveis implemented for backward compatibility, migrating old single-report job configurations to the new list format.<f:repeatableProperty field="reportConfigs">, enabling you to add and configure multiple reports in the job UI.testReadResolve_migratesOldConfigurationto ensure smooth migration of existing job configurations.testPerform_processesAllReportConfigsto verify that multiple configured reports are processed correctly by theperformmethod.This allows you to define multiple instances of report file configurations (JSON, XML, CSV, YAML) in your Freestyle projects, similar to what is possible in Pipeline projects.
Testing done
Submitter checklist