Remote API to connect additional code review tools #737

fo-code · 2023-07-31T09:29:19Z

Adds a REST API that provides the coverage information of modified lines for each modified file - see #731 .

…nto dev

plugin/src/test/java/io/jenkins/plugins/coverage/metrics/steps/LineCoverageViewTest.java

…utines

codecov · 2023-08-25T08:14:54Z

Codecov Report

Merging #737 (04dfec4) into master (2ef24aa) will increase coverage by 0.39%.
Report is 15 commits behind head on master.
The diff coverage is 97.87%.

@@             Coverage Diff              @@
##             master     #737      +/-   ##
============================================
+ Coverage     74.08%   74.47%   +0.39%     
- Complexity     1698     1749      +51     
============================================
  Files           130      135       +5     
  Lines          6289     6393     +104     
  Branches        677      690      +13     
============================================
+ Hits           4659     4761     +102     
- Misses         1407     1408       +1     
- Partials        223      224       +1

Files	Coverage Δ
.../plugins/coverage/metrics/restapi/CoverageApi.java	`100.00% <100.00%> (ø)`
...overage/metrics/restapi/FileWithModifiedLines.java	`100.00% <100.00%> (ø)`
...ins/coverage/metrics/restapi/LineCoverageType.java	`100.00% <100.00%> (ø)`
...s/coverage/metrics/restapi/ModifiedLinesBlock.java	`100.00% <100.00%> (ø)`
...rage/metrics/restapi/ModifiedLinesCoverageApi.java	`100.00% <100.00%> (ø)`
...metrics/restapi/ModifiedLinesCoverageApiModel.java	`83.33% <83.33%> (ø)`
...gins/coverage/metrics/steps/CoverageViewModel.java	`54.13% <66.66%> (-0.07%)`	⬇️

... and 6 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

…naming and reformatting

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/restapi/CoverageApi.java

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/restapi/ModifiedLineCoverageApi.java

uhafner · 2023-09-06T20:46:07Z

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/restapi/ModifiedLineCoverageApi.java

+                    modifiedLinesBlocks);
+            filesWithModifiedLines.add(changedFile);
+        }
+        return filesWithModifiedLines;


I have a student implementation of such a code in the coverage-model (not yet published). So this code is ok for now but might be removed in the future...

uhafner · 2023-09-06T20:55:08Z

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/restapi/ModifiedLineCoverageApi.java

+
+        int currentLine = modifiedLines.get(0);
+        for (int i = 0; i < modifiedLines.size(); i++) {
+            if (i == modifiedLines.size() - 1 || !modifiedLines.get(i).equals(modifiedLines.get(i + 1) - 1)) {


Note: this implementation is only partly correct. Since coverage calculation is done on the byte code, there might be lines without coverage information between two covered lines.

Example:

1 int code; 2 // empty 3 code = 0;

Will have a coverage of line 1 and 3 but not 2. As a user I would expect that the block 1-3 is fully covered. But your code produces two blocks. But this can be improved later one if someone complains 🤷

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/restapi/ModifiedLineCoverageApi.java

plugin/src/main/resources/io/jenkins/plugins/coverage/metrics/restapi/_api.jelly

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/gerrit/GerritCoverageController.java

# Conflicts: # plugin/src/main/java/io/jenkins/plugins/coverage/metrics/gerrit/GerritCoverageController.java

…ine number instead of coverage type

fo-code · 2023-10-07T10:35:28Z

@uhafner I extended the GitForensicsITest with a call to the new API to verify the resulting JSON. I added that in that test class since it offers a special setup where modified code lines as well as related coverage data is provided. Both is required for a decent test scenario here.
Also, I finished the implementation and added a description of the new API to the README.

From my side we can merge this PR, if you don't have any further suggestions.

uhafner

Almost ready for merge, thanks for updating!

README.md

.../src/test/java/io/jenkins/plugins/coverage/metrics/restapi/ModifiedLinesCoverageApiTest.java

plugin/src/test/java/io/jenkins/plugins/coverage/metrics/steps/GitForensicsITest.java

...in/resources/io/jenkins/plugins/coverage/metrics/restapi/ModifiedLinesCoverageApi/_api.jelly

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/restapi/ModifiedLinesCoverageApi.java

…type

plugin/src/test/java/io/jenkins/plugins/coverage/metrics/restapi/FileWithModifiedLinesTest.java

+/**
+ * Tests {@link FileWithModifiedLines}.
+ */
+class FileWithModifiedLinesTest {


plugin/src/test/java/io/jenkins/plugins/coverage/metrics/restapi/ModifiedLinesBlockTest.java

+/**
+ * Tests {@link ModifiedLinesBlock}.
+ */
+class ModifiedLinesBlockTest {


fo-code · 2023-10-14T17:37:44Z

@uhafner I reworked the implementation and included your comments. Now everything works like discussed and is also tested.

The only problem is there are test failures regarding docker images and I think they are not caused by this pull request, so I do not know how to fix it.

uhafner

Thanks!

uhafner · 2023-10-17T10:19:44Z

I am rerunning the checks and will merge if everything is back to green...

aelfric-m and others added 12 commits July 18, 2023 13:43

adds model classes

372e4d8

adds LineCoverageViewModel class

9ca1af4

Add test environment for coverage remote api model calculation

f7070e9

adds LineCoverageViewModel class

2738d94

Merge branch 'dev' of github.com:aelfric-m/code-coverage-api-plugin i…

b8e59bc

…nto dev

fixes LineCoverageViewModel class

b0940cf

adds test for LineCoverageViewModel class

102fb85

adds first working model of ChangedAndCoveredLinesApi

ad3192a

adds first working model of CoolApi

eb1dc94

backup

2c99275

LineCoverageViewModel can now be passed as an argument to an Api

8095485

properly names LineCoverageTest and removes unused code

eca4317

github-advanced-security bot found potential problems Jul 31, 2023

View reviewed changes

plugin/src/test/java/io/jenkins/plugins/coverage/metrics/steps/LineCoverageViewTest.java Fixed Show fixed Hide fixed

uhafner added the enhancement Enhancement of existing functionality label Aug 1, 2023

This comment was marked as resolved.

Sign in to view

Aelfric Mayer added 12 commits August 3, 2023 14:07

refacors model classes to better reflect their usage

3076954

makes model class attributes final and removes associated setters

3ab8736

separates data from LineCoverageViewModel into LineCoverageApi

fdc71c9

changes unit test assertions to AssertJ and removes redundant test ro…

bbba7fc

…utines

adds documentation to classes associated with the line coverage API

c3f0d7c

fixed out of bounds exception

928e0e1

fixes annotations for ModifiedLinesBlock class

7a779d7

fixes jenkins CheckStyle

ef4a9c9

more checks fixes

45e5664

reformatting and import optimization

68e4cde

refactors the LineCoverageViewModel to CoverageApiUtil

de9da44

renames function to better reflect its job

165d80e

This comment was marked as resolved.

Sign in to view

fo-code marked this pull request as ready for review August 31, 2023 15:50

integrates the logic from CoverageApiUtil into the Api class. More re…

dc1dd4b

…naming and reformatting

uhafner reviewed Sep 6, 2023

View reviewed changes

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/restapi/CoverageApi.java Show resolved Hide resolved

uhafner reviewed Sep 6, 2023

View reviewed changes

Aelfric Mayer added 2 commits September 7, 2023 10:43

Adds restapi package to design.puml. Some renaming

07ab227

Adds GerritCoverageController class for Gerrit fronteend communication

94fefc4

uhafner reviewed Sep 13, 2023

View reviewed changes

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/gerrit/GerritCoverageController.java Outdated Show resolved Hide resolved

Aelfric Mayer and others added 12 commits September 20, 2023 09:43

Adds GerritCoverageController class for Gerrit fronteend communication

1531f76

Merge remote-tracking branch 'origin/dev' into dev

4366b71

# Conflicts: # plugin/src/main/java/io/jenkins/plugins/coverage/metrics/gerrit/GerritCoverageController.java

removes GerritCoverageController class

6d09435

visibility changes in restapi package

cc8cdbd

Data provided by ModifiedLinesCoverageApi is now sorted by starting l…

0328e16

…ine number instead of coverage type

Data provided by ModifiedLinesCoverageApi is now sorted by starting l…

b21c729

…ine number instead of coverage type

Merge remote-tracking branch 'origin/dev' into dev

b16555d

Merge branch 'jenkinsci:master' into dev

e5e5470

Add modified lines API integration test

5d3f660

Coverage API test

972649d

Coverage API test

617cf8e

Implemented coverage API test and added README

9b96984

fo-code requested a review from uhafner October 7, 2023 10:35

uhafner suggested changes Oct 12, 2023

View reviewed changes

fo-code added 2 commits October 13, 2023 19:12

Better implementation for calculating line blocks for REST API

54389a9

§Improved calculation of modified line blocks with the same coverage …

0edbb21

…type

github-advanced-security bot found potential problems Oct 14, 2023

View reviewed changes

Fix checkstyle

04dfec4

fo-code requested a review from uhafner October 14, 2023 17:38

uhafner approved these changes Oct 17, 2023

View reviewed changes

uhafner merged commit 582b210 into jenkinsci:master Oct 17, 2023

Remote API to connect additional code review tools #737

Remote API to connect additional code review tools #737

Uh oh!

Conversation

fo-code commented Jul 31, 2023

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

codecov bot commented Aug 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

This comment was marked as resolved.

Uh oh!

Uh oh!

Uh oh!

uhafner Sep 6, 2023

Choose a reason for hiding this comment

Uh oh!

uhafner Sep 6, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fo-code commented Oct 7, 2023

Uh oh!

uhafner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check notice

Check notice

fo-code commented Oct 14, 2023

Uh oh!

uhafner left a comment

Choose a reason for hiding this comment

Uh oh!

uhafner commented Oct 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Aug 25, 2023 •

edited

Loading