mojohaus / exec-maven-plugin

Exec Maven Plugin
https://www.mojohaus.org/exec-maven-plugin/
Apache License 2.0
163 stars 96 forks source link

Doing several invocations through exec:java? #388

Closed jkesselm closed 7 months ago

jkesselm commented 7 months ago

I need to call the same Java program with several different sets of parameters.

I can't replicate the whole <plugin> block because that's a declaration and must be unique.

Maven tells me I can't have multiple <configuration/>s. I can have multiple<executions/>, but your example puts all the<arguments/> in the <configuration/> so that doesn't seem to help me.

Can't imagine that there isn't a standard way to do this, but I'm not sure what it is. Possible it's a standard Maven idiom that I just haven't learned yet... but even so it might be a good thing to explicitly document.

jkesselm commented 7 months ago

.... Oh. Default configuration outside the executions, then a configuration inside each execution to set local parameters? With explicit IDs so they don't collide on the default for that?

Maven accepts that without complaining... but I'm still getting output only from the first <execution>.

Copying or moving <additionalClasspathElements> and <mainClass> into the per-execution configurations doesn't seem to change this.

What's my obvious beginner error?

      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>exec-maven-plugin</artifactId>
        <version>3.1.0</version>
        <executions>
          <execution>
        <id>Stylebook XSLTC documentation</id>
            <phase>package</phase>
            <goals>
              <goal>java</goal>
            </goals>
        <configuration>
              <arguments>
        <argument>loaderConfig=sbk:/style/loaderdesign.xml</argument>
        <argument>targetDirectory=./target/tmp/site/xsltc/</argument>
        <argument>./stylebook/sources/xsltc.xml</argument>
        <argument>./stylebook/style</argument>
              </arguments>
        </configuration>
          </execution>
          <execution>
        <id>Stylebook Xalan interpretive documentation</id>
            <phase>package</phase>
            <goals>
              <goal>java</goal>
            </goals>
        <configuration>
              <arguments>
        <argument>loaderConfig=sbk:/style/loaderdesign.xml</argument>
        <argument>targetDirectory=./target/tmp/site/xalan/</argument>
        <argument>./stylebook/sources/xalan-jsite.xml</argument>
        <argument>./stylebook/style</argument>
              </arguments>
        </configuration>
          </execution>
          <execution>
        <id>Stylebook design documentation</id>
            <phase>package</phase>
            <goals>
              <goal>java</goal>
            </goals>
        <configuration>
              <arguments>
        <argument>loaderConfig=sbk:/style/loaderdesign.xml</argument>
        <argument>targetDirectory=./target/tmp/site/design/</argument>
        <argument>./stylebook/sources/xalandesign.xml</argument>
        <argument>./stylebook/style</argument>
              </arguments>
        </configuration>
          </execution>
        </executions>
        <configuration>
      <additionalClasspathElements>./stylebook/stylebook-1.0-b3_xalan-2.jar</additionalClasspathElements>
          <mainClass>org.apache.stylebook.StyleBook</mainClass>
        </configuration>
      </plugin>
kriegaex commented 7 months ago

@jkesselm: For me, this works locally. Can you please share a link to a full reproducer, so other people or I can take a closer look?

jkesselm commented 7 months ago

You'll see that the xsltc subdirectory has been created, but not target/tmp/site/xalan or target/tmp/site/design. Apparently only the first is running.

Platform is Fedora running under WSL. mvn -version reports

Maven home: /mnt/c/users/keshlam/apache-maven-3.6.3
Java version: 1.8.0_382, vendor: Red Hat, Inc., runtime: /usr/lib/jvm/java-1.8.0-openjdk-1.8.0.382.b05-2.fc37.x86_64/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "linux", version: "5.15.90.1-microsoft-standard-wsl2", arch: "amd64", family: "unix"

(Yes, I'm deliberately using a downlevel JDK, to ensure backward compatibility. That shouldn't affect this, right?)

Let me know if you need other details or experiments performed.


Context: What I'm trying to do is move the logic now in stylebook_docgen.sh into the Maven build, so it doesn't have to be done as postprocessing. As written there it does what's expected (though that's outputting directly to target/site rather than to target/site/tmp). But maven is currently giving me only that one execution of stylebook. I must be missing something obvious.

Maven reminds me of an analog synth. Lots of patch points and knobs; takes quite a while to learn how the designer intended them to be used, how they can actually be (ab)used, and how they all interact. And sometimes the results are not what I expected.


And something else weird is going on. Since adding this, my main compilation has stopped working; I'm no longer getting anything but the target/tmp/site/xsltc output.

Lemme try reverting (to the xalan-java-mvn-refactored branch) and adding this again from scratch...

jkesselm commented 7 months ago

Checked out the xalan-java-mvn-refactored branch.

Added the multi-execution I originally quoted to the POM, directly above </plugins>.

Ran the maven build, both just as package and as clean package site source:jar source:test-jar. Either way, ./target/tmp/site/ contains only xsltc/. Problem confirmed as still present.

Output of mvn -X package attached. You'll see that there's only one [DEBUG] Invoking. So, yes, I'm only getting one of the three executions.

jkesselm-issue-388.log

jkesselm commented 7 months ago

I've updated the exec-maven-plugin-problem branch if you want to run it locally.

slawekjaranowski commented 7 months ago

I tried ... with xalan on branch exec-maven-plugin-problem

commit 9c47e6f74de2ee834c09fbc860653bf36f38c2da (HEAD -> exec-maven-plugin-problem, origin/exec-maven-plugin-problem)

and I have

$ mvn package

INFO] --- exec:3.1.0:java (Stylebook XSLTC documentation) @ xalan-project ---
[StyleBook] Overriding loaderConfig="sbk:/style/loaderdesign.xml" (Old="sbk:/style/loader.xml")
[StyleBook] Overriding targetDirectory="./target/tmp/site/xsltc/" (Old=".")
[StyleBook] Caught java.io.IOException
java.io.IOException: Style File/Directory not found
    at org.apache.stylebook.URLHandler.<init>(Unknown Source)
    at org.apache.stylebook.StyleBook.<init>(Unknown Source)
    at org.apache.stylebook.StyleBook.main(Unknown Source)
    at org.codehaus.mojo.exec.ExecJavaMojo$1.run(ExecJavaMojo.java:279)
    at java.lang.Thread.run(Thread.java:750)
jkesselm commented 7 months ago

Sorry, forgot to check that in. (Ant build expanded it from a jarfile at build time; simpler, I think, to just check it in flat.) Should be there now.

jkesselm commented 7 months ago

(FWIW, I decompiled stylebook to take a quick look at it. About 2500 lines of code, mostly straightforward. Almost tempted to comment it and re-contribute it to Apache, if real source can't be found. "In my copious spare time.")

slawekjaranowski commented 7 months ago

In StyleBook there is code:


    public static void main(String[] var0) throws IOException {
      .....
      exit((String)"All done successfully", 0);
    }

    private static void exit(String var0, int var1) {
        log(var0);
        System.exit(var1);
    }

as exec-maven-plugin simply execute code in the same JVM .... in this case build are finished by System.exit ....

I have:

[INFO] --- exec:3.1.0:java (Stylebook XSLTC documentation) @ xalan-project ---
[StyleBook] Overriding loaderConfig="sbk:/style/loaderdesign.xml" (Old="sbk:/style/loader.xml")
[StyleBook] Overriding targetDirectory="./target/tmp/site/xsltc/" (Old=".")

....

[StyleBook] All done successfully
$
jkesselm commented 7 months ago

Ah. So System.exit() is blowing up the entire Maven session before it can get to the second execution?

If so, the quick fix would be as discussed in https://www.mojohaus.org/exec-maven-plugin/examples/example-exec-for-java-programs.html to launch each StyleBook in a separate JVM. I'll try that.

(The better fix would be to have a version of StyleBook that doesn't gratuitously call System.exit(), of course.)

Thanks. I generally start by assuming I did something stupid... and arguably I did, just not what I thought I had.

slawekjaranowski commented 7 months ago

Ah. So System.exit() is blowing up the entire Maven session before it can get to the second execution?

exactly

jkesselm commented 7 months ago

Seems to have done it. Thanks!

kriegaex commented 7 months ago

@slawekjaranowski, would you be interested in a PR to address this? I thought about an option for the exec:java goal to block System.exit by means of a security manager (SM). That is deprecated for removal since JDK 17, but still possible, if the Maven JVM is called with -Djava.security.manager=allow. The SM would intercept calls to System.exit and throw a SecurityException, as required by the SM API. The caller (Maven Exec) would handle the exception gracefully and in case of exit code 0 just print an info or debug message to the console or fail the build. That way, users would not be forced to use exec:exec in order to fork and could stay within the comfortable bounds of exec:java even for tools behaving badly, trying to exit the VM instead of just throwing uncaught exceptions.

Right after finishing exec:java execution, the original SM would be reactivated, i.e. all other plugins and subsequent executions of the same goal without the option to block System.exit would be unaffected. In multi-threaded Maven, maybe we would have to limit the SM's interference to certain threads or classloaders, I have not thought that through yet. I am open for suggestions there.

Before you refuse, because I suggest a deprecated API, please consider that JEP 411 links to JDK-8199704, which is blocking removal of the SM API until a suitable replacement has been introduced to the JVM, i.e. even in the future there will be a means to block System.exit, and Maven Exec can be updated to use that new API, when available and running on a JDK containing such API.

WDYT? Feel free to also mention other MojoHaus developers to discuss this.

slawekjaranowski commented 7 months ago

@kriegaex sounds reasonable - we can try with such feature, I have no objections for such PR.

kriegaex commented 7 months ago

@jkesselm, feel free to test your project against my PR. That would spare you the effort to use exec:exec in the future, i.e. as soon as a plugin release containing this change would be available.

jkesselm commented 7 months ago

Sounds good, will do so. Thanks!

-- / Joe Kesselman (he/him/his) -/ ) My Alexa skill for New Music/New Sounds fans: / https://www.amazon.com/dp/B09WJ3H657/

() Plaintext Ribbon Campaign /\ Stamp out HTML mail!


From: Alexander Kriegisch @.> Sent: Thursday, November 9, 2023 1:31:29 AM To: mojohaus/exec-maven-plugin @.> Cc: Joe Kesselman @.>; Mention @.> Subject: Re: [mojohaus/exec-maven-plugin] Doing several invocations through exec:java? (Issue #388)

@jkesselmhttps://github.com/jkesselm, feel free to test your project against my PR. That would spare you the effort to use exec:exec in the future, i.e. as soon as a plugin release containing this change would be available.

— Reply to this email directly, view it on GitHubhttps://github.com/mojohaus/exec-maven-plugin/issues/388#issuecomment-1803237902, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A7OJ6W5CS627ZBQMZVVCG7TYDR2EDAVCNFSM6AAAAAA7ALR5HCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMBTGIZTOOJQGI. You are receiving this because you were mentioned.Message ID: @.***>

kriegaex commented 7 months ago

@slawekjaranowski, do you have any indicator for @jkesselm when a plugin release containing the now merged feature might become available? I actually do not need it myself, but Joseph's use case was so interesting that I decided to implement it for his future use in Xalan-Java, which currently he is so heroically porting from Ant to Maven.

slawekjaranowski commented 7 months ago

@kriegaex , @jkesselm - I will release next version in a few days ... maybe in this weekend.

I always like to check topic like site generation, broken links and other simple issue before release

jkesselm commented 7 months ago

No rush; the workaround is fine for now. It's more a matter of making things less surprising for the next person with similar needs than anything else, I think.

-- / Joe Kesselman (he/him/his) -/ ) My Alexa skill for New Music/New Sounds fans: / https://www.amazon.com/dp/B09WJ3H657/

() Plaintext Ribbon Campaign /\ Stamp out HTML mail!


From: Slawomir Jaranowski @.> Sent: Saturday, November 11, 2023 7:34:03 AM To: mojohaus/exec-maven-plugin @.> Cc: Joe Kesselman @.>; Mention @.> Subject: Re: [mojohaus/exec-maven-plugin] Doing several invocations through exec:java? (Issue #388)

@kriegaexhttps://github.com/kriegaex , @jkesselmhttps://github.com/jkesselm - I will release next version in a few days ... maybe in this weekend.

I always like to check topic like site generation, broken links and other simple issue before release

— Reply to this email directly, view it on GitHubhttps://github.com/mojohaus/exec-maven-plugin/issues/388#issuecomment-1806805192, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A7OJ6WZMSEC3ZCW6H333DM3YD5WDXAVCNFSM6AAAAAA7ALR5HCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMBWHAYDKMJZGI. You are receiving this because you were mentioned.Message ID: @.***>