Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Gradle test delegation #1045

Closed
hrsto opened this issue Aug 12, 2020 · 11 comments
Closed

Support Gradle test delegation #1045

hrsto opened this issue Aug 12, 2020 · 11 comments

Comments

@hrsto
Copy link

hrsto commented Aug 12, 2020

Inside src/test/resources there is an arquillian.xml file that has to be expanded by gradle at processTestResources task. When a test is run from within vs code, this doesn't happen and the resource file is used as is. This triggers an error from Junit that basically says that some property is invalid (because it's expanded, i.e. junit see it as ${somePropToExpand}).

Same thing occurs when arquillian.xml is auto generated by a plugin - a gradle plugin can auto create it and put it directly in the buildDir/resources/test dir. When a test is run from within vs code, basically the file is invisible to vs code.

Both of these problems can be corrected by having a:

sourceSets {
    test {
        resources {
            srcDirs += "$buildDir/resources/test"
        }
    }
}

But that by itself creates a new set of problems for the build.

@jdneo
Copy link
Member

jdneo commented Aug 13, 2020

The project classpath is resolved by buildship (if it's a Gradle project). To help us better understand the problem, would you mind to share a sample project for this issue to us?

@hrsto
Copy link
Author

hrsto commented Aug 13, 2020

Attaching the most minimal i could produce.

There's only one test class - ArquillianInitTest.

First do a gradle clean test. It should complete successfully.

This initial normal build is set to auto generate arquillian.xml at built time, thus: /tmp/sample/src/test/resources/__arquillian.xml is prefixed with __ to ignore it. Such a build doesn't work when executed from vscode, because vscode code thinks this file doesn't exist. But it can be found in $buildDir/resources/test.

Now remove the __ prefix from /tmp/sample/src/test/resources/__arquillian.xml to force gradle to explicitly use it. Make sure you manually set the wlpHome (in my case, project ran from /tmp). The following is observed:

  1. when you do gradle clean test it should complete successfully.
  2. when run from vscode, it will error out because of the properties the need to be expanded. For ex., this is the error i get: java.lang.NumberFormatException: For input string: "${SERVER_PORT}"
  3. if you run gradle processTestResources, you can confirm the property expansion works - the files in $buildDir/resources/test have the proper values.
  4. src/test/resources/arquillian.xml and src/test/resources/persistence.xml have commented out lines - toggle those so that you directly set the values. When run from vscode it will complete successfully.

sample.tar.gz

@jdneo
Copy link
Member

jdneo commented Aug 20, 2020

Here are some findings:

I can repro this issue and I also tried the project in Eclipse and IntelliJ.

In Eclipse, same error when running the test, but it can successfully run if I use the Delegate to Gradle feature.

In IntelliJ, since it will delegate to Gradle by default, so the test runs successfully.

Seems that we need to support Delegate to Gradle at VS Code side.

@jdneo jdneo added the bug label Aug 20, 2020
@egvimo
Copy link

egvimo commented Feb 22, 2021

I have the same problem. A "Delegate to Gradle" Feature would be great!

@ytreister
Copy link

Any update on this?

@prbpedro
Copy link

prbpedro commented Sep 6, 2022

I have the same problem. A "Delegate to Gradle" Feature would be great!

@uk-taniyama
Copy link

I tried to call "gardle test" with vscode-gradle but could only get as far as the call.

import * as util from "util";
import * as vscode from "vscode";
import { ExtensionApi as GradleApi, RunTaskOpts, Output } from "vscode-gradle";

function runGradleTest(context: IRunTestContext) {
    const extension = vscode.extensions.getExtension("vscjava.vscode-gradle");
    if (extension == null) {
        return null;
    }

    const gradleApi = extension!.exports as GradleApi;
    const testMethods: TestItem[] = [];
    const visitTestItem = (testItem: TestItem) => {
        if(testItem.id.indexOf('#') > 0 ){
            testMethods.push(testItem);
        } else {
            testItem.children.forEach(visitTestItem)
        }
    }
    context.testItems.forEach(visitTestItem);

    return new Promise(async (resolve, reject) => {
        while(testMethods.length) {
            const testMethod = testMethods.shift();
            if(testMethod==null){
                continue;
            }

            const taskId = testMethod.id;
            const runTaskOpts: RunTaskOpts = {
                projectFolder: context.workspaceFolder.uri.fsPath,
                taskName: "test",
                args: [
                    "--tasks",
                    taskId.replace(/.+@/, '').replace('#', '.'),
                ],
                showOutputColors: false,
                onOutput: (output: Output): void => {
                    const message = new util.TextDecoder("utf-8").decode(
                        output.getOutputBytes_asU8()
                    );
                    console.log(output.getOutputType(), message);
                },
            };
            await gradleApi.runTask(runTaskOpts);
        }
        resolve(null);
    });
}

@violetexistence
Copy link

Yes, please!

@jdneo
Copy link
Member

jdneo commented Jun 26, 2024

Update: I'm implementing gradle test delegation recently and it will come very soon

@jdneo jdneo changed the title Run test fails with gradle when tasks that process resources are involved. Support Gradle test delegation Aug 5, 2024
@jdneo jdneo added enhancement and removed bug labels Aug 5, 2024
@jdneo
Copy link
Member

jdneo commented Aug 5, 2024

The Gradle Test Delegation (both run and debug) has supported now.

To use this feature, you need to install the latest Test Runner for Java and Gradle for Java extension.

To delegate the tests to Gradle, you can set the default testing profile in Testing explorer:
image
image

If you do not want to change the default testing profile, you can trigger an one-time execution via:
image
image

@jdneo jdneo closed this as completed Aug 5, 2024
@piotr-rachwalik
Copy link

@jdneo I don't see Delegate Test to Gradle option in my VS Code:
Screenshot 2024-09-13 at 17 36 30
Screenshot 2024-09-13 at 17 38 08
Screenshot 2024-09-13 at 17 37 01

Screenshot 2024-09-13 at 17 39 07
Screenshot 2024-09-13 at 17 39 40

Any hints how to enable that feature?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

8 participants