org.apache.maven.surefire.booter.StartupConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of surefire-booter Show documentation
API and Facilities used by forked tests running in JVM sub-process.
There is a newer version: 3.5.2
/*
 * 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.surefire.booter;

import javax.annotation.Nonnull;

import java.util.Collections;
import java.util.List;

/**
 * Configuration that is used by the SurefireStarter but does not make it into the provider itself.
 *
 * @author Kristian Rosenvold
 */
public class StartupConfiguration {
    private static final String SUREFIRE_TEST_CLASSPATH = "surefire.test.class.path";

    private final String providerClassName;
    private final AbstractPathConfiguration classpathConfiguration;
    private final ClassLoaderConfiguration classLoaderConfiguration;
    private final ProcessCheckerType processChecker;
    private final List jpmsArguments;

    public StartupConfiguration(
            @Nonnull String providerClassName,
            @Nonnull AbstractPathConfiguration classpathConfiguration,
            @Nonnull ClassLoaderConfiguration classLoaderConfiguration,
            ProcessCheckerType processChecker,
            @Nonnull List jpmsArguments) {
        this.classpathConfiguration = classpathConfiguration;
        this.classLoaderConfiguration = classLoaderConfiguration;
        this.providerClassName = providerClassName;
        this.processChecker = processChecker;
        this.jpmsArguments = jpmsArguments;
    }

    public boolean isProviderMainClass() {
        return providerClassName.endsWith("#main");
    }

    public static StartupConfiguration inForkedVm(
            String providerClassName,
            ClasspathConfiguration classpathConfig,
            ClassLoaderConfiguration classLoaderConfig,
            ProcessCheckerType processChecker) {
        return new StartupConfiguration(
                providerClassName,
                classpathConfig,
                classLoaderConfig,
                processChecker,
                Collections.emptyList());
    }

    public AbstractPathConfiguration getClasspathConfiguration() {
        return classpathConfiguration;
    }

    public boolean isManifestOnlyJarRequestedAndUsable() {
        return classLoaderConfiguration.isManifestOnlyJarRequestedAndUsable();
    }

    public String getProviderClassName() {
        return providerClassName;
    }

    public String getActualClassName() {
        return isProviderMainClass() ? stripEnd(providerClassName, "#main") : providerClassName;
    }

    /**
     * Strip any of a supplied String from the end of a String.
     * 

     * If the strip String is {@code null}, whitespace is
     * stripped.
     *
     * @param str   the String to remove characters from
     * @param strip the String to remove
     * @return the stripped String
     */
    private static String stripEnd(String str, String strip) {
        if (str == null) {
            return null;
        }
        int end = str.length();

        if (strip == null) {
            while ((end != 0) && Character.isWhitespace(str.charAt(end - 1))) {
                end--;
            }
        } else {
            while (end != 0 && strip.indexOf(str.charAt(end - 1)) != -1) {
                end--;
            }
        }
        return str.substring(0, end);
    }

    public ClassLoaderConfiguration getClassLoaderConfiguration() {
        return classLoaderConfiguration;
    }

    public boolean isShadefire() {
        return providerClassName.startsWith("org.apache.maven.shadefire.surefire");
    }

    public void writeSurefireTestClasspathProperty() {
        getClasspathConfiguration().getTestClasspath().writeToSystemProperty(SUREFIRE_TEST_CLASSPATH);
    }

    public ProcessCheckerType getProcessChecker() {
        return processChecker;
    }

    public List getJpmsArguments() {
        return jpmsArguments;
    }
}