Add Code Difference API #372

fo-code · 2021-12-07T09:45:11Z

An API which calculates the code differences - so called 'delta' - between two commits.
The resulting delta model contains information about:

which files have been changed in which way
which concrete lines within these files have been changed in which way

The implementation for Git is available in the downstream PR jenkinsci/git-forensics-plugin#390

codecov · 2021-12-08T11:41:04Z

Codecov Report

Merging #372 (c415577) into master (5a028ef) will increase coverage by 2.16%.
The diff coverage is 89.71%.

@@             Coverage Diff              @@
##             master     #372      +/-   ##
============================================
+ Coverage     66.28%   68.44%   +2.16%     
- Complexity      307      365      +58     
============================================
  Files            41       48       +7     
  Lines          1053     1160     +107     
  Branches         88      100      +12     
============================================
+ Hits            698      794      +96     
- Misses          315      325      +10     
- Partials         40       41       +1

Impacted Files	Coverage Δ
...lugins/forensics/delta/DeltaCalculatorFactory.java	`59.25% <59.25%> (ø)`
...nkins/plugins/forensics/delta/DeltaCalculator.java	`100.00% <100.00%> (ø)`
.../jenkins/plugins/forensics/delta/model/Change.java	`100.00% <100.00%> (ø)`
.../plugins/forensics/delta/model/ChangeEditType.java	`100.00% <100.00%> (ø)`
...o/jenkins/plugins/forensics/delta/model/Delta.java	`100.00% <100.00%> (ø)`
...ins/plugins/forensics/delta/model/FileChanges.java	`100.00% <100.00%> (ø)`
...ns/plugins/forensics/delta/model/FileEditType.java	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5a028ef...c415577. Read the comment docs.

uhafner

In general very well written!

Some methods are not yet clear to me but I did not yet read the downstream PR.

uhafner · 2021-12-12T22:18:25Z

src/main/java/io/jenkins/plugins/forensics/delta/DeltaCalculatorFactory.java

+    /**
+     * Returns a {@link DeltaCalculator} for the specified {@link SCM repository}.
+     *
+     * @param scm      the key of the SCM repository (substring that must be part of the SCM key)
+     * @param run      the current build
+     * @param workTree the working tree of the repository
+     * @param listener a task listener
+     * @param logger   a logger to report error messages
+     * @return a delta calculator for the SCM of the specified build or a {@link NullDeltaCalculator} if the SCM is not
+     * supported
+     */


Somehow you did use a different coding style for JavaDoc comments. Didn't you open these projects using https://github.com/uhafner/warnings-ng-plugin-devenv? Then the coding style settings should be automatically set in IntelliJ.

uhafner · 2021-12-12T22:20:18Z

src/main/java/io/jenkins/plugins/forensics/delta/model/Change.java

+    /**
+     * The {@link ChangeEditType} of the change.
+     */


Such comments are just duplicating the name and type of the field and should be omitted.

uhafner · 2021-12-12T23:54:37Z

src/main/java/io/jenkins/plugins/forensics/delta/model/Delta.java

+    /**
+     * The currently processed commit.
+     */


See above, delete such comments

uhafner · 2021-12-12T23:55:07Z

src/main/java/io/jenkins/plugins/forensics/delta/model/Delta.java

+    /**
+     * The reference commit.
+     */


uhafner · 2021-12-12T23:55:28Z

src/main/java/io/jenkins/plugins/forensics/delta/model/Delta.java

+    /**
+     * The difference file created by Git.
+     */


Is this the content? OR in which format?

uhafner · 2021-12-13T00:04:41Z

src/test/java/io/jenkins/plugins/forensics/delta/model/ChangeTest.java

+    private static Change change;
+
+    @BeforeAll
+    static void init() {
+        change = new Change(EDIT_TYPE, FROM_LINE, TO_LINE);
+    }
+


This makes the test hard to read, inline and use a simple factory method that returns the object in the test.

uhafner · 2021-12-13T00:08:33Z

src/test/java/io/jenkins/plugins/forensics/delta/model/ChangeTest.java

+        Change changeTwo = new Change(EDIT_TYPE, FROM_LINE, TO_LINE);
+
+        assertThat(change).isEqualTo(changeTwo);
+    }


I would recommend to test equals in the following way:

@Test void shouldObeyEqualsContract() { EqualsVerifier.simple().forClass(Change.class).verify(); }

uhafner · 2021-12-13T00:08:46Z

src/test/java/io/jenkins/plugins/forensics/delta/model/DeltaTest.java

+    private static Delta delta;
+
+    @BeforeAll
+    static void init() {
+        delta = new Delta(CURRENT_COMMIT_ID, REFERENCE_COMMIT_ID);
+    }
+


uhafner · 2021-12-13T00:10:43Z

src/test/java/io/jenkins/plugins/forensics/delta/model/DeltaTest.java

+     *
+     * @return the created map
+     */
+    private Map<String, FileChanges> createFileChanges() {


Using an empty map would be sufficient , but it is fine to use the complex map here

uhafner · 2021-12-13T00:11:37Z

src/test/java/io/jenkins/plugins/forensics/delta/model/FileChangesTest.java

+    private static Map<ChangeEditType, List<Change>> changesMap;
+
+    private static FileChanges fileChanges;
+
+    @BeforeAll
+    static void init() {
+        ChangeEditType editType = ChangeEditType.INSERT;
+        List<Change> changes = Collections.singletonList(new Change(editType, 1, 6));
+        changesMap = new HashMap<>();
+        changesMap.put(editType, changes);
+        fileChanges = new FileChanges(FILE_NAME, FILE_CONTENT, FILE_EDIT_TYPE, changesMap);
+    }


See above. Maybe just inline the code and use EqualsVersifier for equals

…plugin into delta-api

fo-code added 5 commits December 6, 2021 16:04

Added an API for calculating the code difference between two commits

db091ef

Reset revision

b399451

Style fixes

5af353b

Style fixes

d8148f6

Style fixes

37a4665

fo-code mentioned this pull request Dec 8, 2021

Git implementation for delta API jenkinsci/git-forensics-plugin#390

Merged

fo-code added 2 commits December 8, 2021 11:08

Fixed model

a7f851f

Style fix

c59a6e6

fo-code added 2 commits December 8, 2021 17:03

Raised code coverage

8721e26

Fixed tests

8a36158

uhafner reviewed Dec 13, 2021

View reviewed changes

uhafner changed the title ~~Code Difference API~~ Add Code Difference API Dec 13, 2021

uhafner added the feature New features label Dec 13, 2021

fo-code and others added 5 commits December 18, 2021 11:44

Rework after code review

854c1c9

Merge branch 'jenkinsci:master' into delta-api

f704164

Fixed warnings

fa21e77

Merge branch 'delta-api' of https://github.com/fo-code/forensics-api-…

0c0660d

…plugin into delta-api

Adjusted model

89b67ff

uhafner approved these changes Dec 30, 2021

View reviewed changes

fo-code and others added 3 commits January 14, 2022 10:46

Checkstyle fix

89679ed

Merge branch 'jenkinsci:master' into delta-api

9044b46

Checkstyle fix

3b11c07

fo-code requested a review from uhafner January 14, 2022 11:31

fo-code and others added 2 commits February 13, 2022 11:55

Merge branch 'jenkinsci:master' into delta-api

a148fd5

Reworked FileChanges

c415577

fo-code marked this pull request as ready for review February 15, 2022 10:01

uhafner approved these changes Feb 15, 2022

View reviewed changes

uhafner merged commit 1e71a9c into jenkinsci:master Feb 15, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Code Difference API #372

Add Code Difference API #372

Uh oh!

fo-code commented Dec 7, 2021 •

edited by uhafner

Loading

Uh oh!

codecov bot commented Dec 8, 2021 •

edited

Loading

Uh oh!

uhafner left a comment

Uh oh!

uhafner Dec 12, 2021

Uh oh!

uhafner Dec 12, 2021

Uh oh!

uhafner Dec 12, 2021

Uh oh!

uhafner Dec 12, 2021

Uh oh!

uhafner Dec 12, 2021

Uh oh!

uhafner Dec 13, 2021

Uh oh!

uhafner Dec 13, 2021

Uh oh!

uhafner Dec 13, 2021

Uh oh!

uhafner Dec 13, 2021

Uh oh!

uhafner Dec 13, 2021

Uh oh!

Uh oh!

Add Code Difference API #372

Add Code Difference API #372

Uh oh!

Conversation

fo-code commented Dec 7, 2021 • edited by uhafner Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Dec 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

uhafner left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fo-code commented Dec 7, 2021 •

edited by uhafner

Loading

codecov bot commented Dec 8, 2021 •

edited

Loading