PHP 8 / CodeCov / GitHub CI (#27)

Author: yoanm

.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+[Makefile]
+indent_style = tab
+indent_size = 8
+
+[{*.yml,*.yaml}]
+indent_style = space
+indent_size = 2

.github/.editorconfig

@@ -0,0 +1,3 @@
+[*.yml]
+indent_style = space
+indent_size = 2

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @yoanm

.github/workflows/CI.yml

@@ -0,0 +1,119 @@
+name: 'CI'
+on: # rebuild any PRs and main branch changes
+ pull_request:
+ types:
+ - opened
+ - synchronize
+ push:
+ branches: [ master ]
+
+concurrency:
+ group: "CI-${{ github.head_ref }}"
+ cancel-in-progress: true
+
+env:
+ # Cache params
+ CACHE_VERSION: 2022031803 # To be able to create a new cache (YYYYMMDDXX)
+ CI: 'true'
+ COVERAGE_OUTPUT_STYLE: clover
+ TEST_OUTPUT_STYLE: 'pretty'
+ PHPCS_REPORT_STYLE: 'full'
+ COMPOSER_OPTIONS: '--optimize-autoloader'
+
+jobs:
+ unit-tests:
+ name: Unit / PHP ${{ matrix.php-version }}
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: true
+ matrix:
+ php-version:
+ - '7.4'
+ - '8.0'
+ - '8.1'
+ steps:
+ - name: Check out code
+ uses: actions/checkout@v2
+
+ - name: Setup PHP
+ uses: shivammathur/setup-php@v2
+ with:
+ php-version: '${{ matrix.php-version }}'
+ tools: composer
+ coverage: xdebug
+ env:
+ # Always use latest available patch for the version
+ update: true
+
+ - name: Setup cache
+ id: cache
+ uses: actions/cache@v2
+ with:
+ path: |
+ ~/.composer
+ ./vendor
+ # Clear the cache if composer json (as composer.lock is in the repo) has been updated
+ key: ${{ env.CACHE_VERSION }}-tests-${{ matrix.php-version }}-${{ hashFiles('composer.json') }}
+
+ - name: Build
+ run: make build
+
+ - name: Test
+ run: make test-unit
+
+ # See the reports at https://codecov.io/gh/yoanm/php-jsonrpc-doc-sdk
+ - name: Upload coverage to codecov
+ uses: codecov/codecov-action@v2
+ with:
+ name: "unit-tests-${{ matrix.php-version }}"
+ flags: "unit-tests,php-${{ matrix.php-version }}"
+ fail_ci_if_error: true
+
+ functional-tests:
+ name: Functional / PHP ${{ matrix.php-version }}
+ needs: [unit-tests]
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: true
+ matrix:
+ php-version:
+ - '7.4'
+ - '8.0'
+ - '8.1'
+ steps:
+ - name: Check out code
+ uses: actions/checkout@v2
+
+ - name: Setup PHP
+ uses: shivammathur/setup-php@v2
+ with:
+ php-version: '${{ matrix.php-version }}'
+ tools: composer
+ coverage: xdebug
+ env:
+ # Always use latest available patch for the version
+ update: true
+
+ - name: Setup cache
+ id: cache
+ uses: actions/cache@v2
+ with:
+ path: |
+ ~/.composer
+ ./vendor
+ # Clear the cache if composer json (as composer.lock is in the repo) has been updated
+ key: ${{ env.CACHE_VERSION }}-tests-${{ matrix.php-version }}-${{ hashFiles('composer.json') }}
+
+ - name: Build
+ run: make build
+
+ - name: Test
+ run: make test-functional
+
+ # See the reports at https://codecov.io/gh/yoanm/php-jsonrpc-doc-sdk
+ - name: Upload coverage to codecov
+ uses: codecov/codecov-action@v2
+ with:
+ name: "functional-tests-${{ matrix.php-version }}"
+ flags: "functional-tests,php-${{ matrix.php-version }}"
+ fail_ci_if_error: true

.scrutinizer.yml

@@ -8,21 +8,26 @@ build_failure_conditions:
  - 'patches.label("Spacing").exists' # No spacing patches allowed
  - 'patches.label("Bug").exists' # No bug patches allowed
  - 'issues.label("coding-style").exists' # No coding style issues allowed
+
 build:
  dependencies:
  override:
  - make build
  tests:
  stop_on_failure: true
  override:
- -
- command: make coverage
- idle_timeout: 1200
- coverage:
- file: 'build/coverage/clover.xml'
- format: 'php-clover'
- - php-scrutinizer-run --enable-security-analysis
  - make codestyle
+ - command: make scrutinizer-phpunit
+ idle_timeout: 1200
+ coverage:
+ file: 'build/coverage/clover.xml'
+ format: 'php-clover'
+ - command: make scrutinizer-behat
+ idle_timeout: 1200
+ coverage:
+ file: 'build/coverage-behat/clover.xml'
+ format: 'php-clover'
+ - php-scrutinizer-run --enable-security-analysis
  cache:
  directories:
  - ~/.composer
@@ -37,7 +42,9 @@ build:
  COVERAGE_CLOVER_FILE_PATH: 'build/coverage/clover.xml'
  PHPCS_DISABLE_WARNING: "true"
  php:
- version: "7.1"
+ version: "7.4.28"
+ ini:
+ memory_limit: "-1"
  timezone: UTC
  postgresql: false
  redis: false

.travis.yml

@@ -1,12 +1,11 @@
 COLOR_ENABLED ?= true
 TEST_OUTPUT_STYLE ?= dot
-COVERAGE_OUTPUT_STYLE ?= html
 
 ## DIRECTORY AND FILE
 BUILD_DIRECTORY ?= build
 REPORTS_DIRECTORY ?= ${BUILD_DIRECTORY}/reports
 COVERAGE_DIRECTORY ?= ${BUILD_DIRECTORY}/coverage
-BEHAT_COVERAGE_DIRECTORY ?= ${BUILD_DIRECTORY}/behat-coverage
+BEHAT_COVERAGE_DIRECTORY ?= ${BUILD_DIRECTORY}/coverage-behat
 COVERAGE_CLOVER_FILE_PATH ?= ${COVERAGE_DIRECTORY}/clover.xml
 
 ## Commands options
@@ -39,14 +38,18 @@ else
 BEHAT_OUTPUT_STYLE_OPTION ?= --format progress
 endif
 
-ifeq ("${COVERAGE_OUTPUT_STYLE}","clover")
-PHPUNIT_COVERAGE_OPTION ?= --coverage-clover ${COVERAGE_CLOVER_FILE_PATH}
-else
+ifdef COVERAGE_OUTPUT_STYLE
+export XDEBUG_MODE=coverage
 ifeq ("${COVERAGE_OUTPUT_STYLE}","html")
-	PHPUNIT_COVERAGE_OPTION ?= --coverage-html ${COVERAGE_DIRECTORY}
- else
-	PHPUNIT_COVERAGE_OPTION ?= --coverage-text
- endif
+PHPUNIT_COVERAGE_OPTION ?= --coverage-html ${COVERAGE_DIRECTORY}
+BEHAT_COVERAGE_OPTION ?= --profile coverage-html
+else ifeq ("${COVERAGE_OUTPUT_STYLE}","clover")
+	PHPUNIT_COVERAGE_OPTION ?= --coverage-clover ${COVERAGE_CLOVER_FILE_PATH}
+	BEHAT_COVERAGE_OPTION ?= --profile coverage-clover
+ else
+PHPUNIT_COVERAGE_OPTION ?= --coverage-text
+BEHAT_COVERAGE_OPTION ?= --profile coverage
+endif
 endif
 
 ifneq ("${PHPCS_REPORT_FILE}","")
@@ -71,39 +74,36 @@ install:
 configure:
 
 # Project tests
-test:
-make test-functional
-make test-technical
-make codestyle
+test: test-functional test-unit codestyle
 
-test-technical:
-./vendor/bin/phpunit ${PHPUNIT_COLOR_OPTION} ${PHPUNIT_OUTPUT_STYLE_OPTION} --testsuite technical
+ifdef PHPUNIT_COVERAGE_OPTION
+test-unit: create-build-directories
+endif
+test-unit:
+./vendor/bin/phpunit ${PHPUNIT_COLOR_OPTION} ${PHPUNIT_OUTPUT_STYLE_OPTION} ${PHPUNIT_COVERAGE_OPTION} --testsuite technical
 
+ifdef BEHAT_COVERAGE_OPTION
+test-functional: create-build-directories
+else ifdef PHPUNIT_COVERAGE_OPTION
+test-functional: create-build-directories
+endif
 test-functional:
-./vendor/bin/phpunit ${PHPUNIT_COLOR_OPTION} ${PHPUNIT_OUTPUT_STYLE_OPTION} --testsuite functional
-./vendor/bin/behat ${BEHAT_COLOR_OPTION} ${BEHAT_OUTPUT_STYLE_OPTION} --no-snippets
+./vendor/bin/phpunit ${PHPUNIT_COLOR_OPTION} ${PHPUNIT_OUTPUT_STYLE_OPTION} ${PHPUNIT_COVERAGE_OPTION} --testsuite functional
+./vendor/bin/behat ${BEHAT_COLOR_OPTION} ${BEHAT_OUTPUT_STYLE_OPTION} ${BEHAT_COVERAGE_OPTION} --no-snippets
 
-codestyle: create-reports-directory
+codestyle: create-build-directories
 ./vendor/bin/phpcs ${PHPCS_DISABLE_WARNING_OPTION} --standard=phpcs.xml.dist ${PHPCS_COLOR_OPTION} ${PHPCS_REPORT_FILE_OPTION} --report=${PHPCS_REPORT_STYLE}
 
-coverage: create-coverage-directory
+scrutinizer-phpunit:
 ./vendor/bin/phpunit ${PHPUNIT_COLOR_OPTION} ${PHPUNIT_OUTPUT_STYLE_OPTION} ${PHPUNIT_COVERAGE_OPTION}
 
-behat-coverage: create-behat-coverage-directory
-composer required leanphp/behat-code-coverage
-./vendor/bin/behat ${BEHAT_COLOR_OPTION} ${BEHAT_OUTPUT_STYLE_OPTION} --no-snippets --profile coverage
+scrutinizer-behat:
+./vendor/bin/behat ${BEHAT_COLOR_OPTION} ${BEHAT_OUTPUT_STYLE_OPTION} ${BEHAT_COVERAGE_OPTION} --no-snippets
 
 
 # Internal commands
-create-coverage-directory:
-mkdir -p ${COVERAGE_DIRECTORY}
-
-create-behat-coverage-directory:
-mkdir -p ${BEHAT_COVERAGE_DIRECTORY}
-
-create-reports-directory:
-mkdir -p ${REPORTS_DIRECTORY}
-
+create-build-directories:
+mkdir -p ${COVERAGE_DIRECTORY} ${BEHAT_COVERAGE_DIRECTORY} ${REPORTS_DIRECTORY} ${REPORTS_DIRECTORY}
 
-.PHONY: build install configure test test-technical test-functional codestyle coverage behat-coverage create-coverage-directory create-behat-coverage-directory create-reports-directory
+.PHONY: build install configure test test-unit test-functional codestyle create-build-directories scrutinizer-behat scrutinizer-phpunit
 .DEFAULT: build

Makefile

@@ -1,11 +1,17 @@
 # JSON-RPC server documentation
-[![License](https://img.shields.io/github/license/yoanm/php-jsonrpc-server-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-server-doc-sdk) [![Code size](https://img.shields.io/github/languages/code-size/yoanm/php-jsonrpc-server-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-server-doc-sdk) [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=yoanm/php-jsonrpc-server-doc-sdk)](https://dependabot.com)
+[![License](https://img.shields.io/github/license/yoanm/php-jsonrpc-server-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-server-doc-sdk)
+[![Code size](https://img.shields.io/github/languages/code-size/yoanm/php-jsonrpc-server-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-server-doc-sdk)
+[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=yoanm/php-jsonrpc-server-doc-sdk)](https://dependabot.com)
 
-[![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/php-jsonrpc-server-doc-sdk.svg?label=Scrutinizer&logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/build-status/master) [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/php-jsonrpc-server-doc-sdk/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/?branch=master) [![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/yoanm/php-jsonrpc-server-doc-sdk/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/?branch=master)
+[![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/php-jsonrpc-server-doc-sdk.svg?label=Scrutinizer&logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/build-status/master)
+[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/php-jsonrpc-server-doc-sdk/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/?branch=master)
+[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/yoanm/php-jsonrpc-server-doc-sdk/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/?branch=master)
 
-[![Travis Build Status](https://img.shields.io/travis/yoanm/php-jsonrpc-server-doc-sdk/master.svg?label=Travis&logo=travis)](https://travis-ci.org/yoanm/php-jsonrpc-server-doc-sdk) [![Travis PHP versions](https://img.shields.io/travis/php-v/yoanm/php-jsonrpc-server-doc-sdk.svg?logo=travis)](https://travis-ci.org/yoanm/php-jsonrpc-server-doc-sdk)
+[![CI](https://github.com/yoanm/php-jsonrpc-server-doc-sdk/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/yoanm/php-jsonrpc-server-doc-sdk/actions/workflows/CI.yml)
+[![codecov](https://codecov.io/gh/yoanm/php-jsonrpc-server-doc-sdk/branch/master/graph/badge.svg?token=NHdwEBUFK5)](https://codecov.io/gh/yoanm/php-jsonrpc-server-doc-sdk)
 
-[![Latest Stable Version](https://img.shields.io/packagist/v/yoanm/jsonrpc-server-doc-sdk.svg)](https://packagist.org/packages/yoanm/jsonrpc-server-doc-sdk) [![Packagist PHP version](https://img.shields.io/packagist/php-v/yoanm/jsonrpc-server-doc-sdk.svg)](https://packagist.org/packages/yoanm/jsonrpc-server-doc-sdk)
+[![Latest Stable Version](https://img.shields.io/packagist/v/yoanm/jsonrpc-server-doc-sdk.svg)](https://packagist.org/packages/yoanm/jsonrpc-server-doc-sdk)
+[![Packagist PHP version](https://img.shields.io/packagist/php-v/yoanm/jsonrpc-server-doc-sdk.svg)](https://packagist.org/packages/yoanm/jsonrpc-server-doc-sdk)
 
 Php SDK to generate (Http) JSON-RPC server documentation
 

README.md

@@ -1,19 +1,30 @@
 default:
+ extensions:
+ DVDoug\Behat\CodeCoverage\Extension:
+ filter:
+ include:
+ directories:
+ 'src': ~
+ reports: [] # No reports
  suites:
  default:
  contexts:
  - Tests\Functional\BehatContext\DocNormalizerContext: ~
 coverage:
  extensions:
- LeanPHP\Behat\CodeCoverage\Extension:
- drivers:
- - local
- filter:
- whitelist:
- include:
- directories:
- 'src': ~
- report:
- format: html
- options:
- target: build/behat-coverage
+ DVDoug\Behat\CodeCoverage\Extension:
+ reports:
+ text:
+ showColors: true
+coverage-html:
+ extensions:
+ DVDoug\Behat\CodeCoverage\Extension:
+ reports:
+ html:
+ target: build/coverage-behat
+coverage-clover:
+ extensions:
+ DVDoug\Behat\CodeCoverage\Extension:
+ reports:
+ clover:
+ target: build/coverage-behat/clover.xml # no default value, you must specify