[CI] Improve build system (Makefile, Docker, Travis) (#21)

Fixes #20

Author: tPl0ch

.gitignore

@@ -1,10 +1,19 @@
+.idea
+
+### Vagrant template
+.vagrant/
+### Composer template
 composer.phar
 /vendor/
-composer.lock
 
 # Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
+composer.lock
 
-.idea
-
-.php_cs.cache
+# Custom entries
+.php_cs*.cache
+.env
+variables.mk
+/build/
+ocular.phar
+php-cs-fixer.phar

.travis.yml

@@ -3,39 +3,103 @@ sudo: required
 language: php
 
 services:
-  - docker
+- docker
 
 php:
-  - '7.0'
-  - '7.1'
-  - '7.2'
-  - nightly
+- '7.1'
+- '7.2'
 
 env:
   global:
-    - DOCKER_COMPOSE_VERSION=1.19.0
+  - DOCKER_COMPOSE_VERSION=1.22.0
   matrix:
-    - DEPENDENCIES="low" INTEGRATION_TEST="enabled"
-    - DEPENDENCIES="low" INTEGRATION_TEST="disabled"
-    - DEPENDENCIES="stable" INTEGRATION_TEST="enabled"
-    - DEPENDENCIES="stable" INTEGRATION_TEST="disabled"
-
-matrix:
-  allow_failures:
-    - php: nightly
+  - DEPENDENCIES="low"
+  - DEPENDENCIES="stable"
 
 before_script:
-  - if [ "$INTEGRATION_TEST" == "enabled" ]; then sudo rm /usr/local/bin/docker-compose; fi;
-  - if [ "$INTEGRATION_TEST" == "enabled" ]; then curl -L https://github.com/docker/compose/releases/download/${DOCKER_COMPOSE_VERSION}/docker-compose-`uname -s`-`uname -m` > docker-compose; fi;
-  - if [ "$INTEGRATION_TEST" == "enabled" ]; then chmod +x docker-compose; fi;
-  - if [ "$INTEGRATION_TEST" == "enabled" ]; then sudo mv docker-compose /usr/local/bin; fi;
-  - composer self-update
-  - if [ "$DEPENDENCIES" == "stable" ]; then composer update --prefer-stable; fi;
-  - if [ "$DEPENDENCIES" == "low" ]; then composer update --prefer-lowest --prefer-stable; fi;
+- make install-phars
+- if [ "$INTEGRATION_TEST" == "enabled" ]; then sudo rm /usr/local/bin/docker-compose; fi;
+- if [ "$INTEGRATION_TEST" == "enabled" ]; then curl -L https://github.com/docker/compose/releases/download/${DOCKER_COMPOSE_VERSION}/docker-compose-`uname -s`-`uname -m` > docker-compose; fi;
+- if [ "$INTEGRATION_TEST" == "enabled" ]; then chmod +x docker-compose; fi;
+- if [ "$INTEGRATION_TEST" == "enabled" ]; then sudo mv docker-compose /usr/local/bin; fi;
+- composer self-update
+- if [ "$DEPENDENCIES" == "stable" ]; then composer update --prefer-stable; fi;
+- if [ "$DEPENDENCIES" == "low" ]; then composer update --prefer-lowest --prefer-stable; fi;
 
 script:
-  - if [ "$INTEGRATION_TEST" == "disabled" ]; then make quick-test; fi;
-  - if [ "$INTEGRATION_TEST" == "enabled" ]; then make integration-test; fi;
+- COMPOSER=composer PHP=php make ci-local
 
+jobs:
+  include:
+  - stage: coverage
+    php: 7.2
+    env:
+    - DEPENDENCIES="stable"
+    script:
+    - PHP=php make coverage
+  - stage: integration
+    php: 7.2
+    env:
+    - DEPENDENCIES="stable"
+    - INTEGRATION_TEST="enabled"
+    - CONFLUENT_VERSION=3.1.2
+    script:
+    - make platform
+    - PHP=php make phpunit-integration
+  - stage: integration
+    php: 7.2
+    env:
+    - DEPENDENCIES="stable"
+    - INTEGRATION_TEST="enabled"
+    - CONFLUENT_VERSION=3.2.4
+    script:
+    - make platform
+    - PHP=php make phpunit-integration
+  - stage: integration
+    php: 7.2
+    env:
+    - DEPENDENCIES="stable"
+    - INTEGRATION_TEST="enabled"
+    - CONFLUENT_VERSION=3.3.2
+    script:
+    - make platform
+    - PHP=php make phpunit-integration
+  - stage: integration
+    php: 7.2
+    env:
+    - DEPENDENCIES="stable"
+    - INTEGRATION_TEST="enabled"
+    - CONFLUENT_VERSION=4.0.2
+    script:
+    - make platform
+    - PHP=php make phpunit-integration
+  - stage: integration
+    php: 7.2
+    env:
+    - DEPENDENCIES="stable"
+    - INTEGRATION_TEST="enabled"
+    - CONFLUENT_VERSION=4.1.2
+    script:
+    - make platform
+    - PHP=php make phpunit-integration
+  - stage: integration
+    php: 7.2
+    env:
+    - DEPENDENCIES="stable"
+    - INTEGRATION_TEST="enabled"
+    - CONFLUENT_VERSION=5.0.0
+    script:
+    - make platform
+    - PHP=php make phpunit-integration
 after_script:
-  - make clean
+- make clean
+
+branches:
+  only:
+  - master
+  - '/^ft-.*/'
+  - '/^\d+\.\d+\.\d+$/'
+
+cache:
+  directories:
+  - $HOME/.composer/cache/files

Dockerfile

@@ -0,0 +1,19 @@
+ARG PHP_VERSION=7.1
+
+FROM php:${PHP_VERSION}-cli-alpine
+
+ARG XDEBUG_VERSION=2.6.1
+
+RUN apk add --no-cache --virtual .build-deps $PHPIZE_DEPS zlib-dev \
+    && apk add --no-cache --virtual .runtime-deps git \
+    && docker-php-ext-install zip \
+    && pecl install xdebug-$XDEBUG_VERSION \
+    && docker-php-ext-enable xdebug \
+    && echo "xdebug.max_nesting_level=15000" >> "$PHP_INI_DIR/conf.d/docker-php-ext-xdebug.ini" \
+    && echo "xdebug.remote_enable=true" >> "$PHP_INI_DIR/conf.d/docker-php-ext-xdebug.ini" \
+    && echo "xdebug.remote_host=localhost" >> "$PHP_INI_DIR/conf.d/docker-php-ext-xdebug.ini" \
+    && echo "xdebug.idekey=PHPSTORM" >> "$PHP_INI_DIR/conf.d/docker-php-ext-xdebug.ini" \
+    && echo "xdebug.remote_handler=dbgp" >> "$PHP_INI_DIR/conf.d/docker-php-ext-xdebug.ini" \
+    && echo "xdebug.remote_autostart=1" >> "$PHP_INI_DIR/conf.d/docker-php-ext-xdebug.ini" \
+    && echo "xdebug.remote_connect_back=0" >> "$PHP_INI_DIR/conf.d/docker-php-ext-xdebug.ini" \
+    && apk del .build-deps

Makefile

@@ -1,12 +1,117 @@
+# no buildin rules and variables
+MAKEFLAGS =+ -rR --warn-undefined-variables
 
-quick-test:
-	./bin/ci
+.PHONY: composer-install composer-update phpstan cs-fixer examples docker run
 
-integration-test:
-	docker-compose up -d
-	sleep 20
-	./vendor/bin/phpunit -c phpunit.xml.integration.dist -v --group integration
+ifndef CONFLUENT_VERSION
+    CONFLUENT_VERSION := latest
+endif
+
+ifndef CONFLUENT_NETWORK_SUBNET
+    CONFLUENT_NETWORK_SUBNET := 172.68.0.0/24
+endif
+
+ifndef SCHEMA_REGISTRY_IPV4
+    SCHEMA_REGISTRY_IPV4 := 172.68.0.103
+endif
+
+ifndef KAFKA_BROKER_IPV4
+    KAFKA_BROKER_IPV4 := 172.68.0.102
+endif
+
+ifndef ZOOKEEPER_IPV4
+    ZOOKEEPER_IPV4 := 172.68.0.101
+endif
+
+ifndef COMPOSER
+    COMPOSER := bin/composer.phar
+endif
+
+ifndef COMPOSER_VERSION
+    COMPOSER_VERSION := 1.7.2
+endif
+
+ifndef PHP
+    PHP := bin/php
+endif
+
+ifndef PHP_VERSION
+    PHP_VERSION := 7.1
+endif
+
+ifndef XDEBUG_VERSION
+    XDEBUG_VERSION := 2.6.1
+endif
+
+-include variables.mk
+export
+
+docker:
+	docker build \
+	  --build-arg PHP_VERSION=$(PHP_VERSION) \
+	  --build-arg XDEBUG_VERSION=$(XDEBUG_VERSION) \
+	  -t schema-registry-client:$(PHP_VERSION) \
+	  -f Dockerfile \
+	  .
+
+composer-install:
+	PHP_VERSION=$(PHP_VERSION) $(PHP) $(COMPOSER) install --no-interaction --no-progress --no-suggest --no-scripts
+
+composer-update:
+	PHP_VERSION=$(PHP_VERSION) $(PHP) $(COMPOSER) update --no-interaction --no-progress --no-suggest --no-scripts
+
+phpstan:
+	PHP_VERSION=$(PHP_VERSION) $(PHP) vendor/bin/phpstan.phar analyse -l 7 src
+
+cs-fixer:
+	PHP_VERSION=$(PHP_VERSION) $(PHP) bin/php-cs-fixer.phar fix --config=.php_cs.dist -v --dry-run \
+	  --path-mode=intersection --allow-risky=yes src test
+
+cs-fixer-modify:
+	PHP_VERSION=$(PHP_VERSION) $(PHP) bin/php-cs-fixer.phar fix --config=.php_cs.dist -v \
+	  --path-mode=intersection --allow-risky=yes src test
+
+phpunit:
+	PHP_VERSION=$(PHP_VERSION) $(PHP) vendor/bin/phpunit --exclude-group integration
+
+phpunit-integration:
+	PHP_VERSION=$(PHP_VERSION) $(PHP) vendor/bin/phpunit -c phpunit.xml.integration.dist --group integration
+
+coverage:
+	mkdir -p build
+	PHP_VERSION=$(PHP_VERSION) $(PHP) vendor/bin/phpunit --coverage-clover=build/coverage.clover --coverage-text
+	PHP_VERSION=$(PHP_VERSION) $(PHP) bin/ocular.phar code-coverage:upload --format=php-clover \
+	  --repository=g/flix-tech/schema-registry-php-client build/coverage.clover
+
+run:
+	PHP_VERSION=$(PHP_VERSION) $(PHP) $(ARGS)
+
+ci-local: cs-fixer phpstan phpunit
+
+examples:
+	PHP_VERSION=$(PHP_VERSION) $(PHP) examples/*
+
+install-phars:
+	curl http://cs.sensiolabs.org/download/php-cs-fixer-v2.phar -o bin/php-cs-fixer.phar -LR -z bin/php-cs-fixer.phar
+	chmod a+x bin/php-cs-fixer.phar
+	curl https://scrutinizer-ci.com/ocular.phar -o bin/ocular.phar -LR -z bin/ocular.phar
+	chmod a+x bin/ocular.phar
+	curl https://getcomposer.org/download/$(COMPOSER_VERSION)/composer.phar -o bin/composer.phar -LR -z bin/composer.phar
+	chmod a+x bin/composer.phar
+
+
+platform:
 	docker-compose down
+	docker-compose up -d
+	sleep 25
 
 clean:
+	rm -rf build
+	docker-compose down
+
+benchmark:
+	docker-compose down
+	docker-compose up -d
+	sleep 15
+	PHP_VERSION=$(PHP_VERSION) $(PHP) ./vendor/bin/phpbench run benchmarks/AvroEncodingBench.php --report=aggregate --retry-threshold=5
 	docker-compose down

README.md

@@ -1,6 +1,8 @@
 # Confluent Schema Registry PHP API
 
 [![Build Status](https://travis-ci.org/flix-tech/schema-registry-php-client.svg?branch=2.0.2)](https://travis-ci.org/flix-tech/schema-registry-php-client)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/flix-tech/schema-registry-php-client/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/flix-tech/schema-registry-php-client/?branch=master)
+[![Code Coverage](https://scrutinizer-ci.com/g/flix-tech/schema-registry-php-client/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/flix-tech/schema-registry-php-client/?branch=master)
 [![Latest Stable Version](https://poser.pugx.org/flix-tech/confluent-schema-registry-api/v/stable)](https://packagist.org/packages/flix-tech/confluent-schema-registry-api)
 [![Total Downloads](https://poser.pugx.org/flix-tech/confluent-schema-registry-api/downloads)](https://packagist.org/packages/flix-tech/confluent-schema-registry-api)
 [![License](https://poser.pugx.org/flix-tech/confluent-schema-registry-api/license)](https://packagist.org/packages/flix-tech/confluent-schema-registry-api)
@@ -226,12 +228,20 @@ There are also requests to use the new `DELETE` API of the schema registry.
 
 ## Testing
 
-This library uses a `Makefile` to run the test suite.
+This library uses a `Makefile` to run the test suite and requires `docker`.
+
+You can set the default variables by copying `variables.mk.dist` to `variables.mk` and change them to your liking.
+
+#### Build the local docker image
+
+```bash
+make docker
+```
 
 #### Unit tests, Coding standards and static analysis
 
 ```bash
-make quick-test
+make ci-local
 ```
 
 #### Integration tests
@@ -240,7 +250,8 @@ This library uses a `docker-compose` configuration to fire up a schema registry
 `docker-compose` from version 1.13.0 is required to run those tests.
 
 ```bash
-make integration-test
+CONFLUENT_VERSION=5.0.0 make platform
+make phpunit-integration
 make clean
 ```
 

bin/ci

@@ -0,0 +1,22 @@
+#!/usr/bin/env sh
+
+set -e
+
+command -v docker >/dev/null 2>&1 || { echo "docker is required to run this binary. Aborting." >&2; exit 1; }
+
+USER=${USER:-$( id -un )}
+GROUP=${GROUP:-$( id -gn )}
+COMPOSER_HOME=${COMPOSER_HOME:-${HOME}/.composer}
+PHP_VERSION=${PHP_VERSION:-7.1}
+DOCKER_OPTS=${DOCKER_OPTS:-'-it'}
+
+exec docker run ${DOCKER_OPTS} --rm \
+    -u $( id -u ${USER} ):$( id -g ${USER} ) \
+    -v "${PWD}":"${PWD}" \
+    -v "${COMPOSER_HOME}":/tmp/composer \
+    -w ${PWD} \
+    -e PHP_IDE_CONFIG="serverName=schema-registry-client" \
+    -e COMPOSER_HOME="/tmp/composer" \
+    --net=host --sig-proxy=true --pid=host \
+    --entrypoint="php" \
+     schema-registry-client:${PHP_VERSION} "${@}"

bin/php

@@ -11,20 +11,18 @@
     }
   ],
   "require": {
-    "php": "~7.0",
+    "php": "~7.1",
     "guzzlehttp/guzzle": "~6.3",
     "beberlei/assert": "~2.7",
     "flix-tech/avro-php": "^2.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "~6.2",
-    "friendsofphp/php-cs-fixer": "~2.0",
-    "phpstan/phpstan": "~0.8",
+    "phpunit/phpunit": "~7.0",
+    "phpstan/phpstan-shim": "~0.8",
     "raphhh/trex-reflection": "~1.0",
     "doctrine/cache": "~1.3"
   },
   "suggest": {
-    "flix-tech/avro-php": "Needed for decoding and encoding messages in Apache Avro format",
     "raphhh/trex-reflection": "Needed if you want to use the `RequestCallbackValidator`",
     "doctrine/cache": "If you want to use the DoctrineCacheAdapter"
   },