src/test/java/org/apache/commons/exec/issues/Exec65Test.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.commons.exec.issues;

import org.apache.commons.exec.CommandLine;
import org.apache.commons.exec.DefaultExecutor;
import org.apache.commons.exec.ExecuteException;
import org.apache.commons.exec.ExecuteWatchdog;
import org.apache.commons.exec.OS;
import org.apache.commons.exec.PumpStreamHandler;
import org.apache.commons.exec.TestUtil;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TestName;

import java.io.File;

import static org.junit.Assert.assertTrue;

/**
 * Test to show that watchdog can destroy 'sudo' and 'sleep'.
 *
 * @see <a href="https://issues.apache.org/jira/browse/EXEC-65">EXEC-65</a>
 */
public class Exec65Test {

    private static final int TEST_TIMEOUT = 15000;
    private static final int WATCHDOG_TIMEOUT = 3000;
    private static final String OS_NAME = System.getProperty("os.name");

    private final File testDir = new File("src/test/scripts");

    @Rule public TestName name = new TestName();

    @Test(expected = ExecuteException.class, timeout = TEST_TIMEOUT)
    public void testExec65WitSleepUsingSleepCommandDirectly() throws Exception {

        if (OS.isFamilyUnix()) {
            final ExecuteWatchdog watchdog = new ExecuteWatchdog(WATCHDOG_TIMEOUT);
            final DefaultExecutor executor = new DefaultExecutor();
            final CommandLine command = new CommandLine("sleep");
            command.addArgument("60");
            executor.setStreamHandler(new PumpStreamHandler(System.out, System.err));
            executor.setWatchdog(watchdog);

            executor.execute(command);
        } else {
            String msg = String.format("The test '%s' does not support the following OS : %s", name.getMethodName(), OS_NAME);
            System.out.println(msg);
            throw new ExecuteException(msg, 0);
        }
    }

    @Test(expected = ExecuteException.class, timeout = TEST_TIMEOUT)
    public void testExec65WithSleepUsingShellScript() throws Exception {

        final DefaultExecutor executor = new DefaultExecutor();
        executor.setStreamHandler(new PumpStreamHandler(System.out, System.err));
        executor.setWatchdog(new ExecuteWatchdog(WATCHDOG_TIMEOUT));
        final CommandLine command = new CommandLine(TestUtil.resolveScriptForOS(testDir + "/sleep"));

        executor.execute(command);
    }

    /**
     * This is the original code snippet from the JIRA to show that
     * killing the process actually works with JDK only but it does
     * not re-direct any streams.
     */
    @Test(timeout = TEST_TIMEOUT)
    public void testExec65WithSleepUsingShellScriptAndJDKOnly() throws Exception {

        Process process = Runtime.getRuntime().exec(TestUtil.resolveScriptForOS(testDir + "/sleep").getAbsolutePath());
        Thread.sleep(WATCHDOG_TIMEOUT);

        process.destroy();
        while (process.isAlive()) {
            Thread.sleep(100);
        }

        assertTrue(process.exitValue() != 0);
    }

    /**
     * Please note that this tests make assumptions about the environment. It assumes
     * that user "root" exists and that the current user is not a "sudoer" already
     * (thereby requiring a password).
     */
    @Test(expected = ExecuteException.class, timeout = TEST_TIMEOUT)
    public void testExec65WithSudoUsingShellScript() throws Exception {

        if (OS.isFamilyUnix()) {
            final DefaultExecutor executor = new DefaultExecutor();
            executor.setStreamHandler(new PumpStreamHandler(System.out, System.err, System.in));
            executor.setWatchdog(new ExecuteWatchdog(WATCHDOG_TIMEOUT));
            final CommandLine command = new CommandLine(TestUtil.resolveScriptForOS(testDir + "/issues/exec-65"));

            executor.execute(command);
        } else {
            String msg = String.format("The test '%s' does not support the following OS : %s", name.getMethodName(), OS_NAME);
            System.out.println(msg);
            throw new ExecuteException(msg, 0);
        }
    }
}