com.xceptance.xlt.nocoding.parser.csv.command.action.ResponseParser Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xlt-nocoding Show documentation
Show all versions of xlt-nocoding Show documentation
A library based on XLT to run Web test cases that are written in either YAML or CSV format.
The newest version!
/*
* Copyright (c) 2013-2023 Xceptance Software Technologies GmbH
*
* Licensed 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 com.xceptance.xlt.nocoding.parser.csv.command.action;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.apache.commons.csv.CSVRecord;
import org.apache.commons.lang3.StringUtils;
import com.xceptance.xlt.nocoding.command.action.response.AbstractResponseSubItem;
import com.xceptance.xlt.nocoding.command.action.response.HttpCodeValidator;
import com.xceptance.xlt.nocoding.command.action.response.Response;
import com.xceptance.xlt.nocoding.command.action.response.Validator;
import com.xceptance.xlt.nocoding.command.action.response.extractor.AbstractExtractor;
import com.xceptance.xlt.nocoding.command.action.response.extractor.RegexpExtractor;
import com.xceptance.xlt.nocoding.command.action.response.extractor.xpath.XpathExtractor;
import com.xceptance.xlt.nocoding.command.action.response.store.AbstractResponseStore;
import com.xceptance.xlt.nocoding.command.action.response.store.ResponseStore;
import com.xceptance.xlt.nocoding.command.action.response.validator.AbstractValidator;
import com.xceptance.xlt.nocoding.command.action.response.validator.MatchesValidator;
import com.xceptance.xlt.nocoding.parser.csv.CsvConstants;
/**
* Extracts the information of a {@link Response} from a {@link CSVRecord}.
*
* @author ckeiner
*/
public class ResponseParser extends AbstractActionSubItemParser
{
/**
* Extracts the information needed for a {@link Response} from the {@link CSVRecord}
*
* @param record
* The {@link CSVRecord} with the action item
* @return The response defined by the CSVRecord
*/
@Override
public Response parse(final CSVRecord record)
{
// Initialize all needed variables for the response
final List responseItems = new ArrayList<>();
String responsecode = null;
AbstractExtractor extractor = null;
AbstractValidator validationMethod = null;
final List responseStores = new ArrayList<>();
boolean hasXpath = false;
boolean hasRegexp = false;
/*
* Read values
*/
// Build an iterator over the headers
final Iterator headerIterator = record.toMap().keySet().iterator();
// While there are headers
while (headerIterator.hasNext())
{
// Get the next header
final String header = headerIterator.next();
// Get the value
final String value = record.get(header);
// If the value is null or empty, discard it
if (value == null || value.isEmpty())
{
continue;
}
// If the fieldName contains either REGEXP_GETTER_PREFIX and XPath isn't used
if (header.contains(CsvConstants.REGEXP_GETTER_PREFIX) && StringUtils.isNotBlank(value))
{
responseStores.add(handleStore(header, value));
hasRegexp = true;
}
// If the fieldName contains either XPATH_GETTER_PREFIX and Regexp isn't used
else if (header.contains(CsvConstants.XPATH_GETTER_PREFIX) && StringUtils.isNotBlank(value))
{
responseStores.add(handleStore(header, value));
hasXpath = true;
}
}
// Get responsecode if it is mapped
if (record.isMapped(CsvConstants.RESPONSECODE))
{
final String value = record.get(CsvConstants.RESPONSECODE);
if (StringUtils.isNotBlank(value))
{
responsecode = value;
}
}
// Get Xpath if it is mapped, and create the extractor
if (record.isMapped(CsvConstants.XPATH))
{
final String value = record.get(CsvConstants.XPATH);
if (StringUtils.isNotBlank(value))
{
extractor = new XpathExtractor(value);
}
hasXpath = true;
}
// Get Regexp if it is mapped, and create the extractor
if (record.isMapped(CsvConstants.REGEXP))
{
final String value = record.get(CsvConstants.REGEXP);
if (StringUtils.isNotBlank(value))
{
extractor = new RegexpExtractor(record.get(CsvConstants.REGEXP));
}
hasRegexp = true;
}
// Get Text if it is mapped, and create the validator
if (record.isMapped(CsvConstants.TEXT))
{
final String value = record.get(CsvConstants.TEXT);
if (StringUtils.isNotBlank(value))
{
validationMethod = new MatchesValidator(value);
}
}
/*
* Verify that values with prerequisites have fulfilled prerequisites
*/
// Verify Xpath and Regexp aren't combined in any way
if (hasXpath && hasRegexp)
{
throw new IllegalArgumentException("Cannot map Xpath Validations/Stores and Regexp Validations/Stores together");
}
// Verify that either CsvConstants.TEXT and the extractor have values, or only the extractor has a value
if (validationMethod != null && (extractor == null))
{
throw new IllegalArgumentException("Cannot map " + CsvConstants.TEXT + " without extractor");
}
/*
* Build the response
*/
// HttpcodeValidator
if (responsecode != null)
{
responseItems.add(new HttpCodeValidator(responsecode));
}
// Validator
if (extractor != null)
{
final String validationName = createValidationName(record, "Validate");
final Validator validator = new Validator(validationName, extractor, validationMethod);
responseItems.add(validator);
}
// ResponseStore
if (responseStores != null && !responseStores.isEmpty())
{
responseItems.addAll(responseStores);
}
// Return the response
return new Response(responseItems);
}
/**
* Creates a name for the validation out of the {@link CSVRecord} and validationNameStart.
*
* @param record
* The CSVRecord with the action item
* @param validationNameStart
* The String the name of the validation should start with
* @return If {@link CsvConstants#NAME} is mapped and not null or empty, returns
* validationNameStart + " " with the value of CsvConstants.NAME. Otherwise,
* returns an empty string.
*/
private String createValidationName(final CSVRecord record, final String validationNameStart)
{
String name = "";
if (record.isMapped(CsvConstants.NAME))
{
final String value = record.get(CsvConstants.NAME);
if (StringUtils.isNotBlank(value))
{
name = validationNameStart + " " + value;
}
}
return name;
}
/**
* Creates an {@link AbstractResponseStore} depending on the fieldName
*
* @param fieldName
* The name of the field
* @param value
* The value of the field
* @return An {@link AbstractResponseStore} with the variableName of fieldName and the proper
* {@link AbstractExtractor} with the extractionExpression of value
*/
private AbstractResponseStore handleStore(final String fieldName, final String value)
{
// Create an empty AbstractExtractor
AbstractExtractor storeExtractor = null;
// If the fieldName contains CsvConstants.REGEXP_GETTER_PREFIX
if (fieldName.contains(CsvConstants.REGEXP_GETTER_PREFIX))
{
// Create an AbstractExtractor
storeExtractor = new RegexpExtractor(value);
}
// If the fieldName contains CsvConstants.XPATH_GETTER_PREFIX
else if (fieldName.contains(CsvConstants.XPATH_GETTER_PREFIX))
{
// Create an AbstractExtractor
storeExtractor = new XpathExtractor(value);
}
// Return the new ResponseStore
return new ResponseStore(fieldName, storeExtractor);
}
}