io.freefair.gradle.plugins.jacoco.tasks.JacocoDump Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jacoco-plugin Show documentation
Collection of JaCoCo related Gradle plugins
There is a newer version: 8.10
package io.freefair.gradle.plugins.jacoco.tasks;


import lombok.Getter;
import org.gradle.api.InvalidUserDataException;
import org.gradle.api.UncheckedIOException;
import org.gradle.api.file.RegularFileProperty;
import org.gradle.api.provider.Property;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.OutputFile;
import org.gradle.api.tasks.TaskAction;
import org.gradle.testing.jacoco.tasks.JacocoBase;
import org.gradle.workers.WorkAction;
import org.gradle.workers.WorkParameters;
import org.gradle.workers.WorkQueue;
import org.gradle.workers.WorkerExecutor;
import org.jacoco.core.tools.ExecDumpClient;
import org.jacoco.core.tools.ExecFileLoader;

import javax.inject.Inject;
import java.io.File;
import java.io.IOException;

/**
 * @author Lars Grefer
 * @see org.jacoco.ant.DumpTask
 */
@Getter
public class JacocoDump extends JacocoBase {

    @Internal
    private final WorkerExecutor workerExecutor;

    /**
     * Sets whether execution data should be downloaded from the remote host.
     * Defaults to true
     *
     * @see org.jacoco.ant.DumpTask#setDump(boolean)
     */
    @Input
    private final Property dump = getProject().getObjects().property(Boolean.class).convention(true);

    /**
     * Sets whether a reset command should be sent after the execution data has been dumped.
     * Defaults to false
     *
     * @see org.jacoco.ant.DumpTask#setReset(boolean)
     */
    @Input
    private final Property reset = getProject().getObjects().property(Boolean.class).convention(false);

    /**
     * Number of retries which the goal will attempt to establish a connection.
     * This can be used to wait until the target JVM is successfully launched.
     *
     * @see org.jacoco.ant.DumpTask#setRetryCount(int)
     */
    @Input
    private final Property retryCount = getProject().getObjects().property(Integer.class).convention(10);

    /**
     * IP Address or hostname to connect to.
     * Defaults to localhost
     *
     * @see org.jacoco.ant.DumpTask#setAddress(String)
     */
    @Input
    private final Property address = getProject().getObjects().property(String.class).convention("localhost");

    /**
     * Port number to connect to.
     * Default is 6300
     *
     * @see org.jacoco.ant.DumpTask#setPort(int)
     */
    @Input
    private final Property port = getProject().getObjects().property(Integer.class).convention(6300);

    /**
     * Sets the location of the execution data file to write. This parameter is
     * required when dump is true.
     *
     * @see org.jacoco.ant.DumpTask#setDestfile(File)
     */
    @OutputFile
    private final RegularFileProperty destfile = getProject().getObjects().fileProperty();

    /**
     * true if the destination file it to be appended to.
     * false if the file is to be overwritten
     *
     * @see org.jacoco.ant.DumpTask#setAppend(boolean)
     */
    @Input
    private final Property append = getProject().getObjects().property(Boolean.class).convention(true);

    @Inject
    public JacocoDump(WorkerExecutor workerExecutor) {
        this.workerExecutor = workerExecutor;
    }

    @TaskAction
    public void dump() {

        if (port.getOrElse(6300) <= 0) {
            throw new InvalidUserDataException("Invalid port value");
        }

        if (dump.getOrElse(true) && !destfile.isPresent()) {
            throw new InvalidUserDataException("Destination file is required when dumping execution data");
        }

        WorkQueue workQueue = workerExecutor.classLoaderIsolation(spec -> spec.getClasspath().from(getJacocoClasspath()));

        workQueue.submit(Action.class, jacocoDumpParameters -> {
            jacocoDumpParameters.getDump().set(dump);
            jacocoDumpParameters.getReset().set(reset);
            jacocoDumpParameters.getRetryCount().set(retryCount);

            jacocoDumpParameters.getAddress().set(address);
            jacocoDumpParameters.getPort().set(port);

            jacocoDumpParameters.getDestfile().set(destfile);
            jacocoDumpParameters.getAppend().set(append);
        });
    }

    interface JacocoDumpParameters extends WorkParameters {
        Property getDump();

        Property getReset();

        Property getRetryCount();

        Property getAddress();

        Property getPort();

        RegularFileProperty getDestfile();

        Property getAppend();
    }

    static abstract class Action implements WorkAction {

        @Override
        public void execute() {

            ExecDumpClient client = new ExecDumpClient();

            client.setDump(getParameters().getDump().getOrElse(false));
            client.setReset(getParameters().getReset().getOrElse(false));
            client.setRetryCount(getParameters().getRetryCount().getOrElse(0));

            try {
                ExecFileLoader loader = client.dump(getParameters().getAddress().get(), getParameters().getPort().get());
                if (getParameters().getDump().getOrElse(false)) {
                    loader.save(getParameters().getDestfile().get().getAsFile(), getParameters().getAppend().get());
                }
            } catch (IOException e) {
                throw new UncheckedIOException(e);
            }
        }
    }
}