| /* |
| * Copyright (C) 2015, Google Inc. and others |
| * |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Distribution License v. 1.0 which is available at |
| * https://www.eclipse.org/org/documents/edl-v10.php. |
| * |
| * SPDX-License-Identifier: BSD-3-Clause |
| */ |
| |
| package org.eclipse.jgit.transport; |
| |
| import static org.junit.Assert.assertEquals; |
| import static org.junit.Assert.assertNull; |
| import static org.junit.Assert.assertTrue; |
| import static org.junit.Assert.fail; |
| |
| import java.util.ArrayList; |
| import java.util.List; |
| import java.util.concurrent.atomic.AtomicInteger; |
| |
| import org.eclipse.jgit.api.Git; |
| import org.eclipse.jgit.api.errors.InvalidRemoteException; |
| import org.eclipse.jgit.api.errors.TransportException; |
| import org.eclipse.jgit.internal.JGitText; |
| import org.eclipse.jgit.internal.storage.dfs.DfsRepositoryDescription; |
| import org.eclipse.jgit.internal.storage.dfs.InMemoryRepository; |
| import org.eclipse.jgit.junit.TestRepository; |
| import org.eclipse.jgit.lib.AnyObjectId; |
| import org.eclipse.jgit.lib.Constants; |
| import org.eclipse.jgit.lib.ObjectId; |
| import org.eclipse.jgit.lib.RefUpdate; |
| import org.eclipse.jgit.lib.Repository; |
| import org.eclipse.jgit.revwalk.RevCommit; |
| import org.eclipse.jgit.revwalk.RevTag; |
| import org.eclipse.jgit.revwalk.RevWalk; |
| import org.eclipse.jgit.storage.pack.PackStatistics; |
| import org.eclipse.jgit.transport.BasePackFetchConnection.FetchConfig; |
| import org.eclipse.jgit.transport.resolver.ReceivePackFactory; |
| import org.eclipse.jgit.transport.resolver.ServiceNotAuthorizedException; |
| import org.eclipse.jgit.transport.resolver.UploadPackFactory; |
| import org.junit.After; |
| import org.junit.Before; |
| import org.junit.Test; |
| |
| public class TestProtocolTest { |
| private static final RefSpec HEADS = new RefSpec("+refs/heads/*:refs/heads/*"); |
| |
| private static final RefSpec MASTER = new RefSpec( |
| "+refs/heads/master:refs/heads/master"); |
| |
| private static final int HAVES_PER_ROUND = 32; |
| private static final int MAX_HAVES = 256; |
| |
| private static class User { |
| private final String name; |
| |
| private User(String name) { |
| this.name = name; |
| } |
| } |
| |
| private static class DefaultUpload implements UploadPackFactory<User> { |
| @Override |
| public UploadPack create(User req, Repository db) { |
| UploadPack up = new UploadPack(db); |
| up.setPostUploadHook((PackStatistics stats) -> { |
| havesCount = stats.getHaves(); |
| }); |
| return up; |
| } |
| } |
| |
| private static class DefaultReceive implements ReceivePackFactory<User> { |
| @Override |
| public ReceivePack create(User req, Repository db) { |
| return new ReceivePack(db); |
| } |
| } |
| |
| private static long havesCount; |
| |
| private List<TransportProtocol> protos; |
| private TestRepository<InMemoryRepository> local; |
| private TestRepository<InMemoryRepository> remote; |
| |
| @Before |
| public void setUp() throws Exception { |
| protos = new ArrayList<>(); |
| local = new TestRepository<>( |
| new InMemoryRepository(new DfsRepositoryDescription("local"))); |
| remote = new TestRepository<>( |
| new InMemoryRepository(new DfsRepositoryDescription("remote"))); |
| } |
| |
| @After |
| public void tearDown() { |
| for (TransportProtocol proto : protos) { |
| Transport.unregister(proto); |
| } |
| } |
| |
| @Test |
| public void testFetch() throws Exception { |
| ObjectId master = remote.branch("master").commit().create(); |
| |
| TestProtocol<User> proto = registerDefault(); |
| URIish uri = proto.register(new User("user"), remote.getRepository()); |
| |
| try (Git git = new Git(local.getRepository())) { |
| git.fetch() |
| .setRemote(uri.toString()) |
| .setRefSpecs(HEADS) |
| .call(); |
| assertEquals(master, |
| local.getRepository().exactRef("refs/heads/master").getObjectId()); |
| } |
| } |
| |
| @Test |
| public void fetchReportsLockFailureWhenAutoFollowTagIsCreated() |
| throws Exception { |
| String tagName = "foo"; |
| String tagRef = "refs/tags/" + tagName; |
| String remoteBranchName = "remotefoo"; |
| String forcedRemoteRef = "+refs/heads/" + remoteBranchName; |
| |
| RevCommit localCommit = local.commit().add("local.txt", "new").create(); |
| RevCommit remoteCommit = remote.branch(remoteBranchName).commit() |
| .add("remote.txt", "remote").create(); |
| RevTag remoteTag = remote.tag("foo", remoteCommit); |
| remote.update(tagRef, remoteTag); |
| |
| URIish uri = registerTestProtocolUpdatingRef((repo) -> repo.lightweightTag(tagName, localCommit)); |
| |
| |
| try (Git git = new Git(local.getRepository())) { |
| FetchResult result = git.fetch().setRemote(uri.toString()) |
| .setRefSpecs(new RefSpec(forcedRemoteRef |
| + ":refs/remotes/origin/" + remoteBranchName)) |
| .setTagOpt(TagOpt.AUTO_FOLLOW).call(); |
| |
| TrackingRefUpdate update = result.getTrackingRefUpdate(tagRef); |
| assertEquals(RefUpdate.Result.LOCK_FAILURE, update.getResult()); |
| // Tag hasn't been clobbered... |
| assertEquals(localCommit, |
| local.getRepository().exactRef(tagRef).getObjectId()); |
| // ...however the object has been downloaded |
| assertTrue(local.getRepository().getObjectDatabase() |
| .has(remoteCommit)); |
| } |
| } |
| |
| @Test |
| public void fetchReportsLockFailureWhenDestinationRefChanges() |
| throws Exception { |
| String localBranchName = "localfoo"; |
| String localRef = "refs/heads/" + localBranchName; |
| String remoteBranchName = "remotefoo"; |
| String forcedRemoteRef = "+refs/heads/" + remoteBranchName; |
| |
| RevCommit oldLocalCommit = local.branch(localBranchName).commit() |
| .add("local.txt", "old").create(); |
| RevCommit newLocalCommit = local.commit().parent(oldLocalCommit) |
| .add("local.txt", "new").create(); |
| RevCommit remoteCommit = remote.branch(remoteBranchName).commit() |
| .add("remote.txt", "remote").create(); |
| |
| URIish uri = registerTestProtocolUpdatingRef((repo) -> repo.update(localBranchName, newLocalCommit)); |
| |
| try (Git git = new Git(local.getRepository())) { |
| FetchResult result = git.fetch().setRemote(uri.toString()) |
| .setRefSpecs( |
| new RefSpec(forcedRemoteRef + ":" + localRef)) |
| .call(); |
| |
| TrackingRefUpdate update = result.getTrackingRefUpdate(localRef); |
| assertEquals(RefUpdate.Result.LOCK_FAILURE, update.getResult()); |
| // Ref hasn't been clobbered... |
| assertEquals(newLocalCommit, |
| local.getRepository().exactRef(localRef).getObjectId()); |
| // ...however the object has been downloaded |
| assertTrue(local.getRepository().getObjectDatabase() |
| .has(remoteCommit)); |
| } |
| } |
| |
| @Test |
| public void fetchReportsLockFailureWhenDestinationRefIsCreated() |
| throws Exception { |
| String localBranchName = "localfoo"; |
| String localRef = "refs/heads/" + localBranchName; |
| String remoteBranchName = "remotefoo"; |
| String forcedRemoteRef = "+refs/heads/" + remoteBranchName; |
| |
| RevCommit newLocalCommit = local.commit().add("local.txt", "new") |
| .create(); |
| RevCommit remoteCommit = remote.branch(remoteBranchName).commit() |
| .add("remote.txt", "remote").create(); |
| |
| URIish uri = registerTestProtocolUpdatingRef((repo) -> repo.update(localBranchName, newLocalCommit)); |
| |
| try (Git git = new Git(local.getRepository())) { |
| FetchResult result = git.fetch().setRemote(uri.toString()) |
| .setRefSpecs( |
| new RefSpec(forcedRemoteRef + ":" + localRef)) |
| .call(); |
| |
| TrackingRefUpdate update = result.getTrackingRefUpdate(localRef); |
| assertEquals(RefUpdate.Result.LOCK_FAILURE, update.getResult()); |
| // Ref hasn't been clobbered... |
| assertEquals(newLocalCommit, |
| local.getRepository().exactRef(localRef).getObjectId()); |
| // ...however the object has been downloaded |
| assertTrue(local.getRepository().getObjectDatabase() |
| .has(remoteCommit)); |
| } |
| } |
| |
| @Test |
| public void testPush() throws Exception { |
| ObjectId master = local.branch("master").commit().create(); |
| |
| TestProtocol<User> proto = registerDefault(); |
| URIish uri = proto.register(new User("user"), remote.getRepository()); |
| |
| try (Git git = new Git(local.getRepository())) { |
| git.push() |
| .setRemote(uri.toString()) |
| .setRefSpecs(HEADS) |
| .call(); |
| assertEquals(master, |
| remote.getRepository().exactRef("refs/heads/master").getObjectId()); |
| } |
| } |
| |
| @Test |
| public void testFullNegotiation() throws Exception { |
| TestProtocol<User> proto = registerDefault(); |
| URIish uri = proto.register(new User("user"), remote.getRepository()); |
| |
| // Enough local branches to cause 10 rounds of negotiation, |
| // and a unique remote master branch commit with a later timestamp. |
| for (int i = 0; i < 10 * HAVES_PER_ROUND; i++) { |
| local.branch("local-branch-" + i).commit().create(); |
| } |
| remote.tick(11 * HAVES_PER_ROUND); |
| RevCommit master = remote.branch("master").commit() |
| .add("readme.txt", "unique commit").create(); |
| |
| try (Git git = new Git(local.getRepository())) { |
| assertNull(local.getRepository().exactRef("refs/heads/master")); |
| git.fetch().setRemote(uri.toString()).setRefSpecs(MASTER).call(); |
| assertEquals(master, local.getRepository() |
| .exactRef("refs/heads/master").getObjectId()); |
| assertEquals(10 * HAVES_PER_ROUND, havesCount); |
| } |
| } |
| |
| @Test |
| public void testMaxHaves() throws Exception { |
| TestProtocol<User> proto = registerDefault(); |
| URIish uri = proto.register(new User("user"), remote.getRepository()); |
| |
| // Enough local branches to cause 10 rounds of negotiation, |
| // and a unique remote master branch commit with a later timestamp. |
| for (int i = 0; i < 10 * HAVES_PER_ROUND; i++) { |
| local.branch("local-branch-" + i).commit().create(); |
| } |
| remote.tick(11 * HAVES_PER_ROUND); |
| RevCommit master = remote.branch("master").commit() |
| .add("readme.txt", "unique commit").create(); |
| |
| TestProtocol.setFetchConfig(new FetchConfig(true, MAX_HAVES)); |
| try (Git git = new Git(local.getRepository())) { |
| assertNull(local.getRepository().exactRef("refs/heads/master")); |
| git.fetch().setRemote(uri.toString()).setRefSpecs(MASTER).call(); |
| assertEquals(master, local.getRepository() |
| .exactRef("refs/heads/master").getObjectId()); |
| assertTrue(havesCount <= MAX_HAVES); |
| } |
| } |
| |
| @Test |
| public void testUploadPackFactory() throws Exception { |
| ObjectId master = remote.branch("master").commit().create(); |
| |
| final AtomicInteger rejected = new AtomicInteger(); |
| TestProtocol<User> proto = registerProto((User req, Repository db) -> { |
| if (!"user2".equals(req.name)) { |
| rejected.incrementAndGet(); |
| throw new ServiceNotAuthorizedException(); |
| } |
| return new UploadPack(db); |
| }, new DefaultReceive()); |
| |
| // Same repository, different users. |
| URIish user1Uri = proto.register(new User("user1"), remote.getRepository()); |
| URIish user2Uri = proto.register(new User("user2"), remote.getRepository()); |
| |
| try (Git git = new Git(local.getRepository())) { |
| try { |
| git.fetch() |
| .setRemote(user1Uri.toString()) |
| .setRefSpecs(MASTER) |
| .call(); |
| fail("accepted not permitted fetch"); |
| } catch (InvalidRemoteException expected) { |
| // Expected. |
| } |
| assertEquals(1, rejected.get()); |
| assertNull(local.getRepository().exactRef("refs/heads/master")); |
| |
| git.fetch() |
| .setRemote(user2Uri.toString()) |
| .setRefSpecs(MASTER) |
| .call(); |
| assertEquals(1, rejected.get()); |
| assertEquals(master, |
| local.getRepository().exactRef("refs/heads/master").getObjectId()); |
| } |
| } |
| |
| @Test |
| public void testReceivePackFactory() throws Exception { |
| ObjectId master = local.branch("master").commit().create(); |
| |
| final AtomicInteger rejected = new AtomicInteger(); |
| TestProtocol<User> proto = registerProto(new DefaultUpload(), |
| (User req, Repository db) -> { |
| if (!"user2".equals(req.name)) { |
| rejected.incrementAndGet(); |
| throw new ServiceNotAuthorizedException(); |
| } |
| return new ReceivePack(db); |
| }); |
| |
| // Same repository, different users. |
| URIish user1Uri = proto.register(new User("user1"), remote.getRepository()); |
| URIish user2Uri = proto.register(new User("user2"), remote.getRepository()); |
| |
| try (Git git = new Git(local.getRepository())) { |
| try { |
| git.push() |
| .setRemote(user1Uri.toString()) |
| .setRefSpecs(HEADS) |
| .call(); |
| fail("accepted not permitted push"); |
| } catch (TransportException expected) { |
| assertTrue(expected.getMessage().contains( |
| JGitText.get().pushNotPermitted)); |
| } |
| assertEquals(1, rejected.get()); |
| assertNull(remote.getRepository().exactRef("refs/heads/master")); |
| |
| git.push() |
| .setRemote(user2Uri.toString()) |
| .setRefSpecs(HEADS) |
| .call(); |
| assertEquals(1, rejected.get()); |
| assertEquals(master, |
| remote.getRepository().exactRef("refs/heads/master").getObjectId()); |
| } |
| } |
| |
| @Test |
| public void nonForcedFetchRejectedWithConcurrentLocalRefUpdate() |
| throws Exception { |
| String localRef = Constants.R_HEADS + "localfoo"; |
| String remoteBranchName = "remotefoo"; |
| String nonForcedRemoteRef = Constants.R_HEADS + remoteBranchName; |
| |
| try (Repository repository = local.getRepository(); |
| Git git = new Git(repository); |
| RevWalk revWalk = local.getRevWalk()) { |
| RefSpec nonForcedFetchRefSpec = new RefSpec( |
| nonForcedRemoteRef + ":" + localRef); |
| RevCommit oldLocalCommit = remote.branch(remoteBranchName) |
| .commit().add("base.txt", "base").create(); |
| |
| git.fetch().setRemote(registerDefaultTestProtocol().toString()).setRefSpecs(nonForcedFetchRefSpec) |
| .call(); |
| assertEquals(oldLocalCommit, repository.exactRef(localRef).getObjectId()); |
| |
| RevCommit updatedLocalCommit = local.commit() |
| .parent(revWalk.parseCommit(oldLocalCommit)) |
| .add("local.txt", "new").create(); |
| RevCommit remoteCommit = remote.commit().parent(oldLocalCommit) |
| .add("remote.txt", "remote").create(); |
| remote.update(remoteBranchName, remoteCommit); |
| |
| URIish uri = registerTestProtocolUpdatingRef((repo) -> repo.update(localRef, updatedLocalCommit)); |
| FetchResult result = git.fetch().setRemote(uri.toString()) |
| .setRefSpecs(nonForcedFetchRefSpec).call(); |
| |
| // Fetch has been rejected (non-ff) |
| TrackingRefUpdate update = result.getTrackingRefUpdate(localRef); |
| assertEquals(RefUpdate.Result.REJECTED, update.getResult()); |
| |
| // Fetched object has been downloaded |
| assertTrue(repository.getObjectDatabase() |
| .has(remoteCommit)); |
| // ... but the local ref has not been altered |
| assertEquals(updatedLocalCommit, |
| repository.exactRef(localRef).getObjectId()); |
| } |
| } |
| |
| @Test |
| public void forcedFetchReportsLockFailureWhenDestinationRefIsDeleted() |
| throws Exception { |
| String localBranchName = "localfoo"; |
| String localRef = Constants.R_HEADS + localBranchName; |
| String remoteBranchName = "remotefoo"; |
| String forcedRemoteRef = "+" + Constants.R_HEADS + remoteBranchName; |
| |
| local.branch(localBranchName).commit() |
| .add("local.txt", "old").create(); |
| RevCommit remoteCommit = remote.branch(remoteBranchName).commit() |
| .add("remote.txt", "remote").create(); |
| |
| URIish uri = registerTestProtocolUpdatingRef((repo) -> { |
| RefUpdate refUpdate = repo.getRepository().updateRef(localRef); |
| refUpdate.setForceUpdate(true); |
| refUpdate.delete(); |
| }); |
| |
| try (Git git = new Git(local.getRepository())) { |
| FetchResult result = git.fetch() |
| .setRemote(uri.toString()) |
| .setRefSpecs(new RefSpec(forcedRemoteRef + ":" + localRef)) |
| .call(); |
| |
| TrackingRefUpdate update = result.getTrackingRefUpdate(localRef); |
| assertEquals(RefUpdate.Result.LOCK_FAILURE, update.getResult()); |
| assertNull(local.getRepository().exactRef(localRef)); |
| assertTrue(local.getRepository().getObjectDatabase() |
| .has(remoteCommit)); |
| } |
| } |
| |
| @Test |
| public void forcedFetchReportsLockFailureWhenDestinationRefAlreadyHasNewId() |
| throws Exception { |
| String localBranchName = "localfoo"; |
| String localRef = Constants.R_HEADS + localBranchName; |
| String remoteBranchName = "remotefoo"; |
| String forcedRemoteRef = "+" + Constants.R_HEADS + remoteBranchName; |
| String tmpRef = Constants.R_HEADS + "tmp"; |
| |
| RevCommit oldLocalCommit = local.branch(localBranchName).commit() |
| .add("local.txt", "old").create(); |
| RevCommit remoteCommit = remote.branch(remoteBranchName).commit() |
| .add("remote.txt", "remote").create(); |
| |
| try (Git git = new Git(local.getRepository())) { |
| // Pre-fetch the remote object into the local object database so the |
| // simulated concurrent local update can point at it. |
| git.fetch().setRemote(registerDefaultTestProtocol().toString()) |
| .setRefSpecs(new RefSpec(forcedRemoteRef + ":" + tmpRef)) |
| .call(); |
| |
| local.update(localRef, oldLocalCommit); |
| |
| URIish uri = registerTestProtocolUpdatingRef( |
| (repo) -> repo.update(localRef, remoteCommit)); |
| |
| FetchResult result = git.fetch().setRemote(uri.toString()) |
| .setRefSpecs(new RefSpec(forcedRemoteRef + ":" + localRef)) |
| .call(); |
| |
| TrackingRefUpdate update = result.getTrackingRefUpdate(localRef); |
| assertEquals(RefUpdate.Result.LOCK_FAILURE, update.getResult()); |
| assertEquals(remoteCommit, |
| local.getRepository().exactRef(localRef).getObjectId()); |
| } |
| } |
| |
| @Test |
| public void nonForcedFetchReportsLockFailureWhenConcurrentUpdateIsFastForward() |
| throws Exception { |
| String localBranchName = "localfoo"; |
| String localRef = Constants.R_HEADS + localBranchName; |
| String remoteBranchName = "remotefoo"; |
| String nonForcedRemoteRef = Constants.R_HEADS + remoteBranchName; |
| String tmpRef = "refs/heads/tmp"; |
| |
| RevCommit baseCommit = remote.branch(remoteBranchName).commit() |
| .add("base.txt", "base").create(); |
| RevCommit updatedLocalCommit = remote.commit().parent(baseCommit) |
| .add("local.txt", "local").create(); |
| RevCommit remoteCommit = remote.commit().parent(updatedLocalCommit) |
| .add("remote.txt", "remote").create(); |
| remote.update(remoteBranchName, remoteCommit); |
| |
| try (Git git = new Git(local.getRepository())) { |
| git.fetch().setRemote(registerDefaultTestProtocol().toString()) |
| .setRefSpecs(new RefSpec(nonForcedRemoteRef + ":" + tmpRef)) |
| .call(); |
| |
| local.update(localRef, baseCommit); |
| |
| URIish uri = registerTestProtocolUpdatingRef( |
| (repo) -> repo.update(localRef, updatedLocalCommit)); |
| |
| FetchResult result = git.fetch().setRemote(uri.toString()) |
| .setRefSpecs(new RefSpec(nonForcedRemoteRef + ":" + localRef)) |
| .call(); |
| |
| TrackingRefUpdate update = result.getTrackingRefUpdate(localRef); |
| assertEquals(RefUpdate.Result.LOCK_FAILURE, update.getResult()); |
| assertEquals(updatedLocalCommit, |
| local.getRepository().exactRef(localRef).getObjectId()); |
| assertTrue(local.getRepository().getObjectDatabase() |
| .has(remoteCommit)); |
| } |
| } |
| |
| @Test |
| public void nonForcedFetchRejectedWhenCurrentRefUnchangedButNonFastForward() |
| throws Exception { |
| String localBranchName = "localfoo"; |
| String localRef = Constants.R_HEADS + localBranchName; |
| String remoteBranchName = "remotefoo"; |
| String nonForcedRemoteRef = Constants.R_HEADS + remoteBranchName; |
| |
| RevCommit localCommit = local.branch(localBranchName).commit() |
| .add("local.txt", "local").create(); |
| RevCommit remoteCommit = remote.branch(remoteBranchName).commit() |
| .add("remote.txt", "remote").create(); |
| |
| try (Git git = new Git(local.getRepository())) { |
| FetchResult result = git.fetch() |
| .setRemote(registerDefaultTestProtocol().toString()) |
| .setRefSpecs( |
| new RefSpec(nonForcedRemoteRef + ":" + localRef)) |
| .call(); |
| |
| TrackingRefUpdate update = result.getTrackingRefUpdate(localRef); |
| assertEquals(RefUpdate.Result.REJECTED, update.getResult()); |
| assertEquals(localCommit, |
| local.getRepository().exactRef(localRef).getObjectId()); |
| assertTrue(local.getRepository().getObjectDatabase() |
| .has(remoteCommit)); |
| } |
| } |
| |
| private TestProtocol<User> registerDefault() { |
| return registerProto(new DefaultUpload(), new DefaultReceive()); |
| } |
| |
| private TestProtocol<User> registerProto(UploadPackFactory<User> upf, |
| ReceivePackFactory<User> rpf) { |
| TestProtocol<User> proto = new TestProtocol<>(upf, rpf); |
| protos.add(proto); |
| Transport.register(proto); |
| return proto; |
| } |
| |
| @FunctionalInterface |
| interface TestRepositoryUpdateFunc { |
| void call(TestRepository<InMemoryRepository> repository) throws Exception; |
| } |
| |
| private <T extends AnyObjectId> URIish registerTestProtocolUpdatingRef(TestRepositoryUpdateFunc repositoryUpdateFunc) { |
| TestProtocol<User> proto = registerProto((User req, Repository db) -> { |
| try { |
| repositoryUpdateFunc.call(local); |
| } catch (Exception e) { |
| throw new AssertionError("Cannot update local ref", e); |
| } |
| return new UploadPack(db); |
| }, new DefaultReceive()); |
| return proto.register(new User("user"), remote.getRepository()); |
| } |
| |
| private URIish registerDefaultTestProtocol() { |
| TestProtocol<User> setupProto = registerDefault(); |
| return setupProto.register(new User("user"), remote.getRepository()); |
| } |
| } |