• Home

  • Documents

  • PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors...
46
PHP QA TOOLS PHP Code Quality Sergej Kurakin

PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

  • Upload
    others

  • View
    7

  • Download
    0

Embed Size (px)

Citation preview

Page 1: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP QA TOOLSPHP Code Quality

Sergej Kurakin

Page 2: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

Why?

● New project● Clean modern code base● Many developers● New challenge

Page 3: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

What?

● PSR Code Style● Minimize Copy/Paste● Reduce Code Complexity● Tests...

Page 4: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

T_PAAMAYIM_NEKUDOTAYIM

Page 5: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Lint - syntax check

● Checks PHP code for syntax errors● Built-in into PHP binary

$ php -l path/to/file.php

Page 6: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

Code Style

Page 7: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php
Page 8: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php
Page 9: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Code Sniffer

● Detects coding standard violations● https://github.

com/squizlabs/PHP_CodeSniffer● Composer/PEAR

Interesting side project: http://squizlabs.github.io/PHP_CodeSniffer/analysis/

https://github.com/squizlabs/PHP_CodeSniffer
https://github.com/squizlabs/PHP_CodeSniffer
https://github.com/squizlabs/PHP_CodeSniffer
http://squizlabs.github.io/PHP_CodeSniffer/analysis/
http://squizlabs.github.io/PHP_CodeSniffer/analysis/
http://squizlabs.github.io/PHP_CodeSniffer/analysis/
Page 10: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Code Sniffer: Run

$ phpcs path/to/file.php

$ phpcs path/to/dir

$ phpcs -h

$ phpcs -i

Page 11: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Code Sniffer: Keys

--sniffs=<sniffs>

--encoding=<encoding>

--extensions=<extensions>

--ignore=<patterns>

--standard=<standard>

Page 12: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Code Sniffer: Standards

● PEAR● PHPCS● PSR1● PSR2● Squiz● Zend

Page 13: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Code Sniffer: Reports

● full● xml● checkstyle● csv● json● emacs

● source● summary● svnblame● gitblame● hgblame● notifysend

Page 14: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

Copy & Paste

Page 15: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php
Page 16: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php
Page 17: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Copy/Paste Detector

● CPD - Copy/Paste (code) Detector● https://github.

com/sebastianbergmann/phpcpd● Composer/PHAR

https://github.com/sebastianbergmann/phpcpd
https://github.com/sebastianbergmann/phpcpd
https://github.com/sebastianbergmann/phpcpd
Page 18: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Copy/Paste Detector: Run

$ phpcpd path/to/file.php path/to/other/file.php$ phpcpd path/to/dir

$phpcpd -h

Page 19: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Copy/Paste Detector: Keys

--names=<names>--names-exclude=<names-exclude>--exclude=<exclude>--log-pmd--min-lines=<5>--min-tokens=<70>

Page 20: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

Mess

Page 21: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php
Page 22: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Mess Detector

● Source Code Analyzer● http://phpmd.org/● Composer

http://phpmd.org/
http://phpmd.org/
Page 23: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Mess Detector: Run

$ phpmd path/to/dir text cleancode,codesize,controversial,design,naming,unusedcode

$ phpmd path/to/dir text path/to/ruleset.xml

Page 24: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Mess Detector: Reports

● xml● text● html

Page 25: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Mess Detector: Rulesets

● cleancode● codesize● controversial● design● naming● unusedcode

Page 26: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

Unused Code

Page 27: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php
Page 28: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Dead Code Detector

● Unused/Dead Code Detector● https://github.

com/sebastianbergmann/phpdcd● Composer/PHAR

https://github.com/sebastianbergmann/phpdcd
https://github.com/sebastianbergmann/phpdcd
https://github.com/sebastianbergmann/phpdcd
Page 29: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Dead Code Detector

$ phpdcd path/to/file.php

$ phpdcd path/to/dir

$phpdcd -h

Page 30: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

Code Statistics

Page 31: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php
Page 32: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

phploc

● Size and Analytics● https://github.

com/sebastianbergmann/phploc● Composer/PHAR

https://github.com/sebastianbergmann/phploc
https://github.com/sebastianbergmann/phploc
https://github.com/sebastianbergmann/phploc
Page 33: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

phploc: Run

$ phploc path/to/dir

$ phploc -h

Page 34: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

phploc: Keys

--names

--names-exclude

--git-repository

--log-csv=<path/to/file.csv>

--log-xml=<path/to/file.xml>

Page 35: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php
Page 36: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Depend

● Software Metrics● http://pdepend.org/● http://pdepend.org/documentation/software-

metrics/index.html● Composer/PHAR/PEAR

http://pdepend.org/
http://pdepend.org/
http://pdepend.org/documentation/software-metrics/index.html
http://pdepend.org/documentation/software-metrics/index.html
http://pdepend.org/documentation/software-metrics/index.html
Page 37: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PHP Depend: Run

$ pdepend \

--summary-xml=/tmp/summary.xml \

--jdepend-chart=/tmp/jdepend.svg \

--overview-pyramid=/tmp/pyramid.svg \

path/to/dir

Page 38: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

Tests...

Page 39: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php
Page 40: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

Testing Frameworks

● PHPUnit - http://phpunit.de/● Behat - http://behat.org/● Spec - http://www.phpspec.net/● JFGI

http://phpunit.de/
http://behat.org/
http://www.phpspec.net/
https://www.google.com/search?q=php+testing+framework
https://www.google.com/search?q=php+testing+framework
Page 41: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

Weapon of choice

Page 42: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

Other stuff

Page 43: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

PhpStorm

Preferences > PHP >Code SnifferMess Detector

Preferences > Inspections

Code > Inspect Code

Page 44: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

php-cs-fixer

● Fixes coding standards● http://cs.sensiolabs.org/● Composer/PHAR● PSR1 and PSR2 only

$ php-cs-fixer fix path/to/dir --level=all

http://cs.sensiolabs.org/
http://cs.sensiolabs.org/
Page 45: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

You can find more at http://phpqatools.org/

Big big thanks to Sebastian Bergmann for the work over PHP QA tools collection.

http://phpqatools.org/
Page 46: PHP QA TOOLS - Kurakin · 2014-09-09 · PHP Lint - syntax check Checks PHP code for syntax errors Built-in into PHP binary $ php -l path/to/file.php

Questions?

Sergej Kurakin

Email: [email protected]: @zaza_lt

Special thanks to authors of all pictures used in this presentation.

mailto:[email protected]
https://twitter.com/zaza_lt

PHP Syntax

PHP Syntax

Documents
PHP Syntax Data Types, Variables, Operators, Expressions, Conditional Statements SoftUni Team Technical Trainers Software University

PHP Syntax Data Types, Variables, Operators, Expressions, Conditional Statements SoftUni Team Technical Trainers Software University

Documents
"Hello World" Script in PHP - Al-Mustansiriya University · Web viewPHP Syntax is C-Like. PHP performs system functions, i.e. from files on a system it can create, open, read, write,

"Hello World" Script in PHP - Al-Mustansiriya University · Web viewPHP Syntax is C-Like. PHP performs system functions, i.e. from files on a system it can create, open, read, write,

Documents
AWeb-Based Introduction to ProgrammingAWeb-Based Introduction to Programming Essential Algorithms, Syntax, and Control Structures Using PHP and XHTML Mike O’Kane Carolina Academic

AWeb-Based Introduction to ProgrammingAWeb-Based Introduction to Programming Essential Algorithms, Syntax, and Control Structures Using PHP and XHTML Mike O’Kane Carolina Academic

Documents
PHP 5 Advanced OOP and Design Patternsee92193/documentacao/phpoo2.pdfthe object syntax. It also allows PHP code to overload a limited subset that is most often needed. This section

PHP 5 Advanced OOP and Design Patternsee92193/documentacao/phpoo2.pdfthe object syntax. It also allows PHP code to overload a limited subset that is most often needed. This section

Documents
PHP Arūnas Liuiza. PHP 101 What is PHP? Widely popular dynamic interpreted opensource programming language, aimed for web development Syntax is simmilar

PHP Arūnas Liuiza. PHP 101 What is PHP? Widely popular dynamic interpreted opensource programming language, aimed for web development Syntax is simmilar

Documents
PHP Programming: PHP Crush Course! Learn PHP Programming

PHP Programming: PHP Crush Course! Learn PHP Programming

Documents
Climbing the Abstract Syntax Tree (Bulgaria PHP 2016)

Climbing the Abstract Syntax Tree (Bulgaria PHP 2016)

Technology
PHP Without PHP—Confoo

PHP Without PHP—Confoo

Technology
Introduction to Server-Side Programming6.470.scripts.mit.edu/2013/assets/resources/php_ppt.pdf · Introduction and Basic Syntax Charles Liu . What is PHP?

Introduction to Server-Side Programming6.470.scripts.mit.edu/2013/assets/resources/php_ppt.pdf · Introduction and Basic Syntax Charles Liu . What is PHP?

Documents
Chapter 02 php basic syntax

Chapter 02 php basic syntax

Data & Analytics
Everything PHP Developers Need to Be Productive · Delphi For PHP 2.0: Everything PHP Developers Need to Be Productive • Syntax highlighting of code makes it clear what each section

Everything PHP Developers Need to Be Productive · Delphi For PHP 2.0: Everything PHP Developers Need to Be Productive • Syntax highlighting of code makes it clear what each section

Documents
1 Open Source Programming. -Introduction to PHP -PHP installation /wamp server installation for PHP environment -PHP syntax -PHP variables -PHP Strings

1 Open Source Programming. -Introduction to PHP -PHP installation /wamp server installation for PHP environment -PHP syntax -PHP variables -PHP Strings

Documents
Basic PHP Syntax - webstepbook.comPHP Arrays Ex. 1 Arrays allow you to assign multiple values to one variable. For this PHP exercise, write an array variable of weather conditions

Basic PHP Syntax - webstepbook.comPHP Arrays Ex. 1 Arrays allow you to assign multiple values to one variable. For this PHP exercise, write an array variable of weather conditions

Documents
WEB DEVELOPMENT EXPERT · Php Basics • Basic Syntax • Variables • Echo/Print • Data Types • Operators Php Conditions,Loops • If Condition • If Else Condtions • Nested

WEB DEVELOPMENT EXPERT · Php Basics • Basic Syntax • Variables • Echo/Print • Data Types • Operators Php Conditions,Loops • If Condition • If Else Condtions • Nested

Documents
PHP Functions and Arrays - Meetupfiles.meetup.com/120882/PHP Chapter 2-3 Training.pdf · Functions Minimal syntax function name() { } PHP function names are not case-sensitive. All

PHP Functions and Arrays - Meetupfiles.meetup.com/120882/PHP Chapter 2-3 Training.pdf · Functions Minimal syntax function name() { } PHP function names are not case-sensitive. All

Documents
PHP - Constructs and Variablesweb.eecs.utk.edu/~bvz/cs465/notes/php/PHPVariables.pdf · PHP: Constructs and Variables Introduction This document describes: 1. the syntax and types

PHP - Constructs and Variablesweb.eecs.utk.edu/~bvz/cs465/notes/php/PHPVariables.pdf · PHP: Constructs and Variables Introduction This document describes: 1. the syntax and types

Documents
1 PHP Introduction Chapter 1. Syntax and language constructs

1 PHP Introduction Chapter 1. Syntax and language constructs

Documents
PHP CCSA CheckpointHow PHP Works b. How PHP differs from ASP.NET c. The php.ini File d. Basic PHP Syntax e. Variables f. PHP Operators g. Creating Dynamic Pages i. Single Quotes vs

PHP CCSA CheckpointHow PHP Works b. How PHP differs from ASP.NET c. The php.ini File d. Basic PHP Syntax e. Variables f. PHP Operators g. Creating Dynamic Pages i. Single Quotes vs

Documents
The SOFT 2007 Alexei Kurakin. All rights reserved. spatiotemporal scales through ... self-organizing fractal theory (SOFT); adaptation through ... The SOFT © 2007 Alexei Kurakin

The SOFT 2007 Alexei Kurakin. All rights reserved. spatiotemporal scales through ... self-organizing fractal theory (SOFT); adaptation through ... The SOFT © 2007 Alexei Kurakin

Documents
COMP519: Web Programming Autumn 2010 PHP Basics: Introduction to PHP a PHP file, PHP workings, running PHP. Basic PHP syntax variables, operators,

COMP519: Web Programming Autumn 2010 PHP Basics: Introduction to PHP a PHP file, PHP workings, running PHP. Basic PHP syntax variables, operators,

Documents
CSC 318 WEB APPLICATION DEVELOPMENT. Introduction to Server Scripting language Client VS Server Introduction to PHP PHP Files and Syntax Function

CSC 318 WEB APPLICATION DEVELOPMENT. Introduction to Server Scripting language Client VS Server Introduction to PHP PHP Files and Syntax Function

Documents
P H P · CORE PHP How PHP Works The php.ini File Basic PHP Syntax PHP Tags PHP Statements and Whitespace Comments PHP Functions Variables Variable Types Variable Names (Identifiers)

P H P · CORE PHP How PHP Works The php.ini File Basic PHP Syntax PHP Tags PHP Statements and Whitespace Comments PHP Functions Variables Variable Types Variable Names (Identifiers)

Documents
CCS 4370/6370: Web Programming Spring 2013 PHP Basics: Introduction to PHP a PHP file, PHP workings, running PHP. Basic PHP syntax variables, operators,

CCS 4370/6370: Web Programming Spring 2013 PHP Basics: Introduction to PHP a PHP file, PHP workings, running PHP. Basic PHP syntax variables, operators,

Documents
PHP and MySQL php-mysql PHP and MySQL

PHP and MySQL php-mysql PHP and MySQL

Documents
Arrays Strings and regular expressions Basic PHP Syntax CS380 1

Arrays Strings and regular expressions Basic PHP Syntax CS380 1

Documents
1 Basic PHP Syntax - University of Rochester€¦ ·  · 2014-02-10Basic PHP Syntax CSC 210 1 . Announcements ! Demo Tomorrow: ... 3, and 4 now, so we can work out problems. CSC

1 Basic PHP Syntax - University of Rochester€¦ ·  · 2014-02-10Basic PHP Syntax CSC 210 1 . Announcements ! Demo Tomorrow: ... 3, and 4 now, so we can work out problems. CSC

Documents
1 PHP Introduction to PHP Basic Syntax of PHP Variables, Constant, Data Type, Type Casting Getting Data From Client PHP Database Manipulation

1 PHP Introduction to PHP Basic Syntax of PHP Variables, Constant, Data Type, Type Casting Getting Data From Client PHP Database Manipulation

Documents
OutlineOutline Introduction to PHP, Features, sample code, PHP script working, PHP syntax, conditions & Loops, Functions, String manipulation, Arrays & Functions,Features of PHP •PHP

OutlineOutline Introduction to PHP, Features, sample code, PHP script working, PHP syntax, conditions & Loops, Functions, String manipulation, Arrays & Functions,Features of PHP •PHP

Documents
Outline What is PHP? History of PHP Why PHP ? What is PHP file? What you need to start using PHP ? Syntax PHP code. echo & print Statement Variables

Outline What is PHP? History of PHP Why PHP ? What is PHP file? What you need to start using PHP ? Syntax PHP code. echo & print Statement Variables

Documents