Kmom05: CI

By . Latest revision .

Tanken är att ge en bild av hur automatiserad testning och continuous integration (CI) kan fungera med en PHP modul som ligger publicerad på GitHub och Packagist.

Vi fortsätter jobba med modulen vi publicerade på GitHub och Packagist i föregående kursmoment. Vi låter externa verktyg checka ut vår kod från GitHub och köra testsuiten via make install test. De externa verktygen kan samtidigt analysera koden ur olika kvalitetsaspekter.

Vi bekantar oss med ett antal olika externa verktyg och försöker förstå vad de kan tillföra till en utvecklares vardag.

Travis har koll på hur modulerna i Anax klarar sina automatiserade tester.

Travis har koll på hur modulerna i Anax klarar sina automatiserade tester.

CircleCI är en byggmiljö likt Travis.

CircleCI är en byggmiljö likt Travis.

Via Scrutinizer kan du få mer detaljerad information om din kod via statiskt kodanalys.

Via Scrutinizer kan du få mer detaljerad information om din kod via statiskt kodanalys.

(Detta är instruktionen för kursmomentet och omfattar det som skall göras inom ramen för kursmomentet. Momentet omfattar cirka 20 studietimmar inklusive läsning, arbete med övningar och uppgifter, felsökning, problemlösning, redovisning och eftertanke. Läs igenom hela kursmomentet innan du börjar jobba. Om möjligt – planera och prioritera var du vill lägga tiden.)

#Läs & Studera

(ca: 2-4 studietimmar)

#Artiklar

Kika igenom följande artiklar.

  1. Artikeln PHP The Right Way innehåller ett kort stycke om “Testing”, läs igenom det som en introduktion.

  2. Bekanta dig med begreppet Automatiserad testning via Wikipedia. Läs översiktligt och få ett grepp om de olika termer som används.

  3. Bekanta dig med begreppet Continuous integration (CI) via Wikipedia. Läs igenom så du får en känsla över vilka delar som begreppet handlar om.

  4. Dokumentet “Awesome PHP” innehåller en sektion för Continuous integration och en sektion för Code analysis, Code Quality samt Static Analysis. Kika snabbt på dem och fortsätt studera om något av verktygen faller dig i smaken. Det finns fler verktyg där ute, fler än de vi valt att använda i detta kmom.

#Ramverk referenser

Undersök hur (minst) ett av ramverken jobbar med continous integration och huruvuda de visar upp sin kodkvalitet med diverse badges. Kan du se vilken nivå av kodtäckning och kodkvalitet som är vanlig i ramverken och dess moduler?

#Referensmaterial

Följande används som referensmaterial i kursmomentet.

  1. Du kan se hur REM-servern är uppbyggd som modul och hur den kopplas till diverse bygg- och kodkvalitetstjänster.

#Övningar & Uppgifter

(ca: 8-16 studietimmar)

#Övningar

Gör följande övningar, de hjälper dig att förbereda inför uppgiften.

  1. Jobba igenom artikeln “Integrera din packagist modul med verktyg för automatisk test och validering” som visar dig hur du använder använder make test för att bygga grunden till automatiserade tester och ett CI-flöde med externa verktyg. Du kan jobba mot din egna modul för kommentarshanteringen och spara koden i me/comment.

#Uppgifter

Dessa uppgifter skall utföras och redovisas.

  1. Utför uppgiften “Integrera din modul med externa byggtjänster”. Jobba mot din modul och uppdatera din me/redovisa när du är klar.

  2. Pusha och tagga din redovisa, allt eftersom och sätt en avslutande tagg (5.0.*) när du är klar med kursmomentet.

#Resultat & Redovisning

(ca: 2-4 studietimmar)

Läs instruktionen om hur du skall redovisa.

Lägg extra tid på skrivandet i momentet då redovisningstexten är aningen mer omfattande än normalt.

  • Berätta om arbetet med din CI-kedja, vilka verktyg valde du och hur gick det att integrera med dem?
  • Vilken extern tjänst uppskattade du mest, eller har du förslag på ytterligare externa tjänster att använda?
  • Vilken kodkvalitet säger verktygen i din CI-kedja att du har, håller du med?
  • Gjorde du några förbättringar på din modul i detta kmom, isåfall vad?
  • Vilket ramverk undersökte du och hur hanterar det ramverket sin CI-kedja, vilka verktyg används?
  • Fann du någon nivå på kodtäckning och kodkvalitet för ramverket och dess moduler?
  • Vilken är din TIL för detta kmom?

PS. Lägg in länken till modulen i din redovisningstext.

Har du frågor eller funderingar som du vill ha besvarade så ställer du dem i GitHub issues.

#Revision history

  • 2018-11-26: (B, mos) Uppdaterat inför ht18 design v2.
  • 2017-10-02: (A, mos) Första utgåvan.

Document source.