Reactivate Checkstyle

[wadoon]

Someone deactivated Sonarqube. We seem to have a deeper inner confusion with our common understanding of clean code. This is my last attempt at getting something going, after this I am on my wit's end.

First, this PR reactivates the Checkstyle using updated versions of the GitDiffFilter, which are now externalized as Maven dependencies. The code of the diff filter are here: https://github.com/wadoon/checkstyle-key-extensions. Ownership transferred on acceptance, also published on Maven Central.

The address of the diff is

        checkstyle("org.key-project.devel:checkstyle-key-extensions:1.17-SNAPSHOT")

which can then be used across projects. The checkstyle-key-extensions are updated to the latest version of checkstyle, which has two filters now: one for files before parsing, one for issues after linting. checkstyle-key-extensions uses both.

Checkstyle is invoked via Gradle via checkstyleMain and checkstyleTest. Dependencies are managed by Gradle.

The bottleneck is the limited reported possibilities on Github. This PR tries to use everything.

1. A Markdown Job summary is added
   

2. Sarif files are joined and uploaded:
   

3. HTML checkstyle artifacts can be downloaded
   

4. Moreover, it simplifies the Jacoco integration.

5. At the end of the Github tests runs, a Gradle task reads JUnit test xml reports and prints out Github annotations. Failing tests should appear on the Github workflow summary.

   

It does not add a comment to the PR as this is not reliable due to reduced permissions on workflow executions for foreign repositories.

Testing

Testing of this PR is hard. You need

1. failing test cases
2. checkstyle violations

It might be a good choice to merge this branch squashily on some of your working branches for testing.

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

[wadoon]

Missing check, if no Java files were altered.

[mattulbrich]

Someone deactivated Sonarqube. We seem to have a deeper inner confusion with our common understanding of clean code.

If there is confusion, should that not be cleared first? What is the confusion about?

[wadoon]

If there is confusion, should that not be cleared first? What is the confusion about?

This was just an euphemism for we agreed on Sonarcube, set up the rules, and someone deactivates it. This leads to questions.

[mattulbrich]

The newly introduced check still fails.

Regarding tools like SonarCube:
CodeQuality measuring gates help improve the code. However, they must work properly. If they fail consistently and are not repaired, they should be turned off.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 47.98%. Comparing base (2aa39bb) to head (124e908).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #3539      +/-   ##
============================================
- Coverage     47.99%   47.98%   -0.01%     
+ Complexity    16046    16042       -4     
============================================
  Files          1683     1683              
  Lines         96044    96044              
  Branches      15387    15387              
============================================
- Hits          46093    46087       -6     
- Misses        44681    44686       +5     
- Partials       5270     5271       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.