docker-symfony-api v1.0.0

Author: dmitriy

.circleci/config.yml

@@ -0,0 +1,38 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/html
+    machine: true
+    branches:
+        ignore:
+          - develop
+    steps:
+      - checkout
+
+      - run:
+          name: Start container and verify it's working
+          command: |
+            make start-test
+
+      - run:
+          name: Wait for DB container is running and initialize DB
+          command: |
+            make wait-for-db
+            make drop-migrate
+            make generate-jwt-keys
+
+      - run:
+          name: Run unit/functional tests
+          command: |
+            make phpunit
+
+      - run:
+          name: Report code coverage
+          command: |
+            make report-code-coverage
+
+      - store_artifacts:
+          path: reports
+
+      - store_test_results:
+          path: reports

.dockerignore

@@ -0,0 +1,18 @@
+/.git*
+/.idea*
+.dockerignore
+.editorconfig
+
+/.env.local
+/.env.*.local
+.env.local.php
+/public/bundles/
+var/mysql-data
+var/rabbitmq
+vendor/
+
+Dockerfile
+docker-compose.yml
+docker-compose-test-ci.yml
+docker-compose-prod.yml
+Makefile

.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2
+
+[{composer.json,Makefile}]
+indent_style = tab

.env

@@ -0,0 +1,54 @@
+# In all environments, the following files are loaded if they exist,
+# the later taking precedence over the former:
+#
+#  * .env                contains default values for the environment variables needed by the app
+#  * .env.local          uncommitted file with local overrides
+#  * .env.$APP_ENV       committed environment-specific defaults
+#  * .env.$APP_ENV.local uncommitted environment-specific overrides
+#
+# Real environment variables win over .env files.
+#
+# DO NOT DEFINE PRODUCTION SECRETS IN THIS FILE NOR IN ANY OTHER COMMITTED FILES.
+#
+# Run "composer dump-env prod" to compile .env files for production use (requires symfony/flex >=1.2).
+# https://symfony.com/doc/current/best_practices/configuration.html#infrastructure-related-configuration
+
+###> symfony/framework-bundle ###
+APP_ENV=dev
+APP_DEBUG=1
+APP_SECRET=42f011ec3a7bde0bec87364b1d967193
+#TRUSTED_PROXIES=127.0.0.1,127.0.0.2
+#TRUSTED_HOSTS='^localhost|example\.com$'
+###< symfony/framework-bundle ###
+
+###> doctrine/doctrine-bundle ###
+# Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
+# For an SQLite database, use: "sqlite:///%kernel.project_dir%/var/data.db"
+# Configure your db driver and server_version in config/packages/doctrine.yaml
+DATABASE_URL=mysql://root:secret@mysql:3306/symfony
+###< doctrine/doctrine-bundle ###
+
+###> symfony/swiftmailer-bundle ###
+# For Gmail as a transport, use: "gmail://username:password@localhost"
+# For a generic SMTP server, use: "smtp://localhost:25?encryption=&auth_mode="
+# Delivery is disabled by default via "null://localhost"
+MAILER_URL=null://localhost
+###< symfony/swiftmailer-bundle ###
+
+###> symfony/messenger ###
+MESSENGER_TRANSPORT_DSN=amqp://guest:guest@rabbitmq:5672/%2f/messages
+###< symfony/messenger ###
+
+###> lexik/jwt-authentication-bundle ###
+JWT_SECRET_KEY=config/jwt/private.pem
+JWT_PUBLIC_KEY=config/jwt/public.pem
+JWT_PASSPHRASE=3a37d3afd9accc7959f952b2ae555d21
+JWT_TOKEN_TTL=3600
+###< lexik/jwt-authentication-bundle ###
+
+###> nelmio/cors-bundle ###
+CORS_ALLOW_ORIGIN=^https?://localhost(:[0-9]+)?$
+###< nelmio/cors-bundle ###
+
+# how many days health history will be stored in the db
+DATABASE_HEALTH_HISTORY_DAYS=7

.env.prod

@@ -0,0 +1,4 @@
+# define your env variables for the prod env here
+APP_ENV=prod
+APP_SECRET=42f011ec3a7bde0bec87364b1d967194
+APP_DEBUG=0

.env.test

@@ -0,0 +1,7 @@
+# define your env variables for the test env here
+APP_ENV=test
+KERNEL_CLASS='App\Kernel'
+APP_SECRET='$ecretf0rt3st'
+APP_DEBUG=0
+SYMFONY_DEPRECATIONS_HELPER=999999
+DATABASE_URL=mysql://root:secret@mysql:3306/symfony_testing

.gitattributes

@@ -0,0 +1,5 @@
+* text=auto
+*.css linguist-vendored
+*.scss linguist-vendored
+*.js linguist-vendored
+CHANGELOG.md export-ignore

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: Symfony Rest API
+
+on:
+    push:
+        branches:
+            - master
+            - develop
+    pull_request:
+        branches:
+            - master
+            - develop
+    release:
+        types: [published]
+
+jobs:
+
+    build:
+
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v1
+            - name: Build the docker images
+              run: docker-compose -f docker-compose-test-ci.yml build
+            - name: Start the docker images
+              run: make start-test
+            - name: Check running containers
+              run: docker ps -a
+            - name: Wait for database connection
+              run: make wait-for-db
+            - name: Run migrations
+              run: make drop-migrate
+            - name: Generate keys
+              run: make generate-jwt-keys
+            - name: Run test suite
+              run: make phpunit
+            - name: Stop the docker images
+              run: make stop-test

.gitignore

@@ -0,0 +1,22 @@
+/.idea
+reports/*
+!reports/.gitkeep
+.phpunit.result.cache
+
+###> symfony/framework-bundle ###
+/.env.local
+/.env.local.php
+/.env.*.local
+/public/bundles/
+/var/
+/vendor/
+###< symfony/framework-bundle ###
+
+###> symfony/phpunit-bridge ###
+.phpunit
+/phpunit.xml
+###< symfony/phpunit-bridge ###
+
+###> lexik/jwt-authentication-bundle ###
+/config/jwt/*.pem
+###< lexik/jwt-authentication-bundle ###

Dockerfile

@@ -0,0 +1,90 @@
+FROM php:7.4-fpm
+
+# set main params
+ARG BUILD_ARGUMENT_DEBUG_ENABLED=false
+ENV DEBUG_ENABLED=$BUILD_ARGUMENT_DEBUG_ENABLED
+ARG BUILD_ARGUMENT_ENV=dev
+ENV ENV=$BUILD_ARGUMENT_ENV
+ENV APP_HOME /var/www/html
+
+# check environment
+RUN if [ "$BUILD_ARGUMENT_ENV" = "default" ]; then echo "Set BUILD_ARGUMENT_ENV in docker build-args like --build-arg BUILD_ARGUMENT_ENV=dev" && exit 2; \
+    elif [ "$BUILD_ARGUMENT_ENV" = "dev" ]; then echo "Building development environment."; \
+    elif [ "$BUILD_ARGUMENT_ENV" = "test" ]; then echo "Building test environment."; \
+    elif [ "$BUILD_ARGUMENT_ENV" = "prod" ]; then echo "Building production environment."; \
+    else echo "Set correct BUILD_ARGUMENT_ENV in docker build-args like --build-arg BUILD_ARGUMENT_ENV=dev. Available choices are dev,test,prod." && exit 2; \
+    fi
+
+# install all the dependencies and enable PHP modules
+RUN apt-get update && apt-get upgrade -y && apt-get install -y \
+      procps \
+      nano \
+      git \
+      unzip \
+      libicu-dev \
+      zlib1g-dev \
+      libxml2 \
+      libxml2-dev \
+      libreadline-dev \
+      supervisor \
+      cron \
+      libzip-dev \
+      librabbitmq-dev \
+    && pecl install amqp \
+    && docker-php-ext-configure pdo_mysql --with-pdo-mysql=mysqlnd \
+    && docker-php-ext-install \
+      pdo_mysql \
+      sockets \
+      intl \
+      zip \
+    && docker-php-ext-enable amqp && \
+      rm -fr /tmp/* && \
+      rm -rf /var/list/apt/* && \
+      rm -r /var/lib/apt/lists/* && \
+      apt-get clean
+
+# create document root
+RUN mkdir -p $APP_HOME/public
+
+# change owner
+RUN chown -R www-data:www-data $APP_HOME
+
+# put php config for Symfony
+COPY ./docker/$BUILD_ARGUMENT_ENV/www.conf /usr/local/etc/php-fpm.d/www.conf
+COPY ./docker/$BUILD_ARGUMENT_ENV/php.ini /usr/local/etc/php/php.ini
+
+# install Xdebug in case dev/test environment
+COPY docker/general/do_we_need_xdebug.sh /tmp/
+COPY ./docker/dev/xdebug.ini /tmp/
+RUN chmod u+x /tmp/do_we_need_xdebug.sh && /tmp/do_we_need_xdebug.sh
+
+# install composer
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/bin/ --filename=composer
+
+# add supervisor
+RUN mkdir -p /var/log/supervisor
+COPY --chown=root:root ./docker/general/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
+COPY --chown=root:root ./docker/general/cron /var/spool/cron/crontabs/root
+RUN chmod 0600 /var/spool/cron/crontabs/root
+
+# set working directory
+WORKDIR $APP_HOME
+
+# create composer folder for user www-data
+RUN mkdir -p /var/www/.composer && chown -R www-data:www-data /var/www/.composer
+
+USER www-data
+
+# copy source files
+COPY --chown=www-data:www-data . $APP_HOME/
+
+# install all PHP dependencies
+RUN if [ "$BUILD_ARGUMENT_ENV" = "dev" ] || [ "$BUILD_ARGUMENT_ENV" = "test" ]; then composer install --optimize-autoloader --no-interaction --no-progress; \
+    else export APP_ENV=$BUILD_ARGUMENT_ENV && composer install --optimize-autoloader --no-interaction --no-progress --no-dev; \
+    fi
+
+# create cached config file .env.local.php in case prod environment
+RUN if [ "$BUILD_ARGUMENT_ENV" = "prod" ]; then composer dump-env $BUILD_ARGUMENT_ENV; \
+    fi
+
+USER root