Overview

Bamboo plugin that provides support for AccuRev repositories use

Compatibility

Primary Features

Pligin provides the following major features:

• Support for 2 operation modes: 'stream' and 'workspace' (see below)
• Detect source code changes (date and time, user name, comment, affected files with versions) in streams and workspaces
• Retrieve source code from repository for a build using existing workspace, stream or snapshot
• Possibility to specify repository location (server name and port) and account to use to access it
• Linux and Windows support

Additional Features

Optional Details in Change Comments

Plugin also has a feature to add useful information (optionally) to change comments:

• Date and time when change was done
• Stream/workspace where change has happened
• Change type (keep, promote, etc.)
• Stream change details if change is related to a streams configuration (re-parent, time lock change)

Bamboo Variables Support

Plugin defines several variables to be used other Build Plan configuration tabs:

• Provide repository related information to Builders (use it to define some other Build Plan option using them)
• Display repository configuration and source retrieval data used for the specific build on 'Meta Data' page
• Remember to use that names like: ${bamboo.<variable>} as per the Bamboo manual and use single quotes to pass through variable values that may contain spaces.
  Eg:

  System Environment Variables:
  AC_PATH=${bamboo.repository.accurev.path.binary} 
  AC_CONFIG_TYPE=${bamboo.repository.accurev.config.type} 
  AC_REVISION='${bamboo.repository.accurev.revision}' 
  AC_CONFIG_NAME=${bamboo.repository.accurev.config.name} 
  

Operation Modes

AccuRev repository plugin supports 2 operation modes that have different repository setup requirements and can be used to serve different needs.

History

Installation

Setup

1. Download required version of AccuRev repository plug-in
2. Put plugin JAR into '$BAMBOO_HOME/webapp/WEB-INF/lib' directory
3. Restart Bamboo Server
4. Go to Bamboo Administration page and click System Information in System category
5. Check that 'AccuRev Repository' plugin and its correct version are listed in Enabled Plugins section of the page (see below)

Configuration

AccuRev Client Location

Plugin uses AccuRev command line client to perform all its actions. By default it executes just 'accurev' binary without a full path assuming that it is the $PATH. If it is not the case AccuRev client install path has to be known to the plugin on server and/or every Build Agent.

AccuRev client location has to be specified as a custom Capability named 'accurev.path'

Plugin Meta Data Storage

Plugin implementation requires to store some additional data per build plan to overcome AccuRev limitation (1-10MB per build plan). This location has to be created before any build plan with AccuRev can be used and Bamboo Server needs to have read/write access to it. The location is used only in change detection phase so no Build Agent need to access it.

Usage

Create or edit a Build Plan

Create a new Build Plan, clone or edit an existing one. Switch to Source Repository tab for the Build Plan.

Select AccuRev as Source Repository

Check if AccuRev is selected as Repository on Source Repository tab and switch to it if it wasn't.

Edit Server Configuration options

When AccuRev is selected as Repository all its options becomes available to configure. Required fileds are marked with asterix.

Enter or modify AccuRev server options providing your server and login details:

• Server Name (host name) and its Port where AccuRev instance is running and serving requests. It can be master or replica server.
• Enter path to Meta Data Location where plugin will store some extra information required to properly detect changes (see for details).
• User Name and Password to log into repository. Password field is displayed if Change Password is checked.

Plugin will check if connection to AccuRev server can be made using host details and credential provided when changes are saved. It will also check if meta data location exists when configuration is saved.

Edit Repository Configuration options

In this section you have to specify configuration to check for changes and to retrieve sources. Based on your needs you have to chose operation mode and set options specific for it.

You have to choose required Mode and set other options as explained below.

Repository Configuration for Stream mode

For this mode just Stream/Snapshot name parameter has to be specified. It can be regular or workspace backing stream or snapshot name.

Plugin will check if existing stream or snapshot name was provided.

Plugin will collect changes in the specified stream and all parent streams in its hierarchy using 'stat' and 'hist' AccuRev commands. Source code is retrieved using 'pop' command into Build Plan working directory.

Repository Configuration for Workspace mode

In 'workspace' mode configuration Workspace/Reftree name has to be entered.

Plugin will check if existing stream or snapshot name was provided.

Plugin will check all streams in the workspace hierarchy starting workspace backing stream for recent changes. Algorithm is implemented in the way to avoid workspace update at this stage but get all recent changes.

In this mode workspace location has to be used for build and it is being updated by plugin to bring all recent changes. Plugin uses 'update' command for this. It might be useful to disable such updates using Disable Update option to

• Allow debug and fix build failures using manual build in workspace location
• Control workspace updates manually if it is being used in Build Plan and by developer

Development

Jira Issues