ops: code review workflow and test coverage

[manuraf]

List of Changes

This pull request introduces improvements to our test coverage reporting and integration with SonarQube for our project. The changes primarily revolve around the 'test-coverage' submodule, which plays a crucial role in assessing the unit test coverage of our entire project.

Here's a breakdown of the key enhancements included in this pull request:

'test-coverage' Submodule: We've enhanced the 'test-coverage' submodule to facilitate comprehensive unit test coverage verification for individual project modules. This submodule contains a range of configurations to support the assessment of test coverage for each module.

Integration with Maven Jacoco Plugin: We've integrated the powerful Maven Jacoco plugin, utilizing the 'report-aggregate' goal to aggregate the test coverage reports generated by individual modules. These aggregated reports are then sent to SonarQube for a holistic evaluation of test coverage and code quality.

Module-specific Jacoco Configuration: To ensure accurate test coverage reporting for each module, we've made it a requirement for every module to include the same plugin or library that generates the 'jacoco.xml' file summarizing the test coverage for that specific module.

Custom Profiles: We've configured custom profiles to simplify the process of running test coverage checks on individual modules. For example, to assess the 'onboarding-ms' module, you can execute the following script: 'mvn --projects :test-coverage --also-make verify -Ponboarding-ms,report,coverage'. The 'report' profile is dedicated to report generation, while the 'coverage' profile is designed for running the SonarQube scan in the cloud environment.

Motivation and Context

These improvements will not only enhance our ability to monitor and improve test coverage but also streamline the integration of test coverage data into our SonarQube analysis, thereby promoting better code quality and reliability.

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.

[sonarqubecloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
131 Code Smells

0.0% Coverage
2.6% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint