wildfly / jandex-maven-plugin Goto Github PK

View Code? Open in Web Editor NEW

14.0 14.0 19.0 215 KB

Jandex Plugin for Apache Maven

License: GNU General Public License v3.0

Java 86.85% HTML 11.48% Groovy 1.67%

jandex-maven-plugin's Introduction

WildFly Application Server

https://wildfly.org

Fast Startup
Small Footprint
Modular Design
Unified Configuration and Management

And of course Jakarta EE!

Building

Prerequisites:

JDK 11 or newer - check java -version
Maven 3.6.0 or newer - check mvn -v
On *nix systems, make sure that the maximum number of open files for the user running the build is at least 4096 (check ulimit -n) or more, depending on what other i/o intensive processes the user is running.

To build with your own Maven installation:

mvn install

Alternatively, you can use the Maven Wrapper script that downloads and installs (if necessary) the required Maven version to ~/.m2/wrapper and runs it from there. On Linux, run

./mvnw install

On Windows

mvnw install

Starting and Stopping WildFly

Change to the bin directory after a successful build

$ cd build/target/wildfly-[version]/bin

Start the server in domain mode

./domain.sh

Start the server in standalone mode

./standalone.sh

To stop the server, press Ctrl + C, or use the admin console

./jboss-cli.sh --connect command=:shutdown

Check 'Getting Started Guide' in the WildFly documentation for more information about how to start and stop WildFly.

Documentation

https://docs.wildfly.org/

Contributing

Please see the instructions available in the contribution guide.

Build vs. Dist directories

After running mvn install, WildFly will be available in two distinct directories, build and dist.

The build directory contains a build of WildFly that is based on Maven artifact resolution for module configuration
The dist directory, on the other hand, contains a full distributable build of WildFly

Using the build directory makes iterating with subsystem or module development easier since there is no need to rebuild the whole of WildFly or copy JAR files around on every change.

The dist directory is better suited when a full build of WildFly is needed for development or test purposes.

Running the Testsuite

The testsuite module contains several submodules including the following:

"smoke" -- core tests that should be run as part of every build of the AS. Failures here will fail the build.
"api" -- tests of features that involve end user use of the public JBoss AS 8 API. Should be run with no failures before any major commits.
"cluster" -- tests of the WildFly HA clustering features. Should be run with no failures before any major commits.
"domain" -- tests of the domain management features. Should be run with no failures before any major commits.
"integration" -- tests of a WildFly standalone server's internals. Should be run with no failures before any major commits.
"spec" -- tests of features that only involve end user use of the Jakarta EE spec APIs. Should be run with no failures before any major commits.

For basic smoke tests, simply: mvn test

To run all the tests

mvn install -DallTests

Using Eclipse

Install the latest version of eclipse
Make sure Xmx in eclipse.ini is at least 1280M, and it's using Java 11
Launch eclipse and install the m2e plugin, make sure it uses your repo configs (get it from: http://www.eclipse.org/m2e/ or install "Maven Integration for Eclipse" from the Eclipse Marketplace)
In eclipse preferences Java->Compiler->Errors/Warnings->Deprecated and restricted set forbidden reference to WARNING
In eclipse preferences Java->Code Style, import the cleanup, templates, and formatter configs in ide-configs/eclipse in the wildfly-core repository.
In eclipse preferences Java->Editor->Save Actions enable "Additional Actions", and deselect all actions except for "Remove trailing whitespace"
Use import on the root pom, which will pull in all modules
Wait (m2e takes a while on initial import)

License

Apache License 2.0

jandex-maven-plugin's People

Contributors

Stargazers

Watchers

Forkers

marschall arcivanov jdcasey ctomc heiko-braun gustavonv afischer211 gastaldi virgo mkouba gnodet geoand coder451 famod hboutemy yrodiere ladicek jamezp

jandex-maven-plugin's Issues

UnsupportedVersion after using Jandex Maven Plugin 1.2.0

For our Quarkus microservice, we upgraded the Jandex Maven Plugin from 1.1.1 to 1.2.0.
During the build, it gives an UnsupportedVersion

Build step io.quarkus.deployment.index.ApplicationArchiveBuildStep#build threw an exception: org.jboss.jandex.UnsupportedVersion: Version: 10

Full error message:

Failed to execute goal io.quarkus:quarkus-maven-plugin:2.2.1.Final:build (default) on project app: Failed to build quarkus application: io.quarkus.builder.BuildException: Build failure: Build failed due to errors
[ERROR] [error]: Build step io.quarkus.deployment.index.ApplicationArchiveBuildStep#build threw an exception: org.jboss.jandex.UnsupportedVersion: Version: 10
[ERROR] at org.jboss.jandex.IndexReader.initReader(IndexReader.java:87)
[ERROR] at org.jboss.jandex.IndexReader.readVersion(IndexReader.java:137)
[ERROR] at org.jboss.jandex.IndexReader.getIndexVersion(IndexReader.java:124)
[ERROR] at io.quarkus.deployment.index.IndexingUtil.indexJar(IndexingUtil.java:58)
[ERROR] at io.quarkus.deployment.index.IndexingUtil.indexJar(IndexingUtil.java:49)
[ERROR] at io.quarkus.deployment.index.ApplicationArchiveBuildStep$1.apply(ApplicationArchiveBuildStep.java:287)
[ERROR] at io.quarkus.deployment.index.ApplicationArchiveBuildStep$1.apply(ApplicationArchiveBuildStep.java:283)
[ERROR] at java.base/java.util.HashMap.computeIfAbsent(HashMap.java:1133)
[ERROR] at io.quarkus.deployment.index.ApplicationArchiveBuildStep.handleJarPath(ApplicationArchiveBuildStep.java:283)
[ERROR] at io.quarkus.deployment.index.ApplicationArchiveBuildStep.indexPath(ApplicationArchiveBuildStep.java:192)
[ERROR] at io.quarkus.deployment.index.ApplicationArchiveBuildStep.addMarkerFilePaths(ApplicationArchiveBuildStep.java:236)
[ERROR] at io.quarkus.deployment.index.ApplicationArchiveBuildStep.scanForOtherIndexes(ApplicationArchiveBuildStep.java:125)
[ERROR] at io.quarkus.deployment.index.ApplicationArchiveBuildStep.build(ApplicationArchiveBuildStep.java:103)
[ERROR] at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
[ERROR] at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
[ERROR] at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
[ERROR] at java.base/java.lang.reflect.Method.invoke(Method.java:566)
[ERROR] at io.quarkus.deployment.ExtensionLoader$2.execute(ExtensionLoader.java:820)
[ERROR] at io.quarkus.builder.BuildContext.run(BuildContext.java:277)
[ERROR] at org.jboss.threads.ContextHandler$1.runWith(ContextHandler.java:18)
[ERROR] at org.jboss.threads.EnhancedQueueExecutor$Task.run(EnhancedQueueExecutor.java:2449)
[ERROR] at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.run(EnhancedQueueExecutor.java:1478)
[ERROR] at java.base/java.lang.Thread.run(Thread.java:834)
[ERROR] at org.jboss.threads.JBossThread.run(JBossThread.java:501)
[ERROR] -> [Help 1]

Do we need to upgrade something else in order to use 1.2.0 instead of 1.1.1?

Make plugin work with Java 8

The plugin contains a dependency to an old jandex version, which is not fully Java 8 compliant (in my specifiy case, I run into 'unknown tag'). This can be worked around by users by adding a dependency to jandex 2.0.0.Final to the plugin, but it would be nicer to have it in the original plugin POM.

Increment minor version on breaking jandex changes

jandex-maven-plugin 1.0.6 included a breaking change due to its update of the jandex version from 2.0.3 to 2.1.1. Jandex 2.1.1 uses a newer index format (version 9) than 2.0.3 (version 6) and the index files written by it cannot be read with the older jandex version.

I think in such cases the maven plugin should be more explicit about the breaking change by increasing its minor version (i.e. it should have gone from 1.0.5 to 1.1.0 at the time).

I don't think that anything useful can be done about this retroactively now, but it would be great if this could be considered for future updates.

I would suggest adding a unit test that checks for the written index version against a current expected value.

Add Eclipse m2e lifecycle mapping

See discussion: https://quarkusio.zulipchat.com/#narrow/stream/187030-users/topic/Jandex-Plugin.20in.20Eclipse.20m2e

tl;dr: Jandex-Plugin should be executed by default in Eclipse (via m2e-Plugin).
Therefore it should contain the respective desciptor: https://wiki.eclipse.org/M2E_compatible_maven_plugins

Since this plugin does not add new source folders etc., the following seems reasonable:

        <execute>
          <runOnIncremental>true</runOnIncremental>
          <runOnConfiguration>false</runOnConfiguration>
        </execute>

    /**
     * If true, construct an implied file-set using the target/classes directory, and process the classes there.
     *
     * @parameter default-value="true"
     */
    private final boolean processDefaultFileSet = true;