org.opennms.smoketest.utils.KarafShell Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smoke-test Show documentation
Smoke Test APIs for OpenNMS
The newest version!
/*
 * Licensed to The OpenNMS Group, Inc (TOG) under one or more
 * contributor license agreements.  See the LICENSE.md file
 * distributed with this work for additional information
 * regarding copyright ownership.
 *
 * TOG licenses this file to You under the GNU Affero General
 * Public License Version 3 (the "License") or (at your option)
 * any later version.  You may not use this file except in
 * compliance with the License.  You may obtain a copy of the
 * License at:
 *
 *      https://www.gnu.org/licenses/agpl-3.0.txt
 *
 * 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.opennms.smoketest.utils;

import static java.util.concurrent.TimeUnit.MINUTES;
import static java.util.concurrent.TimeUnit.SECONDS;
import static org.awaitility.Awaitility.await;

import java.io.PrintStream;
import java.net.InetSocketAddress;
import java.time.Duration;
import java.util.LinkedList;
import java.util.List;
import java.util.Objects;
import java.util.function.Function;

import org.apache.commons.lang3.tuple.Pair;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Helper class to run commands in the Karaf Shell as well as verify the log.
 *
 * @author mvrueden
 */
public class KarafShell {

    private final Logger logger = LoggerFactory.getLogger(getClass());
    private final InetSocketAddress sshAddress;
    private final String username;
    private final String password;

    public KarafShell(InetSocketAddress sshAddress) {
        this(sshAddress, "admin", "admin");
    }

    public KarafShell(InetSocketAddress sshAddress, String username, String password) {
        this.sshAddress = Objects.requireNonNull(sshAddress);
        this.username = username;
        this.password = password;
    }

    public KarafShell runCommand(final String command, Function verifyOutputFunction) {
        return runCommand(command, verifyOutputFunction, true);
    }

    /**
     * Runs the given command in the karaf shell.
     * The optional function verifies the output.
     *
     * @param command the command to run, e.g. "features:list"
     * @param verifyOutputFunction An optional function to verify the output, e.g. to check for certain log messages
     * @param displayLogs include log:display in command output
     * @return The shell itself, to run further commands.
     */
    public KarafShell runCommand(final String command, Function verifyOutputFunction, boolean displayLogs) {
        await().atMost(5, MINUTES)
                .pollInterval(5, SECONDS)
                .until(() -> runCommandOnce(command, verifyOutputFunction, displayLogs));
        return this;
    }

    public Boolean runCommandOnce(String command, Function verifyOutputFunction, boolean displayLogs) {
        try (final SshClient sshClient = new SshClient(sshAddress, username, password)) {
            final PrintStream pipe = sshClient.openShell();

            List foo = new LinkedList();
            if (command != null) {
                foo.add(command);
            }
            if (displayLogs) {
                foo.add("log:display");
            }

            var output = run(foo.toArray(new String[0]));

            // Optionally Verify Output
            boolean result = true;
            if (verifyOutputFunction != null) {
                result = verifyOutputFunction.apply(output.getLeft());
            }

            // Log output
            if (command != null) {
                logger.info(command);
            }
            if (displayLogs) {
                logger.info("log:display");
            }
            logger.info("{}", output.getLeft());

            return result;
        } catch (Exception ex) {
            logger.error("Error while executing command '{}': {}", command, ex.getMessage());
            return false;
        }
    }

    public Pair run(String... command) throws Exception {
        try (final SshClient sshClient = new SshClient(sshAddress, username, password)) {
            final PrintStream pipe = sshClient.openShell();
            for (String c : command) {
                pipe.println(c);
            }
            pipe.println("logout");

            // Wait for karaf to process the commands
            await().atMost(30, SECONDS).until(sshClient.isShellClosedCallable());

            return Pair.of(sshClient.getStdout(), sshClient.getStderr());
        }
    }

    /**
     * Is the same as runCommand(command, null.
     *
     * @see #runCommand(String, Function)
     */
    public KarafShell runCommand(String command) {
        runCommand(command, null);
        return this;
    }

    /**
     * Is the same as runCommand(null, function).
     *
     * @see #runCommand(String, Function)
     */
    public KarafShell verifyLog(Function function) {
        Objects.requireNonNull(function);
        runCommand(null, function);
        return this;
    }

    public void checkFeature(String feature, String regex, Duration wait) {
        await(String.format("waiting for feature %s state to match regex '%s'", feature, regex))
                .atMost(wait)
                .until(() ->
                        runCommandOnce("feature:list | grep " + feature,
                                output -> output.matches("(?ms).*?\\|\\s*(" + regex + ")\\s*\\|.*"), false)
                );
    }
}