redhat-developer / redhat-developer/vscode-java

Depending on a gradle testFixtures module generates java build problems

Open
#2,784 15 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

compile Gradle
Dominant language
TypeScript
Stars
2.3k
Forks
546
Avg merge
20h 1m
Merged PRs (30d)
11

Description

Hi, I have a multi-modules gradle/java project in which I'm trying to centralize some test fixtures (aka test helper classes to help build test data etc) in some kind of library module, so that those java test fixtures classes can then be shared in multiple dependant modules (I'm referring precisely to this gradle test fixtures feature).

The problem I'm having in VS Code (with the Java extension) is that once I've defined my test fixtures in the lib module (see steps to reproduce below), as soon as I try to "consume" them by adding the dependency in a gradle dependant module build file (as explained here in gradle doc), something like:

dependencies {
    implementation(project(":lib-module"))

    testImplementation(testFixtures(project(":lib-module")))
}

it will create compile errors under the vs code Problems tab that the dependant module can no longer see any dependency imports made by the basic implementation(project(":lib-module")).

However, if I build everything with gradle, it will work just fine. The reported compile errors are only visual, within the Problems tab of the vscode editor.

Then, if I comment out the gradle testFixtures dependency import as follow:

dependencies {
    implementation(project(":lib-module"))

    //testImplementation(testFixtures(project(":lib-module")))
}

all compile errors will be gone from the vs code Problems tab, BUT, then if I try to run a gradle build task, it will fail saying that my tests no longer have access to the test fixtures imports from the lib module.

This seems to me like an issue with the vscode-java extension (or upstream?) not supporting properly the gradle testFixtures feature, preventing us from sharing in a very simple way test fixtures among multiple modules.

Environment

Operating System: macOS big sur (11.6.5)
JDK version: openjdk version "17.0.4.1" 2022-08-12
Visual Studio Code version: 1.71.0
Java extension version: 1.12.0

Steps To Reproduce
  1. Create a multi-modules gradle java project (2 modules should be enough, the lib exposing both normal lib utility/service classes and also test fixtures)
  2. Create one normal utility class in the lib module, can be just a simple pojo... (<lib-module>/src/main/java/com/...)
  3. Create one test fixture class also under the lib module, can be just a simple pojo... (<lib-module>/src/testFixture/java/com/...)
  4. Add the gradle test Fixtures plugin under your lib gradle build file (<lib-module>/build.gradle)
plugins {
    // A Java Library
    id 'java-library'
    // which produces test fixtures
    id 'java-test-fixtures'
}
  1. In the second dependant module, create one normal class that will consume/import the utility class from the lib module created in step 2 (<dependant-module>/src/main/java/com/...)
  2. In the second dependant module, create a test class that will consume/import the test fixture class from the lib module created in step 3 (<dependant-module>/src/test/java/com/...), the test class can just be a simple pojo, no need to import any test framework for this, we're just testing dependencies between gradle modules...
  3. Add the dependencies under the dependant module's gradle build file, so that it sees both the utility class AND the test fixture class from the lib module (<dependant-module>/build.gradle):
dependencies {
    implementation(project(":lib-module"))

    testImplementation(testFixtures(project(":lib-module")))
}
  1. Save everything, and you should expect to see compile errors in the vs code Problems tab, complaining about the fact that your dependant module's normal pojo class created in step 5 is unable to import the utility class from the lib module (that's right, the error might not even be inside your test class, but it could, it all depends where you've imported the lib utility class in this example, whether it's within the normal class in step 5, but it could have been under your test class of step 6 too; bottom line is, the compile error will be related to the normal lib classes that can no longer be imported in the dependant module(s); the test fixtures classes 'are' being imported properly.. So it really seems like if importing the 'test fixtures' will PREVENT the normal lib classes from being imported).
Sample project

I've created this basic sample project which reproduces the error:
https://github.com/Frank-D/multi-modules-root

Current Result

Compile errors showing under vs code Problems tab (e.g., using gradle test fixtures lib dependency hides the basic lib module dependency).

Expected Result

No compile errors showing under vs code Problems tab (e.g. using gradle test fixtures works without any issue within vs code using the vscode-java extension).

Additional Informations

Here's a screenshot of the vs code Problems, when reproducing the described error with the previous 'Sample project':
vscode_gradle-for-java_testfixtures-error

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked sample project and reproduce the issue using lib-module/build.gradle and the dependant module's build.gradle, including both project dependencies. Compare the VS Code Problems tab with a successful Gradle build, focusing on how the java-test-fixtures dependency affects visibility of the normal library imports. Done means the fixture and regular library imports both work without visual compile errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, vscode
Domain
build-system, developer-experience, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.