com.lazerycode.jmeter.testrunner.ResultScanner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmeter-maven-plugin Show documentation
A plugin to allow you to run JMeter tests with Maven.
There is a newer version: 3.8.0
package com.lazerycode.jmeter.testrunner;

import com.fasterxml.jackson.databind.MappingIterator;
import com.fasterxml.jackson.dataformat.csv.CsvMapper;
import com.fasterxml.jackson.dataformat.csv.CsvSchema;
import org.apache.maven.plugin.MojoExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.util.Map;
import java.util.Scanner;
import java.util.regex.Pattern;

/**
 * Handles checking a JMeter results file in XML format for errors and failures.
 *
 * @author Jon Roberts
 */
public class ResultScanner implements IResultScanner {
    private static final Logger LOGGER = LoggerFactory.getLogger(ResultScanner.class);
    private static final String CSV_REQUEST_FAILURE = "false";
    private static final String CSV_REQUEST_SUCCESS = "true";
    private static final String XML_REQUEST_FAILURE_PATTERN = "s=\"false\"";
    private static final String XML_REQUEST_SUCCESS_PATTERN = "s=\"true\"";
    private static final CsvMapper CSV_MAPPER = new CsvMapper();
    private static final int DEFAULT_BUFFER_SIZE = 8 * 1024;
    private final boolean countFailures;
    private final boolean countSuccesses;
    private int failureCount = 0;
    private int successCount = 0;
    private boolean csv;
    private String format;

    public ResultScanner(boolean countSuccesses, boolean countFailures, boolean isCsv) {
        this.countFailures = countFailures;
        this.countSuccesses = countSuccesses;
        this.csv = isCsv;
        this.format = this.csv ? "CSV" : "XML";
    }

    public ResultScanner(boolean countSuccesses, boolean countFailures) {
        this(countSuccesses, countFailures, false);
    }

    private static char lookForDelimiter(String line) {
        for (char ch : line.toCharArray()) {
            if (!Character.isLetter(ch)) {
                return ch;
            }
        }
        throw new IllegalStateException("Cannot find delimiter in header " + line);
    }

    /**
     * Work out how to parse the file (if at all)
     *
     * @param file File to parse
     * @throws MojoExecutionException MojoExecutionException
     */
    public void parseResultFile(File file) throws MojoExecutionException {
        if (!file.exists()) {
            throw new MojoExecutionException("Unable to find " + file.getAbsolutePath());
        }
        LOGGER.info(" ");
        LOGGER.info("Parsing results file '{}' as type: {}", file, format);
        if (countFailures) {
            if (csv) {
                failureCount = failureCount + scanCsvForValue(file, CSV_REQUEST_FAILURE);
            } else {
                failureCount = failureCount + scanXmlForPattern(file, XML_REQUEST_FAILURE_PATTERN);
            }
            LOGGER.info("Number of failures in '{}': {}", file.getName(), failureCount);
        }
        if (countSuccesses) {
            if (csv) {
                successCount = successCount + scanCsvForValue(file, CSV_REQUEST_SUCCESS);
            } else {
                successCount = successCount + scanXmlForPattern(file, XML_REQUEST_SUCCESS_PATTERN);
            }
            LOGGER.info("Number of successes in '{}': {}", file.getName(), successCount);
        }
    }

    /**
     * Scans a csv file for the given pattern and returns the number of times
     * the pattern appears in the success column. This function assumes that the
     * csv will always include the header row.
     *
     * @param file             The file to parse
     * @param searchedForValue The pattern to look for
     * @return The number of times the pattern appears in the success column
     * @throws MojoExecutionException When an error occurs while reading the file
     */
    private int scanCsvForValue(File file, String searchedForValue) throws MojoExecutionException {
        int numberOfMatches = 0;
        try {
            char separator = computeSeparator(file);
            CsvSchema schema = CsvSchema.emptySchema().withHeader().withColumnSeparator(separator);
            try (FileReader fr = new FileReader(file);
                 BufferedReader reader = new BufferedReader(fr, DEFAULT_BUFFER_SIZE)) {
                MappingIterator> it = CSV_MAPPER.readerFor(Map.class)
                        .with(schema)
                        .readValues(reader);
                while (it.hasNext()) {
                    Map row = it.next();
                    String successValue = row.get("success");
                    if (searchedForValue.equals(successValue)) {
                        numberOfMatches++;
                    }
                }
            }
        } catch (IOException e) {
            throw new MojoExecutionException("An unexpected error occurred while reading file " + file.getAbsolutePath(), e);
        }

        return numberOfMatches;
    }

    private char computeSeparator(File file) throws java.io.IOException {
        try (FileReader fr = new FileReader(file);
             BufferedReader reader = new BufferedReader(fr, DEFAULT_BUFFER_SIZE)) {
            String line = reader.readLine();
            if (line != null) {
                return lookForDelimiter(line);
            }
            throw new IllegalArgumentException("No line read from file " + file.getAbsolutePath());
        }
    }

    /**
     * Scans an xml file for the given pattern and returns the number of times the
     * pattern appears in the xml.
     *
     * @param file            The file to parse
     * @param patternAsString The pattern to look for
     * @return The number of times the pattern appears in the xml file
     * @throws MojoExecutionException When the file is not found
     */
    private int scanXmlForPattern(File file, String patternAsString) throws MojoExecutionException {
        int patternCount = 0;
        Pattern pattern = Pattern.compile(patternAsString);
        try (Scanner resultFileScanner = new Scanner(file)) {
            while (resultFileScanner.findWithinHorizon(pattern, 0) != null) {
                patternCount++;
            }
        } catch (IOException e) {
            throw new MojoExecutionException("An unexpected error occured while reading file " + file.getAbsolutePath(), e);
        }

        return patternCount;
    }

    /**
     * @return failureCount
     */
    @Override
    public int getFailureCount() {
        return this.failureCount;
    }

    /**
     * @return failureCount
     */
    @Override
    public int getSuccessCount() {
        return this.successCount;
    }
}