Testing APIs - Guru SP

Transcript

1. Testando APIs Rodrigo Flores rmflores@bioritmo.com.br @rlmflores blog.rlmflores.me Saturday, June 22, 13
2. Desenvolvedor @ Saturday, June 22, 13
3. I’ve been on both sides... Aplicações sem “Banco” (SOA) API para aplicações móveis API para aplicações sem Banco Saturday, June 22, 13
4. API para aplicações Mobile API para aplicações web baseadas em serviços Aplicações Web baseadas em serviço Saturday, June 22, 13
5. Como testar essas APIs... ... Tanto consumir ...Como disponibilizar Saturday, June 22, 13
6. ... Como consumir Saturday, June 22, 13
7. Cliente Saturday, June 22, 13
8. Isolado da Aplicação Saturday, June 22, 13
9. “Multi-ambiente” aware Em desenvolvimento, não deve ter efeito Em teste não deve acessar nada Em produção deve funcionar Saturday, June 22, 13
10. Client.new( username: "rodrigoflores", token: "xxx") Saturday, June 22, 13
11. development: username: 'tedmozby' token: 'xxx' production: username: 'barneystinson' token: 'xxxyyy' Saturday, June 22, 13
12. Requests HTTP Saturday, June 22, 13
13. Net::HTTP Saturday, June 22, 13
14. require 'net/http' require 'json' uri = URI.parse('https://api.github.com/users/ rodrigoflores/repos') http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = true request = Net::HTTP::Get.new(uri.request_uri) response = http.request(request) repos = JSON.parse(response.body) repos.each do |repo| puts repo['name'] end Saturday, June 22, 13
15. Fakeweb/Webmock Saturday, June 22, 13
16. “Mockam” o Net::HTTP Saturday, June 22, 13
17. # encoding: utf-8 require 'net/http' require 'json' require 'webmock' include WebMock::API stub_request(:get, "https://api.github.com/users/rodrigoflores/ repos"). to_return(body: File.read('response.json')) uri = URI.parse('https://api.github.com/users/rodrigoflores/ repos') http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = true request = Net::HTTP::Get.new(uri.request_uri) response = http.request(request) repos = JSON.parse(response.body) repos.each do |repo| puts repo['name'] end Saturday, June 22, 13
18. Requests não anotadas levantarão exceções! Saturday, June 22, 13
19. Real HTTP connections are disabled. Unregistered request: GET https:// api.github.com/users/bioritmo/repos with headers {'Accept'=>'*/*', 'User- Agent'=>'Ruby'} (WebMock::NetConnectNotAllowedError) You can stub this request with the following snippet: stub_request(:get, "https://api.github.com/users/bioritmo/repos"). with(:headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}). to_return(:status => 200, :body => "", :headers => {}) registered request stubs: stub_request(:get, "https://api.github.com/users/rodrigoflores/repos") ============================================================ from request_fakeweb.rb:16:in `<main>' É possível desativar e permitir requests HTTP Saturday, June 22, 13
20. Escala ? Saturday, June 22, 13
21. VCR Saturday, June 22, 13
22. 1ª Vez: Faz o Request e grava 2ª-nª Vez: Reproduz o que foi gravado Saturday, June 22, 13
23. uri = URI.parse('https://api.github.com/users/ rodrigoflores/repos') http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = true request = Net::HTTP::Get.new(uri.request_uri) VCR.use_cassette('repos') do response = http.request(request) repos = JSON.parse(response.body) repos.each do |repo| puts repo['name'] end end Saturday, June 22, 13
24. --- http_interactions: - request: method: get uri: https://api.github.com/users/ rodrigoflores/repos body: encoding: US-ASCII string: "" headers: Accept: - "*/*" User-Agent: - Ruby response: (...) recorded_at: Sun, 16 Jun 2013 16:00:06 GMT recorded_with: VCR 2.5.0 Saturday, June 22, 13
25. --- http_interactions: - request: (...) response: status: code: 200 message: OK headers: (...) body: encoding: ASCII-8BIT string: "[{\"id\":1254869,\"name\":\"1001\", \"full_name\":\"rodrigoflores/1001\", (...)" http_version: recorded_at: Sun, 16 Jun 2013 16:00:06 GMT recorded_with: VCR 2.5.0 Saturday, June 22, 13
26. Usando o próprio Cliente Saturday, June 22, 13
27. Faraday Saturday, June 22, 13
28. require 'net/http' require 'json' require 'faraday' require 'faraday_middleware' conn = Faraday.new(:url => 'https://api.github.com') do |faraday| faraday.adapter Faraday.default_adapter faraday.response :json, :content_type => /\bjson$/ end repos = conn.get('/users/rodrigoflores/repos').body repos.each do |repo| puts repo['name'] end Saturday, June 22, 13
29. require 'net/http' require 'json' require 'faraday' require 'faraday_middleware' conn = Faraday.new(:url => 'https://api.github.com') do | faraday| faraday.adapter :test do |stub| stub.get('/users/rodrigoflores/repos') do [ 200, { 'Content-Type' => 'application/json; charset=utf-8' }, File.read('response.json') ] end end faraday.response :json, :content_type => /\bjson$/ end repos = conn.get('/users/rodrigoflores/repos').body repos.each do |repo| puts repo['name'] end Saturday, June 22, 13
30. Esse cliente que cuida de fazer o mock das requisições Saturday, June 22, 13
31. Savon, Typhoeus, OmniAuth (... ) Saturday, June 22, 13
32. Como testo se a API segue o mesmo padrão ? Saturday, June 22, 13
33. Testes de contrato! Saturday, June 22, 13
34. Decidir qual o melhor jeito de testar Testar o cliente como uma aplicação Ruby Tomar cuidado para não fazer requests em teste (pelo menos não o tempo todo) Testes de contrato valem a pena? Saturday, June 22, 13
35. ...Como disponibilizar Saturday, June 22, 13
36. Testar se as respostas HTTP estão corretas Saturday, June 22, 13
37. Testar Body Headers (incluindo Cache) Status Code Saturday, June 22, 13
38. Stateless Saturday, June 22, 13
39. Teste de Controllers Saturday, June 22, 13
40. class ExampleController < ApplicationController def index expires_in 10.minutes, public: true render json: { version: '3.2.19' } end end Saturday, June 22, 13
41. require 'spec_helper' describe ExampleController do describe "GET #index" do it "shows the version info" do get :index parsed_response = JSON.parse(response.body) parsed_response['version'].should == '3.2.19' end it "has a max-age of 10 minutes" do get :index response.headers['Cache-Control'].should == "max- age=600, public" end it 'has a 200 status' do get :index response.status.should == 200 end end end Saturday, June 22, 13
42. Teste somente o que for relevante Saturday, June 22, 13
43. Documentar! Saturday, June 22, 13
44. Colocar no README e reproduzir no / da API Saturday, June 22, 13
45. Usar testes que geram documentação https://github.com/zipmark/rspec_api_documentation Saturday, June 22, 13
46. Testar com testes de controller Testar headers e status code (quando forem relevantes) Manter documentação atualizada! Saturday, June 22, 13
47. Estamos Contratando! Saturday, June 22, 13
48. Perguntas ? Links Relevantes http://bit.ly/testando-apis Twitter @rlmflores Github rodrigoflores E-mail rmflores@bioritmo.com.br Blog blog.rlmflores.me Saturday, June 22, 13