org.apache.maven.plugin.surefire.InPluginVMSurefireStarter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-surefire-common Show documentation
API used in Surefire and Failsafe MOJO.
There is a newer version: 3.5.2
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.plugin.surefire;

import javax.annotation.Nonnull;

import java.lang.reflect.InvocationTargetException;
import java.util.Map;

import org.apache.maven.plugin.surefire.booterclient.Platform;
import org.apache.maven.plugin.surefire.log.api.ConsoleLogger;
import org.apache.maven.surefire.api.suite.RunResult;
import org.apache.maven.surefire.api.testset.TestSetFailedException;
import org.apache.maven.surefire.api.util.DefaultScanResult;
import org.apache.maven.surefire.booter.ClasspathConfiguration;
import org.apache.maven.surefire.booter.ProviderConfiguration;
import org.apache.maven.surefire.booter.StartupConfiguration;
import org.apache.maven.surefire.booter.SurefireExecutionException;

import static org.apache.maven.surefire.booter.ProviderFactory.invokeProvider;

/**
 * Starts the provider in the same VM as the surefire plugin.
 * 

 * This part of the booter is always guaranteed to be in the
 * same vm as the tests will be run in.
 *
 * @author Jason van Zyl
 * @author Brett Porter
 * @author Emmanuel Venisse
 * @author Dan Fabulich
 * @author Kristian Rosenvold
 */
public class InPluginVMSurefireStarter {
    private final StartupConfiguration startupConfig;
    private final StartupReportConfiguration startupReportConfig;
    private final ProviderConfiguration providerConfig;
    private final ConsoleLogger consoleLogger;
    private final Platform platform;

    public InPluginVMSurefireStarter(
            @Nonnull StartupConfiguration startupConfig,
            @Nonnull ProviderConfiguration providerConfig,
            @Nonnull StartupReportConfiguration startupReportConfig,
            @Nonnull ConsoleLogger consoleLogger,
            @Nonnull Platform platform) {
        this.startupConfig = startupConfig;
        this.startupReportConfig = startupReportConfig;
        this.providerConfig = providerConfig;
        this.consoleLogger = consoleLogger;
        this.platform = platform;
    }

    public RunResult runSuitesInProcess(@Nonnull DefaultScanResult scanResult)
            throws SurefireExecutionException, TestSetFailedException {
        // The test classloader must be constructed first to avoid issues with commons-logging until we properly
        // separate the TestNG classloader

        Map providerProperties = providerConfig.getProviderProperties();
        scanResult.writeTo(providerProperties);

        startupConfig.writeSurefireTestClasspathProperty();
        ClassLoader testClassLoader = startupConfig
                .getClasspathConfiguration()
                .toRealPath(ClasspathConfiguration.class)
                .createMergedClassLoader();

        CommonReflector surefireReflector = new CommonReflector(testClassLoader);

        Object factory = surefireReflector.createReportingReporterFactory(startupReportConfig, consoleLogger);

        try {
            return platform.isShutdown()
                    ? new RunResult(0, 0, 0, 0)
                    : invokeProvider(null, testClassLoader, factory, providerConfig, false, startupConfig, true);
        } catch (InvocationTargetException e) {
            throw new SurefireExecutionException("Exception in provider", e.getTargetException());
        }
    }
}