Skip to content

Latest commit

 

History

History
153 lines (123 loc) · 4.08 KB

README.md

File metadata and controls

153 lines (123 loc) · 4.08 KB
Raw

Web service with PHP/Symfony

Build Status codecov

This project is a template to develop/build a Symfony base-project behind a nginx server.

Features

  • Docker containers:
    • api-php : PHP 7.3 / Symfony 5.X
    • api-nginx : NGINX 1.17
    • api-tests : CodeCeption 4.0
  • Makefile
  • Tests : unitary, api, acceptance
  • Continuous Integration : Travis
  • Continuous Integration : GitHub actions
  • Code Coverage Report : Codecov
  • Code quality
    • PHP Code Sniffer (phpcs)
    • PHP Static Analysis (phpstan)

Build

Use a Makefile to run commands

➜ make help                  

Usage:
  make COMMAND [c=<name>]

Commands:
  list                 List the service names available in the docker-compose files
  build                Build all or c=<name> images
  up                   Start all or c=<name> containers in foreground
  stop                 Stop all or c=<name> containers
  restart              Restart all or c=<name> containers
  status               Show status of containers
  ps                   Alias of status
  shell                Start a shell session in the c=<name> container
  exec                 Execute a cmd=<command> on a c=<name> container
  logs                 Show logs for all or c=<name> containers
  clean                Clean the docker services
  clean-all            Remove the docker images (docker services, network and volumes)
  run-tests-all        Run the tests (unit, api, acceptance)
  run-tests-unit       Run the unitary tests
  run-tests-unit-coverage Run the unitary tests and generated the code coverage
  run-tests-api        Run the api tests
  run-tests-api-coverage Run the api tests and generated the code coverage
  run-tests-acceptance Run the acceptance tests

Run the project

Build and run the containers

make build
make up

Liveness probe

➜ curl -i http://127.0.0.1:8881/ping
HTTP/1.1 200 OK
Server: nginx/1.17.6
Content-Type: text/plain; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/7.3.13
Cache-Control: no-cache, private
Date: Thu, 02 Jan 2020 12:52:13 GMT
X-Robots-Tag: noindex

pong

Readiness probe

➜ curl -i http://127.0.0.1:8881/health
HTTP/1.1 200 OK
Server: nginx/1.17.6
Content-Type: text/plain; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/7.3.13
Cache-Control: no-cache, private
Date: Thu, 02 Jan 2020 12:52:13 GMT
X-Robots-Tag: noindex

healthy

Test

make run-tests-all

Note:

  • The unit and api tests can be executed in local within the project via the vendor/bin/codecept command
  • Adding the docker-compose.test.yaml, you can run the tests via the codeception container named api-test
  • The acceptance tests should be executed via the the api-test docker image

Run the unitary tests

via the api-test docker image

make run-tests-unit
make run-tests-unit-coverage

in local

vendor/bin/codecept run unit
vendor/bin/codecept run unit --coverage --coverage-html

Run the api tests

via the api-test docker image

make run-tests-api
make run-tests-api-coverage

in local

vendor/bin/codecept run api
vendor/bin/codecept run api --coverage --coverage-html

Run the acceptance tests

via the api-test docker image

make run-tests-acceptance

in local

ACCEPTANCE_TEST_HOST=http://{host}:{port} vendor/bin/codecept run acceptance

Note : the host to test should be defined via the ACCEPTANCE_TEST_HOST environment variable

Publish code coverage report (on codecov.io)

CODECOV_TOKEN={token} bash <(curl -s https://codecov.io/bash) -f tests/_output/coverage.xml

Note : the Codecov.io repository token should be defined via the CODECOV_TOKEN environment variable