hudson.plugins.clearcase

Class AbstractClearCaseScm

java.lang.Object

hudson.scm.SCM

hudson.plugins.clearcase.AbstractClearCaseScm

All Implemented Interfaces:

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

Direct Known Subclasses:

ClearCaseSCM, ClearCaseUcmSCM

public abstract class AbstractClearCaseScm
extends hudson.scm.SCM

Abstract class for ClearCase SCM. The class contains the logic around checkout and polling, the deriving classes only have to implement the specific checkout and polling logic.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractClearCaseScm.AbstractClearCaseScmDescriptor<T extends AbstractClearCaseScm>
static class	AbstractClearCaseScm.ChangeSetLevel The change set level describes which level of details will be in the changeset

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLEARCASE_VIEWNAME_ENVSTR
static String	CLEARCASE_VIEWPATH_ENVSTR
static String	CLEARCASE_VIEWTAG_ENVSTR
protected static String	REGEX_WHITESPACE Regular Expression Search String for Whitespace.

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor and Description

AbstractClearCaseScm(String viewName, String mkviewOptionalParam, boolean filterOutDestroySubBranchEvent, boolean useUpdate, boolean rmviewonrename, String excludedRegions, boolean useDynamicView, String viewDrive, boolean extractLoadRules, String loadRules, boolean useOtherLoadRulesForPolling, String loadRulesForPolling, String multiSitePollBuffer, boolean createDynView, boolean freezeCode, boolean recreateView, String viewPath, AbstractClearCaseScm.ChangeSetLevel changeset, ViewStorage viewStorage)

Method Summary

Modifier and Type	Method and Description
void	buildEnvVars(hudson.model.AbstractBuild<?,?> build, Map<String,String> env) Adds the env variable for the ClearCase SCMs.
hudson.scm.SCMRevisionState	calcRevisionsFromBuild(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener taskListener)
hudson.scm.SCMRevisionState	calcRevisionsFromPoll(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener taskListener)
boolean	checkout(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.BuildListener listener, File changelogFile)
protected hudson.scm.PollingResult	compareRemoteRevisionWith(hudson.model.AbstractProject<?,?> project, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, hudson.scm.SCMRevisionState baseline)
protected String	computeExtendedViewPath(hudson.util.VariableResolver<String> variableResolver, ClearTool ct)
Filter	configureFilters(hudson.util.VariableResolver<String> variableResolver, hudson.model.AbstractBuild build, hudson.Launcher launcher)
protected abstract CheckoutAction	createCheckOutAction(hudson.util.VariableResolver<String> variableResolver, ClearToolLauncher launcher, hudson.model.AbstractBuild<?,?> build) Create a CheckOutAction that will be used by the checkout method.
protected ClearTool	createClearTool(hudson.util.VariableResolver<String> variableResolver, ClearToolLauncher launcher)
ClearToolLauncher	createClearToolLauncher(hudson.model.TaskListener listener, hudson.FilePath workspace, hudson.Launcher launcher) Creates a Hudson clear tool launcher.
protected abstract HistoryAction	createHistoryAction(hudson.util.VariableResolver<String> variableResolver, ClearToolLauncher launcher, hudson.model.AbstractBuild<?,?> build, hudson.scm.SCMRevisionState baseline, boolean useRecurse) Create a HistoryAction that will be used by the pollChanges() and checkout() method.
protected hudson.scm.SCMRevisionState	createRevisionState(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener taskListener, Date date)
protected abstract SaveChangeLogAction	createSaveChangeLogAction(ClearToolLauncher launcher) Create a SaveChangeLog action that is used to save a change log
String	generateNormalizedViewName(hudson.model.AbstractBuild<?,?> build)
String	generateNormalizedViewName(hudson.util.VariableResolver<String> variableResolver)
String	generateNormalizedViewName(hudson.util.VariableResolver<String> variableResolver, String modViewName) Returns a normalized view name that will be used in cleartool commands.
String[]	getBranchNames() Deprecated. use getBranchNames(VariableResolver) instead
abstract String[]	getBranchNames(hudson.util.VariableResolver<String> variableResolver) Return string array containing the branch names that should be used when polling for changes.
hudson.model.Computer	getBuildComputer(hudson.model.AbstractBuild<?,?> build) Returns the computer a given build ran on.
protected Date	getBuildTime(hudson.model.Run<?,?> lastBuild)
AbstractClearCaseScm.ChangeSetLevel	getChangeset()
hudson.model.Computer	getCurrentComputer() Returns the current computer - used in constructor for BuildVariableResolver in place of direct call to Computer.currentComputer() so we can mock it in unit tests.
String	getExcludedRegions()
String[]	getExcludedRegionsNormalized()
String	getLoadRules()
String	getLoadRules(hudson.util.VariableResolver<String> variableResolver)
String	getLoadRules(hudson.util.VariableResolver<String> variableResolver, boolean forPolling)
String	getLoadRulesForPolling()
String	getMkviewOptionalParam() Returns the user configured optional params that will be used in when creating a new view.
hudson.FilePath	getModuleRoot(hudson.FilePath workspace)
hudson.FilePath	getModuleRoot(hudson.FilePath workspace, hudson.model.AbstractBuild build)
int	getMultiSitePollBuffer()
protected String	getNormalizedViewName()
protected String	getNormalizedViewPath()
String	getViewDrive()
String	getViewName()
String	getViewName(hudson.util.VariableResolver<String> variableResolver)
String	getViewPath()
String	getViewPath(hudson.util.VariableResolver<String> variableResolver)
String[]	getViewPaths(hudson.util.VariableResolver<String> variableResolver, hudson.model.AbstractBuild build, hudson.Launcher launcher) Return string array containing the paths in the view that should be used when polling for changes.
String[]	getViewPaths(hudson.util.VariableResolver<String> variableResolver, hudson.model.AbstractBuild build, hudson.Launcher launcher, boolean forPolling) Return string array containing the paths in the view that should be used when polling for changes.
static String	getViewPathsRegexp(String[] loadRules, boolean isUnix)
ViewStorage	getViewStorage()
protected ViewStorage	getViewStorageOrDefault()
UcmWorkflow	getWorkflow()
protected boolean	hasNewConfigSpec(hudson.util.VariableResolver<String> variableResolver, ClearToolLauncher cclauncher)
protected void	inspectConfigAction(hudson.util.VariableResolver<String> variableResolver, ClearToolLauncher launcher) inspect config action that will be used by the checkout method.
protected boolean	invalidRevisionState(hudson.scm.SCMRevisionState baseline)
boolean	isCreateDynView()
boolean	isExtractLoadRules()
boolean	isFilteringOutDestroySubBranchEvent() Returns if the "Destroyed branch" event should be filtered out or not. For more information about the boolean, see the full discussion at Nabble.
protected abstract boolean	isFirstBuild(hudson.scm.SCMRevisionState baseline)
boolean	isFreezeCode()
boolean	isRecreateView()
boolean	isRemoveViewOnRename()
boolean	isUseDynamicView()
boolean	isUseOtherLoadRulesForPolling()
boolean	isUseUpdate()
boolean	processWorkspaceBeforeDeletion(hudson.model.AbstractProject<?,?> project, hudson.FilePath workspace, hudson.model.Node node)
Object	readResolve()
boolean	requiresWorkspaceForPolling()
protected void	setChangeset(AbstractClearCaseScm.ChangeSetLevel changeset)
protected void	setExtendedViewPath(hudson.util.VariableResolver<String> variableResolver, ClearTool ct, AbstractHistoryAction action)
void	setLoadRules(String ldRls)
protected void	setNormalizedViewName(String normalizedViewName)
protected void	setNormalizedViewPath(String normalizedViewPath)
void	setViewStorage(ViewStorage viewStorage)
void	setWorkflow(UcmWorkflow workflow)
boolean	supportsPolling()

Methods inherited from class hudson.scm.SCM

_calcRevisionsFromBuild, _for, _for, all, calcRevisionsFromBuild, checkout, compareRemoteRevisionWith, createChangeLogParser, createEmptyChangeLog, createEmptyChangeLog, getApi, getBrowser, getDescriptor, getEffectiveBrowser, getKey, getModuleRoots, getModuleRoots, getType, guessBrowser, nullify, poll, pollChanges, postCheckout, postCheckout, processWorkspaceBeforeDeletion

Methods inherited from class java.lang.Object

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

Field Detail

CLEARCASE_VIEWNAME_ENVSTR

public static final String CLEARCASE_VIEWNAME_ENVSTR

See Also:

Constant Field Values

CLEARCASE_VIEWPATH_ENVSTR

public static final String CLEARCASE_VIEWPATH_ENVSTR

See Also:

Constant Field Values

CLEARCASE_VIEWTAG_ENVSTR

public static final String CLEARCASE_VIEWTAG_ENVSTR

See Also:

Constant Field Values

REGEX_WHITESPACE

protected static final String REGEX_WHITESPACE

Regular Expression Search String for Whitespace.

See Also:

Constant Field Values

Constructor Detail

AbstractClearCaseScm

public AbstractClearCaseScm(String viewName,
                            String mkviewOptionalParam,
                            boolean filterOutDestroySubBranchEvent,
                            boolean useUpdate,
                            boolean rmviewonrename,
                            String excludedRegions,
                            boolean useDynamicView,
                            String viewDrive,
                            boolean extractLoadRules,
                            String loadRules,
                            boolean useOtherLoadRulesForPolling,
                            String loadRulesForPolling,
                            String multiSitePollBuffer,
                            boolean createDynView,
                            boolean freezeCode,
                            boolean recreateView,
                            String viewPath,
                            AbstractClearCaseScm.ChangeSetLevel changeset,
                            ViewStorage viewStorage)

Method Detail

buildEnvVars

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

Adds the env variable for the ClearCase SCMs.

• CLEARCASE_VIEWTAG - The clearcase view tag.
• CLEARCASE_VIEWNAME - The name of the clearcase view folder (relative to workspace).
• CLEARCASE_VIEWPATH - The absolute path to the clearcase view.

Overrides:

buildEnvVars in class hudson.scm.SCM

calcRevisionsFromBuild

public hudson.scm.SCMRevisionState calcRevisionsFromBuild(hudson.model.AbstractBuild<?,?> build,
                                                          hudson.Launcher launcher,
                                                          hudson.model.TaskListener taskListener)
                                                   throws IOException,
                                                          InterruptedException

Overrides:

calcRevisionsFromBuild in class hudson.scm.SCM

Throws:

IOException

InterruptedException

calcRevisionsFromPoll

public hudson.scm.SCMRevisionState calcRevisionsFromPoll(hudson.model.AbstractBuild<?,?> build,
                                                         hudson.Launcher launcher,
                                                         hudson.model.TaskListener taskListener)
                                                  throws IOException,
                                                         InterruptedException

Throws:

IOException

InterruptedException

createRevisionState

protected hudson.scm.SCMRevisionState createRevisionState(hudson.model.AbstractBuild<?,?> build,
                                                          hudson.Launcher launcher,
                                                          hudson.model.TaskListener taskListener,
                                                          Date date)
                                                   throws IOException,
                                                          InterruptedException

Throws:

IOException

InterruptedException

checkout

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

Overrides:

checkout in class hudson.scm.SCM

Throws:

IOException

InterruptedException

configureFilters

public Filter configureFilters(hudson.util.VariableResolver<String> variableResolver,
                               hudson.model.AbstractBuild build,
                               hudson.Launcher launcher)
                        throws IOException,
                               InterruptedException

Throws:

IOException

InterruptedException

createClearToolLauncher

public ClearToolLauncher createClearToolLauncher(hudson.model.TaskListener listener,
                                                 hudson.FilePath workspace,
                                                 hudson.Launcher launcher)

Creates a Hudson clear tool launcher.

Parameters:

listener - listener to write command output to

workspace - the workspace for the job

launcher - actual launcher to launch commands with

Returns:

a clear tool launcher that uses Hudson for launching commands

generateNormalizedViewName

public String generateNormalizedViewName(hudson.model.AbstractBuild<?,?> build)

Parameters:

build - the project to get the name from

Returns:

a string containing no invalid chars.

See Also:

AbstractClearCaseScm#generateNormalizedViewName(BuildVariableResolver, String)

generateNormalizedViewName

public String generateNormalizedViewName(hudson.util.VariableResolver<String> variableResolver)

Parameters:

variableResolver - An initialized build variable resolver.

Returns:

a string containing no invalid chars.

See Also:

AbstractClearCaseScm#generateNormalizedViewName(BuildVariableResolver, String)

generateNormalizedViewName

public String generateNormalizedViewName(hudson.util.VariableResolver<String> variableResolver,
                                         String modViewName)

Returns a normalized view name that will be used in cleartool commands.

It will replace :

• ${NODE_NAME} with the name of the node
• ${JOB_NAME} with the name of the job
• ${USER_NAME} with the name of the user

This way it will be easier to add new jobs without trying to find an unique view name. It will also replace invalid chars from a view name.

Parameters:

build - the project to get the name from

Returns:

a string containing no invalid chars.

getBranchNames

@Deprecated
public String[] getBranchNames()

Deprecated. use getBranchNames(VariableResolver) instead

Return string array containing the branch names that should be used when polling for changes.

Returns:

a string array, can not be empty

getBranchNames

public abstract String[] getBranchNames(hudson.util.VariableResolver<String> variableResolver)

Return string array containing the branch names that should be used when polling for changes.

Returns:

a string array, can not be empty

getBuildComputer

public hudson.model.Computer getBuildComputer(hudson.model.AbstractBuild<?,?> build)

Returns the computer a given build ran on. We wrap this here for mocking purposes.

getChangeset

public AbstractClearCaseScm.ChangeSetLevel getChangeset()

getCurrentComputer

public hudson.model.Computer getCurrentComputer()

Returns the current computer - used in constructor for BuildVariableResolver in place of direct call to Computer.currentComputer() so we can mock it in unit tests.

getExcludedRegions

public String getExcludedRegions()

getExcludedRegionsNormalized

public String[] getExcludedRegionsNormalized()

getLoadRules

public String getLoadRules()

getLoadRules

public String getLoadRules(hudson.util.VariableResolver<String> variableResolver)

getLoadRules

public String getLoadRules(hudson.util.VariableResolver<String> variableResolver,
                           boolean forPolling)

getLoadRulesForPolling

public String getLoadRulesForPolling()

getMkviewOptionalParam

public String getMkviewOptionalParam()

Returns the user configured optional params that will be used in when creating a new view.

Returns:

string containing optional mkview parameters.

getModuleRoot

public hudson.FilePath getModuleRoot(hudson.FilePath workspace)

Overrides:

getModuleRoot in class hudson.scm.SCM

getModuleRoot

public hudson.FilePath getModuleRoot(hudson.FilePath workspace,
                                     hudson.model.AbstractBuild build)

Overrides:

getModuleRoot in class hudson.scm.SCM

getMultiSitePollBuffer

public int getMultiSitePollBuffer()

getViewDrive

public String getViewDrive()

getViewName

public String getViewName()

getViewName

public String getViewName(hudson.util.VariableResolver<String> variableResolver)

getViewPath

public String getViewPath()

getViewPath

public String getViewPath(hudson.util.VariableResolver<String> variableResolver)

getViewPaths

public String[] getViewPaths(hudson.util.VariableResolver<String> variableResolver,
                             hudson.model.AbstractBuild build,
                             hudson.Launcher launcher)
                      throws IOException,
                             InterruptedException

Return string array containing the paths in the view that should be used when polling for changes.

Parameters:

variableResolver - [anb0s: HUDSON-8497]

build - TODO

launcher - TODO

Returns:

string array that will be used by the lshistory command and for constructing the config spec, etc.

Throws:

InterruptedException

IOException

getViewPaths

public String[] getViewPaths(hudson.util.VariableResolver<String> variableResolver,
                             hudson.model.AbstractBuild build,
                             hudson.Launcher launcher,
                             boolean forPolling)
                      throws IOException,
                             InterruptedException

Return string array containing the paths in the view that should be used when polling for changes.

Parameters:

variableResolver - [anb0s: HUDSON-8497]

build - TODO

launcher - TODO

forPolling - used for polling?

Returns:

string array that will be used by the lshistory command and for constructing the config spec, etc.

Throws:

InterruptedException

IOException

getViewStorage

public ViewStorage getViewStorage()

getWorkflow

public UcmWorkflow getWorkflow()

isCreateDynView

public boolean isCreateDynView()

isExtractLoadRules

public boolean isExtractLoadRules()

isFilteringOutDestroySubBranchEvent

public boolean isFilteringOutDestroySubBranchEvent()

Returns if the "Destroyed branch" event should be filtered out or not.
For more information about the boolean, see the full discussion at Nabble.

"Usually, CC admins have a CC trigger, fires on an uncheckout event, that destroys empty branches."

Returns:

true if the "Destroyed branch" event should be filtered out or not; false otherwise

isFreezeCode

public boolean isFreezeCode()

isRecreateView

public boolean isRecreateView()

isRemoveViewOnRename

public boolean isRemoveViewOnRename()

isUseDynamicView

public boolean isUseDynamicView()

isUseOtherLoadRulesForPolling

public boolean isUseOtherLoadRulesForPolling()

isUseUpdate

public boolean isUseUpdate()

processWorkspaceBeforeDeletion

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

Overrides:

processWorkspaceBeforeDeletion in class hudson.scm.SCM

Throws:

IOException

InterruptedException

readResolve

public Object readResolve()

requiresWorkspaceForPolling

public boolean requiresWorkspaceForPolling()

Overrides:

requiresWorkspaceForPolling in class hudson.scm.SCM

setLoadRules

public void setLoadRules(String ldRls)

setViewStorage

public void setViewStorage(ViewStorage viewStorage)

setWorkflow

public void setWorkflow(UcmWorkflow workflow)

supportsPolling

public boolean supportsPolling()

Overrides:

supportsPolling in class hudson.scm.SCM

compareRemoteRevisionWith

protected hudson.scm.PollingResult compareRemoteRevisionWith(hudson.model.AbstractProject<?,?> project,
                                                             hudson.Launcher launcher,
                                                             hudson.FilePath workspace,
                                                             hudson.model.TaskListener listener,
                                                             hudson.scm.SCMRevisionState baseline)
                                                      throws IOException,
                                                             InterruptedException

Overrides:

compareRemoteRevisionWith in class hudson.scm.SCM

Throws:

IOException

InterruptedException

computeExtendedViewPath

protected String computeExtendedViewPath(hudson.util.VariableResolver<String> variableResolver,
                                         ClearTool ct)

createCheckOutAction

protected abstract CheckoutAction createCheckOutAction(hudson.util.VariableResolver<String> variableResolver,
                                                       ClearToolLauncher launcher,
                                                       hudson.model.AbstractBuild<?,?> build)
                                                throws IOException,
                                                       InterruptedException

Create a CheckOutAction that will be used by the checkout method.

Parameters:

launcher - the command line launcher

Returns:

an action that can check out code from a ClearCase repository.

Throws:

InterruptedException

IOException

createClearTool

protected ClearTool createClearTool(hudson.util.VariableResolver<String> variableResolver,
                                    ClearToolLauncher launcher)

createHistoryAction

protected abstract HistoryAction createHistoryAction(hudson.util.VariableResolver<String> variableResolver,
                                                     ClearToolLauncher launcher,
                                                     hudson.model.AbstractBuild<?,?> build,
                                                     hudson.scm.SCMRevisionState baseline,
                                                     boolean useRecurse)
                                              throws IOException,
                                                     InterruptedException

Create a HistoryAction that will be used by the pollChanges() and checkout() method.

Parameters:

variableResolver -

launcher - the command line launcher

build - the current build if applicable

baseline - the baseline for comparison

useRecurse - whether to use the -recurse option in cleartool to call lshistory

Returns:

an action that can poll if there are any changes a ClearCase repository. Never null.

Throws:

InterruptedException

IOException

createSaveChangeLogAction

protected abstract SaveChangeLogAction createSaveChangeLogAction(ClearToolLauncher launcher)

Create a SaveChangeLog action that is used to save a change log

Parameters:

launcher - the command line launcher

Returns:

an action that can save a change log to the Hudson changlog file

getBuildTime

protected Date getBuildTime(hudson.model.Run<?,?> lastBuild)

getNormalizedViewName

protected String getNormalizedViewName()

getNormalizedViewPath

protected String getNormalizedViewPath()

getViewStorageOrDefault

protected ViewStorage getViewStorageOrDefault()

hasNewConfigSpec

protected boolean hasNewConfigSpec(hudson.util.VariableResolver<String> variableResolver,
                                   ClearToolLauncher cclauncher)
                            throws IOException,
                                   InterruptedException

Throws:

IOException

InterruptedException

inspectConfigAction

protected void inspectConfigAction(hudson.util.VariableResolver<String> variableResolver,
                                   ClearToolLauncher launcher)
                            throws IOException,
                                   InterruptedException

inspect config action that will be used by the checkout method.

Parameters:

variableResolver -

launcher -

Throws:

InterruptedException

IOException

invalidRevisionState

protected boolean invalidRevisionState(hudson.scm.SCMRevisionState baseline)

isFirstBuild

protected abstract boolean isFirstBuild(hudson.scm.SCMRevisionState baseline)

setChangeset

protected void setChangeset(AbstractClearCaseScm.ChangeSetLevel changeset)

setExtendedViewPath

protected void setExtendedViewPath(hudson.util.VariableResolver<String> variableResolver,
                                   ClearTool ct,
                                   AbstractHistoryAction action)

setNormalizedViewName

protected void setNormalizedViewName(String normalizedViewName)

setNormalizedViewPath

protected void setNormalizedViewPath(String normalizedViewPath)

getViewPathsRegexp

public static String getViewPathsRegexp(String[] loadRules,
                                        boolean isUnix)