src/test/java/org/apache/maven/shared/invoker/DefaultInvokerTest.java

/*
 * 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.shared.invoker;

import java.io.File;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.Arrays;
import java.util.Properties;

import org.apache.maven.shared.utils.Os;
import org.apache.maven.shared.utils.StringUtils;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.DisabledOnOs;
import org.junit.jupiter.api.condition.OS;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

class DefaultInvokerTest {

    private Invoker invoker = newInvoker();
    private InvocationRequest request = new DefaultInvocationRequest();

    @BeforeEach
    public void setUp() {
        request.setDebug(true);
        request.setProperties(getProperties());
        request.setBatchMode(true);
    }

    @Test
    @SuppressWarnings("deprecation")
    void testBuildShouldSucceed() throws MavenInvocationException, URISyntaxException {
        File basedir = getBasedirForBuild();
        request.setBaseDirectory(basedir);
        request.setGoals(Arrays.asList("clean", "package"));

        InvocationResult result = invoker.execute(request);

        assertEquals(0, result.getExitCode());
    }

    @Test
    void testBuildShouldFail() throws MavenInvocationException, URISyntaxException {
        File basedir = getBasedirForBuild();
        request.setBaseDirectory(basedir);
        request.addArgs(Arrays.asList("clean", "package"));

        InvocationResult result = invoker.execute(request);

        assertEquals(1, result.getExitCode());
    }

    @Test
    void testBuildShouldTimeout() throws MavenInvocationException, URISyntaxException {
        File basedir = getBasedirForBuild();
        request.setBaseDirectory(basedir);
        request.addArgs(Arrays.asList("clean", "package"));
        request.setTimeoutInSeconds(4);

        InvocationResult result = invoker.execute(request);

        // We check the exception to be sure the failure is based on timeout.
        assertTrue(result.getExecutionException().getMessage().contains("timed out"));

        // WARN - Windows issue MSHARED-867 - Maven and child surefire test process stays alive on Windows
        // workaround implemented in this test to timeout test after 15 sec
        // please also check timeout logic in maven-shared-utils

        // exitCode can't be used because in case of a timeout it's not correctly
        // set in DefaultInvoker. Need to think about this.
        // assertEquals( 1, result.getExitCode() );
    }

    @Test
    void testSpacePom() throws Exception {
        File basedir = getBasedirForBuild();
        request.setBaseDirectory(basedir);
        request.setPomFileName("pom with spaces.xml");
        request.addArg("clean");

        InvocationResult result = invoker.execute(request);

        assertEquals(0, result.getExitCode());
    }

    @Test
    void testSpaceAndSpecialCharPom() throws Exception {
        File basedir = getBasedirForBuild();
        request.setBaseDirectory(basedir);
        request.setPomFileName("pom with spaces & special char.xml");
        request.addArg("clean");

        InvocationResult result = invoker.execute(request);

        assertEquals(0, result.getExitCode());
    }

    @Test
    void testSpaceSettings() throws Exception {
        File basedir = getBasedirForBuild();
        request.setBaseDirectory(basedir);
        request.setUserSettingsFile(new File(basedir, "settings with spaces.xml"));
        request.addArg("validate");

        InvocationResult result = invoker.execute(request);

        assertEquals(0, result.getExitCode());
    }

    @Test
    void testSpaceLocalRepo() throws Exception {
        File basedir = getBasedirForBuild();
        request.setBaseDirectory(basedir);
        request.setLocalRepositoryDirectory(new File(basedir, "repo with spaces"));
        request.addArg("validate");

        InvocationResult result = invoker.execute(request);

        assertEquals(0, result.getExitCode());
    }

    @Test
    void testSpaceProperties() throws Exception {
        File basedir = getBasedirForBuild();
        request.setBaseDirectory(basedir);
        Properties props = getProperties();
        props.setProperty("key", "value with spaces");
        props.setProperty("key with spaces", "value");
        request.setProperties(props);
        request.addArg("validate");

        InvocationResult result = invoker.execute(request);

        assertEquals(0, result.getExitCode());
    }

    @Test
    void testPomOutsideProject() throws Exception {
        File basedir = getBasedirForBuild();
        request.setBaseDirectory(basedir);
        File pom = new File(basedir, "temp/pom.xml");
        request.setPomFile(pom);
        request.addArg("validate");

        InvocationResult result = invoker.execute(request);

        assertEquals(0, result.getExitCode());
    }

    @Test
    void testMavenWrapperInProject() throws Exception {
        File basedir = getBasedirForBuild();
        request.setBaseDirectory(basedir);
        request.addArg("test-wrapper-goal");
        request.setMavenExecutable(new File("./mvnw"));

        final StringBuilder outlines = new StringBuilder();
        request.setOutputHandler(outlines::append);

        InvocationResult result = invoker.execute(request);

        assertEquals(0, result.getExitCode());
        if (Os.isFamily(Os.FAMILY_WINDOWS)) {
            assertEquals("Windows Wrapper executed", outlines.toString());
        } else {
            assertEquals("Unix Wrapper executed", outlines.toString());
        }
    }

    @Test
    @DisabledOnOs(OS.WINDOWS) // mvn 3.6.3 and windows ...
    void notInheritEnvVariables() throws Exception {

        // ensure that we have env variable in current process
        assertEquals("test-env-value", System.getenv("INVOKER_TEST_ENV_1"));

        File basedir = getBasedirForBuild();
        request.setBaseDirectory(basedir);
        request.addArg("initialize");
        request.setShellEnvironmentInherited(false);
        request.addShellEnvironment("INVOKER_TEST_ENV_2", "test-env-value-2");
        // Maven 3.6.3 required JAVA_HOME
        request.addShellEnvironment("JAVA_HOME", System.getProperty("java.home"));

        final StringBuilder outlines = new StringBuilder();
        request.setOutputHandler(line -> outlines.append(line).append(System.lineSeparator()));

        InvocationResult result = invoker.execute(request);

        String output = outlines.toString();
        assertEquals(
                0,
                result.getExitCode(),
                () -> "Maven exit code: " + result.getExitCode() + System.lineSeparator() + output.trim());
        assertFalse(output.contains("INVOKER_TEST_ENV_1"));
        assertTrue(output.contains("INVOKER_TEST_ENV_2=test-env-value-2"));
    }

    private Invoker newInvoker() {
        Invoker invoker = new DefaultInvoker();

        invoker.setMavenHome(findMavenHome());

        InvokerLogger logger = new SystemOutLogger();
        logger.setThreshold(InvokerLogger.DEBUG);
        invoker.setLogger(logger);

        invoker.setLocalRepositoryDirectory(findLocalRepo());

        return invoker;
    }

    private File findMavenHome() {
        String mavenHome = System.getProperty("maven.home");

        if (mavenHome == null) {
            throw new IllegalStateException(
                    "Cannot find Maven application " + "directory. Specify 'maven.home' system property");
        }

        return new File(mavenHome);
    }

    private File findLocalRepo() {
        String basedir = System.getProperty("maven.repo.local", "");

        if (basedir != null && !basedir.isEmpty()) {
            return new File(basedir);
        }

        return null;
    }

    private File getBasedirForBuild() throws URISyntaxException {
        StackTraceElement element = new NullPointerException().getStackTrace()[1];
        String methodName = element.getMethodName();

        String dirName = StringUtils.addAndDeHump(methodName);

        ClassLoader cloader = Thread.currentThread().getContextClassLoader();
        URL dirResource = cloader.getResource(dirName);

        if (dirResource == null) {
            throw new IllegalStateException("Project: " + dirName + " for test method: " + methodName + " is missing.");
        }

        return new File(new URI(dirResource.toString()).getPath());
    }

    private Properties getProperties() {
        Properties properties = new Properties();
        properties.put("maven.compiler.source", "1.8");
        properties.put("maven.compiler.target", "1.8");

        String httpProtocols = System.getProperty("https.protocols");
        if (httpProtocols != null) {
            properties.put("https.protocols", httpProtocols);
        }
        return properties;
    }
}