This topic explains how to connect SOAtest to your source control repository.
Sections include:
About Source Control Support
Any source control system that plugs into your Parasoft SOAtest environment can be used to manage your source and test files.
If your team is using a one of the specified supported source control system (see list below) and performs the necessary configurations (as described later in this topic), Parasoft can:
- Use file revision data from source control to determine authorship (for automatically assigning test failures and policy violations to the responsible team member as well as for restricting test scope by author and/or modification time). SeeConfiguring Task Assignment and Code Authorship Settings for details.
- Update projects from source control before testing (if the Test Configuration’s Common> Source Control> Update projects setting is enabled).
SOAtest includes out-of-the-box support for the following source control systems:
Vendor | Tested version |
---|---|
Git | 1.7, 1.8, 1.9, 2.x |
Microsoft Team Foundation Server | 2012, 2015, 2017, 2018, 2019 |
Perforce | 2006.2, 2015 |
Subversion (SVN) | 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13 |
You can use the source control API to integrate with other source control systems. Refer to Adding a Custom Source Control Integration.
Deprecated Source Control Systems
Support for the following SCMs is deprecated since SOAtest 2020.1.
- AccuRev
- ClearCase
- CVS
- Serena Dimensions
- StarTeam
- Synergy
- Visual SourceSafe
See Configuring Deprecated Source Control Systems for configuration information.
Subclipse Support
Each Subclipse plugin version is compatible with specific Subversion versions. Ensure that your Subclipse plugin is compatible with a version of Subversion that Parasoft supports.
For example, you do not install Subversion 1.3 and Subclipse plugin 1.2, Subclipse 1.2 uses Subversion 1.4. Subclipse 1.4.x requires Subversion 1.5.0 version of JavaHL/SVNKit. Subclipse 1.4.5 already has subversion client adapter 1.5.2.
Subversion clients earlier than 1.4 do not support working copies produced by Subversion 1.4. If you are using Subclipse plugin 1.2 (which includes Subversion 1.4), you might receive the following error message:
svn: This client is too old to work with working copy '.'; please get a newer Subversion client
This means that Parasoft is using a command-line client that is version 1.3 or older. The solution is to update your command-line SVN client to version 1.4. The client version can be verified by executing the following command:
svn --version
Enabling Source Control Support
To enable support for any of the supported source control systems:
Make sure that the command line client for the given source control is on the system%PATH%/$PATH and is available when SOAtest is launched.
For example, if you have Subversion, it is not sufficient (or even required) to install the Subclipse plugin to Eclipse (SVN Eclipse plugin). Instead, you should have the plain command line svn.exe Subversion client.
- Choose Parasoft> Preferences. The Preferences dialog will open.
- Select Parasoft> Scope and Authorship in the Preferences dialog.
- Check Use source control (modification author) to compute scope.
- Select Parasoft> Source Controls in the Preferences dialog.
- If the appropriate repositories are already set (refer to the auto-configuration process described in Configuring SOAtest Across Teams), enter your user and password, and specify the path to your source control client executable (if it is not already on your system path).
If the appropriate repositories are not already set (refer to the auto-configuration process described in Configuring SOAtest Across Teams) specify them as follows:- Enable the source control system you want to use and specify the path to the SCM client executable. You do not need to specify the executable path if it is already on your system path.
- Click New in Repository properties field and enter the source control properties required for the selected type of source control system.
- Click OK to close the Source Control Description dialog.
- Apply your changes and click OK.
To test the integration:
- In the Parasoft environment, open a project that is checked out from the repository.
- Open a file in the editor.
- Right-click the source code, and choose Parasoft> Show Author at Line. If the correct author is shown, the integration was successful.
Debugging Tip
To troubleshooting problems with source control integration, run -consolelog -J-Dcom.parasoft.xtest.logging.config.jar.file=/com/parasoft/xtest/logging/log4j/config/logging.on.xml.
This should result in detailed log information being printed to the console.
To include messages from the source control system that may contain fragments of user source code, use an additional flag: -Dscontrol.log=true
Git Configuration
The Git repository you connect to must allow anonymous pulls.
- Open a command prompt and clone your repository:
git clone <repository>
- If cloning from a git URL, then the
git push
URL must also be configured to automatically push test cases checked in with Git.git config remote.origin.pushurl git@<your repository URL>
- Set g
it config
on the newly created repositoryuser.name
.git config user.name "<your username>"
This step can be skipped if a global git user.name is already set. The user.name must match the user's DTP user name.
When you are enabling source control support, specify the following repository properties in the Create Source Control Description dialog:
- URL: Specify the remote repository URL to pull/push to. If pulling and pushing is disabled, this field can be left blank. You can use all git urls (e.g., git://host/repositoryssh://user@host user@host). Note that since the Git command line doesn't support setting credentials with flags, protocols which normally require authentication (such as ssh) must have identity files set to enable login without credentials or they must accept anonymous connections.
- Branch: Enter the name of the branch in the local workspace that the source control module will use. If this is left blank, the currently checked out branch will be used.
- Working folder: Enter the root of the local git repository.
Shallow Clones
A Git repository is considered shallow if the file .git/shallow
exists. Git may not accurately produce authorship data when checking out shallow clones from a repository. You should check out full clones to retrieve accurate authorship information.
Perforce Configuration
When you are enabling source control support, specify the following repository properties in the Create Source Control Description dialog:
- Server: Enter the Perforce server’s machine name or IP address.
- Port: Enter the Perforce server’s port.
- User: Enter the user name under which you want to connect to the repository.
- Password: Enter the password for the above user name.
- Client: Enter the client workspace name, as specified in the P4CLIENT environment variable or its equivalent.
Subversion Configuration
Parasoft’s Subversion support is based on the command line client 'svn'. See About Source Control Support for a list of supported SVN versions.
The client certificate must be stored in the Subversion configuration area. The Subversion client has a built-in system for caching authentication credentials on disk. By default, whenever the command-line client successfully authenticates itself to a server, it saves the credentials in the user's private runtime configuration area—in ~/.subversion/auth/ on Unix-like systems or %APPDATA%/Subversion/auth/ on Windows.
When you are enabling source control support, specify the following repository properties in the Create Source Control Description dialog:
- URL: Enter the URL for the SVN server. The URL should specify the protocol, server name, port and starting repository path (for example, svn://buildmachine.foobar.com/home/svn).
- User: Enter the user name under which you want to connect to the repository.
- Password: Enter the password (not encoded) for the above user name.
Team Foundation Server Configuration
See About Source Control Support for a list of supported versions.
SOAtest for Eclipse doesn't require any additional software to be installed for TFS integration (the required libraries are included).
When you are enabling source control support, specify the following repository properties in the Create Source Control Description dialog:
- URL: Enter the URL for the Team Foundation Server repository (for example, http://localhost:8080/tfs).
- Use custom credentials: If you want to provide custom TFS credentials, select this option then provide those credentials. When this option is disabled, system credentials will be used.
- User: Enter the user name.
- Password: Enter the password.
By default, SOAtest uses the cached credentials for accessing TFS (this could be your user login or some previously logged in information). You can provide custom credentials if you want to use them instead of the cached ones.
Configuring Deprecated Source Control Systems
Support for the following SCMs is deprecated and will end in a future release.
AccuRev Configuration
When you are enabling source control support, specify the following repository properties in the Create Source Control Description dialog:
- Server: Enter the hostname of server where AccuRev is running (required).
- Port: Enter the port of the server where AccuRev is running (required).
- Username: Enter the AccuRev username/login (required).
- Password: Enter the AccuRev password (if needed).
ClearCase Configuration
To use ClearCase with SOAtest:
- Check whether a source file is controlled by ClearCase by calling the
cleartool describe -fmt %Vn <file_path>
command. No output means that the file is not controlled by ClearCase. - Ensure that the
VOB
root directory contains alost+found
directory.
When you are enabling source control support, specify the following repository properties in the Create Source Control Description dialog:
- VOB location: Enter the dynamic or snapshot VOB access path. Use the full VOB path (e.g., /vobs/myvob (Linux dynamic view) or M:\\my_dynamic_view\myvob (Windows VOB path). Note that when you enter a Vob Location, the Vob tag field will automatically display the vob tag. If the location is not a proper vob path, a warning message is displayed
CVS Configuration
To use CVS with SOAtest, ensure that the .cvspass file is in one of the following locations:
- user.home system property
- HOME env variable
- (Windows) combination of HOMEDRIVE and HOMEPATH (example: "C:" + "\home")
- current working directory
When you are enabling source control support, specify the following repository properties in the Create Source Control Description dialog:
General tab
- Connection type: Enter the authentication protocol of the CVS server.
- User: Enter the user name under which you want to connect to the repository.
- Password: Enter the password for the above user name.
- Repository path: Enter the path to the repository on the server.
- Server: Enter the CVS server’s machine name or IP address.
- Port: Enter the CVS server’s port.
Custom SSH/CVS_RSH tab
- CVS_SERVER value: If connecting to a CVS server in EXT mode, this specifies which CVS application to start on the server side.
- Use custom authentication properties for ext/server method: Enable this option if you want to use custom authentication for ext/server method.
- Remote shell login: Enter your SSH login.
- Remote shell password: Enter the password for the above SSH login.
- Private key file: Enter the private key file.
- Passphrase for private key file: Enter the passphrase for the above private key file.
- Use command-line program to establish connection: Enables you to run an external program to establish an EXT connection. Use this option only for non-standard and legacy protocol connections (telnet, rsh). Linux/Unix/Cygwin ssh prompts for passwords/passphrases/ security word sequences are not currently supported.
- CVS_RSH path: Specifies the full path to the executable used to establish EXT connections.
- CVS_RSH parameters: Specifies the parameters for the executable. The following macro-definitions (case sensitive) can be used to expand values into command line parameters:
{host}
- host parameter{port} -
port paramete{user}
- user parameter from primary page{password}
- user password from primary page{extuser}
- user parameter from EXT/CVS_RSH page{extpassword}
- password parameter from EXT/CVS_RSH page{keyfile}
- path to key file{passphrase} -
password to key file
Serena Dimensions Configuration
Linux and Solaris Configuration Note
To use Serena Dimensions with SOAtest, Linux and Solaris users should run SOAtest in an environment prepared for using Serena programs, such as 'dmcli'
- LD_LIBRARY_PATH should contain the path to <SERENA Install Dir>/libs.
- DM_HOME should be specified.
Since many Solaris users commonly set the required Serena variables by running the Serena dmgvars.sh file, it also necessary to modify LD_LIBRARY_PATH variable. To use Serena Dimensions with SOAtest, LD_LIBRARY_PATH needs to include the following items (paths can be different on client machines):
- SSL/Crypto library - /usr/local/ssl/lib
- STDC++ library - /usr/local/lib
When you are enabling source control support, specify the repository properties in the following tabs.
Properties tab
- User: Enter the Serena Dimensions login name.
- Password: Enter the Serena Dimensions password.
- Server: Enter the Serena Dimensions server host name.
- Database name: Enter the name of the database for the product you are working with.
- Database connection: Enter the connection string for that database.
- Server locale: Select the language.
Workset Map tab
If the project has been downloaded/moved to a location other than default work area, use this tab to specify a mapping between the project (or stream) with the Serena repository and the local project.
If you are working in the default work area, you do not need to define mappings.
Enter an expression that maps workspace resources to Serena Dimension repository paths.
- Example 1: If you use scontrol.rep.serena.mapping_1=${project_loc\:MyProject};PRODUCT1\: WORKSET1;src\\MyProject, then Project 'MyProject' will be mapped to the Serena workset PRODUCT1:WORKSET1 and workset relative path: src\\MyProject
- Example 2: If you use scontrol.rep.serena.mapping_2=${workspace_loc};PRODUCT1\:WORKSET1 then the complete workspace will be mapped to the Serena workset PRODUCT1:WORKSET1.
StarTeam Configuration
The Borland StarTeam SDK is must be installed. Contact your oThis can be downloaded for free from the Borland web site.
For Visual Studio plugins, Parasoft StarTeam support is available for VS 2005 and VS 2008. When you are enabling source control support, specify the following repository properties:
- Server: Enter the StarTeam server’s machine name or IP address.
- Port: Enter the StarTeam server’s port.
- User: Enter the user name under which you want to connect to the repository.
- Password: Enter the password for the above user name.
- Paths lookup> StarTeam Path: When working with large multi-project repositories, you can improve performance by specifying the project, view, or folder that you are currently working with. You can indicate either a simple Project name (all views will be scanned when searching for the repository path), a Project/View (only the given view will scanned) or Project/View/Folder (only the specified StarTeam folder will be scanned).
- Paths lookup> Working Folder: If the StarTeam Path setting specifies a StarTeam view or folder, you can use this field to indicate a new working directory for the selected view's root folder (if the path represents a view) or a new working directory for the selected folder (if the path represents a folder).
Synergy Configuration
The following Synergy/CM communication modes are supported:
- Web mode (since Synergy 7.0)
- Traditional mode
When you are enabling source control support, specify the following repository properties in the Create Source Control Description dialog:
- Database path: Enter the absolute Synergy database path.
- Engine host: Enter the Synergy server’s machine name or IP address. For Web mode, the host must be a valid Synergy Web URL with protocol and port (e.g., http://synergy.server:8400).
- User: Enter the user name under which you want to connect to the repository.
- Password: Enter the password for the above user name.
- Use remote client (UNIX systems only): Enable this option if you want to start CCM as a remote client session. This is not used for Web mode.
- Local database (remote client): Enter the path to the location where the database information is copied when you are running a remote client session. This is not used for Web mode.
Visual SourceSafe Configuration
When you are enabling source control support, specify the following repository properties in the Create Source Control Description dialog:
- VSS Database Path: Enter the database path (the location of SRCSAFE.INI).
- User: Enter the user name under which you want to connect to the repository.
- Password: Enter the password for the above user name.
- Project root in repository: Enter the project root. This begins with
$/
; for example,$/nightly_test
.
Specifying Source Control Definitions via localsettings
Source control definitions can be specified in localsettings (e.g. for sharing team-wide settings via DTP, Concerto, or by specifying options at the command line). See Configuring Localsettings for details.