devdrops / php-toolbox Goto Github PK

View Code? Open in Web Editor NEW

39.0 2.0 6.0 227 KB

:whale: :elephant: A Docker image designed for PHP developers that care about code quality.

Home Page: https://hub.docker.com/r/devdrops/php-toolbox/

License: GNU General Public License v3.0

Dockerfile 17.11% Shell 42.71% Makefile 40.18%

docker php php-codesniffer php-toolbox php-cs-fixer behat phpunit phpmd composer phploc

php-toolbox's Introduction

devdrops/php-toolbox 🐳 🐘

A Docker image designed for PHP developers that care about code quality.

Available on Docker Hub at devdrops/php-toolbox.

The Project

Each PHP version, starting from 7.4, have at least 2 tags: one version without Xdebug, and another with Xdebug.

PHP 7.4:
- 7.4, 7.4-xdebug
PHP 8.0:
- 8.0, 8.0-xdebug
PHP 8.1:
- 8.1, 8.1-xdebug
PHP 8.2:
- 8.2, 8.2-xdebug
PHP 8.3:
- latest, 8.3, 8.3-xdebug

The following tools are available:

Tool	Description
PHP	The PHP programming language.
PHPUnit	PHPUnit is a programmer-oriented testing framework for PHP.
PHP_CodeSniffer	PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.
PHP CBF	PHP Code Beautifier and Fixer automatically correct coding standard violations.
PHP CS Fixer	A tool to automatically fix PHP Coding Standards issues.
PHP Mess Detector	Checks for bugs, suboptimal code, overcomplicated expressions, unused parameters etc.
Behat	A php framework for autotesting your business expectations.
PHPStan	PHPStan finds bugs in your code without writing tests.
composer-unused	Show unused composer dependencies by scanning your code.
Psalm	Prevent runtime errors and fix bugs automatically.
Pest	The elegant PHP testing framework.
Rector	Instant Upgrades and Automated Refactoring of any PHP 5.3+ code.
PHPArkitect	Put your architectural rules under test!
phpspec	A php toolset to drive emergent design by specification.
Codeception	Codeception collects and shares best practices and solutions for testing PHP web applications.
Infection	PHP Mutation Testing Framework
Deptrac	Deptrac is a static code analysis tool for PHP that helps you communicate, visualize and enforce architectural decisions in your projects.
PhpMetrics	PhpMetrics provides various metrics about PHP projects.
PDepend	PHP_Depend software analyzer and metric tool.

Install

docker pull devdrops/php-toolbox

Usage

All tools can be accessed by executing:

docker run -ti --rm -v $(pwd):/code -w /code devdrops/php-toolbox:latest <CHOOSEN_TOOL>

Where <CHOOSEN_TOOL> is the binary you're looking for 😉

Build it!

Clone this repository. Then, using a terminal window, go to it's root directory. Each version folder have it's own Makefile with the following commands (you can run make help to see a brief explanation of each command):

build                          Build the official tag.
debug                          Build only the image with Xdebug.
develop                        Build '*-dev' tag, including Xdebug.
hadolint                       Lint ./Dockerfile with Hadolint
help                           Print information of each Make task.
latest                         Build two images: 1. official tag, 2. official tag + Xdebug.
push                           Pushes to Docker Hub two images: 1. official tag, 2. official tag + Xdebug.
release                        Build and deploy official tags.
shellcheck                     Run shellcheck to scan sh files at ./helpers.

php-toolbox's People

Contributors

Stargazers

Watchers

Forkers

diego-brocanelli kix marc-casoliva atmosmps thiiagoms zerzeryu

php-toolbox's Issues

Fix code scanning alert - CVE-2023-38039

Tracking issue for:

https://github.com/devdrops/php-toolbox/security/code-scanning/14

Add DiffCS

https://github.com/marcelsud/diffcs

OCI

https://opencontainers.org/

Add Behat

PHP CS Fixer not working :(

Seems that running PHP CS Fixer does not makes any changes to the target files. Why?

Execution:

docker run -it -v $(pwd):/foo -w /foo devdrops/php-toolbox php-cs-fixer fix my/awesome/php/file.php

docker run -it -v $(pwd):/foo -w /foo devdrops/php-toolbox php-cs-fixer fix /foo/my/awesome/php/file.php

WARNING: Libzip >= 1.2.0 needed for encryption support

From the logs:

Configuring for:                                                                                                                                                 [131/409]
PHP Api Version:         20180731                                                                                                                                         
Zend Module Api No:      20180731                                                                                                                                         
Zend Extension Api No:   320180731                                                                                                                                        
checking for grep that handles long lines and -e... /bin/grep                                                                                                             
checking for egrep... /bin/grep -E                                                                                                                                        
checking for a sed that does not truncate output... /bin/sed                                                                                                              
checking for cc... cc                                                                                                                                                     
checking whether the C compiler works... yes                                                                                                                              
checking for C compiler default output file name... a.out                                                                                                                 
checking for suffix of executables...                                                                                                                                     
checking whether we are cross compiling... no                                                                                                                             
checking for suffix of object files... o                                                                                                                                  
checking whether we are using the GNU C compiler... yes                                                                                                                   
checking whether cc accepts -g... yes                                                                                                                                     
checking for cc option to accept ISO C89... none needed                                                                                                                   
checking how to run the C preprocessor... cc -E                                                                                                                           
checking for icc... no                                                                                                                                                    
checking for suncc... no                                                                                                                                                  
checking whether cc understands -c and -o together... yes                                                                                                                 
checking for system library directory... lib                                                                                                                              
checking if compiler supports -R... no                                                                                                                                    
checking if compiler supports -Wl,-rpath,... yes                                                                                                                          
checking build system type... x86_64-pc-linux-gnu                                                                                                                         
checking host system type... x86_64-pc-linux-gnu                                                                                                                          
checking target system type... x86_64-pc-linux-gnu                                                                                                                        
checking for PHP prefix... /usr/local                                                                                                                                     
checking for PHP includes... -I/usr/local/include/php -I/usr/local/include/php/main -I/usr/local/include/php/TSRM -I/usr/local/include/php/Zend -I/usr/local/include/php/e
xt -I/usr/local/include/php/ext/date/lib
checking for PHP extension directory... /usr/local/lib/php/extensions/no-debug-non-zts-20180731
checking for PHP installed headers prefix... /usr/local/include/php
checking if debug is enabled... no
checking if zts is enabled... no
checking for re2c... re2c
checking for re2c version... 0.16 (ok)
checking for gawk... no
checking for nawk... nawk
checking if nawk is broken... no
checking for zip archive read/writesupport... yes, shared
checking for the location of libz... no
checking pcre install prefix... no
checking libzip... yes
checking for the location of zlib... /usr
checking for pkg-config... /usr/bin/pkg-config
checking for libzip... from pkgconfig: version 1.1.2 found in /usr/lib/x86_64-linux-gnu
checking for zip_open in -lzip... yes
checking for zip_file_set_encryption in -lzip... no
configure: WARNING: Libzip >= 1.2.0 needed for encryption support

The last message is warning about the current version of libzip, required for encryption support. Maybe libsodium?

Trivy

https://github.com/aquasecurity/trivy

Fix code scanning alert - CVE-2023-38039

Tracking issue for:

https://github.com/devdrops/php-toolbox/security/code-scanning/15

Snyk

Automate build/push

Trust images

https://docs.docker.com/engine/security/trust/

Add composer-unused

https://github.com/icanhazstring/composer-unused

Add Xdebug

Here's why:

Allow support for debugging (see https://github.com/sohelamin/my-docker);
Allow PHPUnit to support coverage report.

Fix code scanning alert - CVE-2023-38039

Tracking issue for:

https://github.com/devdrops/php-toolbox/security/code-scanning/13

Fix code scanning alert - CVE-2023-38039

Tracking issue for:

https://github.com/devdrops/php-toolbox/security/code-scanning/14

Missing ext-zip from container

Required to run Composer install commands

Roadmap

Which tools?

PHP_CodeSniffer
PHP Mess Detector
PHP CS Fixer
Others?

How to run?

No matter where the code is
IDE compatible

Remove unnecessary curl installation

At https://github.com/devdrops/php-toolbox/blob/master/Dockerfile#L17-L19, we have the following:

RUN apt-get update > /dev/null 2>&1 && \
    apt-get -y install \
        curl \

And so on. BUT, at https://github.com/devdrops/php-toolbox/blob/master/Dockerfile#L14, we have the following:

RUN curl --silent https://getcomposer.org/installer | php > /dev/null 2>&1 && \

This is a call to curl, which points that curl is already installed.

devdrops / php-toolbox Goto Github PK

php-toolbox's Introduction

devdrops/php-toolbox 🐳 🐘

The Project

Install

Usage

Build it!

php-toolbox's People

Contributors

Stargazers

Watchers

Forkers

php-toolbox's Issues

Which tools?

How to run?

Recommend Projects

Recommend Topics

Recommend Org