60º Python Floripa on-line : Factory Boy - testing like a pro

@cmaiacd factory_boy 60º Python Floripa on-line - Jun 2021 Camila
Maia Testing like a pro

@cmaiacd Esta apresentação está disponível em: speakerdeck.com/cmaiacd

@cmaiacd Quem sou eu?

@cmaiacd Quem sou eu? Desenvolvedora Backend 10+ anos xp 👵
Python 🐍 e Ruby 💎 OpenSource e Comunidades ❤ Organização de eventos

@cmaiacd Criadora da ScanAPI

@cmaiacd Primeiro perﬁl aprovado no programa de Sponsors para quem
reside no Brasil 󰎙 Quem sou eu?

@cmaiacd factory_boy: o quê é?

@cmaiacd • Ferramenta que substitui ﬁxtures • Baseada no factory_bot
(Thoughtbot) • Primeira versão: só Django • Atualmente: independe de framework

@cmaiacd Para objetos complexos ❌ Fixtures: estáticas, de difícil manutenção
✅ Factories: fácil de usar

@cmaiacd ❌ conﬁguração de teste extensa todas as combinações possíveis
cobrindo todas as exceções ✅ objetos personalizados para o teste atual enquanto apenas declara os campos especíﬁcos do teste

@cmaiacd Possui muitas ferramentas que auxiliam na criação dos testes:
• Sequence • Fuzzy attributes • Faker • LazyFunction • LazyAttribute • Herança • Params • Traits • Strategies • RelatedFactory/SubFactory

@cmaiacd Aplicação Exemplo

@cmaiacd Questions - Admin

@cmaiacd Create Question - Admin

@cmaiacd Polls

@cmaiacd Poll

@cmaiacd Results

@cmaiacd Modelo - Question

@cmaiacd Modelo - Choice

@cmaiacd Instalar

@cmaiacd $ pip install factory_boy

@cmaiacd Utilizar

@cmaiacd Factories

@cmaiacd shell

@cmaiacd Boas Práticas

@cmaiacd Factories ruins são como vírus • Fixtures podem ﬁcar
muito amarradas • Erros implícitos podem ocorrer • Muito copiar / colar com pequenas alterações • Uma fixture mal projetada pode afetar muitos testes • Os desenvolvedores se deparam com o mesmo problema repetidamente • A mesma gambis tem que ser feita repetidamente

@cmaiacd 1. FACTORIES DEVEM REPRESENTAR SEUS MODELOS

@cmaiacd Modelos

@cmaiacd RUIM ❌

@cmaiacd BOM ✅

@cmaiacd 2. OS TESTES NÃO DEVEM DEPENDER DOS VALORES DEFAULT

@cmaiacd • Se alguém modiﬁcar o valor default, seu teste
irá quebrar. • O teste precisa ter todo o setup necessário para garantir que sempre irá funcionar

@cmaiacd RUIM ❌

@cmaiacd BOM ✅

@cmaiacd 3. FACTORIES DEVEM CONTER APENAS OS CAMPOS NECESSÁRIOS

@cmaiacd Se o campo é nullable (null=True) o atributo deve
estar em uma trait e não como valor default

@cmaiacd RUIM ❌

@cmaiacd BOM ✅

@cmaiacd • O método `.save()` irá funcionar? • Quando vamos
nos lembrar de testar QuestionFactory(author=None)? • Não podemos assumir que existe um campo, quando o BD nos permite tê-lo como nulo.

@cmaiacd 4. EVITAR O USO DO .CREATE()

@cmaiacd • MyFactory.build() cria objeto local (memória) • MyFactory.create() objeto
local + salva no banco de dados

@cmaiacd RUIM ❌

@cmaiacd BOM ✅

@cmaiacd BUILD STRATEGY ======================== 14 passed in 1.76 seconds =========================
CREATE STRATEGY ======================== 14 passed in 3.26 seconds =========================

@cmaiacd 5. FK PRESENTE NA TABELA? UTILIZAR SubFactory FK PRESENTE
NA OUTRA TABELA? UTILIZAR RelatedFactory + TRAIT

@cmaiacd • SubFactory: build/create durante o processo de criação da
primeira factory • RelatedFactory: build/create depois da criação da primeira factory.

@cmaiacd Bom ✅

@cmaiacd 6. FIXTURES APENAS COMO WRAPPERS

@cmaiacd BOM ✅

@cmaiacd 7. EVITAR O USO DE FIXTURES COMPARTILHADAS ENTRE ARQUIVOS,
COMO CONFTEST

@cmaiacd • Muitos testes dependendo da mesma fixtures • Tende
a inflar a fixture • Difícil de manter • Altera a fixture => quebra muitos testes

@cmaiacd Código Código

@cmaiacd 1. Factories devem representar seus modelos 2. Os testes
não devem depender dos valores default 3. Factories devem conter apenas os campos necessários 4. Evitar o uso do .create() 5. FK presente na tabela? Utilizar SubFactory FK presente na outra tabela? Utilizar RelatedFactory + Trait 6. Fixtures apenas como wrappers 7. Evitar o uso de ﬁxtures compartilhadas entre arquivos, como conftest Recapitulando

@cmaiacd Sobre Faker

@cmaiacd Factory Boy Doc completa: https://factoryboy.readthedocs.io/en/stable/ Código: https://github.com/FactoryBoy/factory_boy Faker Faker
doc: https://faker.readthedocs.io/en/master/ Standard providers: https://faker.readthedocs.io/en/stable/providers.html Community providers: https://faker.readthedocs.io/en/stable/communityproviders.html Referências

@cmaiacd MUITO OBRIGADA! @cmaiacd camilamaia 󰠁 cmaiacd.com

60º Python Floripa on-line : Factory Boy - test...

60º Python Floripa on-line : Factory Boy - testing like a pro

More Decks by Camila Maia

Other Decks in Technology

Featured

Transcript