[Feature]: Add docker setup and an updated README for people who want to contribute

[sven-ahrens]

Feature: Docker Setup for Testing

Motivation

I recently opened an issue (#259) and want to contribute to the project to help improve it. However, as a newcomer to Symfony and this specific project, I faced challenges getting started.

Firstly, I couldn't find a README or any documentation to guide me through the project setup. Additionally, running tests or performing other tasks seemed reliant on having PHP, Composer, MySQL, and other services installed locally, which is not an ideal practice.

To address this, I've created this branch to enhance the onboarding process for new contributors like myself.

How to Test

1. Clone this branch.
2. Run: docker-compose up -d to install the necessary services.
3. Enter the container: docker-compose exec php-fpm bash.
4. Install dependencies: composer install.
5. Run tests and ensure everything works as expected: /vendor/bin/phpunit.

[sven-ahrens]

Hm, actually in retrospect, I'm not sure if it's smart to ship a complete docker setup but I think the README would be a smart idea with maybe a reference to such docker setup or alternative and which services the project needs in order to get started like php, composer, sqlite etc.

[alexislefebvre]

Thanks for the PR.

Changing the configuration for the database connections break the CI since the hostnames don't exist on GitHub Actions.

Ideally, we would have a configuration that work in GitHub actions and on local docker-compose stack.

It looks like there is no way to start a database and reach it through the mysql or postgresql, even if that's the name of the service: https://github.com/liip/LiipTestFixturesBundle/blob/2.x/.github/workflows/tests.yml#L44

Maybe the easiest solution if to pass some variables like MYSQL_HOST=mysql to PHP in docker-compose.yml, and use something like this in the YAML file:

doctrine:
    dbal:
        driver: pdo_mysql
        host: '%env(default:127.0.0.1:file:MYSQL_HOST)%'

It should fallback to the current configuration when working without docker-compose.

[alexislefebvre]

We can try to modify .github/workflows/tests.yml in order to add aliases for the mariadb and postgres hosts so that GitHub Actions will be able to connect to the databases: https://stackoverflow.com/questions/66980682/is-it-possible-to-define-host-mappings-in-github-actions/66982842#66982842

MYSQL_ALLOW_EMPTY_PASSWORD should probably be removed and the root password should be provided in order to correspond to the YAML settings.

The file tests/AppConfigMysqlUrl/config.yml will have to be updated too.

[alexislefebvre]

I made some small adjustments and now tests are passing on local environment through docker-compose and on GitHub Actions too.

For some reason, sudo apt install -y -q mariadb-client crashes on one job, it may be a temporary error. It worked 2 weeks ago: #256

Let's merge it as is.

Thanks for your contribution!

---

Update: apt update was missing, see:

• chore: fix installation of mysqldump on CI #262