Add PHPCS to the build

Modifying Travis-CI configuration to use build stages and removing explicit MySQL 5.6 execution (it's default now). PHPCS is running with PHP nightly version so we can have it failing for now.
doctrine · Sep 9, 2017 · e5f3e9a · e5f3e9a
1 parent 2ed580d
commit e5f3e9a
Show file tree

Hide file tree

Showing 5 changed files with 170 additions and 71 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -8,3 +8,4 @@ build.properties export-ignore
 build.xml export-ignore
 phpunit.xml.dist export-ignore
 run-all.sh export-ignore
+/phpcs.xml.dist export-ignore
diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,6 @@ dist/
 download/
 vendor/
 *.phpunit.xml
-composer.lock
+composer.lock
+/phpunit.xml
+/.phpcs-cache
diff --git a/.travis.yml b/.travis.yml
@@ -9,153 +9,223 @@ cache:
 
 php:
   - 7.1
+  - 7.2
   - nightly
 
 env:
   - DB=sqlite
   - DB=mysql
   - DB=mysqli
 
+before_install:
+  - mv ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini{,.disabled} || echo "xdebug not available"
+
 before_script:
-  - if [[ $TRAVIS_PHP_VERSION = '7.1' && $DB = 'sqlite' ]]; then PHPUNIT_FLAGS="--coverage-clover .clover.xml"; else PHPUNIT_FLAGS=""; fi
-  - if [[ "$PHPUNIT_FLAGS" == "" ]]; then phpenv config-rm xdebug.ini || true; fi
-  - if [ "$MYSQL_VERSION" == "5.7" ]; then bash ./tests/travis/install-mysql-5.7.sh; fi;
-  - if [[ "$MYSQL_VERSION" == "5.6" || "$MYSQL_VERSION" == "5.7" || "$MARIADB_VERSION" == "10.2" || "$MARIADB_VERSION" == "10.1" || "$MARIADB_VERSION" == "10.0" || "$DB" == "mysql" || "$DB" == "mysqli" ]]; then mysql < tests/travis/create-mysql-schema.sql; fi;
+  - if [[ "$DB" == "mysql" || "$DB" == "mysqli" || "$DB" == "mariadb" ]]; then mysql < tests/travis/create-mysql-schema.sql; fi;
 
-matrix:
-  fast_finish: true
-  include:
-    - php: 7.1
-      env: DB=mysql MYSQL_VERSION=5.6
-      dist: trusty
-    - php: nightly
-      env: DB=mysql MYSQL_VERSION=5.6
-      dist: trusty
+install:
+  - travis_retry composer -n install
+
+script: ./vendor/bin/phpunit --configuration tests/travis/$DB.travis.xml
 
-    - php: 7.1
-      env: DB=mysqli MYSQL_VERSION=5.6
-      dist: trusty
+jobs:
+  allow_failures:
     - php: nightly
-      env: DB=mysqli MYSQL_VERSION=5.6
-      dist: trusty
 
-    - php: 7.1
+  include:
+    - stage: Test
+      php: 7.1
       env: DB=mysql MYSQL_VERSION=5.7
-      dist: trusty
       sudo: required
-    - php: nightly
+      before_script:
+        - bash ./tests/travis/install-mysql-5.7.sh
+    - stage: Test
+      php: 7.2
+      env: DB=mysql MYSQL_VERSION=5.7
+      sudo: required
+      before_script:
+        - bash ./tests/travis/install-mysql-5.7.sh
+    - stage: Test
+      php: nightly
       env: DB=mysql MYSQL_VERSION=5.7
-      dist: trusty
       sudo: required
+      before_script:
+        - bash ./tests/travis/install-mysql-5.7.sh
 
-    - php: 7.1
+    - stage: Test
+      php: 7.1
       env: DB=mysqli MYSQL_VERSION=5.7
-      dist: trusty
       sudo: required
-    - php: nightly
+      before_script:
+        - bash ./tests/travis/install-mysql-5.7.sh
+    - stage: Test
+      php: 7.2
+      env: DB=mysqli MYSQL_VERSION=5.7
+      sudo: required
+      before_script:
+        - bash ./tests/travis/install-mysql-5.7.sh
+    - stage: Test
+      php: nightly
       env: DB=mysqli MYSQL_VERSION=5.7
-      dist: trusty
       sudo: required
+      before_script:
+        - bash ./tests/travis/install-mysql-5.7.sh
 
-    - php: 7.1
+    - stage: Test
+      php: 7.1
       env: DB=mariadb MARIADB_VERSION=10.0
       addons:
         mariadb: 10.0
-    - php: nightly
+    - stage: Test
+      php: 7.2
+      env: DB=mariadb MARIADB_VERSION=10.0
+      addons:
+        mariadb: 10.0
+    - stage: Test
+      php: nightly
       env: DB=mariadb MARIADB_VERSION=10.0
       addons:
         mariadb: 10.0
 
-    - php: 7.1
+    - stage: Test
+      php: 7.1
       env: DB=mariadb MARIADB_VERSION=10.1
       addons:
         mariadb: 10.1
-    - php: nightly
+    - stage: Test
+      php: 7.2
+      env: DB=mariadb MARIADB_VERSION=10.1
+      addons:
+        mariadb: 10.1
+    - stage: Test
+      php: nightly
       env: DB=mariadb MARIADB_VERSION=10.1
       addons:
         mariadb: 10.1
 
-    - php: 7.1
+    - stage: Test
+      php: 7.1
+      env: DB=pgsql POSTGRESQL_VERSION=9.2
+      services:
+        - postgresql
       addons:
         postgresql: "9.2"
+    - stage: Test
+      php: 7.2
+      env: DB=pgsql POSTGRESQL_VERSION=9.2
       services:
         - postgresql
-      env: DB=pgsql POSTGRESQL_VERSION=9.2
-    - php: nightly
       addons:
         postgresql: "9.2"
+    - stage: Test
+      php: nightly
+      env: DB=pgsql POSTGRESQL_VERSION=9.2
       services:
         - postgresql
-      env: DB=pgsql POSTGRESQL_VERSION=9.2
+      addons:
+        postgresql: "9.2"
 
-    - php: 7.1
+    - stage: Test
+      php: 7.1
+      env: DB=pgsql POSTGRESQL_VERSION=9.3
+      services:
+        - postgresql
       addons:
         postgresql: "9.3"
+    - stage: Test
+      php: 7.2
+      env: DB=pgsql POSTGRESQL_VERSION=9.3
       services:
         - postgresql
-      env: DB=pgsql POSTGRESQL_VERSION=9.3
-    - php: nightly
       addons:
         postgresql: "9.3"
+    - stage: Test
+      php: nightly
+      env: DB=pgsql POSTGRESQL_VERSION=9.3
       services:
         - postgresql
-      env: DB=pgsql POSTGRESQL_VERSION=9.3
+      addons:
+        postgresql: "9.3"
 
-    - php: 7.1
+    - stage: Test
+      php: 7.1
+      env: DB=pgsql POSTGRESQL_VERSION=9.4
+      services:
+        - postgresql
       addons:
         postgresql: "9.4"
+    - stage: Test
+      php: 7.2
+      env: DB=pgsql POSTGRESQL_VERSION=9.4
       services:
         - postgresql
-      env: DB=pgsql POSTGRESQL_VERSION=9.4
-    - php: nightly
       addons:
         postgresql: "9.4"
+    - stage: Test
+      php: nightly
+      env: DB=pgsql POSTGRESQL_VERSION=9.4
       services:
         - postgresql
-      env: DB=pgsql POSTGRESQL_VERSION=9.4
+      addons:
+        postgresql: "9.4"
 
-    - php: 7.1
-      sudo: false
-      dist: trusty
+    - stage: Test
+      php: 7.1
+      env: DB=pgsql POSTGRESQL_VERSION=9.5
+      services:
+        - postgresql
       addons:
         postgresql: "9.5"
+    - stage: Test
+      php: 7.2
+      env: DB=pgsql POSTGRESQL_VERSION=9.5
       services:
         - postgresql
-      env: DB=pgsql POSTGRESQL_VERSION=9.5
-    - php: nightly
-      sudo: false
-      dist: trusty
       addons:
         postgresql: "9.5"
+    - stage: Test
+      php: nightly
+      env: DB=pgsql POSTGRESQL_VERSION=9.5
       services:
         - postgresql
-      env: DB=pgsql POSTGRESQL_VERSION=9.5
+      addons:
+        postgresql: "9.5"
 
-    - php: 7.1
-      sudo: false
-      dist: trusty
+    - stage: Test
+      php: 7.1
+      env: DB=pgsql POSTGRESQL_VERSION=9.6
+      services:
+        - postgresql
       addons:
         postgresql: "9.6"
+    - stage: Test
+      php: 7.2
+      env: DB=pgsql POSTGRESQL_VERSION=9.6
       services:
         - postgresql
-      env: DB=pgsql POSTGRESQL_VERSION=9.6
-    - php: nightly
-      sudo: false
-      dist: trusty
       addons:
         postgresql: "9.6"
+    - stage: Test
+      php: nightly
+      env: DB=pgsql POSTGRESQL_VERSION=9.6
       services:
         - postgresql
-      env: DB=pgsql POSTGRESQL_VERSION=9.6
-
-  allow_failures:
-    - php: nightly
-
-after_script:
- - if [[ "$PHPUNIT_FLAGS" != "" ]]; then wget https://scrutinizer-ci.com/ocular.phar; fi
- - if [[ "$PHPUNIT_FLAGS" != "" ]]; then php ocular.phar code-coverage:upload --format=php-clover .clover.xml; fi
-
-install:
-  - travis_retry composer install
+      addons:
+        postgresql: "9.6"
 
-script: ./vendor/bin/phpunit --configuration tests/travis/$DB.travis.xml $PHPUNIT_FLAGS
+    - stage: Coverage
+      php: 7.1
+      env: DB=sqlite
+      before_script:
+        - mv ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini{.disabled,}
+        - if [[ ! $(php -m | grep -si xdebug) ]]; then echo "xdebug required for coverage"; exit 1; fi
+      script:
+        - ./vendor/bin/phpunit --configuration tests/travis/$DB.travis.xml --coverage-clover clover.xml
+      after_script:
+        - wget https://scrutinizer-ci.com/ocular.phar
+        - php ocular.phar code-coverage:upload --format=php-clover clover.xml
+
+    - stage: Coding standard
+      php: nightly
+      script:
+        - ./vendor/bin/phpcs
diff --git a/composer.json b/composer.json
@@ -19,7 +19,9 @@
     "require-dev": {
         "phpunit/phpunit": "^6.3",
         "phpunit/phpunit-mock-objects": "!=3.2.4,!=3.2.5",
-        "symfony/console": "2.*||^3.0"
+        "symfony/console": "2.*||^3.0",
+        "doctrine/coding-standard": "^1.0",
+        "squizlabs/php_codesniffer": "^3.0"
     },
     "suggest": {
         "symfony/console": "For helpful console commands such as SQL execution and import of files."

diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<ruleset>
+    <arg name="basepath" value="."/>
+    <arg name="extensions" value="php"/>
+    <arg name="parallel" value="80"/>
+    <arg name="cache" value=".phpcs-cache"/>
+    <arg name="colors" />
+
+    <!-- Ignore warnings and show progress of the run -->
+    <arg value="np"/>
+
+    <file>lib</file>
+    <file>tests</file>
+
+    <rule ref="Doctrine"/>
+
+    <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
+        <exclude-pattern>*/tests/*</exclude-pattern>
+    </rule>
+
+    <rule ref="Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase">
+        <exclude-pattern>lib/Doctrine/DBAL/Events.php</exclude-pattern>
+    </rule>
+</ruleset>