/robot-test-api-rest

Automating API Rest tests with Robot Framework.

Primary LanguageRobotFrameworkMIT LicenseMIT

Testes automatizados com Robot Framework para API "FakeRestAPI.Web"

1. Estrutura de arquivos e diretórios

Os testes estão estruturados nos seguintes diretórios:

  • keywords: diretório que contém arquivos .robot com a implementação das palavras-chaves (keywords).
  • other_files: diretório que contém arquivos .json criados para passar os dados do body nos testes com PUT e POST.
  • test-suites: diretório que contém arquivos .robot com as suítes de testes (cenários ou casos de testes).
  • requirements.txt: arquivo que contém as chamadas para instalação das libraries do robot que são necessárias para executar os testes.

2. Pré condições para os testes

  • Clonar esse projeto
  • Python 2.7.x ou superior
  • Usar um editor ASCII de sua preferência (VSCode, Atom, RIDE, etc)

3. Instalando libraries Python necessárias

Instale todas a libraries Python necessárias, digitando no terminal o comando:

Linux / Mac
$ pip install -r requirements.txt --user

4. Executando os testes de aceitação

Os comandos abaixo devem ser executados no terminal, no diretório raiz do projeto.

  • Para executar somente os cenários de consulta (GET):
$ python -m robot -d output/consults test-suites/consult-data.robot
  • Para executar somente os cenários de manipulação de dados (PUT, POST and DELETE):
$ python -m robot -d output/manipultation test-suites/manipulation-data.robot

NOTE: Para os testes com métodos PUT e POST, foram criados dois arquivos .json para passar os dados do body. Eles podem ser alterados conforme necessidade.

5. Gerando documentação adicional

Gerando docuentação para as palavras-chaves do usuário (common.robot):

$ python -m robot.libdoc keywords/faker-api.robot doc/faker-api.html

Gerando documentação para os casos de testes existentes:

$ python -m robot.testdoc test-suites/ doc/test-suites.html