Add support for Git Log API. #2046

ShimonBenYair · 2016-08-04T11:18:25Z

What does this PR do?

What issues does this PR fix or reference?

Previous Behavior

Remove this section if not relevant

New Behavior

This content may also be included in the release notes.

Tests written?

Yes/No

Docs requirements?

Include the content for all the docs changes required.

API changes
User docs changes

Please review Che's Contributing Guide for best practices.

Add support for skip and maxCount when calling the LOG API.
Add support to get the log for a specific folder or file in the repository.
For every commit that is returned when calling the LOG API, the following data was added:
The author of the commit
A list of branch names that the commit is related to.
A list of file names that were changed/deleted/added in the commit.
A list of commit parents (to enable for example clients to paint a graph)

Signed-off-by: Shimon Ben.Yair shimon.ben.yair@sap.com

ShimonBenYair · 2016-08-04T11:19:46Z

@skabashnyuk @vinokurig

All your comments were fixed

codenvy-ci · 2016-08-05T13:13:57Z

Can one of the admins verify this patch?

codenvy-ci · 2016-08-09T10:14:39Z

Can one of the admins verify this patch?

ShimonBenYair · 2016-08-09T10:19:48Z

@skabashnyuk @vinokurig

Hi, do you have more comments to fix ?

vinokurig · 2016-08-09T10:30:40Z

wsagent/che-core-git-impl-jgit/src/main/java/org/eclipse/che/git/impl/jgit/JGitConnection.java

@@ -710,44 +721,163 @@ public void init(InitRequest request) throws GitException {
        }
    }

+    /** @see org.exoplatform.ide.git.server.GitConnection#log(org.exoplatform.ide.git.shared.LogRequest) */


this is invalid link

ShimonBenYair · 2016-08-11T14:23:13Z

@vinokurig
I have fixed all your comments,
please review

vinokurig · 2016-08-12T06:48:43Z

wsagent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/LogRequest.java

+     */
+    LogRequest withRevisionRangeUntil(String revisionRangeUntil);
+
+    /** @return the integer value of the number of commits that will be skipped when calling log API */


the integer value of the number of commits that will be skipped when calling log command ?

vinokurig · 2016-08-26T06:52:20Z

wsagent/che-core-git-impl-jgit/src/main/java/org/eclipse/che/git/impl/jgit/JGitConnection.java

+    }
+
+    private List<DiffCommitFile> getCommitDiffFiles(RevCommit revCommit, String pattern) throws IOException {
+        List<DiffEntry> diffs = null;


It is not necessary to initialize this variable as null

vinokurig · 2016-08-26T07:18:36Z

Could you please add tests for revision range in Log and for new fields in Revision

ShimonBenYair · 2016-09-18T12:28:41Z

@vinokurig
I have fixed all your comments,
can you please review and approve this pull request ?

vinokurig · 2016-09-19T05:13:05Z

I will review, as soon as possible

vinokurig · 2016-09-21T15:14:16Z

...ent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/DiffCommitFile.java

+    /** @return the file change type*/
+    String getChangeType();
+
+    /** set the file change type*/


Start the javadoc with capital letter here and in other javadocs

vinokurig · 2016-09-21T15:16:58Z

wsagent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/LogRequest.java

+    void setRevisionRangeSince(String revisionRangeSince);
+
+    /**
+     * Create a LogRequest object based on a given revision range since.


Create a {@link LogRequest} object based on a given revision range since.
here and in other javadocs

vinokurig · 2016-09-21T15:22:20Z

wsagent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/LogRequest.java

+    /** @return revision range until */
+    String getRevisionRangeUntil();
+
+    /** @set revision range until */


Please remove @

vinokurig · 2016-09-21T15:33:40Z

...ent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/DiffCommitFile.java

+     *
+     * @param oldPath
+     *         file previous location
+     * @return a DiffCommitFile object


Please provide more info here and in other javadocs like this.
May be something like this: {@link DiffCommitFile} object that contains information about changes of the committed file

vinokurig · 2016-09-21T15:40:13Z

wsagent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/Revision.java

+
+    /** Set a list of DiffCommitFile objects, which describes the changes in the commit files */
+    void setDiffCommitFile(List<DiffCommitFile> v);


v is not a good name for parameter

vinokurig · 2016-09-21T15:52:31Z

wsagent/che-core-api-git/src/test/java/org/eclipse/che/git/impl/LogTest.java

+    }
+
+    @Test(dataProvider = "GitConnectionFactory", dataProviderClass = GitConnectionFactoryProvider.class)
+    public void testLogWithSkipAndMaxCount(GitConnectionFactory connectionFactory) throws GitException, IOException {


What is the difference between this test and previous two?

Because i added three tests:

testLogSkip - to check log with skip option

testLogMaxCount - to check log with maxCount option
3)testLogWithSkipAndMaxCount - to check log with skip and maxCount together

In addition i added more tests

ShimonBenYair · 2016-09-22T13:20:57Z

@vinokurig
I have fixed all your comments,
can you please review and approve this pull request ?

vinokurig · 2016-09-23T17:12:26Z

wsagent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/LogRequest.java

+     *
+     * @param revisionRangeSince
+     *         revision range since
+     * @return a {@link LogRequest} object


I think it will be better to remove javadoc fields like this in this class

why ?
Do you mean to remove all javadocs from all the with[...] methods ?

I mean that @return a {@link LogRequest} object tells nothing except methods return type.
As for me it would be better to remove such fields only in this class, or try to provide more information there.

vinokurig

Other Ok fo rme @sleshchenko?

vinokurig · 2016-09-23T17:26:05Z

wsagent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/Revision.java

+     *
+     * @param branch
+     *         branch name
+     * @return a Revision object


@return a {@link Revision} object that contains information about revision

vinokurig · 2016-09-23T18:10:58Z

wsagent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/Revision.java

-
+
+    /**
+     * Create a Revision object based on a given branch name.


Please replace Revision to {@link Revision} here and in other javadocs

vinokurig · 2016-09-23T18:39:38Z

wsagent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/Revision.java

+    /**
+     * Parameter which shows that this revision is a fake revision (i.e. TO for Exception)
+     *
+     * @return boolean


Please provide more info or remove it

It is not a parameter that we added , so i don't know what is the purpose of this parameter ?
It was there before i added my code

return boolean looks bad for me

ShimonBenYair · 2016-09-25T06:56:14Z

@vinokurig
I have fixed all your comments,
can you please review and approve this pull request ?

vinokurig · 2016-09-26T06:40:36Z

@sleshchenko ?

sleshchenko · 2016-09-26T07:04:19Z

wsagent/che-core-git-impl-jgit/src/main/java/org/eclipse/che/git/impl/jgit/JGitConnection.java

        return gitUsers;
    }
-
+	


remove spaces here

sleshchenko · 2016-09-26T07:04:28Z

...ent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/DiffCommitFile.java

+ * Contributors:
+ *   Codenvy, S.A. - initial API and implementation
+ *******************************************************************************/
+


remove extra line

sleshchenko · 2016-09-26T07:04:33Z

...ent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/DiffCommitFile.java

+ *
+ * @author Shimon Ben Yair.
+ */
+


remove extra line

sleshchenko · 2016-09-26T07:06:36Z

...ent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/DiffCommitFile.java

+     */
+    DiffCommitFile withOldPath(String oldPath);
+
+    /** @return the file new location*/


Take a look https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment

sleshchenko · 2016-09-26T07:07:48Z

wsagent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/Revision.java

+    /**
+     * Parameter which shows that this revision is a fake revision (i.e. TO for Exception)
+     *
+     * @return boolean


return boolean looks bad for me

ShimonBenYair · 2016-10-09T07:54:23Z

@vinokurig
I have fixed all your comments,
can you please review and approve this pull request ?

vinokurig · 2016-10-10T07:12:40Z

...ent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/DiffCommitFile.java

+     */
+    DiffCommitFile withOldPath(String oldPath);
+
+    /** @return the file new location */


According to https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment, it should be something like this: Returns new location of the file. Please take a look to other javadocs like this.

Add support for skip and maxCount when calling the LOG API. Add support to get the log for a specific folder or file in the repository. For every commit that is returned when calling the LOG API, the following data was added: The author of the commit A list of branch names that the commit is related to. A list of file names that were changed/deleted/added in the commit. A list of commit parents (to enable for example clients to paint a graph) Change-Id: I2cc486cc49787c681b031067728b7a33f8fb11e7 Signed-off-by: Shimon Ben.Yair <shimon.ben.yair@sap.com>

ShimonBenYair · 2016-10-13T06:33:55Z

@vinokurig
I have fixed all your comments,
can you please review and approve this pull request ?

ShimonBenYair · 2016-10-25T07:38:08Z

@vinokurig
I have fixed all your comments,
can you please review and approve this pull request ?

vinokurig · 2016-10-26T06:59:49Z

QA is in progress

vkuznyetsov · 2016-10-27T08:11:25Z

@vinokurig could you please merge this PR

Add support for skip and maxCount when calling the LOG API. Add support to get the log for a specific folder or file in the repository. For every commit that is returned when calling the LOG API, the following data was added: The author of the commit A list of branch names that the commit is related to. A list of file names that were changed/deleted/added in the commit. A list of commit parents (to enable for example clients to paint a graph) Change-Id: I2cc486cc49787c681b031067728b7a33f8fb11e7 Signed-off-by: Shimon Ben.Yair <shimon.ben.yair@sap.com>

vinokurig reviewed Aug 9, 2016
View reviewed changes

ShimonBenYair force-pushed the add_support_git_log_API branch from 7d27f3e to e2b3485 Compare August 11, 2016 14:11

vinokurig reviewed Aug 12, 2016
View reviewed changes

vinokurig reviewed Aug 26, 2016
View reviewed changes

ShimonBenYair force-pushed the add_support_git_log_API branch from 8d524d7 to 297a3b0 Compare September 18, 2016 12:26

vinokurig reviewed Sep 21, 2016

View reviewed changes

ShimonBenYair force-pushed the add_support_git_log_API branch from 297a3b0 to 652c4f0 Compare September 22, 2016 13:15

vinokurig reviewed Sep 23, 2016

View reviewed changes

ShimonBenYair force-pushed the add_support_git_log_API branch from 652c4f0 to dbdacf0 Compare September 25, 2016 06:55

sleshchenko reviewed Sep 26, 2016

View reviewed changes

ShimonBenYair force-pushed the add_support_git_log_API branch from dbdacf0 to f4ad4cc Compare October 9, 2016 07:50

vinokurig reviewed Oct 10, 2016

View reviewed changes

ShimonBenYair force-pushed the add_support_git_log_API branch from f4ad4cc to e290997 Compare October 13, 2016 06:33

vinokurig approved these changes Oct 25, 2016

View reviewed changes

vinokurig merged commit d55fbe9 into eclipse-che:master Oct 27, 2016

i053322 mentioned this pull request Oct 31, 2016

Add support for Git Log codenvy-legacy/che-core#738

Merged

bmicklea added this to the 5.0.0 milestone Jan 11, 2017


		/** Set a list of DiffCommitFile objects, which describes the changes in the commit files */
		void setDiffCommitFile(List<DiffCommitFile> v);

Add support for Git Log API. #2046

Add support for Git Log API. #2046

Conversation

ShimonBenYair commented Aug 4, 2016

What does this PR do?

What issues does this PR fix or reference?

Previous Behavior

New Behavior

Tests written?

Docs requirements?

ShimonBenYair commented Aug 4, 2016 • edited Loading

codenvy-ci commented Aug 5, 2016

codenvy-ci commented Aug 9, 2016

ShimonBenYair commented Aug 9, 2016

Choose a reason for hiding this comment

ShimonBenYair commented Aug 11, 2016

Choose a reason for hiding this comment

vinokurig Aug 26, 2016 • edited Loading

Choose a reason for hiding this comment

vinokurig commented Aug 26, 2016

ShimonBenYair commented Sep 18, 2016 • edited Loading

vinokurig commented Sep 19, 2016

vinokurig Sep 21, 2016 • edited Loading

Choose a reason for hiding this comment

vinokurig Sep 21, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ShimonBenYair commented Sep 22, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vinokurig left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ShimonBenYair Sep 25, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ShimonBenYair commented Sep 25, 2016

vinokurig commented Sep 26, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ShimonBenYair commented Oct 9, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ShimonBenYair commented Oct 13, 2016

ShimonBenYair commented Oct 25, 2016

vinokurig commented Oct 26, 2016

vkuznyetsov commented Oct 27, 2016

ShimonBenYair commented Aug 4, 2016 •

edited

Loading

vinokurig Aug 26, 2016 •

edited

Loading

ShimonBenYair commented Sep 18, 2016 •

edited

Loading

vinokurig Sep 21, 2016 •

edited

Loading

vinokurig Sep 21, 2016 •

edited

Loading

ShimonBenYair Sep 25, 2016 •

edited

Loading