------ Introduction ------ Jason van Zyl ------ 2006-11-27 ------ ~~ Licensed to the Apache Software Foundation (ASF) under one ~~ or more contributor license agreements. See the NOTICE file ~~ distributed with this work for additional information ~~ regarding copyright ownership. The ASF licenses this file ~~ to you under the Apache License, Version 2.0 (the ~~ "License"); you may not use this file except in compliance ~~ with the License. You may obtain a copy of the License at ~~ ~~ http://www.apache.org/licenses/LICENSE-2.0 ~~ ~~ Unless required by applicable law or agreed to in writing, ~~ software distributed under the License is distributed on an ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY ~~ KIND, either express or implied. See the License for the ~~ specific language governing permissions and limitations ~~ under the License. ~~ NOTE: For help with the syntax of this file, see: ~~ http://maven.apache.org/doxia/references/apt-format.html Maven Invoker Plugin The Invoker Plugin is used to run a set of Maven projects. The plugin can determine whether each project execution is successful, and optionally can verify the output generated from a given project execution. This plugin is in particular handy to perform integration tests for other Maven plugins. The Invoker Plugin can be employed to run a set of test projects that have been designed to assert certain features of the plugin under test. * Goals Overview The plugin has four goals meant to participate in the default build lifecycle: * {{{./install-mojo.html}invoker:install}} copies the project artifacts and dependencies of the main build into a dedicated local repository to prepare the execution of the selected sub projects in an isolated environment. * {{{./integration-test-mojo.html}invoker:integration-test}} runs a set of Maven projects in a directory. * {{{./verify-mojo.html}invoker:verify}} verifies the result of <<>>. * {{{./run-mojo.html}invoker:run}} runs a set of Maven projects in a directory and verifies the result. This is equivalent to running both <<>> and <<>>. [] This last goal is intended for usage with the site lifecycle: * {{{./report-mojo.html}invoker:report}} integrates the results from previous builds into the site. [] * Usage General instructions on how to use the Invoker Plugin can be found on the {{{./usage.html}usage page}}. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the {{{http://docs.codehaus.org/display/MAVENUSER/Invoker+Plugin}plugin's wiki page}}. In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel free to contact the {{{./mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the {{{./mail-lists.html}mail archive}}. If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our {{{./issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our {{{./source-repository.html}source repository}} and will find supplementary information in the {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}. * Examples The following example configurations are available to illustrate selected use cases in more detail: * {{{./examples/clone-projects.html}Clone projects}} to a temporary directory before running. * {{{./examples/filtering.html}Filter files}} to introduce some updates before starting the build. * {{{./examples/install-artifacts.html}Install}} projects artifacts to a local repository before running. * {{{./examples/post-build-script.html}Run a BeanShell or Groovy script}} to verify project output. * {{{./examples/fast-use.html}Fast Invoker Plugin configuration}} to accelerate project execution. * {{{./examples/access-test-classes.html}Access test classes}} to share code between hook scripts. * {{{./examples/invoker-properties.html}Use Invoker Properties}} to configure goals, profiles etc. for individual projects. * {{{./examples/selector-conditions.html}Use Selector Conditions}} to skip projects based on JRE version or OS family. * {{{./examples/prepare-build-env.html}Prepare the Build Environment}} by building some setup projects before other projects. * {{{./examples/integration-test-verify.html}Using with other integration test frameworks}} by decoupling checking the results of the integration tests from executing the integration tests. [] You can also study some real-life usages of the Invoker Plugin by browsing its own integration tests which are located in the directory <<>> of the {{{./source-repository.html}project source tree}}.