expectedLatency field added

documentation and tests updated

Author: Denis

README.md

@@ -2,8 +2,8 @@
 Pk-vcs-git is lightweight library for execute basic Git VCS operations (merge, branch create etc). It uses [pk-vcs-api](https://github.com/ProjectKaiser/pk-vcs-api) exposing IVCS implementation for Git repositories and [JGit](https://eclipse.org/jgit/) as framework to work with Git repositories.
 Features:
 - Branch create and remove
-- Branch merge returning result(success or list of conflicted files)
-- Commit messages list
+- Branch merge returning result (success or list of conflicted files)
+- Branch commits messages list
 - Summarized branch changes list
 - Branches list
 - File content getting and setting
@@ -54,6 +54,7 @@ Features:
 ```
 - Use methods of `IVCS` interface. See [pk-vcs-api](https://github.com/ProjectKaiser/pk-vcs-api) for details
 - Use `vcs.setProxy()` and `vcs.setCredentials()` if necessary
+- Github has some latency for exposing results of previously executed operations. For example if create a new branch and immediately check branches list then Github could return old branches list. Use `GitVCS.setExpectedLatency()` to set delay which will be executed after each operation which may have server latency 
 
 # Implementation details
 - [JGit](https://eclipse.org/jgit/) is used as framework to work with Git repositories
@@ -70,7 +71,7 @@ Features:
   - `PK_VCS_TEST_GITHUB_PASS` environment var or JVM var is used as user password for access to Github
   - New Test Repository is created before each test and deletes automatically after each test
 - To execute tests just run GitVCSTest class as JUnit test. Tests from VCSAbstractTest class will be executed. See  [pk-vcs-test](https://github.com/ProjectKaiser/pk-vcs-test) for details
-- NOTE: Github has some latency for exposing results of previously executed operations. For example if create a new branch and immediately check branches list then Github could return old branches list. Need to wait a couple of second to get new list. So if a test failed then try to execute it again. 
+- NOTE: Github has some latency for exposing results of previously executed operations. For example if create a new branch and immediately check branches list then Github could return old branches list. 2 seconds awaiting is added for testing. Also if a test failed then try to execute it again. 
 
 # Limitations
 - Commit messages can not be attached to branch create and delete operations because Git does not exposes these operations as separate commits

src/main/java/com/projectkaiser/scm/vcs/GitVCS.java

@@ -55,10 +55,19 @@ public class GitVCS implements IVCS {
 	private static final String MASTER_BRANCH_NAME = "master";
 	public static final String GIT_VCS_TYPE_STRING = "git";
 	private static final String REFS_REMOTES_ORIGIN = "refs/remotes/origin/";
+	private Integer expectedLatency = 0;
 
 	private CredentialsProvider credentials;
 	private IVCSRepositoryWorkspace repo;
 
+	public Integer getExpectedLatency() {
+		return expectedLatency;
+	}
+
+	public void setExpectedLatency(Integer expectedLatency) {
+		this.expectedLatency = expectedLatency;
+	}
+
 	public CredentialsProvider getCredentials() {
 		return credentials;
 	}
@@ -100,7 +109,7 @@ public void createBranch(String srcBranchName, String newBranchName, String comm
 								.setRefSpecs(refSpec)
 								.setCredentialsProvider(credentials)
 								.call();
-						Thread.sleep(2000); // github has some latency on branch operations
+						Thread.sleep(expectedLatency); // github has some latency on branch operations
 											// so next request branches operation will return old branches list
 					} finally {
 						git.getRepository().close();
@@ -152,7 +161,7 @@ public void deleteBranch(String branchName, String commitMessage) {
 							.setCredentialsProvider(credentials)
 							.call();
 					git.getRepository().close();
-					Thread.sleep(2000); // github has some latency on branch operations
+					Thread.sleep(expectedLatency); // github has some latency on branch operations
 										// so next request branches operation will return old branches list
 				}
 			}
@@ -196,7 +205,7 @@ public Git getLocalGit(IVCSLockedWorkingCopy wc) {
 	}
 
 	@Override
-	public VCSMergeResult merge(String sourceBranchUrl, String destBranchUrl, String commitMessage) {
+	public VCSMergeResult merge(String srcBranchName, String dstBranchName, String commitMessage) {
 		try {
 			try (IVCSLockedWorkingCopy wc = repo.getVCSLockedWorkingCopy()) {
 				try (Git git = getLocalGit(wc)) {
@@ -208,15 +217,15 @@ public VCSMergeResult merge(String sourceBranchUrl, String destBranchUrl, String
 
 					git
 							.checkout()
-							.setCreateBranch(git.getRepository().exactRef("refs/heads/" + parseBranch(destBranchUrl)) == null)
-							.setName(parseBranch(destBranchUrl))
+							.setCreateBranch(git.getRepository().exactRef("refs/heads/" + parseBranch(dstBranchName)) == null)
+							.setName(parseBranch(dstBranchName))
 							.call(); 
 
 					MergeResult mr = git
 							.merge()
-							.include(git.getRepository().findRef("origin/" + parseBranch(sourceBranchUrl)))
+							.include(git.getRepository().findRef("origin/" + parseBranch(srcBranchName)))
 							.setMessage(commitMessage)
-							.call(); // actually do the merge
+							.call(); 
 
 
 					VCSMergeResult res = new VCSMergeResult();
@@ -388,7 +397,7 @@ public String getFileContent(String branchName, String filePath) {
 	}
 
 	@Override
-	public List<VCSDiffEntry> getBranchesDiff(String srcBranchName, String destBranchName) {
+	public List<VCSDiffEntry> getBranchesDiff(String srcBranchName, String dstBranchName) {
 		List<VCSDiffEntry> res = new ArrayList<>();
 		try (IVCSLockedWorkingCopy wc = repo.getVCSLockedWorkingCopy()) {
 			try (Git git = getLocalGit(wc)) {
@@ -397,7 +406,7 @@ public List<VCSDiffEntry> getBranchesDiff(String srcBranchName, String destBranc
 			        RevCommit srcHeadCommit = walk.parseCommit(git.getRepository().resolve("remotes/origin/" 
 			        		+ parseBranch(srcBranchName)));
 			        RevCommit destHeadCommit = walk.parseCommit(git.getRepository().resolve("remotes/origin/" 
-			        		+ parseBranch(destBranchName)));
+			        		+ parseBranch(dstBranchName)));
 
 					List<RevCommit> startPoints = new ArrayList<RevCommit>();
 					walk.setRevFilter(RevFilter.MERGE_BASE);

src/test/java/com/projectkaiser/scm/vcs/GitVCSTest.java

@@ -102,6 +102,7 @@ protected IVCS getVCS(IVCSRepositoryWorkspace mockedVCSRepo) {
 		if (PROXY_HOST != null) {
 			vcs.setProxy(PROXY_HOST, PROXY_PORT, PROXY_USER, PROXY_PASS);
 		}
+		((GitVCS) vcs).setExpectedLatency(2000);
 		return vcs;
 	}