Maven
  1. Maven
  2. MNG-3719

[regression] plugin execution ordering no longer POM ordered in 2.0.9

    Details

    • Type: Bug Bug
    • Status: Closed Closed
    • Priority: Critical Critical
    • Resolution: Fixed
    • Affects Version/s: 2.0.9, 2.0.10, 2.1.0-M1
    • Fix Version/s: 2.0.11, 2.1.0
    • Component/s: POM
    • Labels:
      None
    • Environment:
      Maven 2.0.9, java version "1.5.0_13" Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_13-b05-241) Java HotSpot(TM) Client VM (build 1.5.0_13-120, mixed mode, sharing), OS X 10.4
    • Complexity:
      Intermediate
    • Patch Submitted:
      Yes
    • Number of attachments :
      2

      Description

      I extend my sincere apologies if there is a much easier way of doing this, but so far I haven't found any.

      There should be some way to ensure order of plugin executions through dependencies on other executions. See attached project for example, or see below for the applicable example in a pom.xml. When plugins are defined in pom.xml in the following manner to ensure correct execution order, they are not executed sequentially and there is no way to indicate dependencies, as would be expected (note- I'm not expecting that it interpret the "step 1...", ..., "step 5..." IDs, I'm only suggesting that either the plugins be executed in order that they are found in the XML (most intuitive) or that there be some concept of priority/ordinal added, or even perhaps (this would be most "ant-like") that plugin executions (and maybe even plugin goal executions) be allowed to define prequisite execution IDs to be run (even if they are IDs not defined in the pom, but maybe a parent pom, even though I don't need that right now).

      I know that this could be problematic if a plugin execution from one lifecycle phase depends on another from another lifecycle phase (and you could get into circular references that way that would have to be recognized during pom validation after loading/merging pom.xmls). However, not being able to at the very least define order of execution of different (or the same) plugin executions as noted below and in attached project makes it difficult to chain plugin executions that depend on each other, thereby reducing the practicality of the pom.xml and Maven 2.

      For example, these plugin executions cannot be ordered properly in Maven 2.0.9, since there appears to be no way to indicate dependencies of one execution on another:

          <build>
              <plugins>
                  <plugin>
                      <groupId>org.apache.maven.plugins</groupId>
                      <artifactId>maven-compiler-plugin</artifactId>
                      <configuration>
                          <source>1.5</source>
                          <target>1.5</target>
                      </configuration>
                  </plugin>
      
                  <plugin>
                      <!-- backup original source web.xml in preparation for chaining of plugin modifications to it -->
                      <groupId>org.apache.maven.plugins</groupId>
                      <artifactId>maven-antrun-plugin</artifactId>
                      <executions>
                          <execution>
                              <id>step 1 - backup-original-web.xml-from-src</id>
                              <phase>generate-resources</phase>
                              <goals>
                                  <goal>run</goal>
                              </goals>
                              <configuration>
                                  <tasks>
                                      <mkdir dir="${pom.basedir}/target"/>
                                      <mkdir dir="${pom.basedir}/target/tmpwebxml"/>
                                      <copy file="${pom.basedir}/src/main/webapp/WEB-INF/web.xml" todir="${pom.basedir}/target/tmpwebxml/"/>
                                  </tasks>
                              </configuration>
                          </execution>
                      </executions>
                  </plugin>
      
                  <plugin>
                      <!-- this plugin converts to ${basedir}/src/main/webapp/WEB-INF/web.xml to ${basedir}/target/jspweb.xml -->
                      <groupId>org.codehaus.mojo</groupId>
                      <artifactId>jspc-maven-plugin</artifactId>
                      <executions>
                          <execution>
                              <id>step 2 - jspc</id>
                              <phase>generate-resources</phase>
                              <goals>
                                  <goal>compile</goal>
                              </goals>
                          </execution>
                      </executions>
                      <configuration>
                          <injectString>&lt;!-- [INSERT JSPC FRAGMENT HERE] --&gt;</injectString>
                      </configuration>
                      <dependencies>
                          <!-- These dependencies are the portlet.tld is needed for JSP compilation -->
                          <dependency>
                              <groupId>org.apache.pluto</groupId>
                              <artifactId>pluto-taglib</artifactId>
                              <version>1.1.3</version>
                              <type>jar</type>
                          </dependency>
                          <dependency>
                              <groupId>javax.portlet</groupId>
                              <artifactId>portlet-api</artifactId>
                              <version>1.0</version>
                              <type>jar</type>
                          </dependency>
                          <dependency>
                              <groupId>javax.servlet</groupId>
                              <artifactId>jstl</artifactId>
                              <version>1.1.2</version>
                              <type>jar</type>
                          </dependency>
                          <dependency>
                              <groupId>taglibs</groupId>
                              <artifactId>standard</artifactId>
                              <version>1.1.2</version>
                              <type>jar</type>
                          </dependency>
                      </dependencies>
                  </plugin>
      
                  <plugin>
                      <!-- copy modified web.xml file into source so it can be worked on by the another plugin. do this before each chained change to web.xml -->
                      <groupId>org.apache.maven.plugins</groupId>
                      <artifactId>maven-antrun-plugin</artifactId>
                      <executions>
                          <execution>
                              <id>step 3 - copy-jspc-web.xml-atop-web.xml-in-src</id>
                              <phase>generate-resources</phase>
                              <goals>
                                  <goal>run</goal>
                              </goals>
                              <configuration>
                                  <tasks>
                                      <copy file="${pom.basedir}/target/jspweb.xml" todir="${pom.basedir}/src/main/webapp/WEB-INF/"/>
                                  </tasks>
                              </configuration>
                          </execution>
                      </executions>
                  </plugin>
      
                  <!-- bind 'pluto:assemble' goal to 'generate-resources' lifecycle -->
                  <plugin>
                      <!-- this plugin converts to ${basedir}/src/main/webapp/WEB-INF/web.xml to ${basedir}/target/pluto-resources/web.xml -->
                      <groupId>org.apache.pluto</groupId>
                      <artifactId>maven-pluto-plugin</artifactId>
                      <version>${pluto.version}</version>
                      <executions>
                          <execution>
                              <id>step 4 - pluto-modifications-to-web.xml</id>
                              <phase>generate-resources</phase>
                              <goals>
                                  <goal>assemble</goal>
                              </goals>
                          </execution>
                      </executions>
                  </plugin>
                  
                  <plugin>
                      <groupId>org.apache.maven.plugins</groupId>
                      <artifactId>maven-war-plugin</artifactId>
                      <configuration>
                          <warName>NewsReaderPortlet</warName>
                          <!--<webXml>${basedir}/src/main/webapp/WEB-INF/web.xml</webXml>-->
                          <!--<webXml>${basedir}/target/jspweb.xml</webXml>-->
                          <webXml>${basedir}/target/pluto-resources/web.xml</webXml>
                      </configuration>
                      <dependencies>
                          <dependency>
                              <groupId>org.apache.pluto</groupId>
                              <artifactId>pluto-util</artifactId>
                              <version>${pluto.version}</version>
                              <scope>provided</scope>
                          </dependency>
                      </dependencies>
                  </plugin>
      
                  
                  <plugin>
                      <!-- restore original web.xml file back into source after "chained" plugin modifications are complete -->
                      <groupId>org.apache.maven.plugins</groupId>
                      <artifactId>maven-antrun-plugin</artifactId>
                      <executions>
                          <execution>
                              <id>step 5 - restore-web.xml-to-src</id>
                              <phase>generate-resources</phase>
                              <goals>
                                  <goal>run</goal>
                              </goals>
                              <configuration>
                                  <tasks>
                                      <copy file="${pom.basedir}/target/tmpwebxml/web.xml" todir="${pom.basedir}/src/main/webapp/WEB-INF/"/>
                                  </tasks>
                              </configuration>
                          </execution>
                      </executions>
                  </plugin>            
              </plugins>
          </build>
      

        Issue Links

          Activity

          Hide
          Gary S. Weaver added a comment -

          Note: the fact that that associated project's pom.xml and plugin executions above are tied to the same lifecycle and yet do not execute in order seems to be a bug with Maven 2, since it states on the lifecycle page in the documentation http://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html that:
          "Note: As of Maven 2.0.5, multiple goals bound to a phase are executed in the same order as they are declared in the POM."

          However, it appears that is not working in Maven 2.0.9, because if it were, then the above pom would execute in order as intended.

          I think though that having executions be allowed to specify dependencies on other executions is probably the better way to do it, wouldn't it be?

          Show
          Gary S. Weaver added a comment - Note: the fact that that associated project's pom.xml and plugin executions above are tied to the same lifecycle and yet do not execute in order seems to be a bug with Maven 2, since it states on the lifecycle page in the documentation http://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html that: "Note: As of Maven 2.0.5, multiple goals bound to a phase are executed in the same order as they are declared in the POM." However, it appears that is not working in Maven 2.0.9, because if it were, then the above pom would execute in order as intended. I think though that having executions be allowed to specify dependencies on other executions is probably the better way to do it, wouldn't it be?
          Hide
          Sandra Bogaert added a comment -

          Hi,
          What about this issue ?
          Do you have a release date ?
          Thanks in advance

          Show
          Sandra Bogaert added a comment - Hi, What about this issue ? Do you have a release date ? Thanks in advance
          Hide
          Brett Porter added a comment -

          confirmed, the order is correct in 2.0.8, but incorrect in 2.0.9/10

          Show
          Brett Porter added a comment - confirmed, the order is correct in 2.0.8, but incorrect in 2.0.9/10
          Hide
          Torben S. Giesselmann added a comment -

          This patch should fix the execution ordering; all test cases still run as expected.

          Show
          Torben S. Giesselmann added a comment - This patch should fix the execution ordering; all test cases still run as expected.
          Hide
          Torben S. Giesselmann added a comment -

          Since the patch won't make it into 2.0.10, the documentation at http://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html
          should be updated in the meantime. To avoid any confusion, it should be mentioned that there's a problem. Or remove the comment altogether or change it to "As of 2.0.11".

          Show
          Torben S. Giesselmann added a comment - Since the patch won't make it into 2.0.10, the documentation at http://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html should be updated in the meantime. To avoid any confusion, it should be mentioned that there's a problem. Or remove the comment altogether or change it to "As of 2.0.11".
          Hide
          Brett Porter added a comment -

          I noted that this is only an issue when there is more than one declaration of a particular plugin.

          Since MNG-2145, multiple declarations are grouped together as if there were executions in one plugin. This patch simply sorts those executions correctly.

          I think the original poster wanted the old functionality back where plugins could be declared multiple times and run in order - however I'm not prepared to undo that on 2.0.x.

          I've applied the patch to resolve the issue.

          Show
          Brett Porter added a comment - I noted that this is only an issue when there is more than one declaration of a particular plugin. Since MNG-2145 , multiple declarations are grouped together as if there were executions in one plugin. This patch simply sorts those executions correctly. I think the original poster wanted the old functionality back where plugins could be declared multiple times and run in order - however I'm not prepared to undo that on 2.0.x. I've applied the patch to resolve the issue.
          Hide
          Torben S. Giesselmann added a comment -

          Exactly, the problem came from from merging multiple plugin declarations into one. I still think the docs should be updated, though.

          Show
          Torben S. Giesselmann added a comment - Exactly, the problem came from from merging multiple plugin declarations into one. I still think the docs should be updated, though.
          Hide
          Brett Porter added a comment -

          Yep, I already updated the docs

          Show
          Brett Porter added a comment - Yep, I already updated the docs
          Hide
          brianfox brianfox added a comment -

          reportedly still broken in 2.1

          Show
          brianfox brianfox added a comment - reportedly still broken in 2.1
          Hide
          Brett Porter added a comment -

          more details please - the IT passes. I would prefer we re-close this based on the successful IT and open a new issue if there is a variant use case that fails.

          Show
          Brett Porter added a comment - more details please - the IT passes. I would prefer we re-close this based on the successful IT and open a new issue if there is a variant use case that fails.
          Hide
          John Casey added a comment -

          The use case given in the examples on this issue have been resolved as well as can be expected. It's not a good idea to redeclare a plugin simply to get the execution ordering you want within a single lifecycle phase, since this can lead to a lot of confusion about the configuration of that plugin. It's better to cheat the phase binding a little bit on one of the executions to ensure it runs later/earlier than the rest. There is a linked issue here that may still be an outstanding problem. It's closed as a duplicate of this one.

          I'll reopen that issue and try to track the problem there.

          Show
          John Casey added a comment - The use case given in the examples on this issue have been resolved as well as can be expected. It's not a good idea to redeclare a plugin simply to get the execution ordering you want within a single lifecycle phase, since this can lead to a lot of confusion about the configuration of that plugin. It's better to cheat the phase binding a little bit on one of the executions to ensure it runs later/earlier than the rest. There is a linked issue here that may still be an outstanding problem. It's closed as a duplicate of this one. I'll reopen that issue and try to track the problem there.

            People

            • Assignee:
              John Casey
              Reporter:
              Gary S. Weaver
            • Votes:
              7 Vote for this issue
              Watchers:
              13 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: