Package org.craftercms.deployer.impl.processors.git

Class GitPullProcessor

java.lang.Object

org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

org.craftercms.deployer.impl.processors.git.AbstractRemoteGitRepoAwareProcessor

org.craftercms.deployer.impl.processors.git.GitPullProcessor

All Implemented Interfaces:

DeploymentProcessor, InitializableByConfigBean, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class GitPullProcessor
extends AbstractRemoteGitRepoAwareProcessor

Processor that clones/pulls a remote Git repository into a local path in the filesystem. A processor instance can be configured with the following YAML properties:

• fastForwardMode: The fast forward mode to use when pulling changes from the remote repo. Supported values are: FF, NO_FF, FF_ONLY. Default is FF.
• mergeStrategy: The merge strategy to use. Supported values are: ours, theirs, simple_two_way_in_core, resolve, recursive. Default is theirs
• contentMergeOption: The content merge strategy to handle conflicts. Supported values are CONFLICT, OURS, THEIRS, UNION. Default is CONFLICT
• remoteRepo.url: The URL of the remote Git repo to pull.
• remoteRepo.name: The name to use for the remote repo when pulling from it (origin by default).
• remoteRepo.branch: The branch of the remote Git repo to pull.
• remoteRepo.username: The username for authentication with the remote Git repo. Not needed when SSH with RSA key pair authentication is used.
• remoteRepo.password: The password for authentication with the remote Git repo. Not needed when SSH with RSA key pair authentication is used.
• remoteRepo.ssh.privateKey.path: The SSH private key path, used only with SSH with RSA key pair authentication.
• remoteRepo.ssh.privateKey.passphrase: The SSH private key passphrase, used only with SSH withRSA key pair authentication.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CONTENT_MERGE_STRATEGY_OPTION_CONFIG_KEY
protected org.eclipse.jgit.merge.ContentMergeStrategy	contentMergeStrategy
protected static final String	FAST_FORWARD_MODE_CONFIG_KEY
protected org.eclipse.jgit.api.MergeCommand.FastForwardMode	fastForwardMode
protected static final String	MERGE_STRATEGY_CONFIG_KEY
protected org.eclipse.jgit.merge.MergeStrategy	mergeStrategy
protected static final String	REMOTE_REPO_NAME_CONFIG_KEY
protected String	remoteRepoName

Fields inherited from class org.craftercms.deployer.impl.processors.git.AbstractRemoteGitRepoAwareProcessor

authConfiguratorFactory, authenticationConfigurator, localRepoFolder, REMOTE_REPO_BRANCH_CONFIG_KEY, REMOTE_REPO_PASSWORD_CONFIG_KEY, REMOTE_REPO_SSH_PRV_KEY_PASSPHRASE_CONFIG_KEY, REMOTE_REPO_SSH_PRV_KEY_PATH_CONFIG_KEY, REMOTE_REPO_URL_CONFIG_KEY, REMOTE_REPO_USERNAME_CONFIG_KEY, remoteRepoBranch, remoteRepoUrl

Fields inherited from class org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

FAIL_DEPLOYMENT_CONFIG_KEY, failDeploymentOnFailure

Fields inherited from class org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

alwaysRun, env, excludeFiles, includeFiles, JUMPING_TO_PARAM_NAME, jumpTo, label, name, siteName, targetId

Constructor Summary

Constructors

Constructor	Description
GitPullProcessor(File localRepoFolder, org.craftercms.commons.git.utils.AuthConfiguratorFactory authConfiguratorFactory)

Method Summary

Modifier and Type	Method	Description
protected String	checkMergeResult(org.eclipse.jgit.api.MergeResult mergeResult)
protected org.eclipse.jgit.api.Git	cloneRemoteRepository()
protected void	doClone(ProcessorExecution execution)
protected void	doInit(org.apache.commons.configuration2.Configuration config)	Allows extending classes perform any custom initialization
protected ChangeSet	doMainProcess(Deployment deployment, ProcessorExecution execution, ChangeSet filteredChangeSet, ChangeSet originalChangeSet)	Performs the actual work of processing the files in the ChangeSet, it is also possible to return a new ChangeSet to be used for the following processors in the pipeline
protected void	doPull(ProcessorExecution execution)
protected boolean	failDeploymentOnProcessorFailure()	Indicates if the deployment should be marked as failed if this processor throws an error
protected boolean	isRepositoryCorrupted(Throwable ex)

Methods inherited from class org.craftercms.deployer.impl.processors.git.AbstractRemoteGitRepoAwareProcessor

createAuthenticationConfigurator, doDestroy, openLocalRepository, shouldExecute

Methods inherited from class org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

doExecute, init

Methods inherited from class org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

destroy, execute, getDeploymentParam, getFilteredChangeSet, isJumpToActive, isPostDeployment, setBeanName, setEnv, setSiteName, setTargetId, shouldIncludeFile, startJumpTo, supportsMode

Methods inherited from class java.lang.Object

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

Field Details

REMOTE_REPO_NAME_CONFIG_KEY

protected static final String REMOTE_REPO_NAME_CONFIG_KEY

See Also:

• Constant Field Values

MERGE_STRATEGY_CONFIG_KEY

protected static final String MERGE_STRATEGY_CONFIG_KEY

See Also:

• Constant Field Values

CONTENT_MERGE_STRATEGY_OPTION_CONFIG_KEY

protected static final String CONTENT_MERGE_STRATEGY_OPTION_CONFIG_KEY

See Also:

• Constant Field Values

FAST_FORWARD_MODE_CONFIG_KEY

protected static final String FAST_FORWARD_MODE_CONFIG_KEY

See Also:

• Constant Field Values

remoteRepoName

protected String remoteRepoName

mergeStrategy

protected org.eclipse.jgit.merge.MergeStrategy mergeStrategy

contentMergeStrategy

protected org.eclipse.jgit.merge.ContentMergeStrategy contentMergeStrategy

fastForwardMode

protected org.eclipse.jgit.api.MergeCommand.FastForwardMode fastForwardMode

Constructor Details

GitPullProcessor

public GitPullProcessor(File localRepoFolder,
 org.craftercms.commons.git.utils.AuthConfiguratorFactory authConfiguratorFactory)

Method Details

doInit

protected void doInit(org.apache.commons.configuration2.Configuration config)
               throws org.craftercms.commons.config.ConfigurationException

Description copied from class: AbstractDeploymentProcessor

Allows extending classes perform any custom initialization

Overrides:

doInit in class AbstractRemoteGitRepoAwareProcessor

Parameters:

config - the bean's configuration

Throws:

org.craftercms.commons.config.ConfigurationException - if there's configuration related exception

failDeploymentOnProcessorFailure

protected boolean failDeploymentOnProcessorFailure()

Description copied from class: AbstractMainDeploymentProcessor

Indicates if the deployment should be marked as failed if this processor throws an error

Overrides:

failDeploymentOnProcessorFailure in class AbstractMainDeploymentProcessor

doMainProcess

protected ChangeSet doMainProcess(Deployment deployment,
 ProcessorExecution execution,
 ChangeSet filteredChangeSet,
 ChangeSet originalChangeSet)
                           throws DeployerException

Description copied from class: AbstractMainDeploymentProcessor

Performs the actual work of processing the files in the ChangeSet, it is also possible to return a new ChangeSet to be used for the following processors in the pipeline

Specified by:

doMainProcess in class AbstractMainDeploymentProcessor

Parameters:

deployment - the current deployment

execution - the current execution

filteredChangeSet - the filtered change set (as returned by AbstractDeploymentProcessor.getFilteredChangeSet(ChangeSet))

originalChangeSet - the original change set (as returned by the previous processors in the pipeline)

Returns:

a new ChangeSet or null

Throws:

DeployerException - if there is any error processing the ChangeSet

doPull

protected void doPull(ProcessorExecution execution)
               throws DeployerException

Throws:

DeployerException

checkMergeResult

protected String checkMergeResult(org.eclipse.jgit.api.MergeResult mergeResult)
                           throws DeployerException

Throws:

DeployerException

doClone

protected void doClone(ProcessorExecution execution)
                throws DeployerException

Throws:

DeployerException

cloneRemoteRepository

protected org.eclipse.jgit.api.Git cloneRemoteRepository()
                                                  throws DeployerException

Throws:

DeployerException

isRepositoryCorrupted

protected boolean isRepositoryCorrupted(Throwable ex)