En esta presentación, se muestran ejemplos de los esfuerzos realizados y de las herramientas usadas para mejorar la calidad del código de Chamilo (en particular a partir de la versión 1.11)

1. Behat, Travis & Scrutinizer
Calidad en PHP
con el proyecto Chamilo
Yannick Warnier
@ywarnier

2. Caso Chamilo
● Sistema de gestión del aprendizaje (LMS)
● Claroline→Dokeos→Chamilo / Moodle / Canvas
● Código abierto
● https://github.com/chamilo
● https://github.com/chamilo/chamilo-lms/

3. Herramientas
Dispositivos
móviles

4. Gestión de competencias,
insignias, evaluaciones de
desempeño, ...

6. Para mejorar la calidad de
Chamilo, necesitamos…
- pruebas
- sistema de build automático
- sistema de análisis de código

7. Behat
● Sistema de pruebas
● Behaviour Driven Development
● Formulación en lenguaje “común”
● Software libre
● https://github.com/Behat/Behat
● http://docs.behat.org/en/latest/

8. Travis-CI
● Portal de servicios de integración continua
● Travis/Jenkins←Hudson
● Código abierto (parcialmente)
● https://github.com/travis-ci
● https://docs.travis-ci.com/user/for-beginners

9. Scrutinizer-CI
● Portal de análisis de código
● Clover/phploc/phpmd/… → Scrutinizer
● Código abierto (parcialmente)
● https://github.com/scrutinizer-ci
● https://scrutinizer-ci.com/docs/

10. Behat vs PHPUnit
public function testLs()
{
mkdir('/tmp/test');
touch('/tmp/test/foo');
$ls = @exec('ls /tmp/test');
$this assertContains($ls, 'foo');→
}

11. Behat vs PHPUnit

12. Mink (compañero web)

13. Behat.yml
default:
extensions:
BehatMinkExtensionExtension:
base_url: http://my.chamilo110.net
goutte: ~
selenium2: ~
paths:
features: features
bootstrap: %behat.paths.features
%/bootstrap

14. Estructura Behat

15. Archivo de prueba
# features/login.feature
@common
Feature: User login
In order to log in
As any registered user
I need to be able to enter my details in the form and get in
Scenario: Login as admin user successfully
Given I am a platform administrator
Then I should not see an ".alert­danger" element
Scenario: Login as student user successfully

16. FeatureContext.php
<?php
use BehatBehatContextClosuredContextInterface,
BehatBehatContextTranslatedContextInterface,
BehatBehatContextBehatContext,
BehatBehatContextStep,
BehatBehatContextStepGiven,
BehatBehatExceptionPendingException,
BehatBehatEventSuiteEvent;
use BehatGherkinNodePyStringNode,
BehatGherkinNodeTableNode;
use BehatMinkExtensionContextMinkContext;

17. FeatureContext.php
class FeatureContext extends MinkContext
{
public function __construct(array $parameters) { //… }
/**
* @Given /^I am a platform administrator$/
*/
public function iAmAPlatformAdministrator()
{
return array(
new Given('I am on "/index.php?logout=logout"'),
new Given('I am on homepage'),
new Given('I fill in "login" with "admin"'),
new Given('I fill in "password" with "admin"'),
new Given('I press "submitAuth"')
);
}

18. Resultados

19. Resultados

20. Travis-CI
● ¿Tienes tu proyecto en Github?
● Usa tu cuenta Github para abrir cuenta travis-ci.org
● Carga tus repos
● Define un .travis.yml en tu proyecto

21. .travis.yml (1/3)
language: php
php:
­ 5.5
­ 5.6
­ 7.0
before_install:
­ sudo apt­get update ­qq
­ sudo apt­get install ­qq mysql­server
­ sudo apt­get install ­qq apache2 libapache2­mod­fastcgi
­ sudo cp ~/.phpenv/versions/$(phpenv version­name)/etc/php­fpm.conf.default ~/.phpenv/versions/$
(phpenv version­name)/etc/php­fpm.conf
­ sudo a2enmod rewrite actions fastcgi alias
­ echo "cgi.fix_pathinfo = 1" >> ~/.phpenv/versions/$(phpenv version­name)/etc/php.ini
­ echo "memory_limit = 2G" >> ~/.phpenv/versions/$(phpenv version­name)/etc/php.ini
­ echo "phar.readonly = 0" >> ~/.phpenv/versions/$(phpenv version­name)/etc/php.ini
­ echo "date.timezone = Europe/Paris" >> ~/.phpenv/versions/$(phpenv version­name)/etc/php.ini
­ ...

22. .travis.yml (2/3)
before_script:
­ composer update
­ phpenv config­add tests/travis­php­
config.ini
­ php ­v
­ cd /home/travis/build/chamilo/chamilo­lms
­ ...comando de instalación…

23. .travis.yml (3/3)
script:
­ cd tests && ../vendor/behat/behat/bin/behat ­v
notifications:
irc: "irc.freenode.org#chamilodev"

24. Travis-CI
● PHP-CLI = 5.3 por defecto
● Doctrine depende de >=5.4!
– Para evitarlo, agregar, en “before_install”:
– sudo cp ~/.phpenv/versions/$(phpenv version­name)/etc/php­fpm.conf.default
~/.phpenv/versions/$(phpenv version­name)/etc/php­fpm.conf

25. Travis-CI: Resultados

26. Travis-CI: Resultados

27. Scrutinizer-CI
● ¿Tienes tu proyecto en Github?
● Usa tu cuenta Github en scrutinizer-ci.org
● Carga tus repos
● Define un .scrutinizer.yml en tu proyecto

28. .scrutinizer.yml (1/2)
build:
environment:
mysql: 5.5
php:
version: 5.6.0
ini:
'date.timezone': 'US/Pacific'
'phar.readonly': false
hosts:
my.chamilo110.net: '127.0.0.1'
dependencies:
override:
­ true
before:
­ php ­d memory_limit=2G /usr/bin/composer.phar ­v update

29. .scrutinizer.yml (2/2)
filter:
excluded_paths:
­ tests/*
­ app/cache/*
­ app/logs/*
­ web/*
­ vendor/*
checks:
php:
code_rating: true
duplication: true

30. Scrutinizer: método
● “Mejores prácticas”
● ISO-25010?
– International Standard for Software Product Quality
● No siempre corresponde a PSR
● Score: solo cuenta la parte “Code”, y no “Issues”
● Chamilo
– 6.3M líneas totales
– 4.9M es código (78%)

31. Scrutinizer: resultados
Nota para la sección “Code”

32. Scrutinizer: resultados
Evolución de la calidad del código
(tendencia en baja por inclusión de más código
de baja calidad)
Cantidad de “Issues” en baja de 4200 a 2200 durante
el mismo periodo (calidad y issues son dos indicadores distintos)

33. Scrutinizer: resultados
Se muestran los cambios de “issues” a cada commit (o PR) en Github

34. Scrutinizer: resultados
Basada en estándares de calidad, esta clasificación es la
que establece el score global (inicia con los peores scripts)

35. Scrutinizer: resultados
Los “issues” se agrupan por categoría y gravedad.
Un “bug” en este caso puede ser el envío de un parámetro entero
A una función que define (en PHPDoc) que tiene que ser de otro tipo

36. Scrutinizer: resultados

37. BeezNest
Miraflores - Lima - Perú
info@beeznest.com
@beeznestla