Joomla Bugs, Patches & Fun - Joomladagen 2014

Joomladagen 2014Joomladagen 2014
Bugs, patches &
fun
Peter Martin, www.db8.nl. twitter: @pe7er
Joomladagen.nl/2014 – 22+ 23 maart 2014

Peter Martin
● Joomla website specialist
Marketing + Communicatie
achtergrond & technische
affiniteit
● Vrijwilliger Joomla:
– Global Moderator
– Community Leadership
Team
● Open Coffee Nijmegen
● Linux User Group Nijmegen
Interesses:
● Open Source Software
● Linux sinds 2007
(Ubuntu → Debian → Arch
Linux → Debian)
● Raspberry Pi
● Muziek (Vinyl)
● Filmhuisfilms
Website: www.db8.nl – e-mail: peter at db8.nl
LinkedIn: http://www.linkedin.com/in/pe7er – Twitter: @pe7er

Overzicht Presentatie
>>> Sheets via: www.db8.nl <<<
a)Introductie
b)Bugs & Patches
c)“Mijn” bug
d)Pizza, Bugs (& Beer) & Fun
e)Bugtracker Process
f) Test, Test, 1, 2, 3
g)Demonstratie
h)Vragen?

b) Bug & Patches

Een software bug
● Fout in een computer
programma
– Onjuist of onverwacht
resultaat, of
onbedoelde gedrag
– Door programmeur
gemaakte fouten in de
bron code (source
code) van het
programma.

Joomla bron code
index.php regel 1-30
<?php
/**
* @package    Joomla.Site
*
* @copyright  Copyright (C) 2005 2013 Open Source Matters, Inc. All rights reserved.
* @license    GNU General Public License version 2 or later; see LICENSE.txt
*/
if (version_compare(PHP_VERSION, '5.3.1', '<'))
{
die('Your host needs to use PHP 5.3.1 or higher to run this version of Joomla!');
}
/**
* Constant that is checked in included files to prevent direct access.
* define() is used in the installation folder rather than "const" to not error for PHP 5.2 and lower
*/
define('_JEXEC', 1);
if (file_exists(__DIR__ . '/defines.php'))
{
include_once __DIR__ . '/defines.php';
}
if (!defined('_JDEFINES'))
{
define('JPATH_BASE', __DIR__);
require_once JPATH_BASE . '/includes/defines.php';
}

Bron code – kleine bug
index.php
require_once JPATH_BASE . '/includes/framework.php';
// Mark afterLoad in the profiler.
JDEBUG ? $_PROFILER>mark('afterLoad') : null;
// Instantiate the application.
$app = Jfactory::getApplication('site');
// Initialise the application.
$app>initialise();
                        ug
                       b
                      g           bug
                      u        bug
      bugbug          b       g
            bug      bugbug bu
               bug  bugbugbugbugbugbug
  bug   bug   bugbugbugbugbugbugbugbugb
     bug   bug bugbugbugbugbugbugbugbugbu
   bugbugbugbu gbugbugbugbugbugbugbugbugbu
  bugbugbugbug
   bugbugbugbu gbugbugbugbugbugbugbugbugbu
     bug   bug bugbugbugbugbugbugbugbugbu
  bug   bug  gbugbugbugbugbugbugbugbugb
               bug  bugbugbugbugbugbug
            bug      bugbug  bu
      bugbug          b        g
                      u         bug
                      g            bug
                       b
                        ug

Bron code – grote bug
index.php
// Mark afterIntialise in the profiler.
JDEBUG ? $_PROFILER>mark('afterInitialise') : null;
                       ""$o               o$""
                         ""$o           o$"                      o
   "$""""o                  "o         $"                 o""" $"
         "$o                "$o" $o "  $                 o$"
          "$o               $$$o$$$$o$$$$               $"
            "oooo      o "" ""$$$$$$$$""o"" oo     oooo"
             "$$$$$$oo"oo$$$o" o$$$$oo" o$$$o "o$$$$$$$
                   "$ $$$$$$$$$oo   o$$$$$$$$$o"$"
                   $ $$$   $$$$$$  o$$$$$$  "$$o"o
                  $ $$$$o  $$$$$$  $$$$$$$  $$$$o"o
                 $  $$$$$  $$$$$"   "$$$$$ $$$$$$ $
                  $o""""" """"         """ """"""$"
                 $  o$$$$$"""$$$$$"$$$$$""$$$$$ooo"o
                 $  o"$o $$$$$$$$oo$$$$$$$$o $$""  $
              oo$     "$$$$$$$$$$$$$$$$$$$$" o" o $oo
           o$$$"$ $$o"o $$$$$$$"" "$$$$$$$    o$$ $$$$o      UN BUG
         o$$$$" $ $$$$ o "$$$$$oo o$$$$$$  "o$$$$ $ $$$$$
        o$$""    $ $$$$$o" "$$$$$$$$$$$$$ o o$$$$$o$   "" $$
        $$"      $ $$$"  o"o$$$$$$$$$$$$   " "$$$ $       $$o
       o$$       "o $$    "  $$$$$$$$$$$"o    "$$ $       $$$
       $$$      oo$ $       o""$$""$$$o "      $"o$o      $$$o
      o$$$$   o$$$"o"$oo$$$$o" o     $o $$$$$oo$ $$$$o    $$$$
      $$$$   $$$$" $ $$$$$""   $$  o$$$ """$$$$"o" "$$$o  "$$$o
      $$$" o """    $ $$$oo   $$$$o" $$   o$$$"o"   """"$  o$$$
   o$"     $$$       $ "$"" o$"o"$$o$$$$  "$$"o"      o$$     "$oo
$ "        $$o       $ "oo$"o$$$"o$o"$$$$o" o"       $$$       ""$o
$$          $$$o       "o$$o$"$$"$$o$$o$$"$$o"       $$$          ""o
             $$$        ""$$$ $$$$$$ $$$$ $"        $$$$            $$
             $$$$           $$$$"$$$o$ $""          $$$
              $$$$             "$$$ """            $$$$
              $$""                                 "$$
           oo$"                                       $ooo
          $                                             "$$

Bron code – hele grote bug
index.php
// Route the application.
$app>route();
// Mark afterRoute in the profiler.
JDEBUG ? $_PROFILER>mark('afterRoute') : null;
     .. ..oooo.....ooo...
  .odSS4PYYYSSOOXXXXXXXXXOodbgooo.
/SSYod$$$$SSOIIPXXXXXXXXXYYP.oo.*b.
($$Yd$$$$SSSOII:XXXXXXXX:IIoSSS$$b.Y,
Yd$$$$SSSOII:XXXXXXXXXX:IIOOSSS$$$b
  d$$$$SSSOOI:XP"YXXXXXXXX:IIOOSSSS$$$
  Y$$$SSSOOII:XbdXXXXXP"YX:IIOOOSS$$$$)
  'Y$$$SSSOI:XXXXXXXXXbodX:IIOOSS$$$$$/
   "Y$$$SSSOI(PoTXXXXXTo)XXIIOOOSS$$$*'
     ""*Y$S(((PXXXXXXXY))dIIOSSS$$dP'
        "*'()P;XXXXXXXXY)IIOSSS$P".oS,
        (S'(P;XXXXXXXP;Y)XXYOP".oSSSSb
       (S'(P;'XXXXXXX';Y).ooooSSSSSSSS)
       (S'(P;'XXXXXXP';Y).oSSSSSSSSSSSP
       (SS'Y);YXXXXX';(Y.oSSSSSSSSSSSSP
        YSS'Y)'YXXX".(Y.oSSP.SSSSSSSSY
         YSS'"" XXX""oooSSP.SSSSSSSSY
         SSSSSS YXXX:SSSSP.SSSSSSSSY
         SSSSSP  Yxb:SSSP.S"SSSSSSP
         S(OO)S   YXb:SY    )SSSSS
         SSSSO    )YXb.I    ISSSSP
         YSSSY    I."YXXb   Y(SS)I
         )SSS(    dSSo.""*b  YSSSY
         OooSb   dSSSSP      )SSS(
                 dSSSY       OooSS
                 OooSP

Bron code – “zombie bug”
index.php
$app>route();
                 .....
                 C C  /
                /<   /
___ __________/_#__=o
/( /(_________
)  )_      o
/| /|       |'     |
              |     _|
              /o   __
             / '     |
            / /      |
           /_/______|
          (   _(    <

                    |
             ________
             ________

Bron code – “ninja bug”
index.php
$app>route();

Een software patch
● Stukje software om
probleem op te lossen
– Verhelpen van
foutmelding
– Verhelpen van
beveiligingsprobleem
– Het verbeteren van de
gebruiksvriendelijkheid of
prestaties
● .diff patch
– Een bestandje dat de
verschillen met
voorgaande versie
beschrijft

Foutmeldingen & patches beheren
● Bijhouden van de gemelde
fouten in de software:
– Rapporteren
– Communicatie
– Patches delen
– Status van fout
– Statistieken
● git
– Versiebeheer software
● github.com
– Opslagplaats &
versiebeheer

Joomla & Patches
● Joomla 1.5 = EOL (einde
oefening)
– Geen patches
– Geen nieuwe functies
● Joomla 2.5 = LTS (Lange
termijn ondersteuning)
– Wel patches
– Geen nieuwe functies
● Joomla 3.x = STS (Korte
termijn ondersteuning)
– Wel patches
– Ook nieuwe functies

c) “Mijn” Bug

“Mijn” Bug
● 7 februari 2013,
rond 10:00 uur
● Joomla 3.0.3 testen voor
gebruik bij een klant

Installatieprocedure, stap 3

Het probleem aanmelden
● Niet echt een bug, wel verwarrend...
● 7 februari 2013, om 10:29 uur (en 35 seconden)
bug aangemeld
op Joomla's Issue Tracker:
http://joomlacode.org/gf/project/joomla/tracker/?
action=TrackerItemEdit&tracker_item_id=30077

Het probleem aanmelden

Werken aan een oplossing
● Lokale Joomla installatie van laatste 3.0 versie
● In Joomla's broncode zelf de functionaliteit
toegevoegd
● 7 februari 2013, 11:38 uur
mijn code toegevoegd als proof-of-concept:
http://joomlacode.org/gf/project/joomla/tracker/?
action=TrackerItemEdit&tracker_item_id=30077

● Februari 2013: reacties van anderen,
paar opmerkingen en suggesties
● 27 Maart 2013:
“can not download sample.php. Please zip it.”
– → Joomlacode.org accepteert uit veiligheidsoogpunt
geen .php bestanden...
● April 2013:
paar opmerkingen & suggesties
● Mei 2013:
….. niks, nada, nothing, ничего, kitu, ‫,لش شيء‬ ไม่มีอะไร

Zaterdag 1 juni 2013:
Joomla Bug Squad Night
bij JandBeyond (internationaal Joomla congres)
in Noordwijkerhout, Nederland
http://www.youtube.com/watch?v=v6YdZJtzJxo

Op Joomla Bug Squad Night:
– Meest recente Joomla versie (“master branch”)
geïnstalleerd vanaf GitHub
– Keuze opties bij installatie van Joomla getest
– Mijn proof-of-concept verandering geprogrammeerd
– Een “diff patch” gemaakt (dank aan Andrea Tarr!)
– De .diff patch toegevoegd aan Joomla Issue Tracker
– Biertje gedronken
Resultaat: Zaterdag 2 juni 2013, 00:30 uur
“I've created a patch 30077.patch ready to test.”

Zaterdag 2 juni 2013, patch “30077”
00:54 uur @test (Hans Kuijpers)
00:56 uur @test (Olaf Offick)
patch tested successfully
01:05 uur @test (Mike Veeckmans)
tested succesfully #jab13
01:05 uur (Andrea Tarr)
Multiple good tests - moving to rtc

Zaterdag 2 juni 2013, patch “30077”
01:31 uur (Michael Babker)
Merged at https://github.com/joomla/joomla-
cms/commit/37843e88ceae995ffa73f245f7abcd45d01
5cb9a
Daarna verder verbeterd door anderen:
– Generieker gemaakt: versie informatie verwijderd (Jean-Marie
Simonet)
– Betere layout voor tooltips

Oplossing – Joomla 3.1.5

“Mijn” Bug

d) Pizza, Bugs (& Beer) & Fun

"Pizza, Bugs & Fun"
Vrijdag 12 juli 2013
– Wereldwijd georganiseerd
– Nederland → Eindhoven:
Josien Verreijt, Marijke Stuivenberg,
Roland Dalmulder & Peter Martin

Joomladay Germany 2013
● Zondag 15 september 2013
Bug Squashing und Accessibility Codesprint (David
Jardin & David Hurley)

Joomladay UK 2013
Zaterdag 5 oktober 2013
Joomla BugSquashing session
(Javier Gómez)

Joomla World Conference 2013
Zaterdag 9 november 2013
Bugs, Beer & Fun

e) De Bugtracker Issue Tracker

Status:
1.Open
2.Confirmed
3.Pending
4.Ready to commit
5.Fixed in SVN/GitHub

BT Proces: 1. Open
● Nieuwe bug?
– Probleem te
reproduceren met Joomla
“Master Branch”?
– Rapporteren: “Add new
Tracker Item”
● Category
● Status: “Open”
● Build: “master”
● How to reproduce...
● Summary & Details
(PHP / Browser /
Database
/ Webserver)
Tracker Team

BT Proces: 2. Confirmed
● Probleem bevestigd?
– Andere gebruikers
kunnen de fout
reproduceren met de
Joomla “Master
Branch”
→ patch ontwikkelen
Coding Team

BT Proces: 3. Pending
● Patch voor bug beschikbaar
● Moet eerst op Joomla
“Master Branch” getest
worden:
– Test bug voor installatie
patch
– Patch installeren
– Test of probleem is
opgelost
– Test of er geen nieuwe
problemen zijn ontstaan
Testing Team

BT Proces: 4. Ready to Commit
● Patch voor bug
– Twee succesvolle tests:
● Commentaar: @test
● Commentaar: @test
– Ready To Commit
(RTC) = gereed om
aan de Joomla core
code toegevoegd te
worden
Testing Team

BT Proces: 5. Fixed in SVN/GitHub
● RTC → Commit Patch
= samengevoegd met
Joomla “Master
Branch”
– In volgende (sub)versie
beschikbaar in de
Joomla download van
joomla.org
PL Team +

f) Test, Test, 1, 2, 3

Testen – Benodigdheden
● Lokale webserver (voor Joomla)
– XAMP/MAMP/LAMP
● Git
– Distributed revision control and source code management
(soort van “Wikipedia” voor broncode)
● Joomla “Master Branch”
– Meest recente Joomla version met alle patches & nieuwe
features
– https://github.com/joomla/joomla-cms/
● Browser
– Chrome (incl Inspector) of FireFox + FireBug addon
● (Integrated Development Environment (IDE))

Testen – download Joomla “Master Branch”
in /var/www/
$ git clone https://github.com/joomla/joomlacms
Cloning into joomlacms...
remote: Counting objects: 381082, done.
remote: Compressing objects: 100% (128076/128076), done.
remote: Total 381082 (delta 271874), reused 357127 (delta
249654)
Receiving objects: 100% (381082/381082), 95.79 MiB | 5.79
MiB/s, done.
Resolving deltas: 100% (271874/271874), done.
Joomla website: /var/www/joomlacms/

Testen – Joomla installeren
● Browser
– Ga naar je lokale Joomla map http://localhost/joomla-
cms/
– Volg normale installatie procedure, maar kies:
● Sample Data: Test English (GB) Sample Data
= voorbeeld inhoud met daarin menu's met links naar alle
Joomla componenten en modules → makkelijker testen
– Verwijder bij de laatste stap de installatie folder NIET!!

Testen – Joomla installeren

Testen – voorbeeld
“Bug” in /administrator/components/com_banners/models/banner.php
“Hardcoded SQL” in regel 511:
$db = Jfactory::getDbo();
$db->setQuery('SELECT MAX(ordering) FROM #__banners');
$max = $db->loadResult();
Joomlacode:
[#32194] Banner model has hardcoded SQL

Joomlacode: [#32194] Banner model has hardcoded SQL
Github.com: patch [#2200]
De “hardcoded SQL“:
$db->setQuery('SELECT MAX(ordering) FROM #__banners');
vervangen met Joomla's $query object:
$query = $db->getQuery(true)
->select('MAX(ordering)')
->from('#__banners');
$db->setQuery($query);

Github: https://github.com/joomla/joomla-cms/pull/2200

Travis: https://travis-ci.org/joomla/joomla-cms/builds/12365303

Joomlacode: [#32194] Banner model has hardcoded SQL
Patch: https://github.com/joomla/joomla-cms/pull/2200.diff

[#32194] Banner model has hardcoded SQL
● Before:
● After:
$ curl https://github.com/joomla/joomlacms/pull/2200.diff | git apply
% Total    % Received % Xferd  Average Speed   Time   Time     Time  Current
                       Dload  Upload   Total  Spent    Left  Speed
100   691  100   691    0     0   1448      0 :: :: ::  1930

Testen – voorbeeld – git commando's
Command line:
● Controleer & vraag informatie over patch status op:
curl https://github.com/joomla/joomla-cms/pull/2200.diff | git apply --check
● Patch uitvoeren op jouw lokale Joomla installatie
curl https://github.com/joomla/joomla-cms/pull/2200.diff | git apply
● Patch verwijderen:
curl https://github.com/joomla/joomla-cms/pull/2200.diff | git apply -R
● Controleer of patch is verwijderd:
git status
# On branch master
nothing to commit (working directory clean)

Testen – voorbeeld – git commando's
● “Hard reset” – verwijder alle veranderingen
git reset --hard HEAD
● Informatie over de veranderingen, commits etc
git log
git log --pretty=oneline
● Joomla “Master Branch” = heel dynamisch. Importeer
de meest recente veranderingen via:
git pull

Dat was makkelijk? Toch?.....

Testen zonder command line git

Testen dmv component
http://docs.joomla.org/Component_Patchtester_for_Testers

Testen dmv component

f) Demonstratie

i e

Vragen?
● Presentatie beschikbaar via www.db8.nl
Peter Martin
e-mail: info at db8.nl
website: www.db8.nl
twitter: @pe7er

Gebruikte foto's 1/2
● First Aid Plaster 1 - Gokhan Okur http://www.sxc.hu/photo/782775
● Moth - Therese Branton http://www.sxc.hu/photo/901692
● ASCII Bugs: http://www.asciiworld.com/
● Executivo 3 - Ivan Soares Ferrer http://www.sxc.hu/photo/215592
● Joomla Sticker + Stroopwafel photo - Paul Orwig
● Night moth - Irina Naumets http://www.sxc.hu/photo/1047402
● Bandaid Bandage - Pam Roth http://www.sxc.hu/photo/291573
● JAB13 Bug Squad, Pizza, Bugs & Fun (Eindhoven, NL), JDDE13 Bug
Squashing & JWC13 foto's - Peter Martin
● JDUK13 Bug Squashing photos - Paul Orwig
● Moth 1 - Irina Naumets http://www.sxc.hu/photo/1059828

Gebruikte foto's 2/2
● Count on us - Laura Leavell http://www.sxc.hu/photo/1206290
● Checkbox - bzuko22 http://www.sxc.hu/photo/1335487
● Hands: Thumbsup - J. Henning Buchholz http://www.sxc.hu/photo/238119
● Hands: Peace - J. Henning Buchholz http://www.sxc.hu/photo/238133
● Multimeter - Maxime Perron Caissy http://www.sxc.hu/photo/498477
● mathematic formulas - Tomasz A. Poszwa http://www.sxc.hu/photo/214561
● Police protecting the demonstration - Michal Zacharzewski
http://www.sxc.hu/photo/559518
● signs signs - Jason Antony http://www.sxc.hu/photo/751034
Bronnen:
● Bug Tracking Process - Marijke Stuivenberg http://tinyurl.com/slides-PBFnl
● Werken met de Joomla Master Code - Roland Dalmulder
http://tinyurl.com/handleiding-PBFnl

Joomla Bugs, Patches & Fun - Joomladagen 2014

Recomendados

Recomendados

Mais conteúdo relacionado

Mais procurados

Mais procurados (16)

Semelhante a Joomla Bugs, Patches & Fun - Joomladagen 2014

Semelhante a Joomla Bugs, Patches & Fun - Joomladagen 2014 (8)

Mais de Peter Martin

Mais de Peter Martin (20)

Joomla Bugs, Patches & Fun - Joomladagen 2014