Introduce Java module descriptors #243

sormuras · 2021-10-12T08:30:00Z

Automatic Modules

Here's a listing of modules used by project that runs on Java 17 and uses jqwik via JUnit Platform's Launcher module.

java.base@17
...
jdk.xml.dom@17
jdk.zipfs@17
net.jqwik@1.5.6 file:///.../jqwik-1.5.6.jar automatic
net.jqwik.api@1.5.6 file:///.../jqwik-api-1.5.6.jar automatic
net.jqwik.engine@1.5.6 file:///.../jqwik-engine-1.5.6.jar automatic
net.jqwik.time@1.5.6 file:///.../jqwik-time-1.5.6.jar automatic
net.jqwik.web@1.5.6 file:///.../jqwik-web-1.5.6.jar automatic
org.apiguardian.api@1.1.2 file:///.../apiguardian-api-1.1.2.jar
org.junit.platform.commons@1.8.1 file:///.../junit-platform-commons-1.8.1.jar
org.junit.platform.engine@1.8.1 file:///.../junit-platform-engine-1.8.1.jar
org.junit.platform.launcher@1.8.1 file:///.../junit-platform-launcher-1.8.1.jar
org.opentest4j@1.2.0 file:///.../opentest4j-1.2.0.jar

Discussion

... commit to jqwik's modular API: namely, its exported packages and possibly provided and/or used services.

Notable benefit: get jqwik's version rendered into stacktraces.

The text was updated successfully, but these errors were encountered:

jlink · 2021-10-12T08:44:07Z

@sormuras Thank for the suggestion.

Do you have by any chance an example handy how to do that in Gradle. Mind that Java 1.8 is still jqwik's main platform and I'd very much prefer to stick with a single artefact per module.

sormuras · 2021-10-12T08:51:56Z

Sure. This is all about adding a module-info.class into each existing JAR file published by jqwik.

Would you mind requiring JDK 17 at build time? With --release 8 for jqwik's production code, with --release 9 for module descriptors and (with implicite --release 17) for test code?

If you want to stay on 8 ... there are ways to compile modules here, too. (For example, let Gradle toolchain provide a recent JDK and use it to compile module descriptors, or also make use of https://github.com/moditect/moditect or https://github.com/beryx/badass-jar-plugin#module-infojava-location).

sormuras · 2021-10-12T08:54:59Z

I guess @marcphilipp could apply some of his Great Gradle-Fu to help us here. 🤓

marcphilipp · 2021-10-12T11:02:39Z

This will require a separate source set or an additional compile task in Gradle. Alternatively, Moditect als has a Gradle plugin.

sormuras · 2021-10-25T07:22:33Z

(FYI: here's a similar feature request at micronaut-projects/micronaut-core#6395)

jlink · 2021-10-26T13:50:57Z

I had a look at the moditect Gradle plugin. 1.0.0 is still a RC and I didn't succeed in making it work for one single module :-(

Guess it's too much hassle for me to tackle it in 1.6.0.

Looks like a perfect task for the community to pick up. If there only was any ;-)

jlink · 2021-10-26T13:53:34Z

@sormuras You probably know if Kotlin modules come with additional challenges?

sormuras · 2021-10-26T15:04:09Z

I don't know - but if you have drafted some module-info.java files, I can try to make them compile and added to the generated JAR files.

sormuras · 2021-10-26T16:22:46Z

Work in progress...


@sormuras ➜ $ jar --describe-module --file api/build/libs/jqwik-api-1.6.0-SNAPSHOT.jar
net.jqwik.api jar:file:///workspaces/jqwik/api/build/libs/jqwik-api-1.6.0-SNAPSHOT.jar/!module-info.class
requires java.base mandated

@sormuras ➜ $ jar --describe-module --file base/build/libs/jqwik-1.6.0-SNAPSHOT.jar 
net.jqwik jar:file:///workspaces/jqwik/base/build/libs/jqwik-1.6.0-SNAPSHOT.jar/!module-info.class
requires java.base mandated
requires net.jqwik.api

Using @beryx's https://github.com/beryx/badass-jar-plugin and some module-info.java skeletons: #244

jlink · 2021-10-27T10:44:40Z

Ready for testing with commit 9c2be82.

Released in 1.6.0-SNAPSHOT

sormuras · 2021-10-27T10:47:20Z

Preparing an integration test module in parallel...

java.lang.module.ResolutionException: Module net.jqwik.engine does not read a module that exports net.jqwik.api.facades

Fixing those exception on-the-fly.

sormuras · 2021-10-27T11:16:57Z

This is one strange. Any clue?

Could not initialize class net.jqwik.api.domains.DomainContext$DomainContextFacade
java.lang.NoClassDefFoundError: Could not initialize class net.jqwik.api.domains.DomainContext$DomainContextFacade
	at net.jqwik.engine/net.jqwik.engine.execution.PropertyMethodExecutor.execute(PropertyMethodExecutor.java:47)
	at net.jqwik.engine/net.jqwik.engine.execution.PropertyTaskCreator.executeTestMethod(PropertyTaskCreator.java:129)
	at net.jqwik.engine/net.jqwik.engine.execution.PropertyTaskCreator.lambda$createTask$1(PropertyTaskCreator.java:55)
	at net.jqwik.engine/net.jqwik.engine.execution.pipeline.ExecutionTask$1.lambda$execute$0(ExecutionTask.java:31)
	at net.jqwik.engine/net.jqwik.engine.execution.lifecycle.CurrentTestDescriptor.runWithDescriptor(CurrentTestDescriptor.java:17)
	at net.jqwik.engine/net.jqwik.engine.execution.pipeline.ExecutionTask$1.execute(ExecutionTask.java:31)
	at net.jqwik.engine/net.jqwik.engine.execution.pipeline.ExecutionPipeline.runToTermination(ExecutionPipeline.java:82)
	at net.jqwik.engine/net.jqwik.engine.execution.JqwikExecutor.execute(JqwikExecutor.java:46)
	at net.jqwik.engine/net.jqwik.engine.JqwikTestEngine.executeTests(JqwikTestEngine.java:70)
	at net.jqwik.engine/net.jqwik.engine.JqwikTestEngine.execute(JqwikTestEngine.java:53)

Never mind. Build was out of sync...

Part of issue jqwik-team#243

Part of issue #243

jlink · 2021-10-27T12:53:02Z

gradle test-modular-api:test fails locally with:
java.lang.IllegalAccessError: class net.jqwik.engine.JqwikTestEngine (in module net.jqwik.engine) cannot access class java.util.logging.Logger (in module java.logging) because module net.jqwik.engine does not read module java.logging

Any idea?

Gradle version 7.2. IntelliJ also complains.

sormuras · 2021-10-27T13:39:19Z

Works on my machine and GH Actions was also fine.

https://github.com/jlink/jqwik/blob/4418ccf9ef65b0ff218f8453a9b9d21b7f86adf2/engine/src/main/module/module-info.java#L1-L3

According to that requires java.logging; line, it smells like an outdated JAR and/or classes folder on your machine.

jlink · 2021-10-27T14:33:36Z

Integration test works. Done!

sormuras · 2021-10-27T14:37:04Z

Cheers! Modules, modules, every where!

sormuras · 2021-11-07T07:28:52Z

Running some smoke-test commands in a workspace of https://github.com/sormuras/jqwik-samples/tree/main/jqwik-starter-bach yields:

@sormuras ➜ /workspaces/jqwik-samples/jqwik-starter-bach $ java --module-path .bach/external-modules --list-modules

java.base@17.0.1
...
jdk.zipfs@17.0.1
net.jqwik.api file:///.../net.jqwik.api.jar
net.jqwik.engine file:///.../net.jqwik.engine.jar
org.apiguardian.api@1.1.2 ...
...

@sormuras ➜ /workspaces/jqwik-samples/jqwik-starter-bach $ java --module-path .bach/external-modules --describe-module net.jqwik.api

net.jqwik.api file:///workspaces/jqwik-samples/jqwik-starter-bach/.bach/external-modules/net.jqwik.api.jar
exports net.jqwik.api
exports net.jqwik.api.arbitraries
exports net.jqwik.api.configurators
exports net.jqwik.api.constraints
exports net.jqwik.api.domains
exports net.jqwik.api.facades
exports net.jqwik.api.footnotes
exports net.jqwik.api.lifecycle
exports net.jqwik.api.providers
exports net.jqwik.api.sessions
exports net.jqwik.api.stateful
exports net.jqwik.api.statistics
requires org.opentest4j
requires java.logging
requires java.base mandated
requires org.junit.platform.commons
uses net.jqwik.api.facades.ShrinkingSupportFacade

...
uses net.jqwik.api.ExhaustiveGenerator$ExhaustiveGeneratorFacade

@sormuras ➜ /workspaces/jqwik-samples/jqwik-starter-bach $ java --module-path .bach/external-modules --describe-module net.jqwik.engine

net.jqwik.engine file:///workspaces/jqwik-samples/jqwik-starter-bach/.bach/external-modules/net.jqwik.engine.jar
requires org.junit.platform.engine
requires java.logging
requires net.jqwik.api
requires java.base mandated
uses net.jqwik.api.providers.TypeUsage$Enhancer
uses net.jqwik.api.SampleReportingFormat
uses net.jqwik.api.providers.ArbitraryProvider
uses net.jqwik.api.lifecycle.LifecycleHook
uses net.jqwik.api.configurators.ArbitraryConfigurator
provides net.jqwik.api.Functions$FunctionsFacade with 
    net.jqwik.engine.facades.FunctionsFacadeImpl
...
provides net.jqwik.api.providers.ArbitraryProvider with
    net.jqwik.engine.providers.BigDecimalArbitraryProvider
    ...
    net.jqwik.engine.providers.StringArbitraryProvider
qualified opens net.jqwik.engine.properties.configurators to
    org.junit.platform.commons
contains net.jqwik.engine
...
contains net.jqwik.engine.support.types

Looks good to me.

✅

jlink · 2021-11-13T11:37:46Z

Feature has been released in 1.6.0

jlink added the help wanted label Oct 26, 2021

sormuras mentioned this issue Oct 26, 2021

Set module version beryx/badass-jar-plugin#3

Closed

sormuras added a commit to sormuras/jqwik that referenced this issue Oct 27, 2021

Add modular integration test

d7dd975

Part of issue jqwik-team#243

jlink pushed a commit that referenced this issue Oct 27, 2021

Add modular integration test

23ef7ed

Part of issue #243

jlink closed this as completed Oct 27, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce Java module descriptors #243

Introduce Java module descriptors #243

sormuras commented Oct 12, 2021

jlink commented Oct 12, 2021

sormuras commented Oct 12, 2021 •

edited

sormuras commented Oct 12, 2021

marcphilipp commented Oct 12, 2021

sormuras commented Oct 25, 2021

jlink commented Oct 26, 2021

jlink commented Oct 26, 2021

sormuras commented Oct 26, 2021

sormuras commented Oct 26, 2021

jlink commented Oct 27, 2021

sormuras commented Oct 27, 2021 •

edited

sormuras commented Oct 27, 2021 •

edited

jlink commented Oct 27, 2021

sormuras commented Oct 27, 2021

jlink commented Oct 27, 2021

sormuras commented Oct 27, 2021

sormuras commented Nov 7, 2021

jlink commented Nov 13, 2021

Introduce Java module descriptors #243

Introduce Java module descriptors #243

Comments

sormuras commented Oct 12, 2021

Automatic Modules

Suggested Solution

Discussion

jlink commented Oct 12, 2021

sormuras commented Oct 12, 2021 • edited

sormuras commented Oct 12, 2021

marcphilipp commented Oct 12, 2021

sormuras commented Oct 25, 2021

jlink commented Oct 26, 2021

jlink commented Oct 26, 2021

sormuras commented Oct 26, 2021

sormuras commented Oct 26, 2021

jlink commented Oct 27, 2021

sormuras commented Oct 27, 2021 • edited

sormuras commented Oct 27, 2021 • edited

jlink commented Oct 27, 2021

sormuras commented Oct 27, 2021

jlink commented Oct 27, 2021

sormuras commented Oct 27, 2021

sormuras commented Nov 7, 2021

jlink commented Nov 13, 2021

sormuras commented Oct 12, 2021 •

edited

sormuras commented Oct 27, 2021 •

edited

sormuras commented Oct 27, 2021 •

edited