feat: implement dockerization with documentation for testing (#474)

* feat: implement dockerization with documentation for testing

* feat: add Dockerfile and docker compose

Author: shakaran

.gitignore

@@ -2,3 +2,4 @@ vendor
 composer.lock
 
 Tests/app/tmp/
+.phpunit.result.cache

Dockerfile

@@ -0,0 +1,28 @@
+FROM php:8.4-cli-bullseye
+
+ENV COMPOSER_ALLOW_SUPERUSER=1
+
+RUN apt-get update && apt-get upgrade -y 
+RUN apt-get update && apt-get upgrade -y && apt-get install --no-install-recommends -y \
+    git unzip zip curl libicu-dev libonig-dev libxml2-dev \
+    libzip-dev libpng-dev libjpeg-dev libfreetype6-dev \
+    libcurl4-openssl-dev pkg-config libssl-dev \
+    default-libmysqlclient-dev default-mysql-client \
+    gnupg2 lsb-release apt-transport-https ca-certificates \
+    && docker-php-ext-install intl mbstring pdo pdo_mysql zip  \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN pecl install mongodb \
+    && docker-php-ext-enable mongodb
+
+# Instalar Composer
+COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
+
+WORKDIR /app
+
+COPY . .
+
+RUN composer install --prefer-dist --no-progress
+
+CMD ["composer", "test"]

README.md

@@ -32,3 +32,8 @@ ___________________
 Here is a little screen shot of the edition page :)
 
 ![edition page screen](https://github.com/lexik/LexikTranslationBundle/raw/master/Resources/doc/screen/grid.jpg)
+
+TESTING
+=======
+
+[Read the documentation for testing ](./testing.md)

Resources/doc/index.md

@@ -6,15 +6,15 @@ Add the bunde to your `composer.json` file:
 ```javascript
 require: {
     // ...
-    "lexik/translation-bundle": "~5.3"
+    "lexik/translation-bundle": "~7.1"
 }
 ```
 
 Or install directly through composer with:
 
 ```shell
 # Latest stable
-composer require lexik/translation-bundle ~5.3
+composer require lexik/translation-bundle ~7.1
 
 # For latest unstable version
 composer require lexik/translation-bundle dev-master
@@ -41,7 +41,9 @@ $bundles = [array(]
 
 Then install the required assets:
 
+```bash
     ./bin/console assets:install
+```
 
 ___________________
 

Resources/doc/testing.md

@@ -25,3 +25,26 @@ Available variables are:
  - DB_PASSWD - database user password (default: null)
  - DB_ENGINE - database engine (default: pdo_mysql)
  - DB_PORT - database port (default: null)
+ - MONGO_SERVER - mongo server DNS string (default: mongodb://admin:secret@127.0.0.1:27017/admin)
+
+All these variables are injected if not provided under the `Tests/bootstrap.php` file.
+
+## Testing with Docker
+
+Direct execution of test:
+
+``` bash
+docker-compose run --rm lexik_translation composer test
+```
+
+Building the image:
+
+``` bash
+docker-compose build --no-cache
+```
+
+Run a test file for a specific test:
+
+``` bash
+docker-compose run --rm lexik_translation composer test Tests/Unit/Translation/Manager/TransUnitManagerTest.php --filter testORMAddTranslation
+```

Tests/bootstrap.php

@@ -7,12 +7,20 @@
 define("ORM_TYPE", getenv("ORM") ?: "doctrine");
 
 define("DB_ENGINE", getenv("DB_ENGINE") ?: "pdo_mysql");
-define("DB_HOST", getenv("DB_HOST") ?: "127.0.0.1");
+if (getenv('DOCKER') === 'true') {
+    define("DB_HOST", getenv("DB_HOST") ?: "mysql");
+} else {
+    define("DB_HOST", getenv("DB_HOST") ?: "127.0.0.1");
+}
 define("DB_PORT", getenv("DB_PORT") ?: 3306);
 define('DB_NAME', getenv("DB_NAME") ?: "lexik_translation_test");
 define("DB_USER", getenv("DB_USER") ?: "root");
 define("DB_PASSWD", getenv("DB_PASSWD") ?: "");
-define("MONGO_SERVER", getenv("MONGO_SERVER") ?: "mongodb://admin:[email protected]:27017/admin");
+if (getenv('DOCKER') === 'true') {
+    define("MONGO_SERVER", getenv("MONGO_SERVER") ?: "mongodb://admin:secret@mongo:27017/admin");
+} else {
+    define("MONGO_SERVER", getenv("MONGO_SERVER") ?: "mongodb://admin:[email protected]:27017/admin");
+}
 
 if (file_exists($file = __DIR__.'/autoload.php')) {
     require_once $file;

docker-compose.yml

@@ -0,0 +1,31 @@
+version: '3.8'
+
+services:
+  lexik_translation:
+    build: .
+    volumes:
+      - .:/app
+    depends_on:
+      - mysql
+      - mongo
+
+  mysql:
+    image: mysql:8.0
+    environment:
+      MYSQL_DATABASE: lexik_translation_test
+      MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
+    ports:
+      - "3306:3306"
+    healthcheck:
+      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
+      interval: 10s
+      timeout: 5s
+      retries: 3
+
+  mongo:
+    image: mongo:4.0
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: admin
+      MONGO_INITDB_ROOT_PASSWORD: secret
+    ports:
+      - "27017:27017"