https://github.com/adamculp/php-compatibility-check
Docker image to check PHP code for compatibility to PHP versions.
https://github.com/adamculp/php-compatibility-check
compatibility compatibility-testing docker docker-image php php7 php71 php71-docker
Last synced: 11 months ago
JSON representation
Docker image to check PHP code for compatibility to PHP versions.
- Host: GitHub
- URL: https://github.com/adamculp/php-compatibility-check
- Owner: adamculp
- License: mit
- Created: 2017-04-03T23:30:21.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-02-11T17:00:40.000Z (over 7 years ago)
- Last Synced: 2025-05-05T05:35:12.035Z (about 1 year ago)
- Topics: compatibility, compatibility-testing, docker, docker-image, php, php7, php71, php71-docker
- Language: Dockerfile
- Homepage: https://hub.docker.com/r/adamculp/php-compatibility-check/
- Size: 5.86 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# php-compatibility-check
Docker image to check PHP code for compatibility to PHP versions.
The objective is to provide a quick report of known PHP security alerts, based on the contents from a given
composer.lock file, in an easy to use Docker image.
More specifically this image provides 3 different applications to test with:
- phpcompatibility/php-compatibility
* Leverages PHP_Codesniffer to "sniff" code for incompatible code to various versions of PHP.
It then reports what version of PHP the code is broken with, and what version of PHP the code
was broken by.
- sstalle/php7cc
* Runs against the codebase and indicates what is broken in PHP version 7
- etsy/phan
* Runs against the codebase and indicates what is broken in PHP version 7+
IMPORTANT: This tool makes no claims of being an exhaustive reference, but with the 3 included tools, should
be fairly comprehensive.
## Usage
Windows users: The use of "$PWD" for present working directory will not work as expected, instead use the full path.
Such as "//c/Users/adamculp/project".
### PHPCompatibility
More info on how to run this tool can be found at: https://github.com/PHPCompatibility/PHPCompatibility
```
$ docker run -it --rm -v "$PWD":/app -w /app adamculp/php-code-quality:latest sh -c \
'php /usr/local/lib/php-code-quality/vendor/bin/phpcs -sv --config-set installed_paths /usr/local/lib/php-code-quality/vendor/phpcompatibility/php-compatibility && \
php /usr/local/lib/php-code-quality/vendor/bin/phpcs -sv --standard='PHPCompatibility' --extensions=php --ignore=vendor . \
--report-file=./php_code_quality/phpcompatibility_results.txt .'
```
In the example above, Docker runs an interactive terminal to be removed when all is completed, and mounts
the current host directory ($PWD) inside the container, sets this as the current working directory, and then
loads the image adamculp/php-compatibility-check. Following this we call the chosen application to check on
the code, and finally, output the results to a text file in the current working directory.
This is the most common use case, enabling the user to run the tool on code located anywhere
on the host system by altering the path used in the command.
### Other Tool Examples
#### php7cc
More info on how to run this tool can be found at: https://github.com/sstalle/php7cc
```
$ docker run -it --rm -v "$PWD":/app -w /app adamculp/php-compatibility-check:latest \
php vendor/bin/php7cc --extensions=php \
--except=vendor > ./php7cc_results.txt .
```
#### Phan
More info on how to run this tool can be found at: https://github.com/etsy/phan
```
$ docker run -it --rm -v "$PWD":/app -w /app adamculp/php-compatibility-check:latest \
php vendor/bin/phan -l . --exclude-directory-list "vendor/" \
> ./phan_results.txt
```
By default Phan examines code in the following directories, plus what is specified in the command:
```php
'directory_list' => [
'src',
'tests/Phan',
'vendor/phpunit/phpunit/src',
'vendor/symfony/console',
'.phan/stubs',
],
```
To do otherwise it will require you to edit the Phan Phan/.phan/config.php file, and use the Alternative
Preparations as indicated below.
## Alternative Preparations
Rather than allowing Docker to retrieve the image from Docker Hub, users could also build the docker image locally
by cloning the image repo from Github.
Why? As an example, a different version of PHP provided by including a different PHP image may be desired. Or a
specific version of the tools loaded by Composer might be required.
After cloning, navigate to the location:
```
$ git clone https://github.com/adamculp/php-compatibility-check.git
$ cd php-compatibility-check
```
Alter the Dockerfile as desired, then build the image locally:
```
$ docker build -t adamculp/php-compatibility-check .
```
Or a user may simply desire the image as-is, for later use:
```
$ docker build -t adamculp/php-compatibility-check https://github.com/adamculp/php-compatibility-check.git
```
## Enjoy!
Please star, on Docker Hub and/or Github, if you find this helpful.