FVP Manual
Introdução
A FVP Manual tem como objetivo validar, de forma controlada e em ambiente produtivo, se os fluxos e as respostas das APIs implementadas pelas instituições participantes estão em conformidade com os padrões técnicos definidos pelo Open Finance Brasil. Para isso, os testes exigem a autenticação e o consentimento do usuário, garantindo que os comportamentos esperados estejam sendo corretamente executados em ambiente de produção das instituições.
Os testes realizados na FVP (Ferramenta de validação em produção) utilizam dados reais dos usuários em produção, tanto para o compartilhamento de dados quanto para as iniciações de transações de pagamentos. Por padrão, as informações relativas às execuções ficam disponibilizadas nos próprios logs de execução dos testes, sendo deletados da ferramenta após 1 hora do início do teste. Caso os logs de execução sejam baixados, eles estarão com informações sensíveis do usuário. Portanto, pedimos atenção redobrada dos usuários no cuidado com o manuseio e compartilhamento desses arquivos, especialmente quando realizados testes em contas de uso pessoal.
Neste página, você encontrará os seguinte tópicos:
1 - Diferença entre FVP Manual - Testes restritos e Testes abertos: Diferença entre os planos de testes e responsabilidades de execução;
2 - FVP Manual - Testes Abertos: O que é a FVP Manual - Testes Abertos, funcionamento dos ciclos e as responsabilidades de execução dos ciclos pelas instituições;
3 - FVP Manual - Testes Restritos: O que é a FVP Manual - Testes Restritos, funcionamento dos ciclos e módulos de testes que serão validados em produção pela estrutura;
Testes de longa duração: Funcionamento e validação dos testes de longa duração;
4 - Configurando e executando testes: Passo-a-passo para configuração e execução da FVP Manual pelas instituições (Testes Abertos), além de um detalhamento para diferenciação de um teste relacionado à uma pessoa física (PF) ou à uma pessoa jurídica (PJ).
1 - Diferença entre FVP Manual - Testes restritos e Testes abertos
Em geral, a FVP Manual - Testes Restritos representa um conjunto de testes (planos de testes) que podem realizados exclusivamente por membros da Associação Open Finance Brasil e fornecedores, enquanto os planos de testes relacionados à FVP Manual - Testes Abertos podem ser executados pelas próprias instituições.
As execuções dos testes da FVP Manual ocorrem em ciclos bimestrais, e a responsabilidade de execução da ferramenta depende das contas abertos pelo fornecedor contratado pela estrutura para execução da FVP Manual:
FVP Manual - Testes Abertos: São planos de testes da FVP acessíveis às instituições (Open tests). Caso o fornecedor não possua conta aberta na marca para execução da FVP Manual, a responsabilidade de execução dos testes na FVP Manual - Testes Abertos para o servidor é de responsabilidade da própria instituição.
FVP Manual - Testes Restritos: São planos de testes da FVP exclusivos à estrutura (Restricted test plans). Caso o fornecedor possua conta aberta na marca para execução da FVP Manual, a responsabilidade de execução dos testes na FVP Manual - Testes Restritos para o servidor é de responsabilidade da estrutura.
A relação das contas abertas pelo fornecedor, bem como a responsabilidade de execução bimestral para cada servidor, pode ser encontrada no Dashboard da FVP Manual - Relação de Contas Abertas .
2 - FVP Manual - Testes Abertos
Os Testes Abertos permitem que instituições realizem testes em produção em seus próprios servidores, restringindo o acesso para usuários da mesma organização e evitando interferências externas. Para o devido acesso, configuração e execução dos testes da FVP, consulte a seção “4 - Configurando e executando testes“.
Os ciclos de execução da FVP Manual obedecem um ciclo bimestral, conforme cronograma de execução abaixo:
Dentro de cada ciclo bimestral acima compartilhado, é esperado que as instituições obtenham sucesso nos testes da FVP Manual - Testes Abertos. Os servidores, segmentos e testes que devem obter sucesso em cada ciclo, dependem dos seguintes critérios :
Servidor: Marcas (servidores) em que o fornecedor contratado não possua conta aberta, a responsabilidade de obtenção de sucesso é da própria instituição, caso esse que caracteriza a necessidade de execução da FVP Manual - Testes Abertos
Segmento suportado (PF e/ou PJ): Para cada segmento suportado pelo servidor (PF e/ou PJ), a instituição deverá obter sucesso nos testes, realizando execuções que são caracterizadas como usuários PF ou PJ. A identificação dos segmentos suportados por cada servidor é baseada nas flags de cada servidor no diretório dos participantes: “Suporta contas PF” e “Suporta contas PJ“
APIs Publicadas: De acordo com as APIs publicadas em cada servidor, serão exigidos sucessos nos testes relativos à essas APIs. A relação de planos e módulos de testes cobrados de acordo com cada API publicada está melhor descrita abaixo.
Nota: As novas instituições participantes de compartilhamento de dados (em onboarding) estão dispensadas do ciclo de Agosto/Setembro da FVP Manual - Testes Abertos ou Restritos.
Segue abaixo a lista de planos e módulos de testes da FVP em que os servidores das instituições deverão obter sucesso completo a cada ciclo bimestral, de acordo com as APIs publicadas em cada servidor:
API Pagamentos Automáticos v2.2.0 - Pix Automático: Criação e validação de consentimento, com realização de 2 pagamentos
Plano de teste: Production Functional Tests for Automatic Pix Payments - API Version 2.2
Módulo de teste a ser executado: fvp_automatic-payments_api_automatic-pix-semanal-core_open_test-module_v2-2
API Pagamentos Automáticos v2.2.0 - Transferências Inteligentes: Criação e validação de consentimento, com realização de 2 pagamentos:
Plano de teste: Production Functional Tests for Automatic Sweeping Payments - API Version 2.2
Módulo de teste a ser executado: fvp_automatic-payments_api_sweeping-accounts-core_test-module_v2-2
API Dados do cliente: Criação de consentimento com prazo indeterminado e chamada de todas as API de Compartilhamento de Dados, a depender das publicações da instituição:
Plano de teste: Production Functional Tests for Customer Data Happy Path - API Version 3
Módulo de teste a ser executado: fvp-customer_data_unique_happy_path_test-module
API Pagamentos v4.0.0: Criação, sem cancelamento, de 2 agendamentos customizados: D+1 e D+2:
Plano de teste: Production Functional Tests for Payments E2E - API Version 4
Módulo de teste a ser executado: fvp-payments_api_recurring-payments-custom-not-cancelled_open_test-module_v4
3 - FVP Manual - Testes Restritos
Caso o fornecedor contratado pela estrutura possua conta aberta em sua instituição, o próprio fornecedor é quem será responsável pela execução bimestral na FVP Manual - Testes Restritos. Os Testes Restritos (Restricted test plan) possuem acesso exclusivo pela própria estrutura do Open Finance Brasil.
Nos ciclos bimestrais de execução da FVP Manual - Testes restritos, caso seja identificada uma falha durante a exeucução dos servidores das instituições, um ticket com as evidências das falhas será direcionado às instituições via Service Desk. Para que o ticket seja encerrado, uma reexecução com sucesso do módulo de teste da FVP deve ser obtida exclusivamente pelo fornecedor responsável pela execução dos testes. Para solicitações de pedidos de reexecução, um novo chamado deve ser aberto na categoria: Requisição > Reexecução > FVP Manual - Testes restritos. Para mais informações sobre solicitações de reexecução ou contestações, acesse o Fluxos de Reexecução e Contestação da FVP Manual – Testes Restritos
Abaixo, conforme discussão e definição do Squad Sandbox, está detalhado o ciclo vigente da FVP Manual - Testes Restritos, relativo ao ciclo de Dezembro-25/Janeiro-26:
Testes de longa duração
Os testes de longa duração, presentes apenas na FVP Manual – Testes Restritos, têm como objetivo validar os comportamentos e etapas que ocorrem em dias posteriores à execução inicial do teste. Esses casos são aplicáveis principalmente em fluxos que envolvem validação da liquidação de pagamentos futuros, tentativas de retry automáticas, ou outras ações que não se encerram imediatamente após o teste inicial.
Visto que os testes de longa duração exigem validações em dias seguintes à primeira execução com sucesso, como a confirmação de uma liquidação, o sucesso em uma primeira etapa de execução não significa que o teste foi concluído com sucesso. O ticket de notificação dos testes de longa duração apenas serão encerrados quando todas as etapas subsequentes do fluxo forem concluídas com sucesso. Assim, mesmo em pedidos de reexecução cujo no primeiro teste é obtido sucesso, é necessário aguardar o resultado completo dos testes de longa duração antes de considerar a pendência como resolvida. Até que a execução subsequente tenha um resultado, o SLA dos tickets serão pausados. Em caso de sucesso, o ticket será encerrado ou, em caso de falha, as novas evidências serão adicionadas ao ticket e o SLA será retomado.
Para identificação dos testes de longa duração, seguem abaixo alguns exemplos de módulos de teste:
Testes de validação da liquidação de Pix Automático:
Teste 1 de 2: automatic-payments_api_automatic-pix-scheduling_1-2_test-module_v2
Teste 2 de 2: automatic-payments_api_automatic-pix-verification_2-2_test-module_v2
Testes de validação de retrys de Pix Automático:
Teste 1 de 3: automatic-payments_api_automatic-pix-scheduling-retry_1-3_test-module_v2
Teste 2 de 3: automatic-payments_api_automatic-pix-scheduling-retry_2-3_test-module_v2
Teste 3 de 3: automatic-payments_api_automatic-pix-scheduling-retry_3-3_test-module_v2
O detalhamento dos testes completos presentes na FVP Manual podem ser encontrados na página do Gitlab do fornecedor responsável pela ferramenta.
4 - Configurando e executando testes da FVP Manual
a. Criando uma conta no Diretório de Produção
Para acessar a plataforma, é necessário ter uma conta no Ambiente de Produção do Diretório dos Participantes. As instruções para criação da conta estão no Capítulo 03 do Guia Operacional do Diretório de Participantes.
A criação de uma conta envolve assinar os Termos e Condições e configurar um TOTP para futuro acesso. Se houver problemas não resolvidos pelo guia do usuário, é recomendado abrir um ticket de suporte no Service Desk.
b. Escopo de acesso ao Diretório
Para obter acesso ao ambiente da FVP, o usuário deve ser designado com a função "PFVPC" no Ambiente de Produção do Diretório, para a organização que será testada. Caso um usuário que não tenha o papel "PFVPC" no diretória tente executar a ferramente, uma mensagem de erro “403 - FORBIDDEN” aparecerá ao tentar fazer login na plataforma.
Tendo-se em vista que o usuário que irá acessar a FVP deve autorizar consentimentos para as APIs do Open Finance que serão testadas, é necessário que o CPF registrado também tenha acesso aos recursos que serão testados na ferramenta.
c. Acessando a plataforma
Para acessar a plataforma da FVP, o usuário (já com a devida permissão PFVPC) deve realizar o login através do Diretório dos participantes. Após autenticar-se, o usuário deve aceitar os termos e condições da FVP, que aparecerá a cada login na ferramenta.
d. Criando um plano de testes
Após aceitar os termos, o usuário acessará uma interface similar à do motor de conformidade funcional. Nela, o plano de testes desejado deverá ser selecionado e as informações preenchidas conforme instruções abaixo, para testes de Pessoa Física (PF) ou Pessoa Jurídica (PJ):
Testes de Pessoa Física (PF)
Para executar os testes com caracterização de Pessoa Física (PF), o usuário deverá fornecer:
Alias: Deve corresponder ao orgId da organização
Authorisation Server ID: Authorisation Server ID que será testado. O Authorisation Server ID deverá estar registrado no orgId mencionado no campo Alias
BrazilCpf: CPF do usuário atrelado ao usuário logado, o com o devido acesso de PFVPC à organização no diretório dos participantes, conforme mencionado no tópico “Configurando e executando testes”.
A depender do plano de testes executado, outras informações deverão ser fornecidas, como debtorAccount ou creditorAccount
Segue abaixo modelo de configuração base de um plano de testes da FVP Manual para um teste para Pessoa Física (PF):
Se o CPF ou o Authorisation Server ID fornecidos não corresponderem ao do PFVPC cadastrado no diretório dos participantes, a mensagem abaixo será exibida, indicando que a criação do plano de testes não poderá ser realizada.
Testes de Pessoa Jurídica (PJ)
Para executar os testes com caracterização de Pessoa Jurídica (PJ), o usuário deverá fornecer:
Alias: Deve corresponder ao orgId da organização
Authorisation Server ID: Authorisation Server ID que será testado. O Authorisation Server ID deverá estar registrado no orgId mencionado no campo Alias
BrazilCpf: CPF do usuário atrelado ao usuário logado, o com o devido acesso de PFVPC à organização no diretório dos participantes, conforme mencionado no tópico “Configurando e executando testes”.
BrazilCnpj: CNPJ cujo o CPF fornecido possua acesso à conta no servidor testado.
A depender do plano de testes executado, outras informações deverão ser fornecidas, como debtorAccount ou creditorAccount
Segue abaixo modelo de configuração base de um plano de testes da FVP Manual para um teste para Pessoa Jurídica (PJ):