IMPORTANTE: esta documentação foi descontinuada. Leia a documentação Assert V1 atualizada no nosso novo portal de documentação.
O Assert V1 permite criar a interrupção da execução de seu pipeline quando uma condição definida por você não for atendida. Essa condição será avaliada de acordo com itens da mensagem do pipeline que o componente Assert receber, através de uma Linguagem de Expressão.
Dê uma olhada nos parâmetros de configuração do componente:
Condition: condição passada através da Linguagem de Expressão SIMPLE, que quando não for verdadeira, fará com que a execução do pipeline seja interrompida.
Error Message: define a mensagem de erro que é retornada pelo pipeline quando a condição passada não for verdadeira.
HTTP Status Code: status HTTP de retorno do componente.
Fluxo de Mensagens
Entrada
O componente aceita qualquer mensagem de entrada e pode fazer uso dela através da Linguagem de Expressão SIMPLE.
Saída
O componente não altera nenhuma informação da mensagem de entrada quando a condição é verdadeira. Portanto, ela é retornada para o componente seguinte ou é utilizada como resposta final se este componente for o último passo do pipeline.
Quando a condição não for verdadeira, a saída desse componente seguirá a estrutura padrão:
{
"timestamp": <momento da interrupção no formato timestamp>,
"error": "<mensagem configurada no parâmetro Error Message>",
"code": <status code configurado no parâmetro HTTP Status Code>
}
Tecnologia SIMPLE
É uma Linguagem de Expressão destinada a ser simples e prática para avaliar Expressões e Predicados sem exigir novas dependências ou conhecimento da tecnologia JSON Path.
Imagine que você precise validar determinada informação de cidade trafegada pelo pipeline:
{
"cidade" : "São Paulo"
}
Apenas mensagens que contenham o campo "cidade" com o valor "São Paulo" devem ser aceitas. Do contrário, a execução do pipeline deve ser interrompida.
O parâmetro Condition do componente Assert V1 deverá ser configurado da seguinte maneira:
#{cidade} == 'São Paulo'
Conheça as demais opções para a declaração de expressões SIMPLE:
==
Igual a
=~
Igual a, ignorando maiúsculas e minúsculas (quando comparando strings)
>
Maior que
>=
Maior ou igual a
<
Menor que
!=
Diferente
!=~
Diferente de, ignorando maiúsculas e minúsculas (quando comparando strings)
regex
Valida uma RegEx contra a string informada
Ex.: #{cidade} regex 'S.*'
&&
Operador lógico E.
Ex.: #{cidade} == 'Sao Paulo' && #{estado} == 'SP'
||
Operador lógico OU.
Ex.: #{cidade} == 'Sao Paulo' || #{estado} == 'SP'
contains
Valida se determinado valor está contido em uma string
Ex.: #{cidade} contains 'Paulo'