Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 8 additions & 20 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ on:
branches: [ main ]

jobs:
build:
ci:

runs-on: ubuntu-latest
strategy:
matrix:
php-versions: [ '8.1', '8.2', '8.3' ]
php-versions: [ '8.3', '8.4', '8.5' ]

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0 # To avoid "Shallow clone detected" error in SonarCloud report
fetch-depth: 0

#~ PHP Setup
- name: Setup PHP ${{ matrix.php-versions }}
Expand Down Expand Up @@ -48,30 +48,18 @@ jobs:

#~ CI part
- name: Dependencies
run: make deps
run: make php/deps

- name: Check Code Style
run: make phpcs
run: make php/check

- name: Units Tests
run: make tests
run: make php/tests

- name: Fix unit tests report path
run: |
sed -i 's+'$GITHUB_WORKSPACE'+/github/workspace+g' build/reports/phpunit/clover.xml
sed -i 's+'$GITHUB_WORKSPACE'+/github/workspace+g' build/reports/phpunit/unit.xml

- name: PHP min compatibility
run: make php-min-compatibility

- name: PHP max compatibility
run: make php-max-compatibility

- name: PHP Static Analyze
run: make analyze

- name: SonarCloud Scan
uses: SonarSource/sonarcloud-github-action@v2.1.1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
run: make php/analyze
46 changes: 46 additions & 0 deletions .github/workflows/sonarcloud.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: SonarQube

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
sonarcloud:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # To avoid "Shallow clone detected" error in SonarCloud report

#~ PHP Setup
- name: Setup PHP 8.3 # Minimum version
uses: shivammathur/setup-php@v2
with:
php-version: '8.3'

#~ Composer Cache
- name: Get Composer Cache Directory
id: composer-cache
run: |
echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT

- uses: actions/cache@v3
with:
path: ${{ steps.composer-cache.outputs.dir }}
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
restore-keys: |
${{ runner.os }}-composer-

- name: Install dependencies
if: steps.composer-cache.outputs.cache-hit != 'true'
run: make install

- name: Units Tests
run: make php/tests # To generate the coverage report

- name: SonarQube Scan
uses: SonarSource/sonarqube-scan-action@v7
env:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
2 changes: 1 addition & 1 deletion .php-cs-fixer.dist.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
//~ Rules
->setRules(
[
'@PER-CS2.0' => true,
'@PER-CS3x0' => true,
]
)

Expand Down
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

----

## [3.0.0] - 2026-01-05
[3.0.0]: https://github.com/eureka-framework/component-serializer/compare/2.1.0...3.0.0
### Added
- Add PHP 8.5 support
### Removed
- Drop PHP 8.1 & 8.2 support
### Changed
- Improve code & types
- Fix phpstan errors
- Fix code style
- Update dev dependencies
- Update CI configs

----

## [2.1.0] - 2024-08-22
[2.1.0]: https://github.com/eureka-framework/component-serializer/compare/2.0.0...2.1.0
### Changed
Expand Down
75 changes: 27 additions & 48 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,25 +1,12 @@
.PHONY: validate install update phpcs phpcbf phpmincompatibility phpmaxcompatibility phpstan analyze tests testdox ci clean
.PHONY: validate install update php/deps php/check php/fix php/min-compatibility php/max-compatibility php/phpstan php/analyze php/tests php/test php/testdox ci clean

PHP_MIN_VERSION := "8.1"
PHP_MAX_VERSION := "8.3"
PHP_MIN_VERSION := "8.3"
PHP_MAX_VERSION := "8.5"
COMPOSER_BIN := composer

ifneq (,$(wildcard ./.env))
include .env
export
endif

define header =
@if [ -t 1 ]; then printf "\n\e[37m\e[100m \e[104m $(1) \e[0m\n"; else printf "\n### $(1)\n"; fi
endef

#~ Composer dependency
build: generator phpcsf

generator:
$(call header,"Build new version of client, formatter & VO")
@./bin/script generator --file="./data/openapi.json" --debug

#~ Composer dependency
validate:
$(call header,Composer Validation)
Expand All @@ -34,16 +21,12 @@ update:
@${COMPOSER_BIN} update
@${COMPOSER_BIN} bump --dev-only

outdated:
$(call header,Composer Outdated)
@${COMPOSER_BIN} outdated --direct

composer.lock: install

#~ Vendor binaries dependencies
vendor/bin/php-cs-fixer:
vendor/bin/phpstan:
vendor/bin/phpunit:
vendor/bin/php-cs-fixer: composer.lock
vendor/bin/phpstan: composer.lock
vendor/bin/phpunit: composer.lock

#~ Report directories dependencies
build/reports/phpunit:
Expand All @@ -53,49 +36,45 @@ build/reports/phpstan:
@mkdir -p build/reports/phpstan

#~ main commands
deps: composer.json # jenkins + manual
php/deps: composer.json
$(call header,Checking Dependencies)
@XDEBUG_MODE=off ./vendor/bin/composer-dependency-analyser --config=./ci/composer-dependency-analyser.php # for shadow & unused required dependencies
@XDEBUG_MODE=off ./vendor/bin/composer-require-checker check # mainly for ext-* missing dependencies
@XDEBUG_MODE=off ./vendor/bin/composer-dependency-analyser --config ./ci/composer-dependency-analyser.php # for shadow, unused required dependencies and ext-* missing dependencies

phpcs: vendor/bin/php-cs-fixer # jenkins + manual
php/check: vendor/bin/php-cs-fixer
$(call header,Checking Code Style)
@XDEBUG_MODE=off ./vendor/bin/php-cs-fixer check -v --diff

phpcsf: vendor/bin/php-cs-fixer # manual
@XDEBUG_MODE=off ./vendor/bin/php-cs-fixer check
php/fix: vendor/bin/php-cs-fixer
$(call header,Fixing Code Style)
@XDEBUG_MODE=off ./vendor/bin/php-cs-fixer fix -v

php-min-compatibility: vendor/bin/phpstan build/reports/phpstan # jenkins + manual
$(call header,Checking PHP $(PHP_MIN_VERSION) compatibility)
@XDEBUG_MODE=off ./vendor/bin/phpstan analyse --configuration=./ci/php-min-compatibility.neon --error-format=table
php/min-compatibility: vendor/bin/phpstan build/reports/phpstan
$(call header,Checking PHP ${PHP_MIN_VERSION} compatibility)
@XDEBUG_MODE=off ./vendor/bin/phpstan analyse --configuration=./ci/phpmin-compatibility.neon --error-format=table

php-max-compatibility: vendor/bin/phpstan build/reports/phpstan # jenkins + manual
$(call header,Checking PHP $(PHP_MAX_VERSION) compatibility)
@XDEBUG_MODE=off ./vendor/bin/phpstan analyse --configuration=./ci/php-max-compatibility.neon --error-format=table
php/max-compatibility: vendor/bin/phpstan build/reports/phpstan #ci
$(call header,Checking PHP ${PHP_MAX_VERSION} compatibility)
@XDEBUG_MODE=off ./vendor/bin/phpstan analyse --configuration=./ci/phpmax-compatibility.neon --error-format=table

phpstan: vendor/bin/phpstan build/reports/phpstan # jenkins
$(call header,Running Static Analyze)
@XDEBUG_MODE=off ./vendor/bin/phpstan analyse --error-format=checkstyle > ./build/reports/phpstan/phpstan.xml

analyze: vendor/bin/phpstan build/reports/phpstan # manual
php/analyze: vendor/bin/phpstan build/reports/phpstan #manual & ci
$(call header,Running Static Analyze - Pretty tty format)
@XDEBUG_MODE=off ./vendor/bin/phpstan analyse --error-format=table

tests: vendor/bin/phpunit build/reports/phpunit # jenkins + manual
php/tests: vendor/bin/phpunit build/reports/phpunit #ci
$(call header,Running Unit Tests)
@XDEBUG_MODE=coverage php -dzend_extension=xdebug.so ./vendor/bin/phpunit --testsuite=unit --coverage-clover=./build/reports/phpunit/clover.xml --log-junit=./build/reports/phpunit/unit.xml --coverage-php=./build/reports/phpunit/unit.cov --coverage-html=./build/reports/coverage/ --fail-on-warning
@XDEBUG_MODE=coverage php ./vendor/bin/phpunit --testsuite=unit --coverage-clover=./build/reports/phpunit/clover.xml --log-junit=./build/reports/phpunit/unit.xml --coverage-php=./build/reports/phpunit/unit.cov --coverage-html=./build/reports/coverage/ --fail-on-warning

php/test: php/tests

integration: vendor/bin/phpunit build/reports/phpunit # manual
php/integration: vendor/bin/phpunit build/reports/phpunit #manual
$(call header,Running Integration Tests)
@XDEBUG_MODE=coverage php -dzend_extension=xdebug.so ./vendor/bin/phpunit --testsuite=integration --fail-on-warning

testdox: vendor/bin/phpunit # manual
php/testdox: vendor/bin/phpunit #manual
$(call header,Running Unit Tests (Pretty format))
@XDEBUG_MODE=coverage php -dzend_extension=xdebug.so ./vendor/bin/phpunit --testsuite=unit --fail-on-warning --testdox

clean: # manual
$(call header,Cleaning previous build)
clean:
$(call header,Cleaning previous build) #manual
@if [ "$(shell ls -A ./build)" ]; then rm -rf ./build/*; fi; echo " done"

ci: clean validate deps phpcs tests php-min-compatibility php-max-compatibility analyze
ci: clean validate install php/deps php/check php/tests php/integration php/min-compatibility php/max-compatibility php/analyze
32 changes: 20 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,46 +217,55 @@ NB: For the components, the `composer.lock` file is not committed.
### Testing & CI (Continuous Integration)

#### Tests
You can run tests (with coverage) on your side with following command:
You can run unit tests (with coverage) on your side with following command:
```bash
make tests
make php/tests
```

You can run tests (with coverage) on your side with following command:
You can run integration tests (without coverage) on your side with following command:
```bash
make integration
make php/integration
```

For prettier output (but without coverage), you can use the following command:
```bash
make testdox # run tests without coverage reports but with prettified output
make php/testdox # run tests without coverage reports but with prettified output
```

#### Code Style
You also can run code style check with following commands:
```bash
make phpcs
make php/check
```

You also can run code style fixes with following commands:
```bash
make phpcsf
make php/fix
```

#### Check for missing explicit dependencies
You can check if any explicit dependency is missing with the following command:
```bash
make php/deps
```

#### Static Analysis
To perform a static analyze of your code (with phpstan, lvl 9 at default), you can use the following command:
```bash
make analyze
make php/analyse
```

To ensure you code still compatible with current supported version at Deezer and futures versions of php, you need to
run the following commands (both are required for full support):

Minimal supported version:
```bash
make php-min-compatibility
make php/min-compatibility
```

Maximal supported version:
```bash
make php-max-compatibility
make php/max-compatibility
```

#### CI Simulation
Expand All @@ -265,7 +274,6 @@ And the last "helper" commands, you can run before commit and push, is:
make ci
```


## License

This project is licensed under the MIT License - see the `LICENSE` file for details
This project is currently under The MIT License (MIT). See [LICENCE](LICENSE) file for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ includes:
- ./../vendor/phpstan/phpstan-phpunit/rules.neon

parameters:
phpVersion: 80100
phpVersion: 80500
level: 0
paths:
- ./../src
Expand Down
File renamed without changes.
16 changes: 8 additions & 8 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,17 @@
},

"require": {
"php": "8.1.*||8.2.*||8.3.*||8.4.*",
"php": ">=8.3",
"ext-json": "*"
},

"require-dev": {
"friendsofphp/php-cs-fixer": "^3.62.0",
"maglnet/composer-require-checker": "^4.7.1",
"phpstan/phpstan": "^1.11.11",
"phpstan/phpstan-phpunit": "^1.4.0",
"phpunit/phpcov": "^9.0.2",
"phpunit/phpunit": "^10.5.30",
"shipmonk/composer-dependency-analyser": "^1.7.0"
"friendsofphp/php-cs-fixer": "^3.92.4",
"phpstan/phpstan": "^2.1.33",
"phpstan/phpstan-phpunit": "^2.0.11",
"phpstan/phpstan-strict-rules": "^2.0.7",
"phpunit/phpcov": "^11.0.3",
"phpunit/phpunit": "^12.5.4",
"shipmonk/composer-dependency-analyser": "^1.8.4"
}
}
Loading