PDF Print E-mail

Compass Version 1.3

<< prev
TOC
next >>

Built-In Script Reference

There are 25 scripts that ship with Compass Version1.1. Each of these scripts is displayed below along with usage information:


Build Script Name Build Script Description and Usage Notes
Ant
Runs the Ant Build tool. Ant must be installed on the client machine. In the build plan, enter the Ant Build target as the build step argument.
Copy File
This copies a file or files to a new location within the source tree. The script takes two parameters passed in to as arguments in the build editor. The parameters must be separated by a space. The first parameter is a relative filename or directory name (wildcards are OK) and the second should be a relative directory name that exists. Copy file will not create destination directories.
Create Directory
The Create Directory script creates a new directory in the source tree. The argument to this script is the name of the directory to be created. Run this script from the parent directory from where the new directory will be created.
CVS Argument Checkout
The CVS Argument Checkout script checks out source code from a CVS repository and should be used only for iteratively scheduled builds. It cannot be used to create revision checkouts. The Arguments should be a fully qualified CVS address, ie: pserver: This e-mail address is being protected from spambots. You need JavaScript enabled to view it . The MODULE_NAME variable must be set in the 'Defaults' window, specifying the module to be checked out.
CVS Argument Update
The CVS Argument Update script updates a source tree from a CVS repository in incremental build plans. The arguments in the build editor should be a fully qualified CVS address, ie: pserver: This e-mail address is being protected from spambots. You need JavaScript enabled to view it . The MODULE_NAME variable must be set in the 'Defaults' window, specifying the module to be updated.
CVS Revision Checkout
The CVS Revision Checkout script checks out source-code from a CVS repository and is provided the revision number and other relevant information from a CVS source-control server trigger.

CVS Revision Update

The CVS Revision Update script updates source-code from a CVS repository and is provided the revision number and other relevant information from a CVS source-control server trigger.
Delete File
The Delete File script deletes a file or directory. In the build editor, the argument should be a relative path to the file or directory to delete, relative to the root project directory.
Display File
The Display File script prints the specified file to standard output. In the build editor, the file is specified as the argument to the build step. This can be used for informational purposes, or for unit test parsing if a project's unit test output is saved to a file.
Execute File
 Use this script to run any executable. Give the name of the executable along with any command line parameters in the arguments textbox.  This is a convenience script that work cross platform, but it does not handle any error results from the running executable and it will generally always report success even if the executable contains errors.  Anx Labs recommends creating custom scripts for all user functionality and only using this script as a placeholder or temporary solution.
Java Compilation
The Java Compilation script compiles a single java file. In the build editor, the build step argument should be the name of the file to compile.
JUnit Execute
The JUnit Execute script executes junit on a single .class file. In the build editor pass the name of the class as the build step argument.
JUnit Test Parser
The JUnit Test Parser script is a unit test parser script. This script is used to parse the output of JUnit executions and takes no arguments. It is typically used with an Ant or JUnit Execute script.
Make
The Make script runs the command make, which is normally the gnu make executable. The argument in the build editor for this script is the target to build with.
Perforce Argument Checkout

The Perforce Argument Checkout script is used to check out code from a perforce repository. The argument to this script in the build editor must be the address of a Perforce server followed by a space and then the desired depot location. For example: perforce_server:1666 //depot/trunk/...

Perforce Argument Update
The Perforce Argument Update script is used to sync an incremental perforce build. The argument to be passed to this script in the build editor is the perforce server followed by a space and then a desired depot location. For Example: perforce_server:1666 //depot/trunk
Perforce Revision Checkout
The Perforce Revision Checkout script checks out source code from a perforce repository and is provided and revision number, server and depot location by a perforce source-control server trigger. It requires no arguments in the build editor.
Perforce Revision Update The Perforce Revision Update scritp updates source-code from a p4 repository and is provided the revision number, server and depot from a perforce source-control server trigger. There are no arguments required in the build editor.
PyUnit Test Case Runner
This script will output the result of running all the test functions that begin with 'test' in a unittest TestCase derived class. The script takes two arguments, the python module path and the name of the TestCase Class. (ie: 'tests.dir.moduleName MyTestCase')

PyUnit Test Parser

The PyUnit Test Parser script is a unit test parser script.This script is used to parse the output of PyUnit Test Runner scripts and takes no arguments.
PyUnit Test Suite Runner
This script will output the result of running a PyUnit Test Suite. The script takes two arguments, the python module path and the name of the TestSuite. (ie: 'tests.dir.moduleName MyTestSuite').
Remove Directory
The Remove Directory script removes an entire directory from the project source tree. The argument in the build step is the relative path to the directory to be deleted.
SVN Argument Checkout
The SVN Argument Checkout script is used to check out code from a subversion repository. The argument to this script in the build editor must be the URL of the repository to be checked out. For Example: svn+ssh:// This e-mail address is being protected from spambots. You need JavaScript enabled to view it /repos/trunk OR http://host.com/repos/trunk
SVN Argument Update
The SVN Argument Update script is used to update code from a subversion repository in incremental build plans. The argument to this script in the build editor must be the URL of the repository to be updated. For Example: svn+ssh:// This e-mail address is being protected from spambots. You need JavaScript enabled to view it /repos/trunk OR http://host.com/repos/trunk
SVN Revision Checkout The SVN Revision Checkout script is used to check out code from a subversion repository every time the repository changes. It should only be used when builds are scheduled for triggered by changes to the repository. It will use the server name and path that the svn source-control trigger is watching. If this script is used in non-triggered builds, then the SERVER_URL, SERVER_PATH, and REVISION arguments should be set in the defaults dialog on the build step.
SVN Revision Update
The SVN Revision update script is used to update code from a subversion respository in incremental build plans every tim the repository changes. It should only be used when builds are triggered by changes to the repository. It will use the server name and path that the svn source-control trigger is watching. If this script is used in non-triggered builds, then the SERVER_URL, SERVER_PATH, and REVISION arguments should be set in the defaults dialog on the build step.
Visual Studio Build
The Visual Studio Build will execute devenv and build a visual studio project. The argument in the build editor must be the name of the solution and in the 'Defaults' dialog the CONFIG_NAME variable must be specified to configuration to use to build the solution. This script uses the /Build switch to devenv.
Visual Studio Rebuild
The Visual Studio Build will execute devenv and build a visual studio project. The argument in the build editor must be the name of the solution and in the 'Defaults' dialog the CONFIG_NAME variable must be specified to configuration to use to build the solution. This script uses the /Rebuild switch to devenv.
 

bottom
top
Copyright © 2012 Anx Labs. All Rights Reserved.
Anx Labs Inc. - 2251 Double Creek Dr. Ste. 604, Round Rock TX 78664 - 1-888-900-6819
bottom