TDC Porto Alegre 2020: ScanAPI Automatização de Testes de Integração para a sua API

by Camila Maia

Slide 1

Slide 1 text

ScanAPI Automatização de Testes de Integração para a sua API Camila Maia 1 TDC Porto Alegre Dezembro de 2020

Slide 2

Slide 2 text

Motivação Tudo começou numa bela semana de firefighter… 2

Slide 3

Slide 3 text

Eu trabalho na... 3

Slide 4

Slide 4 text

Quem sou eu? 4 - Desenvolvedora Backend - Formada em Sistemas de Informação na UFSC - Entrei na área em 2010 - Maior experiência com Python e Ruby - Organização de eventos: Pyjamas, EuroPython 2020, Python Brasil 2020...

Slide 5

Slide 5 text

Motivação Tudo começou numa bela semana de firefighter… 5

Slide 6

Slide 6 text

Motivação Erros de integração 6 - Cliente mandando campos diferentes do esperado - Frontend recebendo campos diferentes do esperado

Slide 7

Slide 7 text

Motivação Documentação desatualizada 7 - Endpoints e campos faltantes - Desinformação

Slide 8

Slide 8 text

Motivação Dificuldade em recriar o cenário 8 /reservar/:id_do_assento id_do_voo? id_da_aeronave? id_do_passageiro? Aeronave está disponível? ????

Slide 9

Slide 9 text

Motivação Dificuldade em recriar o cenário 9

Slide 10

Slide 10 text

No content

Slide 11

Slide 11 text

O quê a ScanAPI se propõe a fazer pela sua API? 11 - Framework de código aberto - Command line interface (CLI) - Escrito em Python 1. Fornecer uma documentação “Ao Vivo” 2. Possibilitar a implementação de testes de Integração

Slide 12

Slide 12 text

PokéAPI: https://pokeapi.co $ http https://pokeapi.co/api/v2/pokemon/ Como funciona? Exemplo: PokéAPI 12

Slide 13

Slide 13 text

Slide 14

Slide 14 text

Slide 15

Slide 15 text

Como funciona? Exemplo: PokéAPI 15 1. Instalar: pip 2. Instalar: $ pip install scanapi

Slide 16

Slide 16 text

Como funciona? Exemplo: PokéAPI 16 # scanapi.yaml endpoints: - name: pokeapi path: https://pokeapi.co/api/v2/ endpoints: - name: pokemon path: pokemon requests: - name: list_all method: get path: / path: https://pokeapi.co/api/v2/ pokemon / name: pokeapi :: pokemon :: list_all

Slide 17

Slide 17 text

Como funciona? Exemplo: PokéAPI 17 Rodar a ScanAPI: $ scanapi run scanapi.yaml

Slide 18

Slide 18 text

Como funciona? Documentação 18

Slide 19

Slide 19 text

Slide 20

Slide 20 text

Slide 21

Slide 21 text

Slide 22

Slide 22 text

22 Até aqui... Não precisamos de nenhum conhecimento de Python

Slide 23

Slide 23 text

Como funciona? Testes de Integração ✅ 23 ... requests: - name: list_all method: get tests: - name: status_code_is_200 assert: ${{ response.status_code == 200 }} - name: response_time_is_under_half_second assert: ${{ response.elapsed.total_seconds() < 0.5 }} - name: results_length_is_20 assert: ${{ len(response.json()["results"]) == 20 }} - name: count_is_gte_1050 assert: ${{ response.json()["count"] >= 1050 }}

Slide 24

Slide 24 text

Slide 25

Slide 25 text

Como funciona? Encadeamento ⛓ 25 - Pegar detalhes de um Pokémon - Neste caso o dado é “estático”, mas poderia não ser - https://pokeapi.co/api/v2/pokemon/bulbasaur

Slide 26

Slide 26 text

Como funciona? Encadeamento ⛓ 26 ... endpoints: - name: pokemon path: pokemon requests: - name: list_all method: get path: / vars: pokemon_name: ${{ response.json()["results"][0]["name"] }} tests: ... pokemon/${pokemon_name} - name: details method: get path: ${pokemon_name}

Slide 27

Slide 27 text

Slide 28

Slide 28 text

Como funciona? E tem mais 28 - Independente de linguagem! - Especificação da API também é aceita em JSON - Variável de Ambiente - Esconder dados sensitivos no relatório - Especificação da API em vários arquivos - Delay entre requests - Templates Customizados - Visual Studio Code Plugin

Slide 29

Slide 29 text

Adicionando ScanAPI ao seu projeto 29 29 29 29 - CI - GitHub Action

Slide 30

Slide 30 text

Adicionando ScanAPI ao seu projeto 30

Slide 31

Slide 31 text

Adicionando ScanAPI ao seu projeto 31 Exemplo: CircleCI

Slide 32

Slide 32 text

Adicionando ScanAPI ao seu projeto 32 Exemplo: CircleCI

Slide 33

Slide 33 text

33 # my_project/.circleci/config.yml ... scanapi: docker: - image: camilamaia/scanapi:2.1.0 steps: - checkout - run: name: Run ScanAPI command: | scanapi run scanapi/scanapi.yaml -c scanapi/scanapi.conf -o scanapi/report.html - store_artifacts: path: scanapi/report.html workflows: version: 2 main: jobs: - scanapi: filters: branches: only: - master - build-push: name: build-push-staging env: staging requires: - scanapi filters: branches: only: - master

Slide 34

Slide 34 text

Adicionando ScanAPI ao seu projeto Exemplo: GitHub Action 34

Slide 35

Slide 35 text

# my_project/.github/workflows/scanapi.yml on: push: branches: [master] name: Run ScanAPI jobs: scanapi: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Run automated API tests uses: scanapi/github-action@v1 with: scanapi_version: "==2.1.0" arguments: "run ./pokeapi/scanapi.yaml" - name: Upload scanapi-report.html uses: actions/upload-artifact@v2 with: name: ScanAPI Report path: scanapi-report.html

Slide 36

Slide 36 text

scanapi.dev 36

Slide 37

Slide 37 text

Comunicação Bora trocar uma ideia - GitHub Issues (por projeto) - Dashboards. Ex: Hacktoberfest - Spectrum (eventos, sprints...) 37

Slide 38

Slide 38 text

Próximos passos E o futuro? 38 - Outros métodos HTTP (além de GET, POST, PUT, PATCH, DELETE) - Melhorar Documentação - Criar Tutoriais - Melhor documentação para contribuição E se…. - Exportar: OpenAPI, Postman Collection, Insomnia… - Chamar Python Modules