Automação de

Testes de API
com Postman
 Exploring Path
01 Apresentação

Conceitos iniciais
02 Testes, Automação de Teste, API, RESTful…

Utilizando o Postman
03 Reconhecimento, Rodando a primeira Requisição

Criando e Rodando nossos Testes

04 Aba “Test”, Bibliotecas e Assertion Functions

Perguntas ???
05

Temas futuros
06 Acrescentando nossos testes no Build: Github + Travis CI + Postman + Heroku
 Lucas Amaral

Desde 2008 na estrada: Dev (-),

Requisitos (++), QA (++)

Quality Assurance
Portfólio GC/Adtalem
Brasil
Testes e Automação
Put things together
 Conceitos Iniciais
Definindo o essencial

A atividade de teste é o processo de executar um

01 programa com a intenção de descobrir ERROS.

Atividades voltadas para planejamento,

02 preparação e avaliação de produtos de software
e produtos de trabalho relacionados a fim de
determinar se elas satisfazem os requisitos
especificados e demonstrar que estão aptas para
sua finalidade

Automação
03 Utilização de software para desempenhar
ou dar suporte às atividades de teste Testes e
Automação
 QA >>> Testes
Flame alert!

Antes de gerar flames sobre o conceito de testes exposto, lembre-se que QA >>> Testes
A propósito, leia ESTE ARTIGO
API, REST e RESTful
Put things together
API
Application Programming
API é um conjunto de rotinas e padrões de programação para acesso a um
aplicativo de software ou plataforma baseado na Web

APIs entregam funcionalidades a websites;

APIs estão por trás das aplicações/softwares online (SaaS);
APIs suportam as aplicações móveis (Apps Mobile);
Interface
Resumindo

“A API é o livro de regras, que estabelece os padrões de comunicação que

poderão ser usados naquela interação. Se eu quero programar uma aplicação
que use os dados do Twitter, eu devo usar o livro de regras conforme definido
pelo Twitter, pela API do Twitter.” (Sensedia)
API
REST (RESTful) x SOAP
• REST é um Modelo arquitetural Funciona em cima do HTTP através de
requisições simples. Suporta várias representações: XML, JSON, YML.
RESTful são Aplicações que seguem o padrão REST

Application Programming • SOAP é um Protocolo que utiliza HTTP para fazer chamadas no padrão RPC:
Interface Remote Procedure Call. Suporta somente XML

Veja mais sobre os níveis de maturidade de Richardson

 Requests e Responses
A ideia por trás: Client/Server

Client faz uma Request Server processa a Request

Envia uma requisição ao Server Realiza validações, autenticação,
informando a ação desejada e …
parâmetros necessários/desejados.

Server retorna Response para

Client
 • Verbos ou Métodos HTTP

HTTP GET | POST | PUT | PATCH | DELETE

HEAD | OPTIONS | TRACE | CONNECT

Request • URL (Resource e Parâmetros)

Composição básica de http://jsonplaceholder.typicode.com/users
uma Request

• HEADER
• BODY
 • HTTP Status Codes

HTTP 1XX: Informacional

2XX: Sucesso na Requisição

Response 3XX: Redirecionamento

4XX: Erro no Cliente
• 401: Unauthorized
Composição básica de • 403: Forbidden
uma Response • 404: Not Found
5XX: Erro no Servidor

Mais em: httpstatuses.com

• HEADER
• BODY
 Requests e Responses
Características de requests e responses

Acessar Digite a URL no campo Verifique o

onlinecurl.com http://jsonplaceholder.typicode.com Resultado
/users

Tanto Request como Response são compostas basicamente pelas seções HEADER e
BODY. Cada uma possui uma série de atributos definidos no momento do desenvolvimento
e que dependem também do resource que está sendo requisitado.

O jsonplaceholder.typicode.com é uma casca de API RESTful para testes

RESPONSE HEADER
RESPONSE BODY
Utilizando o Postman
Put things together
POSTMAN
Ambiente completo para
Desenvolvimento de APIs

https://www.getpostman.com
Interface do Postman
 Sidebar

Collections
Conjunto de Requests

Folders
Mais uma forma de agrupar/organizer Requests

Requests
Requests a serem executadas
Detalhes da Request

Method, URL, Header, Environment

Detalhes da Response

Body, Header
Vamos aos
Testes
Quando
testamos a
API…
… estamos na parte
intermediária da Pirâmide
de Testes

Leia mais
 Testes no Postman
Os testes no Postman são escritos em Javascript

Lodash
A modern JavaScript utility library
delivering modularity, performance
& extras

Cheerio
Crypto.js Fast, flexible, and lean implementa
JavaScript library of crypto standards tion of core jQuery designed specif
ically for the server.
Criando Testes
Aba “Test”, Bibliotecas e Assertion Functions
 Your Text Here
You can simply impress your
audience and add a unique zing
and appeal to your Presentations.

A aba “Tests”
Nesta aba são escritos todos os testes relacionados à Request em
questão. Cada teste é especificado com a função:

pm.test(testName:String, specFunction:Function):Function
Principais
Objeto Response Objeto Request
Objetos pm.response request (read-only)
Objetos a manipuláveis .code:Number .url:Url
nos testes .reason():Function → String .headers:HeaderList
Link API .headers:HeaderList
.responseTime:Number
.text():Function → String
.json():Function → Object
 Funções de Assertion – to.have

Assertions pm.response.to.have (to.not.have)

.status(code:Number)
.status(reason:String)
Assertions usando em cima do Objeto
Response usando o .to.have
.header(key:String)
.header(key:String, optionalValue:String)
.body()
.body(optionalValue:String)
.body(optionalValue:RegExp)
.jsonBody()
.jsonBody(optionalExpectEqual:Object)
.jsonBody(optionalExpectPath:String)
.jsonBody(optionalExpectPath:String,
optionalValue:*)
 Funções de Assertion – to.be

Assertions pm.response.to.be (to.not.be)

.info [1XX status]
.success [2XX status]
Assertion acerca do Código do
Response usando palavras chave
.ok [200 status]
.redirection [3XX status]
.clientError [4XX status]
.serverError [5XX status]
.error [4XX or 5XX status]
.accepted [202 status]
.badRequest [400 status]
.unauthorized [401 status]
.forbidden [403 status]
.notFound [404 status]
.rateLimited [429 status]
 Funções de Assertion - pm.expect
pm.expect(assertion:*):Function → Assertion
Assertions
pm.expect(valor).[cadeia].[função].(valor)
Função de Assertion genérica
utilizando a biblioteca BDD ChaiJS
Onde essa cadeia é montada e a função é disponível de acordo com o padrã
o da biblioteca ChaiJS

pm.expect(pm.response.json().length).to.equal(9)

pm.expect(pm.response.code).to.not.be.oneOf([300, 400,
500, 100])
Rodando Testes
Send e Runner
Runner
Executa a chamada de toda uma
Collections rodando os testes e
gerando o Report de testes

Obs: Os testes são executados a cada “Send” de uma request e são exibidos na aba
“Tests Results”
Questions?
Papo futuro
 • Post da Sensedia sobre Testes de API, Postman e Newman
• https://sensedia.com/blog/apis/realizacao-de-testes-em-api-rest/
•
Material •
https://sensedia.com/blog/apis/o-que-sao-apis-parte-2-como-uma-api-funcio
na/
Instalando Node no Windows
• http://nodesource.com/blog/installing-nodejs-tutorial-windows/
Alguns links relevantes para essa • Importante para rodar o Newman
palestra • Documentação Newman
• https://www.npmjs.com/package/newman
• Marvel API
• https://developer.marvel.com/docs
• Mockando uma API
• https://mockaroo.com/
• API do Postman
• https://www.getpostman.com/docs/v6/
• https://www.getpostman.com/docs/v6/postman/scripts/postman_sandbox_a
pi_reference
• Outros resources:
• https://thecuriousdev.org/postman-test-api
• https://www.udemy.com/restful-apis/learn/v4/overview
• http://jsonplaceholder.typicode.com
• http://downloads.sensedia.com/webinar-design-de-apis-restful/
• https://onebitcode.com/api-completa-rails/
• + os links distribuídos pela apresentação
 Vlw, flws

/doamaral in/lopesdoamaral