Add support for including module-info in Mockito. #3597

raphw · 2025-02-23T22:45:28Z

Adds module-info.java to describe module descriptor.

codecov-commenter · 2025-02-23T23:25:20Z

Codecov Report

Attention: Patch coverage is 78.04878% with 9 lines in your changes missing coverage. Please review.

Project coverage is 85.56%. Comparing base (d01ac9d) to head (5ca72f9).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...on/bytebuddy/InlineDelegateByteBuddyMockMaker.java	53.33%	7 Missing ⚠️
...ernal/configuration/plugins/PluginInitializer.java	83.33%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #3597      +/-   ##
============================================
- Coverage     85.60%   85.56%   -0.04%     
- Complexity     2956     2957       +1     
============================================
  Files           341      341              
  Lines          8995     9028      +33     
  Branches       1119     1119              
============================================
+ Hits           7700     7725      +25     
- Misses         1005     1013       +8     
  Partials        290      290

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

… be declared as modules.

raphw · 2025-02-24T00:26:01Z

I understand why this is failing now.

We add the MockMethodDispatcher class to the org.mockito.internal.creation.bytebuddy.inject package.
We compile the module-info.java where the compiler adds all packages in scope to the module's package list.
Even though we remove the file later and rename it to raw, the package is still in the package list.
The class loader never attempts to check another class loader (the boot loader) for this package. It is never found.

Could we "post-process" the module-info.class after the javac application? We could use ASM to apply a module visitor on it. All we would need to do would be to remove the package in question from the module info file.

raphw · 2025-02-24T00:29:29Z

This would be the code we need to run in the post-processing:

    ClassReader reader = new ClassReader("module-info.class");
    ClassWriter writer = new ClassWriter(reader, 0);
    reader.accept(new ClassVisitor(Opcodes.ASM9, writer) {
        @Override
        public ModuleVisitor visitModule(String name, int access, String version) {
            return new ModuleVisitor(Opcodes.ASM9, super.visitModule(name, access, version)) {
                @Override
                public void visitPackage(String packaze) {
                    if (!packaze.equals("org/mockito/internal/creation/bytebuddy/inject")) {
                        super.visitPackage(packaze);
                    }
                }
            };
        }
    }, 0);

raphw · 2025-02-24T00:37:17Z

@TimvdLippe Any idea how to effectivate this code? https://github.com/mockito/mockito/pull/3597/files

The Class writer returns a byte array that would need to replace the original file.

mockito-core/build.gradle.kts

raphw · 2025-02-28T10:57:22Z

@TimvdLippe or @bric3 - I currently try to move the raw class file into a different folder (and therewith try to avoid that the class loader registers the package that this folder represents, so it can be loaded from the boot loader).

But this does not seem to work. I adjusted the copy task:

    from(sourceSets.main.flatMap { it.java.classesDirectory }
        .map { it.file("org/mockito/internal/creation/bytebuddy/inject/MockMethodDispatcher.class") })
    into(generatedInlineResource.map { it.dir("org/mockito/internal/creation/bytebuddy") })

    rename(".*", "inject-MockMethodDispatcher.raw")

Why does this not work? For me, the jar task fails now with:

Task :mockito-core:jar FAILED
error : Classes found in the wrong directory: {org/mockito/internal/creation/bytebuddy/MockMethodDispatcher.class=org.mockito.internal.creation.bytebuddy.inject.MockMethodDispatcher}

In short, I want the class to be stored as a file in the jar's org/mockito/internal/creation/bytebuddy/ folder, not in the org/mockito/internal/creation/bytebuddy/inject/ folder. And adjust the file name to append the inject and replace .class with .raw. The resulting jar must not contain the org/mockito/internal/creation/bytebuddy/inject/ folder altogether.

TimvdLippe · 2025-02-28T18:18:26Z

You probably fixed the Jar task, as in the Gradle build scan (https://scans.gradle.com/s/x55h4q2hpkgeq/timeline?type=org.gradle.api.tasks.bundling.Jar#76bq4yvmlsst2) it is successful. Looking at the build failure, it seems to be an OSGi issue:

> Task :mockito-extensions:mockito-junit-jupiter:verifyOSGi FAILED
      ⇒ Bundle: org.mockito.junit-jupiter cannot be resolved
              ⇒ Import-Package: org.mockito.internal.configuration; version=[5.15.0,6.0.0); status=INTERNAL cannot be resolved
                      ⇒ because Import-Package requirement for: org.mockito.internal.creation.bytebuddy.inject could not be provided by any available bundle or dependency

We probably need to update our OSGi instead to ignore this error? A possible solution I found after googling this error: bndtools/bnd#2227 (comment)

tasks.jar {
    withConvention(BundleTaskConvention::class) {
        bnd(mapOf(
                "-fixupmessages" to "^Classes found in the wrong directory: \\\\{META-INF/versions/9/module-info\\\\.class=module-info}$"
        ))
    }
}

raphw · 2025-03-02T23:12:05Z

Indeed. I had to clean out my local build to get there.

I think I figured it out. Needed to fix some assumptions, but runs locally now. I think this does the trick altogether.

TimvdLippe · 2025-03-03T06:42:15Z

Nice work! Glad to see we were able to figure it out together.

I do want us to see if we can find an alternative fix for our Javadoc though. I really do want us to omit our internal classes in our Javadoc as it is too easy to read over. With the fixes we made in Gradle, maybe we can add the line back and it "just" works?

raphw · 2025-03-03T08:27:10Z

I found a workaround where I define the sources explicily. It's a Gradle limitation as the missing packages still need to be included in the source task.

TimvdLippe

Happy to see this all work and our Javadoc as well 🎉 I will publish a new minor release after this gets in

sormuras · 2025-03-04T08:29:24Z

Nice 🧩 work!

| Package | Type | Package file | Manager | Update | Change | |---|---|---|---|---|---| | [org.mockito:mockito-core](https://github.com/mockito/mockito) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `5.15.2` -> `5.16.0` | | [io.grpc:grpc-stub](https://github.com/grpc/grpc-java) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `1.70.0` -> `1.71.0` | | [io.grpc:grpc-protobuf](https://github.com/grpc/grpc-java) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `1.70.0` -> `1.71.0` | | [io.grpc:grpc-netty](https://github.com/grpc/grpc-java) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `1.70.0` -> `1.71.0` | | [io.grpc:protoc-gen-grpc-java](https://github.com/grpc/grpc-java) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `1.70.0` -> `1.71.0` | | [io.grpc:grpc-bom](https://github.com/grpc/grpc-java) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `1.70.0` -> `1.71.0` | | [io.grpc:grpc-api](https://github.com/grpc/grpc-java) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `1.70.0` -> `1.71.0` | | [com.google.apis:google-api-services-storage](http://nexus.sonatype.org/oss-repository-hosting.html) ([source](http://svn.sonatype.org/spice/tags/oss-parent-7)) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `v1-rev20241206-2.0.0` -> `v1-rev20250224-2.0.0` | | [com.fasterxml.jackson.module:jackson-module-kotlin](https://github.com/FasterXML/jackson-module-kotlin) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.18.2` -> `2.18.3` | | [com.fasterxml.jackson.datatype:jackson-datatype-jsr310](https://github.com/FasterXML/jackson-modules-java8) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.18.2` -> `2.18.3` | | [com.fasterxml.jackson.dataformat:jackson-dataformat-yaml](https://github.com/FasterXML/jackson-dataformats-text) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.18.2` -> `2.18.3` | | [com.fasterxml.jackson.core:jackson-databind](https://github.com/FasterXML/jackson) ([source](https://github.com/FasterXML/jackson-databind)) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.18.2` -> `2.18.3` | | [com.fasterxml.jackson.core:jackson-core](https://github.com/FasterXML/jackson-core) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.18.2` -> `2.18.3` | | [com.fasterxml.jackson:jackson-bom](https://github.com/FasterXML/jackson-bom) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.18.2` -> `2.18.3` | | [com.fasterxml.jackson.core:jackson-annotations](https://github.com/FasterXML/jackson) ([source](https://github.com/FasterXML/jackson-annotations)) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.18.2` -> `2.18.3` | | [software.amazon.awssdk:sdk-core](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.30.30` -> `2.30.32` | | [software.amazon.awssdk:sqs](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.30.30` -> `2.30.32` | | [software.amazon.awssdk:dynamodb-enhanced](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.30.30` -> `2.30.32` | | [software.amazon.awssdk:dynamodb](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.30.30` -> `2.30.32` | | [software.amazon.awssdk:aws-core](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.30.30` -> `2.30.32` | | [software.amazon.awssdk:bom](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.30.30` -> `2.30.32` | | [software.amazon.awssdk:auth](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.30.30` -> `2.30.32` | --- ### Release Notes <details> <summary>mockito/mockito (org.mockito:mockito-core)</summary> ### [`v5.16.0`](https://github.com/mockito/mockito/releases/tag/v5.16.0) <sup><sup>*Changelog generated by [Shipkit Changelog Gradle Plugin](https://github.com/shipkit/shipkit-changelog)*</sup></sup> ##### 5.16.0 - 2025-03-03 - [10 commit(s)](mockito/mockito@v5.15.2...v5.16.0) by Brice Dutheil, Rafael Winterhalter, TDL, dependabot\[bot] - Add support for including module-info in Mockito. [(#3597)](mockito/mockito#3597) - Bump com.gradle.develocity from 3.19 to 3.19.1 [(#3579)](mockito/mockito#3579) - Bump org.assertj:assertj-core from 3.27.2 to 3.27.3 [(#3577)](mockito/mockito#3577) - Bump com.diffplug.spotless:spotless-plugin-gradle from 7.0.1 to 7.0.2 [(#3574)](mockito/mockito#3574) - Bump com.diffplug.spotless:spotless-plugin-gradle from 6.25.0 to 7.0.1 [(#3571)](mockito/mockito#3571) - Bump org.assertj:assertj-core from 3.27.1 to 3.27.2 [(#3569)](mockito/mockito#3569) - Tweaks documentation on mockito agent config for maven [(#3568)](mockito/mockito#3568) - Adds `--info` to diagnose closeAndReleaseStagingRepositories issues [(#3567)](mockito/mockito#3567) - Refine reflection when calling management factory [(#3566)](mockito/mockito#3566) - Avoid warning when dynamic attach is enabled [(#3551)](mockito/mockito#3551) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 6pm every weekday,before 2am every weekday" in timezone Australia/Melbourne, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Never, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). GitOrigin-RevId: b36ad622d93f38a65018855e51bd093a591e512b

raphw added 2 commits February 22, 2025 21:41

Add module-info and import injected module.

ff11c30

Avoid error during javadoc generation.

5cb2254

raphw mentioned this pull request Feb 23, 2025

feat: add jpms module-info #3381

Closed

8 tasks

raphw added 4 commits February 23, 2025 23:50

Add junit static reference.

7a6ab7b

Add module read adjustment for plugin initializer.

e1c5d18

Clean up formatting.

02a0f16

Complete module system integration.

0fb978d

raphw added 5 commits February 24, 2025 00:26

Remove module-info from code-empty jars as they will unlikely need to…

bd6faed

… be declared as modules.

Add test module.

451cf6b

Fix jar resolution.

602a4e5

Improve error message.

e3201cb

Remove package-info.

dc2292f

Add comment for transfer.

547e7e4

TimvdLippe reviewed Feb 26, 2025

View reviewed changes

mockito-core/build.gradle.kts Outdated Show resolved Hide resolved

raphw added 3 commits February 26, 2025 23:02

Adjust build to transform module info.

898987e

Add transformation for module-info.

22bde40

Attempt compatible renaming.

0757e59

Adjust build and test.

825009d

raphw added 4 commits March 2, 2025 23:25

Adjust OSGi to avoid artificial package.

051e8a7

Fix export for internal dispatcher implementation.

d5c775f

Unseal loader prior to injection.

63dd38b

Read jdk.unsupported to allow use of internal API if requested.

adf6b25

Remove comment.

5de7543

Fix javadoc task.

2265a5e

raphw added 4 commits March 3, 2025 09:39

Remove IntelliJ added import.

94509e1

Fix comment.

ddeb779

Make code more readable.

834dbe1

Improve error message.

5ca72f9

TimvdLippe approved these changes Mar 3, 2025

View reviewed changes

TimvdLippe merged commit c81be5d into main Mar 3, 2025
18 checks passed

TimvdLippe deleted the module-prototype branch March 3, 2025 10:11

This was referenced Mar 3, 2025

Bump mockito from 5.15.2 to 5.16.0 kousen/junit5_workshop#252

Merged

Bump org.mockito:mockito-junit-jupiter from 5.15.2 to 5.16.0 kousen/java_8_recipes#126

Merged

natzei mentioned this pull request Mar 3, 2025

Bump org.mockito:mockito-core from 5.14.2 to 5.16.0 natzei/jvrp#25

Merged

xazap mentioned this pull request Mar 13, 2025

Build fails when testing under module path (Regression in 5.16.0) #3612

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add support for including module-info in Mockito. #3597

Add support for including module-info in Mockito. #3597

Uh oh!

raphw commented Feb 23, 2025 •

edited by TimvdLippe

Loading

Uh oh!

codecov-commenter commented Feb 23, 2025 •

edited

Loading

Uh oh!

raphw commented Feb 24, 2025

Uh oh!

raphw commented Feb 24, 2025

Uh oh!

raphw commented Feb 24, 2025

Uh oh!

Uh oh!

raphw commented Feb 28, 2025 •

edited

Loading

Uh oh!

TimvdLippe commented Feb 28, 2025

Uh oh!

raphw commented Mar 2, 2025

Uh oh!

TimvdLippe commented Mar 3, 2025

Uh oh!

raphw commented Mar 3, 2025

Uh oh!

TimvdLippe left a comment

Uh oh!

Uh oh!

sormuras commented Mar 4, 2025

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

Add support for including module-info in Mockito. #3597

Add support for including module-info in Mockito. #3597

Uh oh!

Conversation

raphw commented Feb 23, 2025 • edited by TimvdLippe Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Feb 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

raphw commented Feb 24, 2025

Uh oh!

raphw commented Feb 24, 2025

Uh oh!

raphw commented Feb 24, 2025

Uh oh!

Uh oh!

raphw commented Feb 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TimvdLippe commented Feb 28, 2025

Uh oh!

raphw commented Mar 2, 2025

Uh oh!

TimvdLippe commented Mar 3, 2025

Uh oh!

raphw commented Mar 3, 2025

Uh oh!

TimvdLippe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sormuras commented Mar 4, 2025

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

raphw commented Feb 23, 2025 •

edited by TimvdLippe

Loading

codecov-commenter commented Feb 23, 2025 •

edited

Loading

raphw commented Feb 28, 2025 •

edited

Loading