Agile Hacking » pt-br http://gabrielfalcao.com The GNUs of mine, and its green builds Tue, 08 Jun 2010 13:22:40 +0000 en hourly 1 http://wordpress.org/?v=3.2.1 Apresentando Lettuce, BDD em python http://gabrielfalcao.com/2010/05/12/apresentando-lettuce-bdd-em-python/ http://gabrielfalcao.com/2010/05/12/apresentando-lettuce-bdd-em-python/#comments Wed, 12 May 2010 23:50:14 +0000 Gabriel Falcão http://gabrielfalcao.com/?p=175 Depois de muitas horas de hacking intenso, venho apresentar a primeira release candidate do Lettuce.

Trata-se de uma ferramenta de BDD 100% baseada no Cucumber.

O nome teve duas motivações:

  • Lettuce (Alface) é um vegetal verde, assim como Cucumber (Pepino), a idéia é que os testes sempre estejam verdes :)
  • Letuce é também o nome de uma banda à qual tenho muita admiração.

Mãos ao código

Deixei links para a documentação no fim deste post, mas aqui vai uma prévia:

Funcionalidades são descritas em arquivos com a extensão .feature, e devem ficar por padrão, dentro do seu projeto, chamada features

Por sua vez, features são descritas assim:

Feature: Introduce lettuce to my friends
  In order to show it working
  As lettuce author
  I want to create a scenario that passes

  Scenario: Concatenate names
    Given I have the following names:
      | name | surname |
      | john | doe     |
      | ian  | murdock |
    When I join them
    Then I see the data:
      | joined       |
      | Doe, John    |
      | Murdock, Ian |

Para implementar as steps, basta criar um arquivo python qualquer dentro da pasta features o Lettuce importará todos eles recursivamente.
Exemplo:

# -*- coding: utf-8 -*-
from lettuce import step, world, before
from some_module import NameJoiner

# setup
@before.each_scenario
def set_joined(scenario):
    world.joined = []

# steps
@step('I have the following names')
def set_names(step):
    world.people = step.hashes

@step('join them')
def join_names(step):
    for person in world.people:
        joiner = NameJoiner(
            name=person["name"],
            surname=person["surname"]
        )
        world.joined.append(joiner.join())

@step('I see the data')
def check_names(step):
    for name, data in zip(world.joined, step.hashes):
        assert name == data['joined']

(baixe o exemplo completo aqui)

Motivação

Desde que comecei a praticar TDD em Python tive várias experiências, testei várias bibliotecas de mock e técnicas de teste.
Em projetos de aplicações web usei o Pyccuracy, assim podia descrever o comportamento da aplicação ao mesmo tempo que fazia testes automatizados da interface.

No entanto, tive a chance de testar o  Cucumber num projeto Django aqui na globo.com, me apaixonei por funcionalidades incrivelmente produtivas, como step tables que permite desenhar uma tabela com caracteres, e mapear como lista de hashes, bem como scenario outlines.

Daí veio a grande inspiração: implementar uma ferramenta como o Cucumber, mas em python puro.

Por que?
Para programadores python, é mais cômodo usar bibliotecas em python puro. Eu pessoalmente evito misturar linguagens, a não ser que a melhor solução seja realmente em outra linguagem.

Cucumber é, na minha opinião, uma lib que torna ruby ainda mais sexy :)
Criar uma aplicação robusta, bem testada requer paciência, que tal tornar isso mais divertido ?
É mais fácil empacotar módulos python para debian/ubuntu :P

Além disso, apesar de Cucumber dar suporte a Python, seria interessante usar python puro dentro das step definitions.
Supondo o desenvolvimento de uma aplicação Django com cucumber, seria útil manipular os models dentro de step definitions. Entretanto, para isso acontecer, é necessário usar algo como rubypython, cuja última release data outubro de 2009.

Exemplos de bibliotecas similares/equivalentes entre python e ruby

Framework web:

ruby: rails
python: django

Micro-framework web:

ruby: sinatra
python: cherrypy

Deploy automatizado:

ruby: capistrano
python: fabric

Behaviour-driven development:

ruby: cucumber
python: lettuce ?! (quem sabe :P )

Direto ao assunto!

Hoje estou liberando oficialmente a primeira release candidate do Lettuce, que atualmente possui as seguintes features:

  • Hooks pre/pós execução de:
    • Toda a suíte de testes
    • Cada feature
    • Cada scenario
    • Cada step
  • Contexto global: world
  • Scenario outlines
  • Step tables
  • Nomes e formato de arquivo de features compatível com cucumber
  • Output colorido
  • Output sem cor

Mas… O que falta para fechar a primeira release oficial? Além de ter feedback sobre possíveis bugs das features já implementadas para melhorá-las, a intenção é que a primeira release também tenha as seguintes funcionalidades:

Documentação

Não poderia faltar, mas ainda está sendo escrita.
De qualquer forma, já possui o básico para colocar o um novo projeto funcionando. E se você já conhece o Cucumber, não terá dificuldades.

Acesse a documentação aqui

Ou melhor ainda, vá direto ao “quick start”

Contribua!

Estou sedento por feedbacks (negativos e positivos), sendo assim:

Por fim, o lettuce está sob GNU GPL 3+ e ainda tem um longo caminho pela frente. Toda forma de ajuda é bem vinda, seja com patches, documentação, suporte para outros idiomas, etc.

Happy hacking :)

]]> http://gabrielfalcao.com/2010/05/12/apresentando-lettuce-bdd-em-python/feed/ 16