io.hakbot.providers.shell.ShellProvider.java Source code

Introduction

Here is the source code for io.hakbot.providers.shell.ShellProvider.java

Source

/*
 * This file is part of Hakbot Origin Controller.
 *
 * Hakbot Origin Controller is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any
 * later version.
 *
 * Hakbot Origin Controller 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 General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * Hakbot Origin Controller. If not, see http://www.gnu.org/licenses/.
 */
package io.hakbot.providers.shell;

import alpine.logging.Logger;
import io.hakbot.controller.model.Job;
import io.hakbot.controller.model.JobArtifact;
import io.hakbot.controller.workers.JobException;
import io.hakbot.controller.workers.State;
import io.hakbot.providers.BaseProvider;
import io.hakbot.providers.SynchronousProvider;
import io.hakbot.util.JsonUtil;
import org.apache.commons.io.IOUtils;
import javax.json.JsonObject;
import java.io.IOException;
import java.io.InputStream;

public class ShellProvider extends BaseProvider implements SynchronousProvider {

    // Setup logging
    private static final Logger LOGGER = Logger.getLogger(ShellProvider.class);
    private Process process;
    private String command;

    public boolean initialize(Job job) {
        final JsonObject payload = JsonUtil.toJsonObject(getProviderPayload(job).getContents());
        if (!JsonUtil.requiredParams(payload, "command")) {
            addProcessingMessage(job, "Invalid request. Expected parameters: [command]");
            return false;
        }
        command = JsonUtil.getString(payload, "command");
        return true;
    }

    public boolean process(Job job) {
        try (InputStream inputStream = process.getInputStream();
                InputStream errorStream = process.getErrorStream()) {

            final ProcessBuilder pb = new ProcessBuilder(command.split(" "));
            process = pb.start();
            final int exitCode = process.waitFor();
            final byte[] stdout = IOUtils.toByteArray(inputStream);
            final byte[] stderr = IOUtils.toByteArray(errorStream);
            if (LOGGER.isDebugEnabled()) {
                LOGGER.debug("STDOUT:");
                LOGGER.debug(new String(stdout));
                LOGGER.debug("STDERR:");
                LOGGER.debug(new String(stderr));
            }

            if (exitCode == 0) {
                addArtifact(job, JobArtifact.Type.PROVIDER_RESULT, JobArtifact.MimeType.PLAIN_TEXT.value(), stdout,
                        "Console-STDOUT-" + job.getUuid() + ".txt");
            } else {
                if (stdout.length == 0) {
                    addArtifact(job, JobArtifact.Type.PROVIDER_RESULT, JobArtifact.MimeType.PLAIN_TEXT.value(),
                            stderr, "Console-STDERR-" + job.getUuid() + ".txt");
                } else {
                    addArtifact(job, JobArtifact.Type.PROVIDER_RESULT, JobArtifact.MimeType.PLAIN_TEXT.value(),
                            stdout, "Console-STDOUT-" + job.getUuid() + ".txt");
                }
                throw new JobException(exitCode);
            }
            return true;
        } catch (IOException | InterruptedException e) {
            addProcessingMessage(job, "Could not execute job.");
            addProcessingMessage(job, e.getMessage());
        } catch (JobException e) {
            addProcessingMessage(job, "Job terminated abnormally. Exit code: " + e.getExitCode());
            addProcessingMessage(job, e.getMessage());
        }
        return false;
    }

    public boolean cancel(Job job) {
        updateState(job, State.CANCELED);
        process.destroy();
        if (process.isAlive()) {
            process.destroyForcibly();
        }
        return !process.isAlive();
    }

    public String getName() {
        return "Shell";
    }

    public String getDescription() {
        return "Executes a shell command or script and captures the output from STDOUT/STDERR.";
    }

}