Wir zeigen dir worauf du achten musst und wie du einen Pull Request findest und den Patch testen kannst. Wir haben ein Youtube-Video erstellt, in dem gezeigt wird, wie man einen Patch testet: Live-Präsentation "Patch testen in 3 Minuten"
 

Was brauche ich um einen Patch zu testen?

 

Und so funktioniert´s:

1. Pull Request zum testen finden:

Am Morgen des PBF-Events wird ein Google-Dokument veröffentlicht, in dem alle Patches stehen, die wir heute gerne testen möchten. Da beim Schreiben der Anleitung diese Liste noch nicht vorhanden war, wird hier die Liste vom letzten PBF gezeigt. Sobald es ein aktuelles Muster gibt, wird diese Grafik ausgetauscht:
Fehler finden beim PBF-Event

Die Liste beinhaltet:

• Spalte A beinhaltet den verlinkten Patch mit Farbmarkierung (ID = letzte Zahl).
Grün bedeutet einfaches Testen mit Testbeschreibung.
Gelb bedeutet erweitertes Testen; wenige oder keine Testbeschreibung / einfacher Code.
Rot bedeutet keine Testbeschreibung und umfangreicherer Code oder selber Code schreiben.

• Spalte B: Tester 1 trägt seinen Namen ein, sobald er sich für einen Patch entschieden hat. Nachdem man fertig ist, wird “erledigt” oder “nicht erfolgreich getestet” eingetragen.

• Spalte C: Tester 2 kann zeitgleich zum Tester 1 arbeiten.

• Spalte D: Diese Spalte bearbeitet ein “Produktverantwortlicher”. Das ist jemand, der die Schreibrechte für den Quelltext hat.

• Hinweise / Probleme werden hierhin geschrieben, wenn niemand in der JUG oder im Glip-Chatroom helfen kann.

Die alte Liste von 2015 (https://docs.google.com/spreadsheets/d/1-k-VsUA9enmwtAayr-l5C72-jNPQXqVEFnLi8-IctxY/edit?pli=1#gid=0) war mit dem “Issue Tracker” (http://issues.joomla.org) verlinkt, auf dem man die Fehlerbeschreibungen lesen konnte.

 

2. Aufbau des Issue Tracker

Aufbau des Issue Tracker
zu Punkt 1: Für die Nutzung des Issue Trackers ist ein GitHub Konto erforderlich. Du kannst dir auf der Seite https://github.com/ ein GitHub Konto registrieren. Bei der Anmeldung musst du Joomla! autorisieren. Hinweis: Wenn du die Zwei-Faktor-Authentifizierung für dein GitHub-Konto aktiviert hast, musst du ein persönliches Token für den Zugriff unter https://github.com/settings/applications generieren und dieses in das Feld GitHub Token einfügen. Mehr Informationen findest Du in der Anleitung zum Patch Tester.

 Github-Authentifizierung

zu Punkt 2: Sprache wählen; Du kannst die deutsche Sprache auswählen, es werden dann aber nur die Menüpunkte in deutscher Sprache angezeigt. Warum? Weil es für Kommentare keinen Übersetzer gibt. Bitte unbedingt beachten: Nur in englischer Sprache kommentieren, weil an der Fehlerbehebung Menschen aller Nationen arbeiten und die meisten kein deutsch sprechen.

zu Punkt 3: Das Suchwerkzeug; Die Reihenfolge kann mit Hilfe des Filters bei den Suchwerkzeugen ändern. Über den Button „Suchwerkzeuge“ kann man im Patch Tester
• nach einer bestimmten ID
• nach dem Typ „issue“ (Eintrag) oder „pull request“ (Fehlerbehebung)
• nach leichten oder dringenden Tests suchen.

zu Punkt 4: Der Status ist wichtig und wird hier erklärt:

Neu („new“): Der Bug wurde gemeldet, es wurde noch nichts gemacht. Unmittelbar nachdem ein Problem gemeldet wurde erhält es diesen Status. Wenn du also einen Bug findest, erstelle eine Beschreibung wie er reproduziert werden kann. Dann wissen diejenigen, die das Problem testen wollen, wie sie den Patch testen können. Schon gewusst? In Deutschland gibt es die Möglichkeit mit GitHub oder über die Internetseite https://www.joomla-bugs.de/forum/index.php einen Bug zu melden.

Bestätigt („confirmed“): Der Bug wurde bestätigt, aber es gibt noch keinen Patch dazu. Das Tracker-Team war in der Lage das Problem nachzuvollziehen. Das Coding-Team wird nun nach einer Lösung suchen.

Wartend („pending“): Es gibt einen Patch um den Bug zu beheben. Eine Lösung für das Problem wurde gefunden. Ein Patch wurde erstellt und kann getestet werden. Das Problem muss nun getestet werden. Achte auf das Label neben dem Titel, da es verrät, für welche Joomla! Version der Patch erstellt wurde.

Einfach („easy“): Der Patch hat ausreichende Testbeschreibung um ihn ohne großes Vorwissen zu testen.

Fertig zum Anwenden („ready for commit“ = „RTC“): Hier gibt es nichts mehr für uns zu tun, auch wenn der Patch auf unserer Liste steht; Der Patch wurde erfolgreich getestet und der Code kann übergeben werden und wird demnächst veröffentlicht.  

Geschlossen - („closed“): Der Patch oder Bug Eintrag wurde geschlossen, beispielsweise, weil der Fehler nicht nachgestellt werden konnte oder nichts mit dem Joomla!-Core - sondern beispielsweise mit einer Fremderweiterung - zu tun hat. Der Status gilt für alle Probleme, die nicht weiter bearbeitet werden müssen. Die Filterung im Issue Tracker ist nützlich. Eine Überwachung kann sinnvoll sein um Meldungen zu erhalten, wenn ein Problem aktualisiert wurde. Im Grunde kannst du alles bearbeiten, was den Wartend “pending” hat.

5. Die Fehlerbeschreibung; Mit einem Klick auf die Überschrift wird der Fehler erklärt. Hat man sich für eine Fehlerbehebung entschieden, dann stellt man den Fehler auf der eigenen Installation nach.

3. Fehler nachstellen und Testbeschreibung (Issue Tracker) durchführen

Eine Liste mit allen Fehlern, die wir beim PBF bearbeiten wollen, wird am Morgen des 08.09.2018 verteilt. Die Fehler sind mit dem “Issue Tracker” (http://issues.joomla.org) verlinkt und man gelangt zur Fehlerbeschreibung. Wenn man sich im Patch Tester mit GitHub authentifiziert hat, kann man den Patchtester nutzen, denn auch im Patchtester gelangt man zur Fehlerbeschreibung. Dazu wechselt man ins Joomla Backend in die Komponente “Patch Tester” und sucht den Fehler. Normalerweise kann man rechts oben das Suchfeld nutzen, um z. B. nach der Pull-ID zu suchen.



Fehlerbeschreibung lesen

Zuerst liest man sich die Fehlerbeschreibung (Gelbe Schaltfläche Issue Tracker) durch und entscheidet, ob man diesen Patch testen kann/will. Nachdem man sich für einen Patch entschieden hat, schreibt man seinen Namen in die PBF-Liste.

Testbeschreibung durchführen, Bug nachstellen

Nun loggt man sich in sein Joomla Backend ein und stellt den Fehler in der eigenen Joomla-Installation nach. Das ist ein wichtiger Schritt, denn durch das nachstellen des Fehlers prüft man, ob es den Bug tatsächlich (noch) gibt.

 

4. Patch anwenden (Patch Tester)

Den Patch wendet man an, indem man auf die blaue Schaltfläche "Patch anwenden" bzw. “Apply Patch” klickt. Die Schaltfläche wird grün. Die Fehlerkorrektur oder neue Funktion wird automatisch in deine Joomla! - Installation eingespielt.

Wenn der Button “Apply Patch” überdeckt ist, musst du in der Liste nach der ID suchen.

Apply Patch

Der Patch wurde angewendet. Das bedeutet, die Programmzeilen, die den Fehler verbessern bzw. die neue Funktion enthalten,  sind in deine Joomla!-Installation übernommen worden. Nun prüfst du:

  • Ist das Problem behoben?
  • Hat der Patch Nebenwirkungen?
  • Code angucken! Wurde eine Datei betroffen? Bei kleineren Änderungen nicht schlimm, aber bei großen macht es Sinn. Auch wenn man den Code nicht direkt versteht.
  • Bitte alle betroffenen Teile testen!
  • Worauf kann sich der Patch noch auswirken?

 

5. Patch zurücknahmen (Revert Patch)

Danach nehmen wir den Patch wieder mit der grünen Schaltfläche “Revert Patch” zurück.

Apply Patch


Und erhalten, nachdem die Schaltfläche wieder blau gefärbt ist, folgende Meldung:
Patch reverted

6. Kommentieren (Issue Tracker)

Ob der Test erfolgreich oder nicht erfolgreich war muss man im “Issue Tracker” (http://issues.joomla.org) eintragen. Man gelangt entweder über die Seite (http://issues.joomla.org) zum “Issue Tracker” oder über den Patchtester durch anklicken der gelben Schaltfläche “Issue Tracker”.

Ob der Test erfolgreich oder nicht erfolgreich war muss man im Issue Tracker eintragen.
Feedback hinterlassen:

  • Ehrlich sein und dazu schreiben wenn z. B. der Code nicht überprüft werden kann, z. B. “I don´t understand the Code, but it works”
  • Bei Fragen im PBF-Chat oder in der JUG-Gruppe fragen
  • Bei Fragen an den Ersteller des Patches einen Kommentar im Tracker hinterlassen, ein Beispiel wie eine Diskussion aussehen kann, sieht man hier: https://issues.joomla.org/tracker/joomla-cms/21025
  • Wenn der Patch geklappt hat, klickt man auf die blaue Schaltfläche “Test this” oder “Testen” und wählt “Erfolgreich getestet” aus.

 Erfolgreich getestet

 

Hemmungen auf englisch Kommentare zu schreiben?

Hier findest Du Beispiele für Kommentartexte (englisch)

Egal ob du ein Neuling, Anfänger oder Profi, Grafiker oder Programmierer bist, ob du eine Agentur hast oder eine Vereinsseite betreust, ob weiblich oder männlich, ob jung oder alt. Wir freuen uns über jeden, der bereits mit Joomla! arbeitet oder Joomla! erst kennen lernen will. Einzig das Interesse an Joomla! zählt. Jede und jeder ist hier herzlich willkommen.

Wir möchten alle Joomla-begeisterten Nutzer, gleich mit welchem Vorkenntnissen, dazu einladen Joomla! noch besser zu machen. Wir sind dir für jede Unterstützung dankbar! Die Teilnahme ist kostenlos, alkoholfreie Getränke und eine Pizza inklusiv.

Hast du Anregungen, Ergänzungen, einen Fehler gefunden oder möchtest du gerne teilnehmen? Möchtest Du einen PBF organisieren und brauchst Unterstützung? Dann freuen wir uns auf deine Nachricht an Benjamin per E-Mail an pbf@benjamintrenkle.de.