hudson.plugins.perforce
Class PerforceSCM

java.lang.Object
  hudson.scm.SCM
      hudson.plugins.perforce.PerforceSCM

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.scm.SCM>

public class PerforceSCM
extends hudson.scm.SCM

Extends SCM to provide integration with Perforce SCM repositories.

Author:

Mike Wille, Brian Westrich, Victor Szoltysek

Nested Class Summary

static class

PerforceSCM.PerforceSCMDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

PerforceSCM(java.lang.String p4User, java.lang.String p4Passwd, java.lang.String p4Client, java.lang.String p4Port, java.lang.String projectPath, java.lang.String projectOptions, java.lang.String p4Exe, java.lang.String p4SysRoot, java.lang.String p4SysDrive, java.lang.String p4Label, java.lang.String p4Counter, java.lang.String lineEndValue, java.lang.String p4Charset, java.lang.String p4CommandCharset, boolean updateCounterValue, boolean forceSync, boolean alwaysForceSync, boolean updateView, boolean disableAutoSync, boolean wipeBeforeBuild, boolean dontUpdateClient, boolean exposeP4Passwd, java.lang.String slaveClientNameFormat, int firstChange, PerforceRepositoryBrowser browser)

Method Summary

void	buildEnvVars(hudson.model.AbstractBuild build, java.util.Map<java.lang.String,java.lang.String> env) Override of SCM.buildEnvVars() in order to setup the last change we have sync'd to as a Hudson environment variable: P4_CHANGELIST
boolean	checkout(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.BuildListener listener, java.io.File changelogFile)
hudson.scm.ChangeLogParser	createChangeLogParser()
java.util.List<java.lang.String>	getAllLineEndChoices()
PerforceRepositoryBrowser	getBrowser()
protected Depot	getDepot(hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.AbstractProject project) This only exists because we need to do initialization after we have been brought back to life.
java.lang.String	getFirstChange() This is only for the config screen.
int	getLastChange(hudson.model.Run build)
java.lang.String	getLineEndValue()
java.lang.String	getP4Charset()
java.lang.String	getP4Client()
java.lang.String	getP4CommandCharset()
java.lang.String	getP4Counter()
java.lang.String	getP4Exe()
java.lang.String	getP4Label()
java.lang.String	getP4Passwd()
java.lang.String	getP4Port()
java.lang.String	getP4SysDrive()
java.lang.String	getP4SysRoot()
java.lang.String	getP4User()
java.lang.String	getProjectOptions() The current perforce option set for the view.
java.lang.String	getProjectPath()
java.lang.String	getSlaveClientNameFormat()
java.lang.String	getViewMask()
boolean	isAlwaysForceSync()
boolean	isDisableAutoSync()
boolean	isDontRenameClient()
boolean	isDontUpdateClient()
boolean	isExposeP4Passwd()
boolean	isForceSync()
boolean	isSlaveClientNameStatic()
boolean	isUpdateCounterValue()
boolean	isUpdateView()
boolean	isUseLabel()
boolean	isUseOldClientName()
boolean	isUseViewMask()
boolean	isUseViewMaskForPolling()
boolean	isUseViewMaskForSyncing()
boolean	isWipeBeforeBuild()
boolean	pollChanges(hudson.model.AbstractProject project, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener)
static java.lang.String	processPathName(java.lang.String path, boolean isUnix)
boolean	processWorkspaceBeforeDeletion(hudson.model.AbstractProject<?,?> project, hudson.FilePath workspace, hudson.model.Node node) With Perforce the server keeps track of files in the workspace.
boolean	requiresWorkspaceForPolling()
void	setAlwaysForceSync(boolean force)
void	setDisableAutoSync(boolean disable)
void	setDontRenameClient(boolean dontRenameClient)
void	setDontUpdateClient(boolean dontUpdateClient)
void	setExposeP4Passwd(boolean exposeP4Passwd)
void	setForceSync(boolean force)
void	setLineEndValue(java.lang.String lineEndValue)
void	setP4Charset(java.lang.String p4Charset)
void	setP4Client(java.lang.String client)
void	setP4CommandCharset(java.lang.String p4CommandCharset)
void	setP4Counter(java.lang.String counter)
void	setP4Exe(java.lang.String exe)
void	setP4Label(java.lang.String label)
void	setP4Passwd(java.lang.String passwd)
void	setP4Port(java.lang.String port)
void	setP4SysDrive(java.lang.String sysDrive)
void	setP4SysRoot(java.lang.String sysRoot)
void	setP4User(java.lang.String user)
void	setProjectOptions(java.lang.String projectOptions) Set the perforce options for view creation.
void	setProjectPath(java.lang.String projectPath)
void	setSlaveClientNameFormat(java.lang.String clientFormat)
void	setUpdateCounterValue(boolean updateCounterValue)
void	setUpdateView(boolean update)
void	setUseOldClientName(boolean use)
void	setUseViewMask(boolean useViewMask)
void	setUseViewMaskForPolling(boolean useViewMaskForPolling)
void	setUseViewMaskForSyncing(boolean useViewMaskForSyncing)
void	setViewMask(java.lang.String viewMask)
void	setWipeBeforeBuild(boolean wipeBeforeBuild)

Methods inherited from class hudson.scm.SCM

_for, all, createEmptyChangeLog, getApi, getDescriptor, getEffectiveBrowser, getModuleRoot, getModuleRoots, getType, nullify, supportsPolling

Methods inherited from class java.lang.Object

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

Constructor Detail

PerforceSCM

@DataBoundConstructor
public PerforceSCM(java.lang.String p4User,
                                        java.lang.String p4Passwd,
                                        java.lang.String p4Client,
                                        java.lang.String p4Port,
                                        java.lang.String projectPath,
                                        java.lang.String projectOptions,
                                        java.lang.String p4Exe,
                                        java.lang.String p4SysRoot,
                                        java.lang.String p4SysDrive,
                                        java.lang.String p4Label,
                                        java.lang.String p4Counter,
                                        java.lang.String lineEndValue,
                                        java.lang.String p4Charset,
                                        java.lang.String p4CommandCharset,
                                        boolean updateCounterValue,
                                        boolean forceSync,
                                        boolean alwaysForceSync,
                                        boolean updateView,
                                        boolean disableAutoSync,
                                        boolean wipeBeforeBuild,
                                        boolean dontUpdateClient,
                                        boolean exposeP4Passwd,
                                        java.lang.String slaveClientNameFormat,
                                        int firstChange,
                                        PerforceRepositoryBrowser browser)

Method Detail

getDepot

protected Depot getDepot(hudson.Launcher launcher,
                         hudson.FilePath workspace,
                         hudson.model.AbstractProject project)

This only exists because we need to do initialization after we have been brought back to life. I'm not quite clear on stapler and how all that works. At any rate, it doesn't look like we have an init() method for setting up our Depot after all of the setters have been called. Someone correct me if I'm wrong... UPDATE: With the addition of PerforceMailResolver, we now have need to share the depot object. I'm making this protected to enable that. Always create a new Depot to reflect any changes to the machines that P4 actions will be performed on.

buildEnvVars

public void buildEnvVars(hudson.model.AbstractBuild build,
                         java.util.Map<java.lang.String,java.lang.String> env)

Override of SCM.buildEnvVars() in order to setup the last change we have sync'd to as a Hudson environment variable: P4_CHANGELIST

Overrides:

buildEnvVars in class hudson.scm.SCM

Parameters:

build -

env -

processPathName

public static java.lang.String processPathName(java.lang.String path,
                                               boolean isUnix)

checkout

public boolean checkout(hudson.model.AbstractBuild build,
                        hudson.Launcher launcher,
                        hudson.FilePath workspace,
                        hudson.model.BuildListener listener,
                        java.io.File changelogFile)
                 throws java.io.IOException,
                        java.lang.InterruptedException

Specified by:

checkout in class hudson.scm.SCM

Throws:

java.io.IOException

java.lang.InterruptedException

getBrowser

public PerforceRepositoryBrowser getBrowser()

Overrides:

getBrowser in class hudson.scm.SCM

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class hudson.scm.SCM

pollChanges

public boolean pollChanges(hudson.model.AbstractProject project,
                           hudson.Launcher launcher,
                           hudson.FilePath workspace,
                           hudson.model.TaskListener listener)
                    throws java.io.IOException,
                           java.lang.InterruptedException

Specified by:

pollChanges in class hudson.scm.SCM

Throws:

java.io.IOException

java.lang.InterruptedException

getLastChange

public int getLastChange(hudson.model.Run build)

getSlaveClientNameFormat

public java.lang.String getSlaveClientNameFormat()

getProjectPath

public java.lang.String getProjectPath()

Returns:

the projectPath

setProjectPath

public void setProjectPath(java.lang.String projectPath)

Parameters:

projectPath - the projectPath to set

getP4User

public java.lang.String getP4User()

Returns:

the p4User

setP4User

public void setP4User(java.lang.String user)

Parameters:

user - the p4User to set

getP4Passwd

public java.lang.String getP4Passwd()

Returns:

the p4Passwd

setP4Passwd

public void setP4Passwd(java.lang.String passwd)

Parameters:

passwd - the p4Passwd to set

getP4Port

public java.lang.String getP4Port()

Returns:

the p4Port

setP4Port

public void setP4Port(java.lang.String port)

Parameters:

port - the p4Port to set

getP4Client

public java.lang.String getP4Client()

Returns:

the p4Client

setP4Client

public void setP4Client(java.lang.String client)

Parameters:

client - the p4Client to set

getP4SysDrive

public java.lang.String getP4SysDrive()

Returns:

the p4SysDrive

setP4SysDrive

public void setP4SysDrive(java.lang.String sysDrive)

Parameters:

sysDrive - the p4SysDrive to set

getP4SysRoot

public java.lang.String getP4SysRoot()

Returns:

the p4SysRoot

setP4SysRoot

public void setP4SysRoot(java.lang.String sysRoot)

Parameters:

sysRoot - the p4SysRoot to set

getP4Exe

public java.lang.String getP4Exe()

Returns:

the p4Exe

setP4Exe

public void setP4Exe(java.lang.String exe)

Parameters:

exe - the p4Exe to set

getP4Label

public java.lang.String getP4Label()

Returns:

the p4Label

setP4Label

public void setP4Label(java.lang.String label)

Parameters:

label - the p4Label to set

getP4Counter

public java.lang.String getP4Counter()

Returns:

the p4Counter

setP4Counter

public void setP4Counter(java.lang.String counter)

Parameters:

counter - the p4Counter to set

isUpdateCounterValue

public boolean isUpdateCounterValue()

Returns:

True if the plugin should update the counter to the last change

setUpdateCounterValue

public void setUpdateCounterValue(boolean updateCounterValue)

Parameters:

updateCounterValue - True if the plugin should update the counter to the last change

isExposeP4Passwd

public boolean isExposeP4Passwd()

Returns:

True if the P4PASSWD value must be set in the environment

setExposeP4Passwd

public void setExposeP4Passwd(boolean exposeP4Passwd)

Parameters:

exposeP4Passwd - True if the P4PASSWD value must be set in the environment

getProjectOptions

public java.lang.String getProjectOptions()

The current perforce option set for the view.

Returns:

current perforce view options

setProjectOptions

public void setProjectOptions(java.lang.String projectOptions)

Set the perforce options for view creation.

Parameters:

projectOptions - the effective perforce options.

setUpdateView

public void setUpdateView(boolean update)

Parameters:

update - True to let the plugin manage the view, false to let the user manage it

isUpdateView

public boolean isUpdateView()

Returns:

True if the plugin manages the view, false if the user does.

isForceSync

public boolean isForceSync()

Returns:

True if we are performing a one-time force sync

isAlwaysForceSync

public boolean isAlwaysForceSync()

Returns:

True if we are performing a one-time force sync

isDisableAutoSync

public boolean isDisableAutoSync()

Returns:

True if auto sync is disabled

isUseOldClientName

public boolean isUseOldClientName()

Returns:

True if we are using the old style client names

setForceSync

public void setForceSync(boolean force)

Parameters:

force - True to perform a one time force sync, false to perform normal sync

setAlwaysForceSync

public void setAlwaysForceSync(boolean force)

Parameters:

force - True to perform a one time force sync, false to perform normal sync

setDisableAutoSync

public void setDisableAutoSync(boolean disable)

Parameters:

disable - True to disable the pre-build sync, false to perform pre-build sync

setUseOldClientName

public void setUseOldClientName(boolean use)

Parameters:

use - True to use the old style client names, false to use the new style

isUseLabel

public boolean isUseLabel()

Returns:

True if we are using a label

setDontRenameClient

public void setDontRenameClient(boolean dontRenameClient)

Parameters:

dontRenameClient - False if the client will rename the client spec for each slave

isDontRenameClient

public boolean isDontRenameClient()

Returns:

True if the client will rename the client spec for each slave

isWipeBeforeBuild

public boolean isWipeBeforeBuild()

Returns:

True if the plugin is to delete the workpsace files before building.

setSlaveClientNameFormat

public void setSlaveClientNameFormat(java.lang.String clientFormat)

Parameters:

clientFormat - A string defining the format of the client name for slave workspaces.

setWipeBeforeBuild

public void setWipeBeforeBuild(boolean wipeBeforeBuild)

Parameters:

wipeBeforeBuild - True if the client is to delete the workspace files before building.

isDontUpdateClient

public boolean isDontUpdateClient()

setDontUpdateClient

public void setDontUpdateClient(boolean dontUpdateClient)

isUseViewMaskForPolling

public boolean isUseViewMaskForPolling()

setUseViewMaskForPolling

public void setUseViewMaskForPolling(boolean useViewMaskForPolling)

isUseViewMaskForSyncing

public boolean isUseViewMaskForSyncing()

setUseViewMaskForSyncing

public void setUseViewMaskForSyncing(boolean useViewMaskForSyncing)

getViewMask

public java.lang.String getViewMask()

setViewMask

public void setViewMask(java.lang.String viewMask)

isUseViewMask

public boolean isUseViewMask()

setUseViewMask

public void setUseViewMask(boolean useViewMask)

getP4Charset

public java.lang.String getP4Charset()

setP4Charset

public void setP4Charset(java.lang.String p4Charset)

getP4CommandCharset

public java.lang.String getP4CommandCharset()

setP4CommandCharset

public void setP4CommandCharset(java.lang.String p4CommandCharset)

getLineEndValue

public java.lang.String getLineEndValue()

setLineEndValue

public void setLineEndValue(java.lang.String lineEndValue)

getAllLineEndChoices

public java.util.List<java.lang.String> getAllLineEndChoices()

getFirstChange

public java.lang.String getFirstChange()

This is only for the config screen. Also, it returns a string and not an int. This is because we want to show an empty value in the config option if it is not being used. The default value of -1 is not exactly empty. So if we are set to default of -1, we return an empty string. Anything else and we return the actual change number.

Returns:

The one time use variable, firstChange.

processWorkspaceBeforeDeletion

public boolean processWorkspaceBeforeDeletion(hudson.model.AbstractProject<?,?> project,
                                              hudson.FilePath workspace,
                                              hudson.model.Node node)

With Perforce the server keeps track of files in the workspace. We never want files deleted without the knowledge of the server so we disable the cleanup process.

Overrides:

processWorkspaceBeforeDeletion in class hudson.scm.SCM

Parameters:

project - The project that owns this SCM. This is always the same object for a particular instanceof SCM. Just passed in here so that SCM itself doesn't have to remember the value.

workspace - The workspace which is about to be deleted. Never null. This can be a remote file path.

node - The node that hosts the workspace. SCM can use this information to determine the course of action.

Returns:

true if SCM is OK to let Hudson proceed with deleting the workspace. False to veto the workspace deletion.

requiresWorkspaceForPolling

public boolean requiresWorkspaceForPolling()

Overrides:

requiresWorkspaceForPolling in class hudson.scm.SCM

isSlaveClientNameStatic

public boolean isSlaveClientNameStatic()