Introduction

ConfigChecker is a tool to analyze the numerous configuration settings of a software system and report the current configuration values or detect misconfiguration.

Essentially the tool can do two things:

1. Report the current configuration settings
2. Check the current configuration against an instruction set which defines what is expected and report the differences

A major strength of ConfigChecker is its capability to extract configuration settings from various sources.
For example it can read or check values in

• Plain text files
• XML files
• Java properties files
• Java manifest files
• Windows ini files
• Windows registry
• Apache conf files
• LDIF files

Get the trial version and see yourself what ConfigChecker can do for you.

Version 2.0

New data source adapter:

• Databse (not in trial version)
• WinRegistry (not in trial version)

New assertion commands:

• AssertMatchAll
• AssertMatchOneOf

Other features:

• Supports now <ValueList> as sub-tag of <AssertOneOf>
• Command <SetFrom> now supports an attribute default
• New pre-defined variable OS_FAMILY which containes the operating system family (i.e. "windows", "unix", "mac")
• In <ReportBlock> two new attributes for conditional execution are available: beforeVersion, sinceVersion
• In the element attribute of commands it is now possible to specify a variable name instead of a data source adapter specific element description path.

Dependencies:

• Now requires JRE 1.5 or later
• Now based on pf.jar 4.0.1

Bugfixes:

• Placeholders in <Value> elements have not been replaced
• NullPointerException if a cci without instructions file was included
• Commands AssertMatch, AssertContains, AssertOneOf didn't support the not-attribute
• Empty settings were not handled correctly
• Empty tags in XML files were not found
• Variable LAST_ASSERTION_RESULT was always true for optional="true" if element was not found

Version 1.0

Supported Data Source Adapter:

• SettingsFile
• XmlFile
• HttpdConfFile
• TextFile
• FileSystem
• SettingsObject
• LdifFile

Supported assertion commands:

• AssertExistence
• AssertEquals
• AssertLess
• AssertGreater
• AssertLessOrEqual
• AssertGreaterOrEqual
• AssertContains
• AssertMatch
• AssertOneOf
• AssertNewLine

Supported control commands:

• Include
• Set
• SetFrom
• SetFromFile
• ReportVariable
• ReportValue
• ReportBlock
• ForEach
• ForFiles

Supported reports:

• Minimum XML report that contains only output messages
• Default XML report with and output section
• Extended XML report with header, input and output sections
• Full XML report with header, plug-in list, input and output sections

Other features:

• Bundle with utility Start Script Shell Generator
• Automatic location of files inside zipped files
• Remote access to files via http
• Variables/Placeholders
• Automatic authentication
• Pluggable data source adapters and assertion commands

Guides

Find here information about

• Installation
• Usage

Installation

Installation of ConfigChecker is very easy. Just follow these steps:

• Create a new directory wherever you want
• Unzip the contents of configchecker.zip into this new directory
• Ensure that the environment variable JAVA_HOME points to an existing JRE 1.5.x directory (e.g. c:/programs/java1.5.0/jre)
• Generate a shell script that enables invocation of ConfigChecker from any directory (see below)

To learn about how to start ConfigChecker see Usage.

Start Script Shell Generator

There is a little utility program bundled with ConfigChecker called Start Script Shell Generator. The purpose of this tool is to generate a shell script (according to the current operating system) that allows to run ConfigChecker from everywhere in the system without being forced to change the current path or explicitly specify a classpath or modify any environment variables.

To use it just run:
java -jar pf-sssgen.jar -f configchecker.jar
(under Windows you also can use the sssgen.bat instead)
This generates a run.bat or run.sh depending on the operating system.

To get help about the start parameters of Start Script Shell Generator just call it without any parameter.

Command-line Parameters

ConfigChecker understands the following command line options which can be specified in any order.

-i filename

Specifies the file that contains the instructions to be executed. This start parameter is required.

-o filename

Specifies the file to which the output (i.e. the report) must be written. This start parameter is optional. If omitted the report will be written to stdout.

-v filenames

Specifies the name of one ore more properties files that contain initial variable definitions. Separate multiple files with the OS path separator (';' for Windows and ':' for Unix). The files are loaded in the order as specified from left to right.
This start parameter is optional. These files can be used to define variable values that are referred to in the instructions set. That simplifies re-using the same instruction set(s) in slightly different environments.

-var

Specifies one ore more variable definitions as name/value pairs. Name and value must be separated by '='. Multiple variables must be separated by the OS path separator (';' for Windows and ':' for Unix). The variables specified with this parameter will be set after the loading of the properties files specified by parameter -v. This start parameter is optional.

-xsl [filename]

Specifies that the generated report should contain a processing instruction for an XSL style-sheet. That allows to display it immediately in a browser. The optional filename specifies the XSL file to refer to. If no filename is given then the default cocheck_default.xsl is used. If necessary it will be copied automatically to the same folder as the XML report. So the XML report can be rendered if opended in a browser. This start parameter is optional.

-html

If defined an HTML version of the report will be created. This is only possible if -o and -xsl are set too. This start parameter is optional.

-rm

Minimum report. Only the <Output> section will be reported. This start parameter is optional.

-rd

Default report. Only the <Header> and <Output> sections will be reported. This start parameter is optional.

-re

Enhanced report. The <Header> and <Intput> and <Output> sections will be reported. This start parameter is optional.

-rf

Full report. All available data will be reported. This start parameter is optional.

-q

Sets the quiet mode. That is, no processing monitor window will be shown. This could be useful on Unix servers where no GUI components are supported. This start parameter is optional.

-no

Specifies to write no output. Usually that is only useful if ConfigChecker is used embedded inside another application. This start parameter is optional.

-a filename

Specifies a file that contains authentication credentials for particular URLs or realm. This start parameter is optional. If a remote file with a protected URL is to be worked on, ConfigChecker can automatically authenticate if the credentials are specified in the file specified with the -a option.

Variables

In all text and attribute values of an instruction file variables can be used. That makes instruction files very flexible and independent of a particular environment.
Usually variables should be used if

• the same value is needed at several places in the instruction file
• the value has to be changed more frequently than the instruction file logic itself
• the location of files should variable and not fixed to a particular environment

Variables as Placeholder

If a variable is used as placeholder in an attribute value or the text of an XML tag then its name must be enclosed in curly braces.
At execution time the placeholder will be replaced by the current value assigned to the variable name.

Example:

<Set name="color" value="red"/>            
<ReportBlock message="The preferred color is {color}"/>            
          

<Block message="The preferred color is red"/>            
          

Checking the Values of Variables

It is also possible to apply all assertion commands on the value of variables.
Therefore the variable name with prefix character '^' must be specified in the element attribute of the assertion command.

            
<AssertMatch element="^redirect.url">https://*</AssertMatch>
          

Variable Names

Variables can consist of the following characters only:

a-z A-Z 0-9 . _ - $

Other characters are not allowed and will cause an error with msgid="SERR003".

Predefined Variables

There are two variables that are always present during the execution of ConfigChecker.

CONFIGCHECKER_VERSION

Contains the version number (e.g. "2.2.0") of the ConfigChecker that is currently executed (this is not available in ConfigChecker versions before 2.2.0).

Example:

<ReportBlock sinceVersion="{CONFIGCHECKER_VERSION}:2.2.0">...</ReportBlock>
            

INSTRUCTION_DIR

Contains the absolute directory path of the instruction file (i.e. "*.cci" file) that was passed to ConfigChecker with the -i start parameter.
Usually that is very helpful to be used in <Include> commands if the cci file to be included is located in the same directory or a sub directory of where the main cci file is.

Example:

<Include>{INSTRUCTION_DIR}/server_checks.cci</Include>
            

LAST_ASSERTION_RESULT

This variable always contains the result of the last executed assertion. That is, its value is either "true" or "false". Before the first assertion its value is "true".
This variable can be used to control further execution depending on the result of an assertion.

Lets say for example, that the properties of a particular properties file should only be checked if the value of a particular element in an XML configuration file equals "enabled".

<XmlFile name="server_cfg.xml">
  <AssertEquals element="//Connection[@name='backup']/@remote">enabled<AssertEquals/>
</XmlFile>
<ReportBlock if="{LAST_ASSERTION_RESULT}=true">
  <SettingsFile type="properties" name="remote.properteis">
    <AssertEquals element="port">7265<AssertEquals/>
    <AssertGreater element="max.threads">15<AssertGreater/>
  </SettingsFile>
</ReportBlock>
            

OS_FAMILY

This variable gets automatically set to one of the following values:

• "windows"
• "unix"
• "mac"

It can be used in if and ifNot attributes of the Include and ReportBlock commands to achieve operating system dependant execution control.

Example:

<Include if="OS_FAMILY='unix'">other_unix.cci</Include>
            

For the exact operating system name the Java system property os.name can be used.

Apart from these variables there are other predefined variable names that are defined by particular command.
For details see the command description of

• <ForEach>
• <ForFiles>

Scope of Variables

Variables can have a value in global and local.
The global scope is outside a Data Source Adapter tag.
The local scope is inside a Data Source Adapter tag.

If a value has been assigned to a variable in global as well as in local scope then the corresponding placeholder is always replaced by the local value.
That means, the local value always overrides the global value as long as the execution is inside the Data Source Adapter tag where the local variable has been set.

When execution reaches the end of a Data Source Adapter tag then the local values of these variables are all removed.

Ways to set Variables

There are many different ways to set the value of a variable.

1. Providing one or multiple properties files with start parameter -v (see Usage). The separator between the filenames is the OS specific path separator (':' for Unix and ';' for Windows). That loads all properties from the specified files as variables into ConfigChecker. The files are loaded from left to right. That implies, that later loaded files may override variables that have been set by previously loaded files.
2. Specifying name/value pairs files with start parameter -var (see Usage). These variables are set after the loading of properties files with parameter -v. That allows overriding particular variables that have been set by the properties files.
3. Loading a properties file with the command <SetFromFile> from within an instruction set. This also loads all properties from the specified file as variables into ConfigChecker.
4. Using the command <Set> in an instruction set. This command's purpose is to assign a value to a variable.
5. Using the command <SetFrom> within an instruction set. This command's purpose is to assign a value from a configuration element to a variable.
6. All AssertXXX commands support an attribute resultVar. It allows to assign the assertion's result (true|false) to a variable with the name specified in that attribute. The scope of this variable can be set with the scope attribute.
7. The <ForEach> also sets a variable. That is either the default variable name "_EACH_" or the variable specified by its name attribute. The scope is always determined from the context the command is used in.
8. Since all Java system properties are generally available as variables for ConfigChecker it is also possible (but not recommended) to use the -D option with the JVM execution to set a variable.
   The better way is using start-parameter -var.

Control Commands

Include

The purpose of this command is to include another instruction file at exactly the point where this command is invoked. The Include command cannot be put inside a Data Source Adapter. It can only be used directly under Instructions or one of the following control commands if they are directly placed under Instructions.

• ReportBlock
• ForEach
• ForFiles

Attribues

The following table lists all attributes that can be used with the Include command.

Examples

ForEach

The purpose of this command is to repeat all enclosed instructions for all values specified in this command.

Attribues

The following table lists all attributes that can be used with this command.

Examples

<ForEach name="filename" values="test.jar:sample.jar:util.jar" separator=":">
  <FileSystem>
      <AssertExistence label="{filename}" element="/testdata/lib/{filename}"/>
  </FileSystem>
</ForEach>
          

Description: For each JAR file listed in the values attribute it will be checked if it exists in the directory /testdata/lib.

ForFiles

The purpose of this command is to iterate over a set of files or directories and execute all enclosed instructions for each file/directory found.

This command always sets some variables for each iteration (i.e. for each found file).

_ABSFILENAME_

Contains the absolute filename of the current iteration's file.

_ABSDIRNAME_

Contains the absolute directory name (i.e. without the file's name) of the current iteration's file.

_RELFILENAME_

Contains the relative file path of the found file. That is relative to the defined start directory in attribute dir.

_RELDIRNAME_

Contains the relative directory path of the found file. That is relative to the defined start directory in attribute dir.

_FILENAME_

Contains the filename without any path information.

_DIRNAME_

Contains the relative directory path of the found file. That is relative to the current work directory.

Attribues

The following table lists all attributes that can be used with this command.

Examples

<ForFiles dir="configuration/local" pattern="*.properties" recursive="true">
  <FileSystem>
    <ReportValue label="Timestamp of {_FILENAME_}" element="{_ABSFILENAME_}|@lastModified"/>
  </FileSystem>
</ForFiles>
          

Description: For each found properties file the corresponding timestamp of its last modification gets reported.

            
<ForFiles pattern="*.html" dir="stats" recursive="yes">
  ...
</ForFiles>
          

Description:

            
  Assuming that the current directory is c:/temp and the file 
  c:/temp/stats/january/access.html was found with the above command
  then the variables will have the folowing values:
            
  _ABSFILENAME_    c:/temp/stats/january/access.html
  _ABSDIRNAME_     c:/temp/stats/january
  _RELFILENAME_    january/access.html
  _RELDIRNAME_     january
  _FILENAME_       access.html
  _DIRNAME_        stats/january
          

Set

The purpose of this command is to set the value of a variable. It can be used everywhere in an instruction file.
Each setting of a variable overwrites the previous value.
Since variables can have a global and a local scope it is possible to specify the scope with this command. However, it is only reasonable to use this feature when setting a global variable's value from inside a local context (i.e. from inside a data source adapter).

Attribues

The following table lists all attributes that can be used with this command.

Examples

<Set name="basePath" value="sample/data/config"/>
          

Description: Sets the variable basePath to the current value sample/data/config.

<Set name="server.hostname" value="target.example.com" scope="global"/>
          

Description: Sets the global variable server.hostname to the current value target.example.com.

SetFrom

The purpose of this command is to assign the value of a configuration element to a variable.

By default the variable is treated as local if not explicitly specified differently.

Attribues

The following table lists all attributes that can be used with this command.

Examples

<SettingsFile type="properties" name="base.properties">
  <SetFrom name="color_config_file" element="color.definitions" scope="global"/>
</SettingsFile>
<SettingsFile type="ini" name="{color_config_file}">
  <ReportValue element="[Dialogs]/background"/>
</SettingsFile>
          

Description: Reads the filename of the ini-file that contains color configurations from property color.definitions in file base.properties and assigns it to variable color_config_file. Then it reports the current value of the [Dialogs]/background setting in this ini-file.

SetFromFile

With this command it is possible to load a set of variables from a properties file.
By default the loaded variables are added to the variable scope the command is executed in.
Only if the command is running inside a Data Source Adapter (i.e. in local scope) it is possible to specify to load the variables to the global scope anyway.

Attribues

The following table lists all attributes that can be used with this command.

Examples

<SetFromFile file="set2.properties" scope="global"/>
          

Description: Reads all properties into the global variable pool. If some of the variables already exist their value will be modified.

Report Commands

The purpose of these commands is to explicitly write something to the report. Usually (with assertion commands) only a failed assertion is reported in the output document. The commands explained here are used to add more data and arbitrary text to the output.

ReportBlock

This command can be used everywhere in an instruction file. It can be indefinitly nested and can always contain all tags its parent tag would allow. The effect of ReportBlock is that in the output file a corresponding output tag <Block> is added. The tag contains a copy of all attributes from the ReportBlock command. So the ReportBlock can be used to add any arbitrary text to the ouput file. Apart from that the <Block> in the output will also contain all output tags corresponding to the inner tags of the ReportBlock instruction.

An additional feature is, that ReportBlock supports conditional execution of its inner tags. With the attributes if and ifNot it is possible to make the execution of the inner tags depending on the value of a variable or an even more complex expression.

Attribues

The following table lists all attributes that can be used with the ReportBlock command.

Examples

<ReportBlock label="First test set">
  <AssertExistence element="....."/>
</ReportBlock>
                

ReportVariable

The purpose of this command is to write the current value of a variable to the output.

Attribues

The following table lists all attributes that can be used with this command.

Examples

<Set name="title" value="Example"/>
<SettingsFile type="properties" name="config.properties">
  <Set name="title" value="inside"/>
  <ReportVariable name="title"/>
</SettingsFile>
<ReportVariable name="title"/>
          

Description: The first <ReportVariable> command will add

<Variable name="title">inside</Variable>  
            

<Variable name="title">Example</Variable>
            

ReportValue

With this command it is possible to write the current value(s) of a configuration element to the report.

Attribues

The following table lists all attributes that can be used with this command.

Examples

<SettingsFile type="manifest" name="base.jar/META-INF/MANIFEST.MF">
  <ReportValue element="Specification-Title"/>
  <ReportValue element="Specification-Version"/>
  <ReportValue element="Specification-Vendor"/>
</SettingsFile>
          

Description: Writes the values of the "Specification" settings in the manifest file of base.jar to the report.

Common Attributes

The following table lists all attributes the assertion commands have in common. However, keep in mind that particularly the syntax of the element attribute depends on the Data Source Adapter it is used with.

Apart from these common attributes each assertion command might have additional attributes that are specific for a particular Data Source Adapter. If such attributes exist they are documented with the corresponding Data Source Adapter.

Common Child Elements for Multiple Values

The purpose of the following elements is to specify multiple values to check the found value(s) against.
There are several assertion commands that do not just check against a single pre-defined value but against a whole set of values.

Both elements can occur multiple times in any order. All their values are collected into a set which the found element(s) will be checked against.

Example:

        <Assert...... element="...">
          <Value>200</Value>
          <Value>500</Value>
          <ValueList>330,340,350,380</ValueList>
          <Value>700</Value>
          <ValueList separator="|">1000|2000|9000|11000|{number_list}</ValueList>
        </Assert......>
        

Commands

• AssertEquals
• AssertGreater
• AssertGreaterOrEqual
• AssertLess
• AssertLessOrEqual

AssertEquals

The purpose of this command is to check whether or not the value of the specified element is equal to the value specified in the body this command. If the element's value is not equal to the specified value then a failure message (msgid="FAIL0001") is written to the report.

Attributes

This command supports all the common attributes.

Example

<AssertEquals id="CHECK78" element="MaxConnections">25</AssertEquals>
          

Description: If the element MaxConnections ist not 25 then an assertion failure message will be written to the report.

<AssertEquals label="Server Name" element="//Config/server[@id='M19']/host/@fqdn">
  www.testserver.com
</AssertEquals>
          

Description: If the element (i.e the server name) that is specified by the XPath expression is not www.testserver.com then an assertion failure message will be written to the report.

AssertLess

The purpose of this command is to check whether or not the value of the specified element is less than the value specified in the body of this command. If the element's value is not less than the specified value then a failure message (msgid="FAIL0002") is written to the report.

Attributes

This command supports all the common attributes.

Example

<AssertLess id="L210" label="Limit LDAP search result" element="searchLimit">1000</AssertLess>
          

Description: If the element SearchLimit ist not less than 1000 then an assertion failure message will be written to the report.

AssertGreater

The purpose of this command is to check whether or not the value of the specified element is greater than the value specified in the body of this command. If the element's value is not greater than the specified value then a failure message (msgid="FAIL0003") is written to the report.

Attributes

This command supports all the common attributes.

Example

<AssertGreater id="GR09" element="port">9000</AssertGreater>
          

Description: If the element port ist not greater than 9000 then an assertion failure message will be written to the report.

<AssertGreater element="Specification-Version">F<AssertGreater> 
          

Description: If the element Specification-Version is not greater than F then an assertion failure message will be written to the report.

AssertLessOrEqual

The purpose of this command is to check whether or not the value of the specified element is less or equal compared to the value specified in the body of this command. If the element's value is not less than or equal to the specified value then a failure message (msgid="FAIL004") is written to the report.

Attributes

This command supports all the common attributes.

Example

<AssertLessOrEqual element="logLevel">3</AssertLessOrEqual>
          

Description: If the element logLevel ist not 3 or less then an assertion failure message will be written to the report.

<AssertLessOrEqual label="Max memory usage" element="memory">1024<AssertLessOrEqual>      
          

Description: If the element memory is not greater than 1024 then an assertion failure message will be written to the report.

AssertGreaterOrEqual

The purpose of this command is to check whether or not the value of the specified element is greater or equal compared to the value specified in the body of this command. If the element's value is not greater than or equal to the specified value then a failure message (msgid="FAIL005") is written to the report.

Attributes

This command supports all the common attributes.

Example

<AssertGreaterOrEqual element="open.files">8</AssertGreaterOrEqual>
          

Description: If the element open.files ist not 8 or greater then an assertion failure message will be written to the report.

<AssertGreaterOrEqual element="//product[@name='tools']/@patch-level">
  4
<AssertGreaterOrEqual>      
          

Description: If the element //product[@name='tools']/@patch-level is not greater than 4 then an assertion failure message will be written to the report.

AssertExistence

The purpose of this command is to check whether or not the specified element exists. If the element does not exist then a failure message (msgid="FAIL0006") is written to the report.

Attributes

This command supports all the common attributes and additionally the following:

Example

<AssertExistence label="proxy module" element="LoadModule[@1='proxy_module']/@2"/>
          

Description: Asserts that the LoadModule proxy_module with a second parameter exists. If not a failure message is added to the report.

AssertMatch

With this command a value can be checked against a simple pattern. The pattern can be any string. In such a pattern the characters '*', '?' and '#' have specials meanings. The '*' stands for any number and any character. The '?' represents any single occurance of an arbitrary character. The '#' represents a single digit (i.e. 0-9). If the element does not match the pattern then the failure message (msgid="FAIL0008") is added to the report.

Attributes

This command supports all the common attributes.

Example

<AssertMatch id="D420" label="Mail address" 
    element="[cn=jdoe,ou=users,dc=company]/@mail">*.*@*.*</AssertMatch>
          

Description: If the LDAP element with the distinguished name cn=jdoe,ou=users,dc=company must have an attribute named mail with a typical eMail address value that is matching the pattern *.*@*.*. The value john.doe@company.com will be fine but the value jdoe@company.com will cause an assertion failure message being added to the report.

AssertContains

This command allows to treat the value of elements as a list of values. It can assert that a particular value is in such a list. The default separator for the list elements is comma (','). If the list value does not contain the expected value then the failure message (msgid="FAIL0009") is added to the report.

Attributes

This command supports all the common attributes.

Example

<AssertContains id="ABC" label="Italian" 
    element="supported.languages" case-sensitive="no">it</AssertContains>
          

Description: If the property supported.languages doesn't contain the value "it" (case insensitive comparison) then a failure message gets reported.

AssertOneOf

This command allows to check if the value of an element is equal to at least one of a list of allowed values. If the element's value is not equal to any of the allowed values then failure message (msgid="FAIL0010") is added to the report.

The values to check against have to be specified by child elements <Value> and <ValueList>.
Both child elements can be used as often as necessary and in arbitrary order. Find the detailed description here.

Attributes

This command supports all the common attributes.

Examples

<AssertOneOf label="Language" element="current.language" case-sensitive="no">
  <Value>it</Value>
  <Value>fr</Value>
  <Value>de</Value>
</AssertOneOf>
          

<AssertOneOf label="Language" element="current.language" case-sensitive="no">
  <ValueList>it,fr,de</ValueList>
</AssertOneOf>
          

Description: Both examples are equivalent. They are checking if the property current.language is "it" or "fr" or "de" (case insensitive comparison). If that is not the case then a failure message is added to the report.

AssertMatchOneOf

This command is useful to check if the value of an element matches at least one of a list of specified patterns. If the element's value does not match any of the defined patterns then failure message (msgid="FAIL0018") is added to the report.
Currently only '*' and '?' are supported in patterns. Regular expressions are not yet supported.

The values to check against have to be specified by child elements <Value> and <ValueList>.
Both child elements can be used as often as necessary and in arbitrary order. Find the detailed description here.

Attributes

This command supports all the common attributes.

Examples

<AssertMatchOneOf label="Port" element="redirect.url" case-sensitive="no">
  <Value>http://*:8080/*</Value>
  <Value>https://*:9443/*</Value>
  <Value>http://*:81/*</Value>
</AssertMatchOneOf>
          

<AssertMatchOneOf label="Port" element="redirect.url" case-sensitive="no">
  <ValueList separator=";">http://*:8080/*;https://*:9443/*;http://*:81/*</ValueList>
</AssertMatchOneOf>
          

Description: Both examples are equivalent. They are checking if the property redirect.url contains a URL with one of the port numbers "81" or "8080" or "9443". If that is not the case then a failure message is added to the report.

AssertMatchAll

With this command it is possible to ensure that the value of an element matches all of a list of specified patterns. If the element's value does not match any one of the defined patterns then failure message (msgid="FAIL0016") will be added to the report.
If the assertion is negated (not="true") then failure message (msgid="FAIL0015") will be added to the report if the found element's value matches at least one of the specified patterns.
Currently the wildcard characters '*' and '?' are supported in patterns. Regular expressions are not yet supported.

The patterns to check against have to be specified by child elements <Value> and <ValueList>.
Both child elements can be used as often as necessary and in arbitrary order. Find the detailed description here.

Attributes

This command supports all the common attributes.

Examples

<AssertMatchAll not="true" label="Logo" element="image.main.logo" case-sensitive="no">
  <Value>*.gif</Value>
  <Value>*.jpg</Value>
  <Value>*.png</Value>
</AssertMatchAll>
          

<AssertMatchAll not="yes" label="Logo" element="image.main.logo" case-sensitive="no">
  <ValueList>*.gif,*.jpg,*.png</ValueList>
</AssertMatchAll>
          

Description: Both examples are equivalent. They are checking if the property image matches none of the file name patterns "*.gif" or "*.jpg" or "*.png". If the property matches one of the patterns then a failure message is added to the report.

AssertNewLine

This assertion command is only reasonable within a text file data source adapter. It can be used to check the end-of-line characters in a text file. If at least one line is terminated by a different one than the expected the failure message (msgid="FAIL0011") is added to the report.

Attributes

Example

<AssertNewLine label="Unix style line end" element="EOL" value="LF"/>
          

Description: Checks all lines in a file to end with line-feed (LF) character. If any line has different line-end character(s) then the assertion fails.

Data Source Adapter Commands

SettingsFile

This data source adapter can be used to work on files that contain settings specified by key/value pairs. That is, Java properties files, Java manifest files and Windows ini files.

Attribues

The following table lists all attributes that can be used with this data source adapter.

Example

<?xml version="1.0" encoding="ISO-8859-1" ?>
<Instructions version="1">
  <Set name="testdata.dir">testdata</Set>
  <Set name="BasePath">{testdata.dir}/ini</Set>
    
  <SettingsFile name="{BasePath}/sample1.ini" type="ini" label="Base Configuration" id="I01" case-sensitive="no">
    <AssertEquals id="AE01" element="[Configuration]/Editor">notepad.exe</AssertEquals>
    <AssertExistence id="AX01" element="[Packer]/InternalUnzip"/>
    <ReportValue id="RV01" element="[Packer]/ZIP"/>
    <AssertGreater id="AG01" element="[1280x1024 (8x16)]/divider">400</AssertGreater>
    <ReportValue id="RV02" element="[1280x1024 (8x16)]/divider"/>
  </SettingsFile>
</Instructions>
          

TextFile

This data source adapter can be used to check text files. In general it allows to search for specific text lines in a file and check the found line(s) against a pattern.
Another useful feature is to check the line-end convention (i.e. LF or CRLF).

Attribues

The following table lists all attributes that can be used with this data source adapter.

XmlFile

The purpose of this data source adapter is to report or check values in XML files.

Attribues

The following table lists all attributes that can be used with this data source adapter.

Element Syntax

The element attribute in all enclosed commands must specify a valid XPath expression. With such an expression the element is identifed that has to be checked or of which the current value should be reported.

HttpdConfFile

With this data source adapter it is possible to check values in files that comply with the Apache configuration file format as for example the httpd.conf of the Apache Web Server.

Attribues

The following table lists all attributes that can be used with this data source adapter.

Element Syntax

The element attribute in all enclosed commands must use the following syntax to identify an element:

• Section::CommandName[@param='...']/@param
• CommandName/@param
• CommandName[@param='...']/@param
• CommandName
  This is the same as CommandName/@1

Where Section is the (optional) section name which is enclosed <...> tags like XML. CommandName is the command. It must always be specified. Finally param is the number of the command's parameter (starting with 1).
If '*' is used for param then all parameters are treated as one string.

Example

<?xml version="1.0" encoding="ISO-8859-1" ?>
<Instructions version="1">
  <Include>{INSTRUCTION_DIR}/defaults.cci}</Include>
  <HttpdConfFile name="{RootPath}/httpd/sample1.conf">
    <AssertEquals element="AccessFileName">.htaccess</AssertEquals>
    <AssertEquals element="DirectoryIndex/@3">welcome.html</AssertEquals>
    <AssertEquals element="LoadModule[@1='proxy_module']/@2">modules/ApacheModuleProxy.dll</AssertEquals>
    <AssertEquals element="Directory ''/usr/ApacheGroup/Apache/cgi-bin''::AllowOverride/@1">None</AssertEquals>
    <ReportValue element="CustomLog/@*"/>
  </HttpdConfFile>          
</Instructions>
          

LdifFile

With this data source adapter it is possible to report and check values in LDIF files. It allows to select one or more directory objects in the LDIF file by either a distinguished name (see RFC 2253) or a search filter (not LDAP search query - RFC 2254).

Attribues

The following table lists all attributes that can be used with this data source adapter.

Element Syntax

The element attribute of all enclosed commands must use the following syntax to identify an element:

• dn/@attrname
• [serach filter]/@attrname

The first variant identifies exactly one object by its distinguished name.
The second variant uses a search filter with a simple syntax. It uses attribute names of the searched objects and compares them with static values. The following operators are supported:

In both variants the @attrname then is the name of the attribute of the found object(s) to be reported or checked.

Example

<?xml version="1.0" encoding="ISO-8859-1" ?>
<Instructions version="1">
  <LdifFile name="{RootPath}/ldif/sample1.ldif">
    <AssertEquals element="uid=tmorris,ou=People, dc=example,dc=com/@roomNumber">4117</AssertEquals>
    <AssertOneOf element="[givenName='Gern'|sn='W*']/@location">
      <Value>Santa Clara</Value>
      <Value>Cupertino</Value>
      <Value>Sunnyvale</Value>
    </AssertOneOf>
    <AssertMatch element="[(sn='B*'|sn='F*')+!(sn='Burton'|sn='Fisher')]/@telephoneNumber">
      +1 ### ### ####
    </AssertMatch>
  </LdifFile>          
</Instructions>
          

FileSystem

The purpose of this data source adapter is to check/report the existence of files. It also allows to refer to the "last modified" date or the size of a file.

Attribues

This data source adapter has no attributes.

Extra Command Attribues

The following table lists attributes that can be used with assertion or report commands when used inside this data source adapter.

Example

<?xml version="1.0" encoding="ISO-8859-1" ?>
<Instructions version="1">
  <Set name="testdata.dir">/usr/ben/testdata</Set>
  <Set name="BasePath">{testdata.dir}/config</Set>
    
  <FileSystem>
    <AssertExistence label="default configuration" element="{BasePath}/default.cfg"/>
    <ReportValue id="F99" element="{BasePath}/sample.jar/base.properties|@lastmodified"/>
    <AssertGreater element="{BasePath}/install.log|@size">800</AssertGreater>
    <ReportValue label="Size of install.log" element="{BasePath}/install.log|@size"/>
    <AssertGreaterOrEqual element="{BasePath}/install.log|@lastmodified" format="dd.MM.yyyy">10.07.2004</AssertGreaterOrEqual>
  </FileSystem>
</Instructions>
          

Tomcat 5 Environment

Here you can find an example of a ConfigChecker report and the corresponding ConfigChecker instruction file that was used to create the report about an installation of Tomcat 5.

• Tomcat 5 Installation: Instruction files tomcat5.cci and jar_info.cci => Report (tomcat5.xml)

Trial Version

ConfigChecker is available for immediate download as a trial version.
The trial version is fully functioning but does not contain all data source adapters.

Full Version

In contrary the full version of ConfigChecker contains all data source adapters but cannot be downloaded from this site.
It must be ordered from Caprica Ltd.

Instruction File Editor (Eclipse Plugin)

To simplify creation and editing of ConfigChecker instruction files (cci) there is an eclipse plugin available for download. It supports content assist with help for the supported instructions.

V2.0

Download

Included are the following data sourec adapters:

• SettingsFile
• XmlFile
• FileSystem

Buy the full version of ConfigChecker

To purchase the full version of ConfigChecker please send an eMail to orders@configchecker.com.
Please provide your postal address and the number of licenses you want to buy.
We'll then send you an invoice. After the amount is paid onto our account we send you a URL from where you can download the full version of ConfigChecker.

Pricing

Eclipse Plugin

This version of the ConfigChecker instructions editor was created for Eclipse 3.1 up to 3.5.x.

Download ConfigChecker Instructions Editor V2.2.0