This page last changed on Jan 26, 2010 by dhommel.

CCValidator is a GUI tool for validating the contents of a ccnet.config file. It uses the same underlying rules engine as both the service and the console to check all the rules around what is valid in the configuration.

Starting

To start the validator double-click on the validator short-cut under CruiseControl.Net. This will display the following window:

Validating

To validate a configuration file, click on File, then Open..., then select the file to validate. Selecting the file will load the file and validate it:

  • The display on the left shows the results of the validation. If there are any validation errors they will be displayed underneath the project or queue where the error occurred.
  • The display on the right shows the configuration that was validated. This provides two views: original and processed.
  • The original view is the view of the actual file. This is the config file on the file system, before any pre-processing or default values.
  • The processed view is how CruiseControl.Net sees the file. This includes any pre-processing and default values. If there is a validation error then this view is likely to be incorrect.
    Both views will show the full details of the configuration file, including any passwords and user names.

Command-line Interface

It is also possible to use CCValidator as a command-line tool.

Syntax

CCValidator [Configuration File] [Options]

The configuration file (if used) must be the first argument.

The command line arguments are implemented using the Mono.Options class,
which allows short and long options as well as different "well known" ways of writing arguments.

Example:
CCValidator.exe --help
CCValidator.exe /help
CCValidator.exe --logfile=log.txt
CCValidator.exe /logfile:log.txt

The following long options are available:

Command (Long) Description Required Default Version
--logfile Set the log file. This is the location where all validation messages will be written to. No None 1.4.4
--nogui Hide the GUI interface. No False 1.4.4
--help Display command line help. No False 1.5

The following short options are available:

Command (Short) Description Required Default Version
-l Set the log file. This is the location where all validation messages will be written to. No None 1.4.4
-n Hide the GUI interface. No False 1.4.4
-h|-? Display command line help. No False 1.5

Examples

Run the validator in GUI mode and automatically load the configuration file:
CCValidator "C:\Program Files\CruiseControl.NET\Server\ccnet.config"

Run the validator without a GUI and write the messages to a log file:
CCValidator "C:\Program Files\CruiseControl.NET\Server\ccnet.config" --nogui --logfile="C:\Logs\ccnet.log"


Start.png (image/x-png)
Validating.png (image/x-png)
Document generated by Confluence on Jan 23, 2011 08:52