Add php code coverage (secultce#515)

sertao-dev · Jan 14, 2025 · e116d4b · e116d4b
1 parent a7ffc8e
commit e116d4b
Show file tree

Hide file tree

Showing 11 changed files with 116 additions and 21 deletions.
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -0,0 +1,46 @@
+name: Tests with coverage
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  code-coverage:
+    name: Run PHPUnit with coverage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Start the aurora
+        run: docker compose up -d --build
+
+      - name: Install dependencies
+        run: docker compose exec --user root php composer install
+
+      - name: Generate public/private keys for use in your application.
+        run: docker compose exec --user root php bin/console lexik:jwt:generate-keypair
+
+      - name: Give permissions for var
+        run: sudo chmod -R 777 var/
+
+      - name: Give permissions for assets/uploads
+        run: chmod -R 777 assets/uploads
+
+      - name: Create the phpunit.xml
+        run: docker compose exec --user root php cp phpunit.xml.dist phpunit.xml
+
+      - name: Run migrations
+        run: docker compose exec php bin/console d:m:migrate -n
+
+      - name: Run fixtures
+        run: docker compose exec php bin/console d:f:l -n --purge-exclusions=city --purge-exclusions=state
+
+      - name: Start the PHPUnit
+        run: docker compose exec --user root -T php bash -c "php -d memory_limit=512M bin/phpunit --coverage-clover=coverage.xml"
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          files: coverage.xml
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -53,7 +53,7 @@ jobs:
         run: docker compose exec php bin/console d:f:l -n --purge-exclusions=city --purge-exclusions=state
 
       - name: Start the PHPUnit
-        run: docker compose exec php bin/phpunit
+        run: docker compose exec php bin/phpunit --no-coverage
 
   cypress-run:
     name: Run Cypress

diff --git a/.gitignore b/.gitignore
@@ -26,8 +26,14 @@ package-lock.json
 ###> phpunit/phpunit ###
 /phpunit.xml
 .phpunit.result.cache
+/var/phpunit
 ###< phpunit/phpunit ###
 
+###> phpunit/php-code-coverage ###
+/coverage-html
+coverage.xml
+###< phpunit/php-code-coverage ###
+
 ###> symfony/asset-mapper ###
 /public/assets/
 /assets/vendor/

diff --git a/Makefile b/Makefile
@@ -51,7 +51,11 @@ tests_front: load_fixtures
 
 # Executa as fixtures de dados e os testes de back-end
 tests_back: load_fixtures
-	docker compose exec -T php bash -c "php bin/phpunit"
+	docker compose exec -T php bash -c "php bin/phpunit --no-coverage"
+
+# Executa as fixtures de dados e os testes de back-end
+tests_back_coverage: load_fixtures
+	docker compose exec -T php bash -c "php -d memory_limit=512M bin/phpunit"
 
 # Limpa o cache do projeto
 reset:

diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+[![codecov](https://codecov.io/gh/secultce/aurora/graph/badge.svg?token=CG2AH922DO)](https://codecov.io/gh/secultce/aurora)
+
 # Estrutura inicial Aurora
 
 Este repositório fornece uma configuração base de aplicação Symfony com Docker, Nginx e PostgreSQL para substituir o projeto Aurora utilizado no Ceará.
@@ -90,7 +92,7 @@ php bin/console doctrine:migrations:migrate -n
 php bin/console doctrine:fixtures:load -n
 ```
 
-5 - Instalação das dependêncis do frontend:
+5 - Instalação das dependências do frontend:
 ```bash
 php bin/console importmap:install
 ```
@@ -107,12 +109,12 @@ php bin/console lexik:jwt:generate-keypair
 
 ### Uso
 
-Depois que tudo estiver configurado e as dependências instaladas, você pode acessar sua aplicação Symfony em [http://localhost:8080](http://localhost:8080).
+Depois que tudo estiver configurado e as dependências instaladas, você pode acessar a sua aplicação Symfony em [http://localhost:8080](http://localhost:8080).
 
 Há também uma rota de teste para a API. Você pode acessá-la em [http://localhost:8080/api/example](http://localhost:8080/api/example). Esta rota está definida no controller `ExampleController` e retorna a mensagem de sucesso.
 
 #### Usuário padrão
-Há alguns usuarios que você pode utilizar para fins de teste:
+Há alguns usuários que você pode utilizar para fins de teste:
 
 <table>
 <tr>
@@ -140,7 +142,7 @@ Há alguns usuarios que você pode utilizar para fins de teste:
 <details>
 <summary>Arquitetura e Decisões técnicas</summary>
 
-Estamos utilizando o Symfony e o seu ecossistma de bibliotecas, porém a arquitetura é baseada em camadas e trata-se de um monolítico com a metodologia API First
+Estamos utilizando o Symfony e o seu ecossistema de bibliotecas, porém a arquitetura é baseada em camadas e trata-se de um monolítico com a metodologia API First
 
 ```mermaid
 flowchart TD
@@ -161,8 +163,8 @@ flowchart TD
     CW --HTML/CSS/JS--> B
 ```
 
-- Para saber mais sobre nossas decisões técnicas [acesse aqui](./help/TECHNICAL-DECISIONS.md)
-- Para entender nosso fluxo de desenvolvimento decisões técnicas [clique aqui](./help/DEV-FLOW.md)
+- Para saber mais sobre as nossas decisões técnicas [acesse aqui](./help/TECHNICAL-DECISIONS.md)
+- Para entender o nosso fluxo de desenvolvimento decisões técnicas [clique aqui](./help/DEV-FLOW.md)
 </details>
 
 ## Design UI/UX

diff --git a/bin/phpunit b/bin/phpunit
@@ -5,16 +5,12 @@ if (!ini_get('date.timezone')) {
     ini_set('date.timezone', 'UTC');
 }
 
-$options = ['--testdox'];
-
 if (is_file(dirname(__DIR__).'/vendor/phpunit/phpunit/phpunit')) {
     if (PHP_VERSION_ID >= 80000) {
-        $_SERVER['argv'] = array_merge($_SERVER['argv'], $options);
         require dirname(__DIR__).'/vendor/phpunit/phpunit/phpunit';
     } else {
         define('PHPUNIT_COMPOSER_INSTALL', dirname(__DIR__).'/vendor/autoload.php');
         require PHPUNIT_COMPOSER_INSTALL;
-        $_SERVER['argv'] = array_merge($_SERVER['argv'], $options);
         PHPUnit\TextUI\Command::main();
     }
 } else {
@@ -23,6 +19,5 @@ if (is_file(dirname(__DIR__).'/vendor/phpunit/phpunit/phpunit')) {
         exit(1);
     }
 
-    $_SERVER['argv'] = array_merge($_SERVER['argv'], $options);
     require dirname(__DIR__).'/vendor/symfony/phpunit-bridge/bin/simple-phpunit.php';
 }
diff --git a/composer.json b/composer.json
@@ -92,6 +92,7 @@
         "dama/doctrine-test-bundle": "^8.2",
         "doctrine/doctrine-fixtures-bundle": "^3.6",
         "friendsofphp/php-cs-fixer": "^3.62",
+        "phpunit/php-code-coverage": "^11.0",
         "phpunit/phpunit": "^11.3",
         "symfony/browser-kit": "7.1.*",
         "symfony/css-selector": "7.1.*",

diff --git a/composer.lock b/composer.lock
diff --git a/docker/php/Dockerfile b/docker/php/Dockerfile
@@ -35,6 +35,12 @@ COPY --chown=user:developer . /var/www
 
 RUN chown -R www-data /var/www/assets/uploads
 
+RUN pecl install xdebug \
+    && docker-php-ext-enable xdebug \
+    && echo "zend_extension=xdebug.so" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
+    && echo "xdebug.mode=coverage" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
+    && echo "xdebug.start_with_request=no" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
+
 USER user
 
 EXPOSE 9000
diff --git a/help/COMMANDS.md b/help/COMMANDS.md
@@ -112,6 +112,17 @@ Executa as fixtures de dados e os testes de backend.
 - **Descrição:** Carrega os dados de fixtures e roda os testes backend usando PHPUnit.
 </details>
 
+<details>
+
+<summary>TESTS_BACK_COVERAGE</summary>
+
+### `tests_back_coverage`
+Executa as fixtures de dados, os testes de backend e gera um relatório sobre a atual cobertura de testes.
+- **Uso:** `make tests_back_coverage`
+- **Descrição:** Carrega os dados de fixtures e roda os testes backend usando PHPUnit, utiliza também o xdebug e a biblioteca phpunit/php-code-coverage.
+> O resultado da análise de cobertura pode ser visto no diretório coverage-html, ou no arquivo coverage.xml
+</details>
+
 <details>
 <summary>RESET</summary>
 

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -26,4 +26,28 @@
     <extensions>
         <bootstrap class="DAMA\DoctrineTestBundle\PHPUnit\PHPUnitExtension"/>
     </extensions>
+
+    <source>
+        <include>
+            <directory>src</directory>
+        </include>
+        <exclude>
+            <directory>src/Command</directory>
+            <directory>src/DTO</directory>
+            <directory>src/Helper</directory>
+            <directory>src/Serializer</directory>
+        </exclude>
+    </source>
+
+    <coverage pathCoverage="true">
+        <report>
+            <html outputDirectory="coverage-html"/>
+            <clover outputFile="coverage.xml"/>
+        </report>
+    </coverage>
+
+    <logging>
+        <testdoxHtml outputFile="var/phpunit/tests.html"/>
+        <testdoxText outputFile="var/phpunit/tests.txt"/>
+    </logging>
 </phpunit>