bad implementation

Author: JMLamodiere

.editorconfig

@@ -18,6 +18,9 @@ indent_size = 4
 [docs/**openapi.yml]
 indent_size = 2
 
+[docker-compose*.yml]
+indent_size = 2
+
 [*.json]
 indent_size = 4
 

.env

@@ -13,6 +13,12 @@
 # Run "composer dump-env prod" to compile .env files for production use (requires symfony/flex >=1.2).
 # https://symfony.com/doc/current/best_practices.html#use-environment-variables-for-infrastructure-configuration
 
+# See https://home.openweathermap.org/api_keys
+# OPENWEATHER_API_KEY=??? (defined in .env.local ignored by .gitignore)
+# See https://developer.accuweather.com/user/me/apps
+# ACCUWEATHER_API_KEY=??? (defined in .env.local ignored by .gitignore)
+ACCUWEATHER_BASE_URI='http://dataservice.accuweather.com/'
+
 ###> symfony/framework-bundle ###
 APP_ENV=dev
 APP_SECRET=d63e877b0444331114e7842dd8105ae1
@@ -25,3 +31,12 @@ CORS_ALLOW_CREDENTIALS=true
 CORS_ORIGIN_REGEX=false
 CORS_ALLOW_ORIGIN=*
 ###< nelmio/cors-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"
+# For a PostgreSQL database, use: "postgresql://db_user:[email protected]:5432/db_name?serverVersion=11&charset=utf8"
+# IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
+# DATABASE_URL=mysql://db_user:[email protected]:3306/db_name?serverVersion=5.7
+# NB : already set in dev and test by symfony server, see https://symfony.com/doc/4.4/setup/symfony_server.html#docker-integration
+###< doctrine/doctrine-bundle ###

.env.test

@@ -2,3 +2,11 @@
 KERNEL_CLASS='App\Kernel'
 APP_SECRET='$ecretf0rt3st'
 SYMFONY_DEPRECATIONS_HELPER=999999
+
+ACCUWEATHER_API_KEY='accuweatherTestKey'
+ACCUWEATHER_BASE_URI='http://wiremock:8080/'
+
+###> doctrine/doctrine-bundle ###
+# See docker-compose.yml
+DATABASE_URL=postgres://forumphp:forumphp@database:5432/forumphp?sslmode=disable&charset=utf8
+###< doctrine/doctrine-bundle ###

.travis.yml

@@ -1,11 +1,14 @@
-# Ensure that PHP is installed in Travis' build environment. Travis provides several versions of
-# PHP like 5.6, 7.0, 7.1, 7.2, 7.3, 7.4, etc., each of them including XDebug and PHPUnit.
-language: php
 sudo: false
 
+env:
+  global:
+    - APP_ENV = test
+
+services:
+  - docker
+
 # Travis can cache content between builds. This speeds up the build process and saves resources.
 cache:
-  yarn: true
   directories:
     # Cache composer packages so "composer install" is faster.
     - $HOME/.composer/cache/files
@@ -16,27 +19,16 @@ jobs:
   # conditions are met: The only remaining jobs are allowed to fail, or a job has already failed. In
   # these cases, the status of the build can already be determined, so there’s no need to wait around
   fast_finish: true
-  include:
-    - php: 7.4
 
 branches:
   only:
     - main
 
 before_install:
-  - phpenv config-rm xdebug.ini || true
+  - make preinstall
 
 install:
-  - composer install
+  - make install
 
 script:
-  - ./vendor/bin/phpunit
-  - ./vendor/bin/behat
-  # this checks that the source code follows the Symfony Code Syntax rules
-  - './vendor/bin/php-cs-fixer --config=.php_cs.dist fix --diff --dry-run -v'
-  # this checks that the YAML config files contain no syntax errors
-  - ./bin/console lint:yaml config --parse-tags
-  # This checks that arguments injected into services match type declarations.
-  - ./bin/console lint:container
-  # this checks that the composer.json and composer.lock files are valid
-  - composer validate --strict
+  - make test

Makefile

@@ -14,23 +14,55 @@ SHELL := $(shell which bash)
 help: ## Show Help
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
-serve: ## Run local dev server
+# Dev environment. Require php and symfony executables
+
+start: ## [dev] Start local dev server
+	docker-compose up -d
 	symfony serve -d
 
-log: ## Follow logs on local dev server
+ps: ## [dev] docker-compose ps
+	docker-compose ps
+
+server-logs: ## [dev] Follow logs on local dev server
 	symfony server:log
 
-stop: ## Stop local dev server
+docker-logs: ## [dev] Follow logs on docker containers
+	docker-compose logs -f
+
+stop: ## [dev] Stop local dev server
 	symfony server:stop
+	docker-compose stop
+
+prune: ## [dev] Prune docker containers
+	docker-compose down -v --rmi local --remove-orphans
+
+fix-style: ## [dev] Run php-cs-fixer
+	vendor/bin/php-cs-fixer fix --config=.php_cs.dist -v
 
-test:phpunit ## Run all tests
+# Test / CI environment. Require docker and docker-compose executables
+
+preinstall: ## Pre-install steps
+	docker-compose up -d
+
+install: ## Install steps
+	docker-compose run php composer install
+
+test:lint ## Run all tests
+test:phpunit
 test:behat
 
+lint: ## Run all linters
+	# Checks coding standards. Fixable with "make fix-style"
+	docker-compose run php ./vendor/bin/php-cs-fixer --config=.php_cs.dist fix --diff --dry-run -v
+	# checks that the YAML config files contain no syntax errors
+	docker-compose run php ./bin/console lint:yaml config --parse-tags
+	# checks that arguments injected into services match type declarations.
+	docker-compose run php ./bin/console lint:container
+	# checks that the composer.json and composer.lock files are valid
+	docker-compose run php composer validate --strict
+
 phpunit: ## Run phpunit
-	vendor/bin/phpunit
+	docker-compose run php vendor/bin/phpunit
 
 behat: ## Run behat
-	vendor/bin/behat
-
-fix-style: ## Run php-cs-fixer
-	vendor/bin/php-cs-fixer fix --config=.php_cs.dist -v
+	docker-compose run php vendor/bin/behat

README.md

@@ -1,13 +1,74 @@
 # TDD Demo - ForumPHP 2020
 
+[![Build Status](https://travis-ci.com/JMLamodiere/tdd-demo-forumphp2020.svg?branch=main)](https://travis-ci.com/JMLamodiere/tdd-demo-forumphp2020)
+
 Forum PHP 2020 talk (in French) : [Trop de mock tue le test : ce que l'archi hexagonale a changé](https://event.afup.org/forum-php-2020/programme-forum-php-2020/#3414)
 
+:warning: **WARNING:** The [bad_implementation](https://github.com/JMLamodiere/tdd-demo-forumphp2020/tree/bad_implementation)
+branch contains example of bad practices ! See [main](https://github.com/JMLamodiere/tdd-demo-forumphp2020) branch
+for correct implementation.
+
 ## API documentation
 
 - Local : [docs/openapi.yml](docs/openapi.yml)
 - Github Pages : https://jmlamodiere.github.io/tdd-demo-forumphp2020
-- Swaggger Hub : https://app.swaggerhub.com/apis/JMLamodiere/tdd-demo_forum_php_2020/1.0.0
+- Swaggger Hub (with online mock) : https://app.swaggerhub.com/apis/JMLamodiere/tdd-demo_forum_php_2020/1.0.0
 
 ## Makefile
 
 Run `make` or `make help` to see available commands.
+
+### Test environment
+
+Pre-requisites :
+
+- [docker](https://www.docker.com/)
+- [docker-compose](https://docs.docker.com/compose/)
+
+Run tests with:
+
+    make install
+    make test
+
+### Dev environment
+
+Pre-requisites (see [composer.json](composer.json)) :
+
+- PHP >= 7.4
+- ext-pgsql
+- [Symfony local web server](https://symfony.com/doc/current/setup/symfony_server.html)
+
+Start local dev environment with:
+
+```
+composer install
+make start
+```
+
+- Symfony homepage (404): https://127.0.0.1:8000/
+- Symfony profiler: https://127.0.0.1:8000/_profiler/
+
+### SwaggerHub mock server
+
+An online mock server is auto-generated based on openapi doc at https://virtserver.swaggerhub.com/JMLamodiere/tdd-demo_forum_php_2020/1.0.0 . Example :
+
+    curl -i -X PUT "https://virtserver.swaggerhub.com/JMLamodiere/tdd-demo_forum_php_2020/1.0.0/runningsessions/42" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"id\":42,\"distance\":5.5,\"shoes\":\"Adadis Turbo2\"}"
+
+## Postgresql
+
+To access Postgresql database, configure a tool such as
+[Database Tools and SQL](https://www.jetbrains.com/help/phpstorm/connecting-to-a-database.html#connect-to-postgresql-database)
+included in PHPStorm:
+
+- URL: `jdbc:postgresql://localhost:32774/forumphp` (replace `32774` with the port given by `make ps` command)
+- login: `forumphp`
+- password: `forumphp` (see [docker-compose.yml](docker-compose.yml))
+
+## Wiremock
+
+- Local server: https://hub.docker.com/r/rodolpheche/wiremock/ (see [docker-compose.yml](docker-compose.yml))
+- PHP Client: https://github.com/rowanhill/wiremock-php (used in PHP tests)
+
+See Swagger UI documentation at http://localhost:32775/__admin/swagger-ui/
+
+Replace `32775` with the port given by `make ps` command

behat.yml.dist

@@ -4,6 +4,8 @@ default:
             contexts:
                 - FeatureContext:
                     kernel: '@kernel'
+                    dbal: '@doctrine.dbal.default_connection'
+                    accuweatherApiKey: '%%accuweather.apikey%%'
 
     extensions:
         Behat\Symfony2Extension:

composer.json

@@ -8,20 +8,27 @@
         "ext-ctype": "*",
         "ext-iconv": "*",
         "ext-json": "*",
+        "ext-pgsql": "*",
+        "doctrine/doctrine-bundle": "^2.1",
+        "guzzlehttp/guzzle": "^7.2",
         "symfony/console": "4.4.*",
         "symfony/dotenv": "4.4.*",
         "symfony/flex": "^1.3.1",
         "symfony/framework-bundle": "4.4.*",
-        "symfony/yaml": "4.4.*"
+        "symfony/serializer": "4.4.*",
+        "symfony/yaml": "4.4.*",
+        "webmozart/assert": "^1.9"
     },
     "require-dev": {
         "behat/behat": "^3.7",
         "behat/symfony2-extension": "^2.1",
         "friendsofphp/php-cs-fixer": "^2.16",
         "nelmio/cors-bundle": "^2.1",
+        "phpspec/prophecy-phpunit": "^2.0",
         "phpunit/phpunit": "^9.4",
         "symfony/phpunit-bridge": "^5.1",
-        "symfony/web-profiler-bundle": "4.4.*"
+        "symfony/web-profiler-bundle": "4.4.*",
+        "wiremock-php/wiremock-php": "^2.27"
     },
     "config": {
         "platform": {
@@ -39,7 +46,7 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "App\\Tests\\": "tests/"
+            "App\\": "tests/"
         }
     },
     "replace": {