Testes automatizados em API

Vitor Mattos

Quem sou eu?

Realizador de sonhos desde 2003
Amante de opensource
Palestrante
PHP Zend Certified Engineer ( ZEND024235 )
PHPRio ( https://telegram.me/phprio )

CTO LibreCode
Redes sociais: ( VitorMattos ou VitorMattosRJ )

  • Economia solidária
  • Segurança e privacidade
  • Comunidades de Software Livre
  • Transparência (dados abertos)
  • Copyleft, claro! LibreCode!
  • Conhecendo a API
  • Implementando testes
    • estáticos
    • unitários
    • funcionais
    • documentação
  • Automatizando tudo

Cronograma

git clone https://github.com/vitormattos/api-test
cd api-test
# PRESENTING CODE

Preparando ambiente

# PRESENTING CODE

Preparando ambiente

Com docker

docker-compose up
# PRESENTING CODE

Preparando ambiente

Sem docker

php -S 0.0.0.0:8080 -t public
# Endpoints

Endpoints

Verbo Endpoint Body
GET /api/user
POST /api/user {"name": "oi","id":1}
DELETE /api/user/{id}

Objetivo: Manipular arquivo storage/database.json

composer require --dev squizlabs/php_codesniffer
# PRESENTING CODE

Análise estática - PHP_CodeSniffer

PSR

https://github.com/squizlabs/PHP_CodeSniffer

vendor/bin/phpcs
# PRESENTING CODE

Análise estática - PHP_CodeSniffer

PSR

https://github.com/squizlabs/PHP_CodeSniffer

vendor/bin/phpcs --standard=PSR12 -n src -n public
# PRESENTING CODE

Análise estática - PHP_CodeSniffer

PSR

https://github.com/squizlabs/PHP_CodeSniffer

    "scripts" : {
        "phpcs" : "phpcs --standard=PSR12 -n src"
    }
# PRESENTING CODE

Análise estática - PHP_CodeSniffer

PSR

https://github.com/squizlabs/PHP_CodeSniffer

composer.json

<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="PHP_CodeSniffer">
    <description>The coding standard for PHP_CodeSniffer itself.</description>
    <arg name="colors"/>
    <file>./src</file>
    <file>./public</file>
    <rule ref="PSR12"></rule>
</ruleset>
# PRESENTING CODE

Análise estática - PHP_CodeSniffer

.phpcs.xml, phpcs.xml, .phpcs.xml.dist, phpcs.xml.dist

Config file

composer require --dev vimeo/psalm
./vendor/bin/psalm --init
# PRESENTING CODE

Análise estática - psalm

install

https://psalm.dev/

./vendor/bin/psalm
# PRESENTING CODE

Análise estática - psalm

Verificando

https://psalm.dev/

./vendor/bin/psalm --show-info=true

Verificando com mais detalhes

    "scripts" : {
        "phpcs" : "phpcs",
        "phpcbf" : "phpcbf",
        "psalm" : "psalm",
        "test" : [
            "@phpcs",
            "@psalm"
        ]
    }
# PRESENTING CODE

Análise estática - psalm

composer.json

https://psalm.dev/

composer require --dev phpstan/phpstan
# PRESENTING CODE

Análise estática - PHPStan

install

https://phpstan.org/

    "scripts" : {
        "phpcs" : "phpcs",
        "phpcbf" : "phpcbf",
        "psalm" : "psalm",
        "phpstan" : "phpstan analyse src --level 5",
        "test" : [
            "@phpcs",
            "@psalm",
            "@phpstan"
        ]
    }
# PRESENTING CODE

Análise estática - PHPStan

composer.json

https://phpstan.org/

Levels: 0-9

# PRESENTING CODE

Análise estática - Phan

Requer extensão, setup mais complexo

https://github.com/phan/phan

# PRESENTING CODE

Análise estática - Phan

# PRESENTING CODE

Unitário - PHPUnit

Tem documentação em português

https://phpunit.de/

# PRESENTING CODE

Unitário - PHPUnit

https://phpunit.de/

composer require --dev phpunit/phpunit
mkdir tests
# PRESENTING CODE

Unitário - PHPUnit

https://phpunit.de/

<?php declare(strict_types=1);

use PHPUnit\Framework\TestCase;

final class UserControllerTest extends TestCase
{
    public function testTrue(): void
    {
        $this->assertTrue(true);
    }
}

tests/unit/Controller/UserControllerTest.php

# PRESENTING CODE

Unitário - PHPUnit

https://phpunit.de/

<testsuites>
  <testsuite name="default">
    <directory suffix="Test.php">tests/Unit</directory>
    <directory suffix="Test.php">tests/Doc</directory>
  </testsuite>
  <testsuite name="unit">
    <directory suffix="Test.php">tests/Unit</directory>
  </testsuite>
  <testsuite name="doc">
    <directory suffix="Test.php">tests/Doc</directory>
  </testsuite>
</testsuites>

Configure: phpunit.xml

# PRESENTING CODE

Unitário - PHPUnit

https://phpunit.de/

run

vendor/bin/phpunit --testsuite unit
# PRESENTING CODE

Funcional - Behat

composer require --dev behat/behat
vendor/bin/behat --init

install

# PRESENTING CODE

Testando documentação

composer require --dev byjg/swagger-test

install

https://github.com/byjg/php-swagger-test

# PRESENTING CODE

Testando documentação

vendor/bin/phpunit --testsuite doc

run

https://github.com/byjg/php-swagger-test

# PRESENTING CODE

Automação de testes - GitHub Actions

name: Psalm
on: pull_request

jobs:
  psalm:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        php-versions: ['8.1', '8.2']

    name: psalm check php${{ matrix.php-versions }}

    steps:
      - name: Checkout
        uses: actions/checkout@master

      - name: Set up php
        uses: shivammathur/setup-php@master
        with:
          php-version: ${{ matrix.php-versions }}
          coverage: none

      - name: Install dependencies
        run: composer i

      - name: Run coding standards check
        run: composer psalm

https://docs.github.com/pt/actions

“Eu cheguei a seguinte conclusão: não adianta consertar o resto, conserta a gente ajuda pra caramba”

Renato Russo

Que país é esse?

Conclusão

Obrigado!

Redes sociais:
( VitorMattos ou VitorMattosRJ )

Testes automatizados em API

By Vitor Mattos

Testes automatizados em API

  • 740

More from Vitor Mattos