123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256 |
- /*
- * Copyright (C) 2014 Matthias Sohn <matthias.sohn@sap.com>
- * and other copyright owners as documented in the project's IP log.
- *
- * 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.util;
-
- import static org.junit.Assert.assertEquals;
- import static org.junit.Assert.assertNull;
- import static org.junit.Assert.fail;
-
- import java.io.ByteArrayOutputStream;
- import java.io.File;
- import java.io.IOException;
- import java.io.PrintStream;
-
- import org.eclipse.jgit.api.Git;
- import org.eclipse.jgit.api.errors.AbortedByHookException;
- import org.eclipse.jgit.hooks.CommitMsgHook;
- import org.eclipse.jgit.hooks.PostCommitHook;
- import org.eclipse.jgit.hooks.PreCommitHook;
- import org.eclipse.jgit.junit.JGitTestUtil;
- import org.eclipse.jgit.junit.RepositoryTestCase;
- import org.eclipse.jgit.revwalk.RevCommit;
- import org.junit.Assume;
- import org.junit.Test;
-
- public class HookTest extends RepositoryTestCase {
-
- @Test
- public void testFindHook() throws Exception {
- assumeSupportedPlatform();
-
- assertNull("no hook should be installed",
- FS.DETECTED.findHook(db, PreCommitHook.NAME));
- File hookFile = writeHookFile(PreCommitHook.NAME,
- "#!/bin/bash\necho \"test $1 $2\"");
- assertEquals("expected to find pre-commit hook", hookFile,
- FS.DETECTED.findHook(db, PreCommitHook.NAME));
- }
-
- @Test
- public void testFindPostCommitHook() throws Exception {
- assumeSupportedPlatform();
-
- assertNull("no hook should be installed",
- FS.DETECTED.findHook(db, PostCommitHook.NAME));
- File hookFile = writeHookFile(PostCommitHook.NAME,
- "#!/bin/bash\necho \"test $1 $2\"");
- assertEquals("expected to find post-commit hook", hookFile,
- FS.DETECTED.findHook(db, PostCommitHook.NAME));
- }
-
- @Test
- public void testFailedCommitMsgHookBlocksCommit() throws Exception {
- assumeSupportedPlatform();
-
- writeHookFile(CommitMsgHook.NAME,
- "#!/bin/sh\necho \"test\"\n\necho 1>&2 \"stderr\"\nexit 1");
- Git git = Git.wrap(db);
- String path = "a.txt";
- writeTrashFile(path, "content");
- git.add().addFilepattern(path).call();
- ByteArrayOutputStream out = new ByteArrayOutputStream();
- try {
- git.commit().setMessage("commit")
- .setHookOutputStream(new PrintStream(out)).call();
- fail("expected commit-msg hook to abort commit");
- } catch (AbortedByHookException e) {
- assertEquals("unexpected error message from commit-msg hook",
- "Rejected by \"commit-msg\" hook.\nstderr\n",
- e.getMessage());
- assertEquals("unexpected output from commit-msg hook", "test\n",
- out.toString());
- }
- }
-
- @Test
- public void testCommitMsgHookReceivesCorrectParameter() throws Exception {
- assumeSupportedPlatform();
-
- writeHookFile(CommitMsgHook.NAME,
- "#!/bin/sh\necho $1\n\necho 1>&2 \"stderr\"\nexit 0");
- Git git = Git.wrap(db);
- String path = "a.txt";
- writeTrashFile(path, "content");
- git.add().addFilepattern(path).call();
- ByteArrayOutputStream out = new ByteArrayOutputStream();
- git.commit().setMessage("commit")
- .setHookOutputStream(new PrintStream(out)).call();
- assertEquals(".git/COMMIT_EDITMSG\n",
- out.toString("UTF-8"));
- }
-
- @Test
- public void testCommitMsgHookCanModifyCommitMessage() throws Exception {
- assumeSupportedPlatform();
-
- writeHookFile(CommitMsgHook.NAME,
- "#!/bin/sh\necho \"new message\" > $1\nexit 0");
- Git git = Git.wrap(db);
- String path = "a.txt";
- writeTrashFile(path, "content");
- git.add().addFilepattern(path).call();
- ByteArrayOutputStream out = new ByteArrayOutputStream();
- RevCommit revCommit = git.commit().setMessage("commit")
- .setHookOutputStream(new PrintStream(out)).call();
- assertEquals("new message\n", revCommit.getFullMessage());
- }
-
- @Test
- public void testPostCommitRunHook() throws Exception {
- assumeSupportedPlatform();
-
- writeHookFile(PostCommitHook.NAME,
- "#!/bin/sh\necho \"test $1 $2\"\nread INPUT\necho $INPUT\necho 1>&2 \"stderr\"");
- ByteArrayOutputStream out = new ByteArrayOutputStream();
- ByteArrayOutputStream err = new ByteArrayOutputStream();
- ProcessResult res = FS.DETECTED.runHookIfPresent(db,
- PostCommitHook.NAME,
- new String[] {
- "arg1", "arg2" },
- new PrintStream(out), new PrintStream(err), "stdin");
-
- assertEquals("unexpected hook output", "test arg1 arg2\nstdin\n",
- out.toString("UTF-8"));
- assertEquals("unexpected output on stderr stream", "stderr\n",
- err.toString("UTF-8"));
- assertEquals("unexpected exit code", 0, res.getExitCode());
- assertEquals("unexpected process status", ProcessResult.Status.OK,
- res.getStatus());
- }
-
- @Test
- public void testAllCommitHooks() throws Exception {
- assumeSupportedPlatform();
-
- writeHookFile(PreCommitHook.NAME,
- "#!/bin/sh\necho \"test pre-commit\"\n\necho 1>&2 \"stderr pre-commit\"\nexit 0");
- writeHookFile(CommitMsgHook.NAME,
- "#!/bin/sh\necho \"test commit-msg $1\"\n\necho 1>&2 \"stderr commit-msg\"\nexit 0");
- writeHookFile(PostCommitHook.NAME,
- "#!/bin/sh\necho \"test post-commit\"\necho 1>&2 \"stderr post-commit\"\nexit 0");
- Git git = Git.wrap(db);
- String path = "a.txt";
- writeTrashFile(path, "content");
- git.add().addFilepattern(path).call();
- ByteArrayOutputStream out = new ByteArrayOutputStream();
- try {
- git.commit().setMessage("commit")
- .setHookOutputStream(new PrintStream(out)).call();
- } catch (AbortedByHookException e) {
- fail("unexpected hook failure");
- }
- assertEquals("unexpected hook output",
- "test pre-commit\ntest commit-msg .git/COMMIT_EDITMSG\ntest post-commit\n",
- out.toString("UTF-8"));
- }
-
- @Test
- public void testRunHook() throws Exception {
- assumeSupportedPlatform();
-
- writeHookFile(PreCommitHook.NAME,
- "#!/bin/sh\necho \"test $1 $2\"\nread INPUT\necho $INPUT\necho 1>&2 \"stderr\"");
- ByteArrayOutputStream out = new ByteArrayOutputStream();
- ByteArrayOutputStream err = new ByteArrayOutputStream();
- ProcessResult res = FS.DETECTED.runHookIfPresent(db,
- PreCommitHook.NAME,
- new String[] {
- "arg1", "arg2" },
- new PrintStream(out), new PrintStream(err), "stdin");
-
- assertEquals("unexpected hook output", "test arg1 arg2\nstdin\n",
- out.toString("UTF-8"));
- assertEquals("unexpected output on stderr stream", "stderr\n",
- err.toString("UTF-8"));
- assertEquals("unexpected exit code", 0, res.getExitCode());
- assertEquals("unexpected process status", ProcessResult.Status.OK,
- res.getStatus());
- }
-
- @Test
- public void testFailedPreCommitHookBlockCommit() throws Exception {
- assumeSupportedPlatform();
-
- writeHookFile(PreCommitHook.NAME,
- "#!/bin/sh\necho \"test\"\n\necho 1>&2 \"stderr\"\nexit 1");
- Git git = Git.wrap(db);
- String path = "a.txt";
- writeTrashFile(path, "content");
- git.add().addFilepattern(path).call();
- ByteArrayOutputStream out = new ByteArrayOutputStream();
- try {
- git.commit().setMessage("commit")
- .setHookOutputStream(new PrintStream(out)).call();
- fail("expected pre-commit hook to abort commit");
- } catch (AbortedByHookException e) {
- assertEquals("unexpected error message from pre-commit hook",
- "Rejected by \"pre-commit\" hook.\nstderr\n",
- e.getMessage());
- assertEquals("unexpected output from pre-commit hook", "test\n",
- out.toString());
- }
- }
-
- private File writeHookFile(final String name, final String data)
- throws IOException {
- File path = new File(db.getWorkTree() + "/.git/hooks/", name);
- JGitTestUtil.write(path, data);
- FS.DETECTED.setExecute(path, true);
- return path;
- }
-
- private void assumeSupportedPlatform() {
- Assume.assumeTrue(FS.DETECTED instanceof FS_POSIX
- || FS.DETECTED instanceof FS_Win32_Cygwin);
- }
- }
|