Built by Maven

expanders:validate-model

Full name:

net.democritus.maven.plugins:expanders-maven-plugin:2024.7.0:validate-model

Description:

Validates project model files

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2022.0.0.
  • Binds by default to the lifecycle phase: validate.

Required Parameters

Name Type Since Description
<expansionSettings> File 2019.5.3 Expansion settings used for expansion.
Default: ${project.basedir}/conf/expansionSettings.xml
User Property: expansion.settings
<mavenBuildDir> File 2019.5.3

Alternative location where nsx-prime should be installed.

nsf command will be available in ${mavenBuildDir}/repositories/nsx/prime/nsf


Default: ${project.build.directory}

Optional Parameters

Name Type Since Description
<clean> Boolean 2019.5.3 Remove previous expansion before expanding, or harvest files before harvesting.
Default: false
User Property: expansion.clean
<configFile> File - Configuration file containing exclusions for validation rules.
User Property: validation.config
<debugAddress> String 2020.18.0 Set a debug address (hostname:port) to debug expansion/harvest
User Property: expansion.debug.address
<failIfError> boolean 2023.6.0 Set to false in order to prevent the goal from failing when an error rule fails.
Default: true
User Property: validation.failIfError
<forceModel> boolean 2023.8.0 Force expansion, ignoring issues in the model such as expired options. This feature is provided to support expansion of an earlier project version, it should not be used in day-to-day use. Requires prime-core 2023.11.0, or 2023.4.0.1 (backport patch) to work.
Default: false
User Property: expansion.model.force
<htmlReport> File - Export validation report as an HTML file.
User Property: validation.html
<junitReport> File - Export validation report as a Junit compatible XML file.
User Property: validation.junit
<nsfArgs> List<String> 2020.8.0

Experimental. Additional arguments passed directly to nsf/NsxPrimeRunner. Example:

<nsfArgs>
  <arg>--expander</arg>
  <arg>DataExpander</arg>
</nsfArgs>
<preserveExpansionSettingsVersions> boolean 2023.7.0 Use the versions for prime-core and metamodel-runtime defined in the expansionSettings.xml file instead of using those provided by the expanders-maven-plugin.
Default: true
User Property: expansion.versions.preserve
<printReport> boolean - Print validation report to stdout
Default: false
User Property: validation.print
<workDirectory> File - Work directory to use for temporary files.
Default: ${project.build.directory}
<xmlReport> File - Export validation report as an XML file.
User Property: validation.xml

Parameter Details

<clean>

Remove previous expansion before expanding, or harvest files before harvesting.
  • Type: java.lang.Boolean
  • Since: 2019.5.3
  • Required: No
  • User Property: expansion.clean
  • Default: false

<configFile>

Configuration file containing exclusions for validation rules.
  • Type: java.io.File
  • Required: No
  • User Property: validation.config

<debugAddress>

Set a debug address (hostname:port) to debug expansion/harvest
  • Type: java.lang.String
  • Since: 2020.18.0
  • Required: No
  • User Property: expansion.debug.address

<expansionSettings>

Expansion settings used for expansion.
  • Type: java.io.File
  • Since: 2019.5.3
  • Required: Yes
  • User Property: expansion.settings
  • Default: ${project.basedir}/conf/expansionSettings.xml

<failIfError>

Set to false in order to prevent the goal from failing when an error rule fails.
  • Type: boolean
  • Since: 2023.6.0
  • Required: No
  • User Property: validation.failIfError
  • Default: true

<forceModel>

Force expansion, ignoring issues in the model such as expired options. This feature is provided to support expansion of an earlier project version, it should not be used in day-to-day use. Requires prime-core 2023.11.0, or 2023.4.0.1 (backport patch) to work.
  • Type: boolean
  • Since: 2023.8.0
  • Required: No
  • User Property: expansion.model.force
  • Default: false

<htmlReport>

Export validation report as an HTML file.
  • Type: java.io.File
  • Required: No
  • User Property: validation.html

<junitReport>

Export validation report as a Junit compatible XML file.
  • Type: java.io.File
  • Required: No
  • User Property: validation.junit

<mavenBuildDir>

Alternative location where nsx-prime should be installed.

nsf command will be available in ${mavenBuildDir}/repositories/nsx/prime/nsf

  • Type: java.io.File
  • Since: 2019.5.3
  • Required: Yes
  • Default: ${project.build.directory}

<nsfArgs>

Experimental. Additional arguments passed directly to nsf/NsxPrimeRunner. Example:

<nsfArgs>
  <arg>--expander</arg>
  <arg>DataExpander</arg>
</nsfArgs>
  • Type: java.util.List<java.lang.String>
  • Since: 2020.8.0
  • Required: No

<preserveExpansionSettingsVersions>

Use the versions for prime-core and metamodel-runtime defined in the expansionSettings.xml file instead of using those provided by the expanders-maven-plugin.
  • Type: boolean
  • Since: 2023.7.0
  • Required: No
  • User Property: expansion.versions.preserve
  • Default: true

<printReport>

Print validation report to stdout
  • Type: boolean
  • Required: No
  • User Property: validation.print
  • Default: false

<workDirectory>

Work directory to use for temporary files.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}

<xmlReport>

Export validation report as an XML file.
  • Type: java.io.File
  • Required: No
  • User Property: validation.xml