Test your AI Agents with the all-new Agent to Agent Testing Platform.Learn More

How to use JsonPathMessageValidationContext class of com.consol.citrus.validation.json package

Best Citrus code snippet using com.consol.citrus.validation.json.JsonPathMessageValidationContext

Source:ZooExecuteAction.java

...21import com.consol.citrus.message.DefaultMessage;22import com.consol.citrus.message.Message;23import com.consol.citrus.validation.context.ValidationContext;24import com.consol.citrus.validation.json.JsonMessageValidationContext;25import com.consol.citrus.validation.json.JsonPathMessageValidationContext;26import com.consol.citrus.validation.json.JsonPathMessageValidator;27import com.consol.citrus.validation.json.JsonTextMessageValidator;28import com.consol.citrus.variable.VariableExtractor;29import com.consol.citrus.zookeeper.client.ZooClient;30import com.consol.citrus.zookeeper.command.ZooCommand;31import com.fasterxml.jackson.core.JsonProcessingException;32import com.fasterxml.jackson.databind.ObjectMapper;33import org.slf4j.Logger;34import org.slf4j.LoggerFactory;35import org.springframework.beans.factory.annotation.Autowired;36import org.springframework.beans.factory.annotation.Qualifier;37import org.springframework.util.CollectionUtils;38import org.springframework.util.StringUtils;39import java.util.ArrayList;40import java.util.List;41/**42 * Executes zookeeper command with given zookeeper client implementation. Possible command result is stored within command object.43 *44 * @author Martin Maher45 * @since 2.546 */47public class ZooExecuteAction extends AbstractTestAction {48    @Autowired(required = false)49    @Qualifier("zookeeperClient")50    /** Zookeeper client instance  */51    private ZooClient zookeeperClient = new ZooClient();52    /**53     * Zookeeper command to execute54     */55    private ZooCommand command;56    /**57     * Expected command result for validation58     */59    private String expectedCommandResult;60    @Autowired(required = false)61    @Qualifier("zookeeperCommandResultMapper")62    /** JSON data binding */63    private ObjectMapper jsonMapper = new ObjectMapper();64    @Autowired65    private JsonTextMessageValidator jsonTextMessageValidator = new JsonTextMessageValidator();66    @Autowired67    private JsonPathMessageValidator jsonPathMessageValidator = new JsonPathMessageValidator();68    /**69     * An optional validation contextst containing json path validators to validate the command result70     */71    private JsonPathMessageValidationContext jsonPathMessageValidationContext;72    /**73     * List of variable extractors responsible for creating variables from received message content74     */75    private List<VariableExtractor> variableExtractors = new ArrayList<VariableExtractor>();76    /**77     * Logger78     */79    private static Logger log = LoggerFactory.getLogger(ZooExecuteAction.class);80    /**81     * Default constructor.82     */83    public ZooExecuteAction() {84        setName("zookeeper-execute");85    }86    @Override87    public void doExecute(TestContext context) {88        try {89            if (log.isDebugEnabled()) {90                log.debug(String.format("Executing zookeeper command '%s'", command.getName()));91            }92            command.execute(zookeeperClient, context);93            validateCommandResult(command, context);94            log.info(String.format("Zookeeper command execution successful: '%s'", command.getName()));95        } catch (CitrusRuntimeException e) {96            throw e;97        } catch (Exception e) {98            throw new CitrusRuntimeException("Unable to perform zookeeper command", e);99        }100    }101    /**102     * Validate command results.103     *104     * @param command105     * @param context106     */107    private void validateCommandResult(ZooCommand command, TestContext context) {108        Message commandResult = getCommandResult(command);109        extractVariables(commandResult, context);110        if (log.isDebugEnabled()) {111            log.debug("Validating Zookeeper response");112        }113        if (StringUtils.hasText(expectedCommandResult)) {114            assertResultExists(commandResult);115            JsonMessageValidationContext validationContext = new JsonMessageValidationContext();116            jsonTextMessageValidator.validateMessage(commandResult, new DefaultMessage(expectedCommandResult), context, validationContext);117        }118        if (jsonPathMessageValidationContext != null) {119            assertResultExists(commandResult);120            jsonPathMessageValidator.validateMessage(commandResult, null, context, jsonPathMessageValidationContext);121        }122        log.info("Zookeeper command result validation successful - all values OK!");123        if (command.getResultCallback() != null) {124            command.getResultCallback().doWithCommandResult(command.getCommandResult(), context);125        }126    }127    private void assertResultExists(Message commandResult) {128        if (commandResult == null) {129            throw new ValidationException("Missing Zookeeper command result");130        }131    }132    private Message getCommandResult(ZooCommand command) {133        if (command.getCommandResult() == null) {134            return null;135        }136        try {137            Object commandResult = command.getCommandResult();138            String commandResultJson = jsonMapper.writeValueAsString(commandResult);139            return new DefaultMessage(commandResultJson);140        } catch (JsonProcessingException e) {141            throw new CitrusRuntimeException(e);142        }143    }144    private void extractVariables(Message commandResult, TestContext context) {145        if (log.isDebugEnabled()) {146            log.debug("Extracting variables from Zookeeper response");147        }148        for (VariableExtractor variableExtractor : variableExtractors) {149            variableExtractor.extractVariables(commandResult, context);150        }151    }152    /**153     * Gets the zookeeper command to execute.154     *155     * @return156     */157    public ZooCommand getCommand() {158        return command;159    }160    /**161     * Sets zookeeper command to execute.162     *163     * @param command164     * @return165     */166    public ZooExecuteAction setCommand(ZooCommand command) {167        this.command = command;168        return this;169    }170    /**171     * Gets the zookeeper client.172     *173     * @return174     */175    public ZooClient getZookeeperClient() {176        return zookeeperClient;177    }178    /**179     * Sets the zookeeper client.180     *181     * @param zookeeperClient182     */183    public ZooExecuteAction setZookeeperClient(ZooClient zookeeperClient) {184        this.zookeeperClient = zookeeperClient;185        return this;186    }187    /**188     * Gets the expected command result data.189     *190     * @return191     */192    public String getExpectedCommandResult() {193        return expectedCommandResult;194    }195    /**196     * Sets the expected command result data.197     *198     * @param expectedCommandResult199     */200    public ZooExecuteAction setExpectedCommandResult(String expectedCommandResult) {201        this.expectedCommandResult = expectedCommandResult;202        return this;203    }204    /**205     * Sets the JSON object mapper.206     *207     * @param jsonMapper208     */209    public ZooExecuteAction setJsonMapper(ObjectMapper jsonMapper) {210        this.jsonMapper = jsonMapper;211        return this;212    }213    /**214     * Adds a new variable extractor.215     *216     * @param variableExtractor the variableExtractor to add217     */218    public ZooExecuteAction addVariableExtractors(VariableExtractor variableExtractor) {219        this.variableExtractors.add(variableExtractor);220        return this;221    }222    /**223     * Set the list of variable extractors.224     *225     * @param variableExtractors the variableExtractors to set226     */227    public ZooExecuteAction setVariableExtractors(List<VariableExtractor> variableExtractors) {228        this.variableExtractors = variableExtractors;229        return this;230    }231    /**232     * Gets the variable extractors.233     *234     * @return the variableExtractors235     */236    public List<VariableExtractor> getVariableExtractors() {237        return variableExtractors;238    }239    /**240     * Sets the JsonPathMessageValidationContext for this action.241     *242     * @param jsonPathMessageValidationContext the json-path validation context243     */244    public ZooExecuteAction setJsonPathMessageValidationContext(JsonPathMessageValidationContext jsonPathMessageValidationContext) {245        this.jsonPathMessageValidationContext = jsonPathMessageValidationContext;246        return this;247    }248    /**249     * Gets the JsonPathMessageValidationContext.250     *251     * @return the validationContexts252     */253    public JsonPathMessageValidationContext getJsonPathMessageValidationContext() {254        return jsonPathMessageValidationContext;255    }256}...

Source:JsonPathMessageValidator.java

...34 * Message validator evaluates set of JSONPath expressions on message payload and checks that values are as expected.35 * @author Christoph Deppisch36 * @since 2.337 */38public class JsonPathMessageValidator extends AbstractMessageValidator<JsonPathMessageValidationContext> {39    /** Logger */40    private static Logger log = LoggerFactory.getLogger(JsonPathMessageValidator.class);41    @Override42    public void validateMessage(Message receivedMessage, Message controlMessage, TestContext context, JsonPathMessageValidationContext validationContext) throws ValidationException {43        if (CollectionUtils.isEmpty(validationContext.getJsonPathExpressions())) { return; }44        if (receivedMessage.getPayload() == null || !StringUtils.hasText(receivedMessage.getPayload(String.class))) {45            throw new ValidationException("Unable to validate message elements - receive message payload was empty");46        }47        log.debug("Start JSONPath element validation ...");48        String jsonPathExpression;49        try {50            JSONParser parser = new JSONParser(JSONParser.MODE_JSON_SIMPLE);51            Object receivedJson = parser.parse(receivedMessage.getPayload(String.class));52            ReadContext readerContext = JsonPath.parse(receivedJson);53            for (Map.Entry<String, Object> entry : validationContext.getJsonPathExpressions().entrySet()) {54                Object expectedValue = entry.getValue();55                if (expectedValue instanceof String) {56                    //check if expected value is variable or function (and resolve it, if yes)57                    expectedValue = context.replaceDynamicContentInString(String.valueOf(expectedValue));58                }59                jsonPathExpression = context.replaceDynamicContentInString(entry.getKey());60                Object jsonPathResult = JsonPathUtils.evaluate(readerContext, jsonPathExpression);61                //do the validation of actual and expected value for element62                ValidationUtils.validateValues(jsonPathResult, expectedValue, jsonPathExpression, context);63                if (log.isDebugEnabled()) {64                    log.debug("Validating element: " + jsonPathExpression + "='" + expectedValue + "': OK.");65                }66            }67            log.info("JSONPath element validation successful: All values OK");68        } catch (ParseException e) {69            throw new CitrusRuntimeException("Failed to parse JSON text", e);70        }71    }72    @Override73    protected Class<JsonPathMessageValidationContext> getRequiredValidationContextType() {74        return JsonPathMessageValidationContext.class;75    }76    @Override77    public boolean supportsMessageType(String messageType, Message message) {78        return new JsonTextMessageValidator().supportsMessageType(messageType, message);79    }80}...

Source:ItemTest.java

...9import org.testng.annotations.Test;10import static com.consol.citrus.actions.ExecuteSQLAction.Builder.sql;11import static com.consol.citrus.actions.ExecuteSQLQueryAction.Builder.query;12import static com.consol.citrus.http.actions.HttpActionBuilder.http;13import static com.consol.citrus.validation.json.JsonPathMessageValidationContext.Builder.jsonPath;14@Test15public class ItemTest extends TestNGCitrusSpringSupport {16    @Autowired17    private HttpClient secondHandApiEndpoint;18    @Autowired19    private BasicDataSource secondHandApiDataSource;20    @CitrusTest21    public void getOneItem() {22        description("WENN ein Item in der Datenbank vorhanden ist " +23                "UND alle Items abegrufen werden " +24                "DANN sollte die API ein JSON mit einem Item herausgeben");25        $(sql(secondHandApiDataSource)26                .statement("DELETE FROM items"));27        $(sql(secondHandApiDataSource)...