Maven Plugin for XSpec

This project provides an alternative Maven Plugin to execute XSpec scripts. This plugin is just a Maven Plugin wrapper to execute the native XSpec framework by an internal ANT process. Note: Use this plugin only if the main plugin does not cover your needs.

Release notes

2.1.1

• Bugfix:
  • Patch for issue #12 - nested scenarios are now detected for the summary report.
  • Patch for issue #13 - handles execution errors and shows it on the summary report as "errors".

2.1.0

• Implements issue #10:
  • The process is no more terminated by the first XSpec script with a test failure.
  • A summary report is generated to give an overview over all executed XSpec scripts and their result reports.
  • The CSS of the single reports is switched to the classic theme.
  • Introduced the configuration parameter <failFast> to specify whether the Maven build process should be terminated by the first failing XSpec script or all test should be executed. Only in the last case (which is the default behavior) the summary report is generated.
• Implements issue #8:
  • By default the focus attributes of the executed XSpecs are ignored
  • Introduced the configuration parameter <ignoreFocus> to control this behavior with true|false
  • The Maven property -Dxspecmaven.ignoreFocus will set this config parameter from commandline.
• Bugfix:
  • Do not print the stack trace in case of XSpec test failures #9
• Upgrade dependencies:
  • Commons-IO 2.7 → 2.14.0

2.0.1

• Bugfix:
  • Patch for issue #7 – handles edge case of mixing XSpec files with different test-type (XSLT/Schematron) but same file name.
• Upgrade dependencies:
  • Ant 1.10.9 → 1.10.11
  • Maven Core 3.5.3 → 3.8.1

2.0.0

• Update of used XSpec framework to v1.6.0 - and use it as fallback only.
• Added the possibility to use newer XSpec framework versions (2.0.7+).
• Detects XSpec test type (xslt, schematron, xquery) automatically per each XSpec file.
• Adds possibility to integrate SchXslt as Schematron compiler.
• Configuration extensions:
  • Added possibility to specify properties for the XSpec Ant call (<xspecProperties>).
  • Added project runtime classpath as xspec.additional.classpath (<addDependenciesToClasspath>)
  • Removed <testType> as it is detected now directly from the XSpec file.
• Publish on Maven Central.
• Handling of catalog fixed.

1.0.1

• Minor fixes of Readme handling
• Fixes Release procedure

1.0.0

• First public release

Usage

You can add the plugin call with a minimal configuration:

<plugin>
    <groupId>com.nkutsche</groupId>
    <artifactId>xspec-maven-plugin</artifactId>
    <version>2.0.0</version>
    <executions>
        <execution>
            <goals>
                <goal>run-xspec</goal>
            </goals>
        </execution>
    </executions>
</plugin>

**Note: ** since version v2.0.0 the plugin is on Maven Central. For using older versions, you have to add https://raw.github.com/nkutsche/xspec-maven-plugin/master/bin/releases/ as <pluginRepository> to your POM file.

XSpec Version

By default this plugin uses XSpec 1.6.0. To use a newer version you can add it as a plugin dependency:

<dependency>
    <groupId>io.xspec</groupId>
    <artifactId>xspec</artifactId>
    <version>{xspec.version}</version>
    <classifier>enduser-files</classifier>
    <type>zip</type>
</dependency>

Please make sure you use the classifier enduser-files and as type zip! Supported are XSpec v2.0.7+.

SchXslt Integration as Schematron Compiler

To integrate the schXslt as Schematron compiler add it as plugin dependency:

<dependency>
    <groupId>name.dmaus.schxslt</groupId>
    <artifactId>schxslt</artifactId>
    <version>{schxslt.version}</version>
</dependency>

Tested with XSpec v2.2.4 and SchXslt v1.5.2 and v1.8.6.

Plugin configuration

This is the default configuration:

<configuration>
<!--  If true, it skips the test runs. Connect to Maven property ${skipTests} -->
    <skipTests>false</skipTests>
<!--  Working directory for the internal ant processes  -->
    <workingDir>${project.build.directory}/xspecmaven</workingDir>
<!--  Working directory to store the temporary files of the XSpec framework  -->
    <xspecTempDir>${project.build.directory}/xspecmaven/xspec-temp-files</xspecTempDir>
<!--  Directory to search for XSpec files  -->
    <testDir>${project.basedir}/src/test/xspec</testDir>
<!--  Whitelist patterns to search for XSpec files in {testDir}  -->
    <includes>
        <include>**/*.xspec</include>
    </includes>
<!--  Blacklist patterns to exclude files from search for XSpec files in {testDir}  -->
    <excludes>
        <exclude>**/*.xspec-compiled.xspec</exclude>
    </excludes>
<!--  Catalog file to resolve URLs -->
    <catalogFile>${catalog.filename}</catalogFile>
<!--  Directory for generating surefire reports (Only if {generateSurefireReport} == true!) -->
    <surefireReportDir>${project.build.directory}/surefire-reports</surefireReportDir>
<!--  Directory to generate the XSpec reports -->
    <xspecReportDir>${project.build.directory}/xspec-reports</xspecReportDir>
<!--  Boolean value to generate surefire reports -->
    <generateSurefireReport>false</generateSurefireReport>
    
<!--  A list of properties which is passed to the XSpec ant process, see  https://github.com/xspec/xspec/wiki/Running-with-Ant#ant-properties
    Note: use this carefully. In the most cases the properties should be set by the plugin.
-->
    <xspecProperties>
        <!-- <saxon.custom.options>...</saxon.custom.options> -->
    </xspecProperties>   
    
<!--  Adds the project and dependency artifacts to the classpath of the internal XSpec Java calls (e.g. to enable extension functions) -->
    <addDependenciesToClasspath>true</addDependenciesToClasspath>

  <!--  If true the focus attributes of the executed XSpec scripts are ignored. Only in case of false, they are respected.
    You can overwrite this also by the Maven property -Dxspecmaven.ignoreFocus=false
  -->
  <ignoreFocus>true</ignoreFocus>


  <!--  If true the first failing XSpec script will terminate the Maven build process. Otherwise (if false or by default) all XSpec tests are executed. Only in the last case a summary report is generated.
    You can overwrite this also by the Maven property -Dxspecmaven.failFast=true
  -->
  <failFast>false</failFast>
  
</configuration>