com.powsybl.computation.local.AbstractLocalCommandExecutor Maven / Gradle / Ivy

/**
 * Copyright (c) 2017, RTE (http://www.rte-france.com)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 * SPDX-License-Identifier: MPL-2.0
 */
package com.powsybl.computation.local;

import java.io.IOException;
import java.nio.file.Path;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;

public abstract class AbstractLocalCommandExecutor implements LocalCommandExecutor {

    protected final Map processMap = new HashMap<>();
    protected final ReadWriteLock lock = new ReentrantReadWriteLock();

    protected static final String NON_ZERO_LOG_PATTERN = "Command '{}' has failed (exitValue={})";

    @Override
    public void stop(Path workingDir) {
        Process process = getProcessByWorkingDir(workingDir);
        if (process != null) {
            process.destroy(); // kill -15 PID
        }
    }

    @Override
    public void stopForcibly(Path workingDir) throws InterruptedException {
        Process process = getProcessByWorkingDir(workingDir);
        if (process != null) {
            Process killProcess = process.destroyForcibly(); // kill -9 PID
            killProcess.waitFor();
        }
    }

    private Process getProcessByWorkingDir(Path workingDir) {
        try {
            lock.readLock().lock();
            return processMap.get(workingDir);
        } finally {
            lock.readLock().unlock();
        }
    }

    protected int execute(List cmdLs, Path workingDir, Path outFile, Path errFile, long timeout) throws IOException, InterruptedException {
        ProcessBuilder.Redirect outRedirect = ProcessBuilder.Redirect.appendTo(outFile.toFile());
        ProcessBuilder.Redirect errRedirect = ProcessBuilder.Redirect.appendTo(errFile.toFile());
        Process process = new ProcessBuilder(cmdLs)
                .directory(workingDir.toFile())
                .redirectOutput(outRedirect)
                .redirectError(errRedirect)
                .start();

        try {
            lock.writeLock().lock();
            processMap.put(workingDir, process);
        } finally {
            lock.writeLock().unlock();
        }

        int exitCode;
        if (timeout <= 0) {
            exitCode = process.waitFor();
        } else {
            exitCode = ProcessHelper.runWithTimeout(timeout, process);
        }

        if (exitCode != 0) {
            nonZeroLog(cmdLs, exitCode);
        }
        return exitCode;
    }

    abstract void nonZeroLog(List cmdLs, int exitCode);
}