org.jenkinsci.plugins.pretestedintegration

Class AbstractSCMInterface

java.lang.Object

org.jenkinsci.plugins.pretestedintegration.AbstractSCMInterface

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<AbstractSCMInterface>

Direct Known Subclasses:

Mercurial

public abstract class AbstractSCMInterface
extends Object
implements hudson.model.Describable<AbstractSCMInterface>, hudson.ExtensionPoint

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
AbstractSCMInterface()

Method Summary

Methods

Modifier and Type	Method and Description
static hudson.DescriptorExtensionList<AbstractSCMInterface,SCMInterfaceDescriptor<AbstractSCMInterface>>	all()
void	commit(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
hudson.model.Descriptor<AbstractSCMInterface>	getDescriptor()
static List<SCMInterfaceDescriptor<?>>	getDescriptors()
hudson.model.Result	getRequiredResult()
void	handlePostBuild(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) This is called after the build has run.
Commit<?>	nextCommit(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener, Commit<?> commit) Calculate and return the next commit from the argument
void	prepareWorkspace(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener, Commit<?> commit) This function is called after the SCM plugin has updated the workspace with remote changes.
void	rollback(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractSCMInterface

@DataBoundConstructor
public AbstractSCMInterface()

Method Detail

getDescriptor

public hudson.model.Descriptor<AbstractSCMInterface> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<AbstractSCMInterface>

all

public static hudson.DescriptorExtensionList<AbstractSCMInterface,SCMInterfaceDescriptor<AbstractSCMInterface>> all()

getDescriptors

public static List<SCMInterfaceDescriptor<?>> getDescriptors()

prepareWorkspace

public void prepareWorkspace(hudson.model.AbstractBuild<?,?> build,
                    hudson.Launcher launcher,
                    hudson.model.BuildListener listener,
                    Commit<?> commit)
                      throws hudson.AbortException,
                             IOException,
                             IllegalArgumentException

This function is called after the SCM plugin has updated the workspace with remote changes. When this function has been run, the workspace must be ready to perform a build and tests. The integration branch must be checked out, and the given commit must be merged into it.

Parameters:

commit - This commit represents the code that must be checked out.

Throws:

hudson.AbortException - It is not possible to leave the workspace in a state as described above.

IOException - A repository could not be reached.

InvalidArgumentException - The given repository is not in a valid condition.

IllegalArgumentException

nextCommit

public Commit<?> nextCommit(hudson.model.AbstractBuild<?,?> build,
                   hudson.Launcher launcher,
                   hudson.model.BuildListener listener,
                   Commit<?> commit)
                     throws IOException,
                            IllegalArgumentException

Calculate and return the next commit from the argument

Returns:

The next pending commit. If no commit is pending null is returned.

Throws:

IOException - A repository could not be reached.

InvalidArgumentException - The given repository is not in a valid condition.

IllegalArgumentException

commit

public void commit(hudson.model.AbstractBuild<?,?> build,
          hudson.Launcher launcher,
          hudson.model.BuildListener listener)
            throws IOException,
                   InterruptedException

Throws:

IOException

InterruptedException

rollback

public void rollback(hudson.model.AbstractBuild<?,?> build,
            hudson.Launcher launcher,
            hudson.model.BuildListener listener)
              throws IOException,
                     InterruptedException

Throws:

IOException

InterruptedException

getRequiredResult

public hudson.model.Result getRequiredResult()

handlePostBuild

public void handlePostBuild(hudson.model.AbstractBuild<?,?> build,
                   hudson.Launcher launcher,
                   hudson.model.BuildListener listener)
                     throws IOException,
                            IllegalArgumentException

This is called after the build has run. If the build was successful, the changes should be committed, otherwise the workspace is cleared as before the changes

Parameters:

build - The status of the build.

Throws:

IOException - A repository could not be reached.

InvalidArgumentException - The given repository is not in a valid condition.

IllegalArgumentException