Browse Source
Hooks are now obtained via a convenient API like git commands, and callers don't have to check for their existence. The pre-commit hook has been updated accordingly. Change-Id: I3383ffb10e2f3b588d7367b9139b606ec7f62758 Signed-off-by: Laurent Delaigue <laurent.delaigue@obeo.fr> Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>stable-4.0
Laurent Delaigue
10 years ago
committed by
Christian Halstrick
17 changed files with 435 additions and 238 deletions
@ -0,0 +1,104 @@
|
||||
/* |
||||
* Copyright (C) 2015 Obeo. |
||||
* 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.api.errors; |
||||
|
||||
import java.text.MessageFormat; |
||||
|
||||
import org.eclipse.jgit.internal.JGitText; |
||||
|
||||
/** |
||||
* Exception thrown when a hook returns a process result with a value different |
||||
* from 0. It is up to the caller to decide whether this should block execution |
||||
* or not. |
||||
* |
||||
* @since 4.0 |
||||
*/ |
||||
public class AbortedByHookException extends GitAPIException { |
||||
private static final long serialVersionUID = 1L; |
||||
|
||||
/** |
||||
* The hook that caused this exception. |
||||
*/ |
||||
private final String hookName; |
||||
|
||||
/** |
||||
* The process result. |
||||
*/ |
||||
private final int returnCode; |
||||
|
||||
/** |
||||
* @param message |
||||
* The error details. |
||||
* @param hookName |
||||
* The name of the hook that interrupted the command, must not be |
||||
* null. |
||||
* @param returnCode |
||||
* The return code of the hook process that has been run. |
||||
*/ |
||||
public AbortedByHookException(String message, String hookName, |
||||
int returnCode) { |
||||
super(message); |
||||
this.hookName = hookName; |
||||
this.returnCode = returnCode; |
||||
} |
||||
|
||||
/** |
||||
* @return the type of the hook that interrupted the git command. |
||||
*/ |
||||
public String getHookName() { |
||||
return hookName; |
||||
} |
||||
|
||||
/** |
||||
* @return the hook process result. |
||||
*/ |
||||
public int getReturnCode() { |
||||
return returnCode; |
||||
} |
||||
|
||||
@Override |
||||
public String getMessage() { |
||||
return MessageFormat.format(JGitText.get().commandRejectedByHook, |
||||
hookName, super.getMessage()); |
||||
} |
||||
} |
||||
@ -0,0 +1,159 @@
|
||||
/* |
||||
* Copyright (C) 2015 Obeo. |
||||
* 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.hooks; |
||||
|
||||
import java.io.ByteArrayOutputStream; |
||||
import java.io.IOException; |
||||
import java.io.PrintStream; |
||||
import java.util.concurrent.Callable; |
||||
|
||||
import org.eclipse.jgit.api.errors.AbortedByHookException; |
||||
import org.eclipse.jgit.lib.Repository; |
||||
import org.eclipse.jgit.util.FS; |
||||
import org.eclipse.jgit.util.ProcessResult; |
||||
|
||||
/** |
||||
* Git can fire off custom scripts when certain important actions occur. These |
||||
* custom scripts are called "hooks". There are two groups of hooks: client-side |
||||
* (that run on local operations such as committing and merging), and |
||||
* server-side (that run on network operations such as receiving pushed |
||||
* commits). This is the abstract super-class of the different hook |
||||
* implementations in JGit. |
||||
* |
||||
* @param <T> |
||||
* the return type which is expected from {@link #call()} |
||||
* @see <a href="http://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks">Git |
||||
* Hooks on the git-scm official site</a> |
||||
* @since 4.0 |
||||
*/ |
||||
abstract class GitHook<T> implements Callable<T> { |
||||
|
||||
private final Repository repo; |
||||
|
||||
/** |
||||
* The output stream to be used by the hook. |
||||
*/ |
||||
protected final PrintStream outputStream; |
||||
|
||||
/** |
||||
* @param repo |
||||
* @param outputStream |
||||
* The output stream the hook must use. {@code null} is allowed, |
||||
* in which case the hook will use {@code System.out}. |
||||
*/ |
||||
protected GitHook(Repository repo, PrintStream outputStream) { |
||||
this.repo = repo; |
||||
this.outputStream = outputStream; |
||||
} |
||||
|
||||
/** |
||||
* Run the hook. |
||||
* |
||||
* @throws IOException |
||||
* if IO goes wrong. |
||||
* @throws AbortedByHookException |
||||
* If the hook has been run and a returned an exit code |
||||
* different from zero. |
||||
*/ |
||||
public abstract T call() throws IOException, AbortedByHookException; |
||||
|
||||
/** |
||||
* @return The name of the hook, which must not be {@code null}. |
||||
*/ |
||||
public abstract String getHookName(); |
||||
|
||||
/** |
||||
* @return The repository. |
||||
*/ |
||||
protected Repository getRepository() { |
||||
return repo; |
||||
} |
||||
|
||||
/** |
||||
* Override this method when needed to provide relevant parameters to the |
||||
* underlying hook script. The default implementation returns an empty |
||||
* array. |
||||
* |
||||
* @return The parameters the hook receives. |
||||
*/ |
||||
protected String[] getParameters() { |
||||
return new String[0]; |
||||
} |
||||
|
||||
/** |
||||
* Override to provide relevant arguments via stdin to the underlying hook |
||||
* script. The default implementation returns {@code null}. |
||||
* |
||||
* @return The parameters the hook receives. |
||||
*/ |
||||
protected String getStdinArgs() { |
||||
return null; |
||||
} |
||||
|
||||
/** |
||||
* @return The output stream the hook must use. Never {@code null}, |
||||
* {@code System.out} is returned by default. |
||||
*/ |
||||
protected PrintStream getOutputStream() { |
||||
return outputStream == null ? System.out : outputStream; |
||||
} |
||||
|
||||
/** |
||||
* Runs the hook, without performing any validity checks. |
||||
* |
||||
* @throws AbortedByHookException |
||||
* If the underlying hook script exited with non-zero. |
||||
*/ |
||||
protected void doRun() throws AbortedByHookException { |
||||
final ByteArrayOutputStream errorByteArray = new ByteArrayOutputStream(); |
||||
final PrintStream hookErrRedirect = new PrintStream(errorByteArray); |
||||
ProcessResult result = FS.DETECTED.runHookIfPresent(getRepository(), |
||||
getHookName(), getParameters(), getOutputStream(), |
||||
hookErrRedirect, getStdinArgs()); |
||||
if (result.isExecutedWithError()) { |
||||
throw new AbortedByHookException(errorByteArray.toString(), |
||||
getHookName(), result.getExitCode()); |
||||
} |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,84 @@
|
||||
/* |
||||
* Copyright (C) 2015 Obeo. |
||||
* 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.hooks; |
||||
|
||||
import java.io.IOException; |
||||
import java.io.PrintStream; |
||||
|
||||
import org.eclipse.jgit.api.errors.AbortedByHookException; |
||||
import org.eclipse.jgit.lib.Repository; |
||||
|
||||
/** |
||||
* The <code>pre-commit</code> hook implementation. This hook is run before the |
||||
* commit and can reject the commit. |
||||
* |
||||
* @since 4.0 |
||||
*/ |
||||
public class PreCommitHook extends GitHook<Void> { |
||||
|
||||
/** The pre-commit hook name. */ |
||||
public static final String NAME = "pre-commit"; //$NON-NLS-1$
|
||||
|
||||
/** |
||||
* @param repo |
||||
* The repository |
||||
* @param outputStream |
||||
* The output stream the hook must use. {@code null} is allowed, |
||||
* in which case the hook will use {@code System.out}. |
||||
*/ |
||||
protected PreCommitHook(Repository repo, PrintStream outputStream) { |
||||
super(repo, outputStream); |
||||
} |
||||
|
||||
@Override |
||||
public Void call() throws IOException, AbortedByHookException { |
||||
doRun(); |
||||
return null; |
||||
} |
||||
|
||||
@Override |
||||
public String getHookName() { |
||||
return NAME; |
||||
} |
||||
|
||||
} |
||||
@ -1,149 +0,0 @@
|
||||
/* |
||||
* Copyright (C) 2014 Obeo. |
||||
* 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; |
||||
|
||||
/** |
||||
* An enum describing the different hooks a user can implement to customize his |
||||
* repositories. |
||||
* |
||||
* @since 3.7 |
||||
*/ |
||||
public enum Hook { |
||||
/** |
||||
* Literal for the "pre-commit" git hook. |
||||
* <p> |
||||
* This hook is invoked by git commit, and can be bypassed with the |
||||
* "no-verify" option. It takes no parameter, and is invoked before |
||||
* obtaining the proposed commit log message and making a commit. |
||||
* </p> |
||||
* <p> |
||||
* A non-zero exit code from the called hook means that the commit should be |
||||
* aborted. |
||||
* </p> |
||||
*/ |
||||
PRE_COMMIT("pre-commit"), //$NON-NLS-1$
|
||||
|
||||
/** |
||||
* Literal for the "prepare-commit-msg" git hook. |
||||
* <p> |
||||
* This hook is invoked by git commit right after preparing the default |
||||
* message, and before any editing possibility is displayed to the user. |
||||
* </p> |
||||
* <p> |
||||
* A non-zero exit code from the called hook means that the commit should be |
||||
* aborted. |
||||
* </p> |
||||
*/ |
||||
PREPARE_COMMIT_MSG("prepare-commit-msg"), //$NON-NLS-1$
|
||||
|
||||
/** |
||||
* Literal for the "commit-msg" git hook. |
||||
* <p> |
||||
* This hook is invoked by git commit, and can be bypassed with the |
||||
* "no-verify" option. Its single parameter is the path to the file |
||||
* containing the prepared commit message (typically |
||||
* "<gitdir>/COMMIT-EDITMSG"). |
||||
* </p> |
||||
* <p> |
||||
* A non-zero exit code from the called hook means that the commit should be |
||||
* aborted. |
||||
* </p> |
||||
*/ |
||||
COMMIT_MSG("commit-msg"), //$NON-NLS-1$
|
||||
|
||||
/** |
||||
* Literal for the "post-commit" git hook. |
||||
* <p> |
||||
* This hook is invoked by git commit. It takes no parameter and is invoked |
||||
* after a commit has been made. |
||||
* </p> |
||||
* <p> |
||||
* The exit code of this hook has no significance. |
||||
* </p> |
||||
*/ |
||||
POST_COMMIT("post-commit"), //$NON-NLS-1$
|
||||
|
||||
/** |
||||
* Literal for the "post-rewrite" git hook. |
||||
* <p> |
||||
* This hook is invoked after commands that rewrite commits (currently, only |
||||
* "git rebase" and "git commit --amend"). It a single argument denoting the |
||||
* source of the call (one of <code>rebase</code> or <code>amend</code>). It |
||||
* then accepts a list of rewritten commits through stdin, in the form |
||||
* <code><old SHA-1> <new SHA-1>LF</code>. |
||||
* </p> |
||||
* <p> |
||||
* The exit code of this hook has no significance. |
||||
* </p> |
||||
*/ |
||||
POST_REWRITE("post-rewrite"), //$NON-NLS-1$
|
||||
|
||||
/** |
||||
* Literal for the "pre-rebase" git hook. |
||||
* <p> |
||||
* </p> |
||||
* This hook is invoked right before the rebase operation runs. It accepts |
||||
* up to two parameters, the first being the upstream from which the branch |
||||
* to rebase has been forked. If the tip of the series of commits to rebase |
||||
* is HEAD, the other parameter is unset. Otherwise, that tip is passed as |
||||
* the second parameter of the script. |
||||
* <p> |
||||
* A non-zero exit code from the called hook means that the rebase should be |
||||
* aborted. |
||||
* </p> |
||||
*/ |
||||
PRE_REBASE("pre-rebase"); //$NON-NLS-1$
|
||||
|
||||
private final String name; |
||||
|
||||
private Hook(String name) { |
||||
this.name = name; |
||||
} |
||||
|
||||
/** |
||||
* @return The name of this hook. |
||||
*/ |
||||
public String getName() { |
||||
return name; |
||||
} |
||||
} |
||||
Loading…
Reference in new issue