src/components/src/test/java/org/apache/jmeter/visualizers/backend/SamplerMetricFixedModeTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.apache.jmeter.visualizers.backend;

import static org.junit.jupiter.api.Assertions.assertEquals;

import java.util.Arrays;

import org.apache.jmeter.control.TransactionController;
import org.apache.jmeter.samplers.SampleResult;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

public class SamplerMetricFixedModeTest {

    private static final int DEFAULT_ELAPSED_TIME = 1_000;
    private static final double ALLOWED_DELTA = 25.0;

    @BeforeEach
    @SuppressWarnings("deprecation")
    public void initMode() throws Exception {
        SamplerMetric.setDefaultWindowMode(WindowMode.FIXED);
    }

    @Test
    public void checkResetOkAndAllStats() throws Exception {
        SamplerMetric metric = new SamplerMetric();
        metric.add(createSampleResult(true));
        assertEquals(DEFAULT_ELAPSED_TIME, metric.getOkMaxTime(), 0.001, "Before reset  ok.max");
        assertEquals(DEFAULT_ELAPSED_TIME, metric.getAllMaxTime(), 0.001, "Before reset all.max");
        assertEquals(1, metric.getHits(), 0.0, "Before reset failure");
        assertEquals(1000, metric.getSentBytes(), 0.0, "Before reset sent bytes");
        assertEquals(2000, metric.getReceivedBytes(), 0.0, "Before reset received bytes");

        // In fixed mode DescriptiveStatistics are not reset, just sliding on a window
        metric.resetForTimeInterval();

        assertEquals(DEFAULT_ELAPSED_TIME, metric.getOkMaxTime(), 0.001, "After reset in FIXED mode ok.max");
        assertEquals(DEFAULT_ELAPSED_TIME, metric.getAllMaxTime(), 0.0, "After reset in FIXED mode all.max");
        assertEquals(0, metric.getHits(), 0.0, "After reset failure");
        assertEquals(0, metric.getSentBytes(), 0.0, "After reset sent bytes");
        assertEquals(0, metric.getReceivedBytes(), 0.0, "After reset received bytes");
    }

    @Test
    public void checkResetKoAndAllStats() throws Exception {
        SamplerMetric metric = new SamplerMetric();
        metric.add(createSampleResult(false));
        assertEquals(DEFAULT_ELAPSED_TIME, metric.getKoMaxTime(), 0.001, "Before reset  ko.max");
        assertEquals(DEFAULT_ELAPSED_TIME, metric.getAllMaxTime(), 0.001, "Before reset all.max");
        assertEquals(1, metric.getFailures(), 0.0, "Before reset failure");
        assertEquals(1000, metric.getSentBytes(), 0.0, "Before reset sent bytes");
        assertEquals(2000, metric.getReceivedBytes(), 0.0, "Before reset received bytes");

        // In fixed mode DescriptiveStatistics are not reset, just sliding on a window
        metric.resetForTimeInterval();

        assertEquals(DEFAULT_ELAPSED_TIME, metric.getKoMaxTime(), 0.0, "After reset in FIXED mode  ko.max");
        assertEquals(DEFAULT_ELAPSED_TIME, metric.getAllMaxTime(), 0.0, "After reset in FIXED mode all.max");
        assertEquals(0, metric.getFailures(), 0.001, "After reset failure");
        assertEquals(0, metric.getSentBytes(), 0.0, "After reset sent bytes");
        assertEquals(0, metric.getReceivedBytes(), 0.0, "After reset received bytes");
    }

    @Test
    public void checkErrorsDetailStat() {
        SamplerMetric metric = new SamplerMetric();
        metric.add(createSampleResult("400", "bad request"));
        metric.add(createSampleResult("400", "Bad Request "));
        metric.add(createSampleResult("500", "Internal Server Error"));
        ErrorMetric error = new ErrorMetric(createSampleResult("400", "Bad request"));
        assertEquals(2, metric.getErrors().get(error), 0.0, "Count for '400 - bad request' error ");
        error = new ErrorMetric(createSampleResult("500", "Internal Server Error"));
        assertEquals(1, metric.getErrors().get(error), 0.0, "Count for '500 - Internal Server Error' error ");
    }

    private SampleResult createSampleResult(boolean success) {
        SampleResult result = new SampleResult();
        result.setSuccessful(success);
        result.setSampleCount(1);
        result.setErrorCount(success ? 0 : 1);
        result.sampleStart();
        result.setEndTime(result.getStartTime() + DEFAULT_ELAPSED_TIME);
        result.setSentBytes(1000);
        result.setBytes(2000L);
        return result;
    }

    private SampleResult createSampleResult(String errorCode, String errorMessage) {
        SampleResult result = createSampleResult(false);
        result.setResponseCode(errorCode);
        result.setResponseMessage(errorMessage);
        return result;
    }

    private SampleResult createSampleResultWithSubresults(boolean success) {
        SampleResult result = new SampleResult();
        result.sampleStart();
        result.setSampleCount(1);
        result.setErrorCount(success ? 0 : 1);
        result.setSuccessful(success);
        result.addSubResult(createSampleResult(success));
        result.addSubResult(createSampleResult(success));
        result.setEndTime(Arrays.stream(result.getSubResults()).mapToLong(SampleResult::getEndTime).max().orElse(0));
        result.setBytes(Arrays.stream(result.getSubResults()).mapToLong(SampleResult::getBytesAsLong).sum());
        result.setSentBytes(Arrays.stream(result.getSubResults()).mapToLong(SampleResult::getSentBytes).sum());
        result.setResponseMessage("Number of samples in transaction : "); // This is a constant in TransactionController
        return result;
    }

    @Test
    public void checkAddCumulatedOk() throws Exception {
        SamplerMetric metric = new SamplerMetric();
        SampleResult sample = createSampleResultWithSubresults(true);
        assertEquals(Boolean.TRUE, TransactionController.isFromTransactionController(sample), "We are recognized as a TransactionController made sample");
        metric.addCumulated(sample);
        assertEquals(DEFAULT_ELAPSED_TIME, metric.getOkMaxTime(), ALLOWED_DELTA, "Before reset  ok.max");
        assertEquals(DEFAULT_ELAPSED_TIME, metric.getAllMaxTime(), ALLOWED_DELTA, "Before reset all.max");
        assertEquals(2, metric.getHits(), 0.0, "Before reset hits");
        assertEquals(2000, metric.getSentBytes(), 0.0, "Before reset sent bytes");
        assertEquals(4000, metric.getReceivedBytes(), 0.0, "Before reset received bytes");

        metric.resetForTimeInterval();

        assertEquals(DEFAULT_ELAPSED_TIME, metric.getOkMaxTime(), ALLOWED_DELTA, "After reset in TIMED mode ok.max");
        assertEquals(DEFAULT_ELAPSED_TIME, metric.getAllMaxTime(), ALLOWED_DELTA, "After reset in TIMED mode all.max");
        assertEquals(0, metric.getHits(), 0.0, "After reset hits");
        assertEquals(0, metric.getSentBytes(), 0.0, "After reset sent bytes");
        assertEquals(0, metric.getReceivedBytes(), 0.0, "After reset received bytes");
    }

    @Test
    public void checkAddCumulatedKo() throws Exception {
        SamplerMetric metric = new SamplerMetric();
        SampleResult sample = createSampleResultWithSubresults(false);
        assertEquals(Boolean.TRUE, TransactionController.isFromTransactionController(sample), "We are recognized as a TransactionController made sample");
        metric.addCumulated(sample);
        assertEquals(DEFAULT_ELAPSED_TIME, metric.getKoMaxTime(), ALLOWED_DELTA, "Before reset  ko.max");
        assertEquals(DEFAULT_ELAPSED_TIME, metric.getAllMaxTime(), ALLOWED_DELTA, "Before reset all.max");
        assertEquals(1, metric.getFailures(), 0.0, "Before reset failures");
        assertEquals(2000, metric.getSentBytes(), 0.0, "Before reset sent bytes");
        assertEquals(4000, metric.getReceivedBytes(), 0.0, "Before reset received bytes");

        metric.resetForTimeInterval();

        assertEquals(DEFAULT_ELAPSED_TIME, metric.getKoMaxTime(), ALLOWED_DELTA, "After reset in TIMED mode ko.max");
        assertEquals(DEFAULT_ELAPSED_TIME, metric.getAllMaxTime(), ALLOWED_DELTA, "After reset in TIMED mode all.max");
        assertEquals(0, metric.getFailures(), 0.0, "After reset failures");
        assertEquals(0, metric.getSentBytes(), 0.0, "After reset sent bytes");
        assertEquals(0, metric.getReceivedBytes(), 0.0, "After reset received bytes");
    }
}