src/components/src/test/java/org/apache/jmeter/config/TestCVSDataSet.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.config;

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

import java.io.IOException;

import org.apache.jmeter.junit.JMeterTestCase;
import org.apache.jmeter.services.FileServer;
import org.apache.jmeter.threads.JMeterContext;
import org.apache.jmeter.threads.JMeterContextService;
import org.apache.jmeter.threads.JMeterVariables;
import org.apache.jorphan.test.JMeterSerialTest;
import org.apache.jorphan.util.JMeterStopThreadException;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

public class TestCVSDataSet extends JMeterTestCase implements JMeterSerialTest {

    private JMeterVariables threadVars;

    @BeforeEach
    public void setUp(){
        JMeterContext jmcx = JMeterContextService.getContext();
        jmcx.setVariables(new JMeterVariables());
        threadVars = jmcx.getVariables();
        threadVars.put("b", "value");
    }

    @AfterEach
    public void tearDown() throws IOException {
        // Use of singleton requires this test run in serial
        FileServer.getFileServer().closeFiles();
    }

    @Test
    public void testopen() throws Exception {
        CSVDataSet csv = new CSVDataSet();
        csv.setFilename("No.such.filename");
        csv.setVariableNames("a,b,c");
        csv.setDelimiter(",");
        try {
            csv.iterationStart(null);
            fail("Bad filename in CSVDataSet -> IllegalArgumentException: File No.such.filename must exist and be readable");
        } catch (IllegalArgumentException ignored) {
            assertEquals("File No.such.filename must exist and be readable", ignored.getMessage(), "Bad filename in CSVDataSet -> exception");
        }

        csv = new CSVDataSet();
        csv.setFilename(findTestPath("testfiles/testempty.csv"));
        csv.setVariableNames("a,b,c");
        csv.setDelimiter(",");

        csv.iterationStart(null);
        assertEquals("", threadVars.get("a"));
        assertEquals("b1", threadVars.get("b"));
        assertEquals("c1", threadVars.get("c"));

        csv.iterationStart(null);
        assertEquals("a2", threadVars.get("a"));
        assertEquals("", threadVars.get("b"));
        assertEquals("c2", threadVars.get("c"));

        csv.iterationStart(null);
        assertEquals("a3", threadVars.get("a"));
        assertEquals("b3", threadVars.get("b"));
        assertEquals("", threadVars.get("c"));


        csv.iterationStart(null);
        assertEquals("a4", threadVars.get("a"));
        assertEquals("b4", threadVars.get("b"));
        assertEquals("c4", threadVars.get("c"));

        csv.iterationStart(null); // Restart file
        assertEquals("", threadVars.get("a"));
        assertEquals("b1", threadVars.get("b"));
        assertEquals("c1", threadVars.get("c"));
    }

    @Test
    public void testutf8() throws Exception {

        CSVDataSet csv = new CSVDataSet();
        csv.setFilename(findTestPath("testfiles/testutf8.csv"));
        csv.setVariableNames("a,b,c,d");
        csv.setDelimiter(",");
        csv.setQuotedData( true );
        csv.setFileEncoding( "UTF-8" );

        csv.iterationStart(null);
        assertEquals("a1", threadVars.get("a"));
        assertEquals("b1", threadVars.get("b"));
        assertEquals("\u00e71", threadVars.get("c"));
        assertEquals("d1", threadVars.get("d"));

        csv.iterationStart(null);
        assertEquals("a2", threadVars.get("a"));
        assertEquals("b2", threadVars.get("b"));
        assertEquals("\u00e72", threadVars.get("c"));
        assertEquals("d2", threadVars.get("d"));

        csv.iterationStart(null);
        assertEquals("a3", threadVars.get("a"));
        assertEquals("b3", threadVars.get("b"));
        assertEquals("\u00e73", threadVars.get("c"));
        assertEquals("d3", threadVars.get("d"));

        csv.iterationStart(null);
        assertEquals("a4", threadVars.get("a"));
        assertEquals("b4", threadVars.get("b"));
        assertEquals("\u00e74", threadVars.get("c"));
        assertEquals("d4", threadVars.get("d"));
    }

    // Test CSV file with a header line
    @Test
    public void testHeaderOpen(){
        CSVDataSet csv = new CSVDataSet();
        csv.setFilename(findTestPath("testfiles/testheader.csv"));
        csv.setDelimiter("|");
        assertNull(csv.getVariableNames());
        csv.iterationStart(null);
        assertNull(threadVars.get("a"));
        assertEquals("a1", threadVars.get("A"));
        assertEquals("b1", threadVars.get("B"));
        assertEquals("c1", threadVars.get("C"));
        assertEquals("d1", threadVars.get("D|1"));
        csv.iterationStart(null);
        assertNull(threadVars.get("a"));
        assertEquals("a2", threadVars.get("A"));
        assertEquals("b2", threadVars.get("B"));
        assertEquals("c2", threadVars.get("C"));
        assertEquals("d2", threadVars.get("D|1"));
    }

    // Test CSV file with a header line and recycle is true
    @Test
    public void testHeaderOpenAndRecycle(){
        CSVDataSet csv = new CSVDataSet();
        csv.setFilename(findTestPath("testfiles/testheader.csv"));
        csv.setDelimiter("|");
        csv.setRecycle(true);
        assertNull(csv.getVariableNames()); // read 1st line
        // read 5 lines + restart to file begin
        csv.iterationStart(null); // line 2
        csv.iterationStart(null); // line 3
        csv.iterationStart(null); // line 4
        csv.iterationStart(null); // line 5
        csv.iterationStart(null); // return to 2nd line (first line is names)
        assertEquals("a1", threadVars.get("A"));
        assertEquals("b1", threadVars.get("B"));
        assertEquals("c1", threadVars.get("C"));
        assertEquals("d1", threadVars.get("D|1"));
    }

    // Test CSV file with a header line
    @Test
    public void testHeaderQuotes(){
        CSVDataSet csv = new CSVDataSet();
        csv.setFilename(findTestPath("testfiles/testquoted.csv"));
        csv.setDelimiter("|");
        csv.setQuotedData(true);
        csv.setRecycle(false);
        csv.setStopThread(true);
        assertNull(csv.getVariableNames());
        csv.iterationStart(null);
        assertNull(threadVars.get("a"));
        assertEquals("a1", threadVars.get("A"));
        assertEquals("b1", threadVars.get("B"));
        assertEquals("c1", threadVars.get("C"));
        assertEquals("d1", threadVars.get("D|1"));
        csv.iterationStart(null);
        assertNull(threadVars.get("a"));
        assertEquals("a2", threadVars.get("A"));
        assertEquals("b2", threadVars.get("B"));
        assertEquals("c2", threadVars.get("C"));
        assertEquals("d2", threadVars.get("D|1"));
        csv.iterationStart(null);
        assertNull(threadVars.get("a"));
        assertEquals("a3", threadVars.get("A"));
        assertEquals("b3", threadVars.get("B"));
        assertEquals("c3", threadVars.get("C"));
        assertEquals("d3", threadVars.get("D|1"));
        try {
            csv.iterationStart(null);
            fail("Expected JMeterStopThreadException");
        } catch (JMeterStopThreadException expected) {
        }
    }

    private CSVDataSet initCSV(){
        CSVDataSet csv = new CSVDataSet();
        csv.setFilename(findTestPath("testfiles/unit/TestCVSDataSet.csv"));
        csv.setVariableNames("a,b,c");
        csv.setDelimiter(",");
        return csv;
    }

    @Test
    public void testShareMode(){

        new CSVDataSetBeanInfo(); // needs to be initialised
        CSVDataSet csv0 = initCSV();
        CSVDataSet csv1 = initCSV();
        assertNull(csv1.getShareMode());
        csv1.setShareMode("abc");
        assertEquals("abc", csv1.getShareMode());
        csv1.iterationStart(null);
        assertEquals("a1", threadVars.get("a"));
        csv1.iterationStart(null);
        assertEquals("a2", threadVars.get("a"));
        CSVDataSet csv2 = initCSV();
        csv2.setShareMode("abc");
        assertEquals("abc", csv2.getShareMode());
        csv2.iterationStart(null);
        assertEquals("a3", threadVars.get("a"));
        csv0.iterationStart(null);
        assertEquals("a1", threadVars.get("a"));
        csv1.iterationStart(null);
        assertEquals("a4", threadVars.get("a"));
    }
}