org.sonarsource.nodejs.ProcessWrapper Maven / Gradle / Ivy
/*
* SonarQube JavaScript Plugin
* Copyright (C) 2011-2022 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonarsource.nodejs;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import java.util.function.Consumer;
import javax.annotation.CheckForNull;
import org.sonar.api.scanner.ScannerSide;
import org.sonarsource.api.sonarlint.SonarLintSide;
/**
* This interface provides thin wrapper around Java ProcessBuilder and related APIs. The goal is to make them testable
* across different OS flavors.
*
* It also handles the issue of consuming stdout and stderr of started process in an asynchronous way using a daemon
* thread
*/
@ScannerSide
@SonarLintSide(lifespan = SonarLintSide.MULTIPLE_ANALYSES)
public interface ProcessWrapper {
Process startProcess(List commandLine, Map env, Consumer outputConsumer,
Consumer errorConsumer) throws IOException;
boolean waitFor(Process process, long timeout, TimeUnit unit) throws InterruptedException;
void interrupt();
void destroyForcibly(Process process);
boolean isMac();
boolean isWindows();
@CheckForNull
String getenv(String name);
int exitValue(Process process);
}