org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/ReceivePackTest.java

/*
 * Copyright (C) 2015, Google Inc.
 *
 * This program and the accompanying materials are made available
 * under the terms of the Eclipse Distribution License v1.0 which
 * accompanies this distribution, is reproduced below, and is
 * available at http://www.eclipse.org/org/documents/edl-v10.php
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the following
 *   disclaimer in the documentation and/or other materials provided
 *   with the distribution.
 *
 * - Neither the name of the Eclipse Foundation, Inc. nor the
 *   names of its contributors may be used to endorse or promote
 *   products derived from this software without specific prior
 *   written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.eclipse.jgit.transport;

import java.util.ArrayList;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.eclipse.jgit.errors.PackProtocolException;
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.junit.TestRepository.BranchBuilder;
import org.eclipse.jgit.lib.NullProgressMonitor;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.transport.ReceiveCommand.Result;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.revwalk.RevCommit;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

/** Tests for receive-pack utilities. */
public class ReceivePackTest {
	private URIish uri;
	private TestProtocol<Object> testProtocol;
	private InMemoryRepository client;
	private InMemoryRepository server;
	private TestRepository clientTestRepo;
	private TestRepository serverTestRepo;

	@Before
	public void setUp() throws Exception {
		client = new InMemoryRepository(new DfsRepositoryDescription("client"));
		server = new InMemoryRepository(new DfsRepositoryDescription("server"));
		clientTestRepo = new TestRepository<>(client);
		serverTestRepo = new TestRepository<>(server);

		testProtocol = new TestProtocol<>(null, (Object req, Repository db) -> {
			ReceivePack rp = new ReceivePack(db);
			return rp;
		});
		uri = testProtocol.register(new Object(), server);
	}

	@After
	public void tearDown() {
		Transport.unregister(testProtocol);
	}

	@Test
	public void parseCommand() throws Exception {
		String o = "0000000000000000000000000000000000000000";
		String n = "deadbeefdeadbeefdeadbeefdeadbeefdeadbeef";
		String r = "refs/heads/master";
		ReceiveCommand cmd = ReceivePack.parseCommand(o + " " + n + " " + r);
		assertEquals(ObjectId.zeroId(), cmd.getOldId());
		assertEquals("deadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
				cmd.getNewId().name());
		assertEquals("refs/heads/master", cmd.getRefName());

		assertParseCommandFails(null);
		assertParseCommandFails("");
		assertParseCommandFails(o.substring(35) + " " + n.substring(35)
				+ " " + r + "\n");
		assertParseCommandFails(o + " " + n + " " + r + "\n");
		assertParseCommandFails(o + " " + n + " " + "refs^foo");
		assertParseCommandFails(o + " " + n.substring(10) + " " + r);
		assertParseCommandFails(o.substring(10) + " " + n + " " + r);
		assertParseCommandFails("X" + o.substring(1) + " " + n + " " + r);
		assertParseCommandFails(o + " " + "X" + n.substring(1) + " " + r);
	}

	/**
	 * Ensure receive-pack rejects a push to a one level ref (refs/master).
	 */
	@Test
	public void rejectsCreationOfOneLevelRef() throws Exception {
		// Create refs/master on the client so we can attempt to push it
		RevCommit clientCommit;
		BranchBuilder bb = clientTestRepo.branch("refs/master");
		clientCommit = bb.commit().noFiles().message("Testing").create();

		ArrayList<RemoteRefUpdate> refUpdates = new ArrayList<>();
		refUpdates.add(new RemoteRefUpdate(
				clientTestRepo.getRepository(), "refs/master", clientCommit,
				"refs/master", false, /* force update */
				null, /* no local tracking ref */
				ObjectId.zeroId() // expected advertisement
		));
		Transport tn = testProtocol.open(uri, client, "server");
		PushResult result = tn.push(NullProgressMonitor.INSTANCE, refUpdates);
		RemoteRefUpdate update = result.getRemoteUpdate("refs/master");

		assertEquals(RemoteRefUpdate.Status.REJECTED_OTHER_REASON,
				update.getStatus());
		assertEquals(JGitText.get().funnyRefname, update.getMessage());
	}

	/**
	 * Allow deletion of one level refs (refs/master).
	 */
	@Test
	public void acceptsDeletionOfOneLevelRef() throws Exception {
		BranchBuilder bb = serverTestRepo.branch("refs/master");
		bb.update(bb.commit().noFiles().message("Testing").create());

		ArrayList<RemoteRefUpdate> refUpdates = new ArrayList<>();
		refUpdates.add(new RemoteRefUpdate(null, null, ObjectId.zeroId(),
				"refs/master", false, // force update
				null, // no local tracking ref
				null // expected advertisement
		));
		Transport tn = testProtocol.open(uri, client, "server");
		PushResult result = tn.push(NullProgressMonitor.INSTANCE, refUpdates);
		RemoteRefUpdate update = result.getRemoteUpdate("refs/master");

		assertEquals(RemoteRefUpdate.Status.OK, update.getStatus());
		assertEquals(null, update.getMessage());
	}

	private void assertParseCommandFails(String input) {
		try {
			ReceivePack.parseCommand(input);
			fail();
		} catch (PackProtocolException e) {
			// Expected.
		}
	}

	@Test
	public void testCertificatePushOptionsMismatch() throws Exception {
		ReceiveCommand cmd1 = new ReceiveCommand(
				ObjectId.fromString("0000000000000000000000000000000000000000"),
				ObjectId.fromString("deadbeefdeadbeefdeadbeefdeadbeefdeadbeef"),
				"refs/heads/master");
		ReceiveCommand cmd2 = new ReceiveCommand(
				ObjectId.fromString("0000000000000000000000000000000000000000"),
				ObjectId.fromString("badc0ffebadc0ffebadc0ffebadc0ffebadc0ffe"),
				"refs/heads/branch");

		List<ReceiveCommand> commands = new ArrayList<>();
		commands.add(cmd1);
		commands.add(cmd2);

		ReceivePack.validateCertificatePushOptions(
				Arrays.asList("option1", "option2"),
				Arrays.asList("option1", "different"), commands);

		assertEquals(Result.REJECTED_OTHER_REASON, cmd1.getResult());
		assertEquals(Result.REJECTED_OTHER_REASON, cmd2.getResult());
		assertEquals(JGitText.get().pushCertificateInconsistentPushOptions,
				cmd1.getMessage());
		assertEquals(JGitText.get().pushCertificateInconsistentPushOptions,
				cmd2.getMessage());
	}

	@Test
	public void testCertificatePushOptionsMatch() throws Exception {
		ReceiveCommand cmd = new ReceiveCommand(
				ObjectId.fromString("0000000000000000000000000000000000000000"),
				ObjectId.fromString("deadbeefdeadbeefdeadbeefdeadbeefdeadbeef"),
				"refs/heads/master");

		List<ReceiveCommand> commands = Collections.singletonList(cmd);

		ReceivePack.validateCertificatePushOptions(
				Arrays.asList("option1", "option2"),
				Arrays.asList("option1", "option2"), commands);

		assertEquals(Result.NOT_ATTEMPTED, cmd.getResult());
	}

	@Test
	public void testCertificatePushOptionsNullTreatedAsEmpty() throws Exception {
		ReceiveCommand cmd = new ReceiveCommand(
				ObjectId.fromString("0000000000000000000000000000000000000000"),
				ObjectId.fromString("deadbeefdeadbeefdeadbeefdeadbeefdeadbeef"),
				"refs/heads/master");

		List<ReceiveCommand> commands = Collections.singletonList(cmd);

		ReceivePack.validateCertificatePushOptions(Collections.emptyList(),
				null, commands);

		assertEquals(Result.NOT_ATTEMPTED, cmd.getResult());
	}
}