Port Test Gids

Inhoudsopgave

• Inleiding
• Hoe
• Eerste stap
• Testen
• Opmerkingen maken
• Meer testen

Introductie

De ports tree is een enorm stuk werk dat OpenBSD gebruikers in staat stelt om programma's van derden gemakkelijk te installeren zonder deze eerst afzonderlijk te patchen, te configureren en te installeren. Dit werk wordt gedaan door een groep vrijwilligers die hun tijd spenderen aan het porten en testen van applicaties op de verschillende OpenBSD platformen. Veel mensen denken dat ze hier niet bij kunnen helpen vanwege het feit dat ze niet genoeg kennis hebben; dit klopt niet, ze kunnen de porters wel degelijk helpen, zodat ze beter en sneller kunnen werken.

Hoe

Het testen van updates of nieuwe ports die bekend worden gemaakt op de ports mailinglijst. Door dit te doen kunt u de wachttijd van commits verkleinen en zo ook het aantal ports dat wordt gecommit vergroten (veel ports worden niet gecommit vanwege het gebrek aan testen!).

Eerste stap

De ports tree wordt ontwikkeld met behulp van OpenBSD-current; er kan niet worden gegarandeerd dat nieuwe ports of updates op andere branches werken. Dit betekent dat u uw systeem en de ports tree moet upgraden naar -current (instructies hoe u dit moet doen staan op de anoncvs en "-current volgen") pagina's. Het is tevens aan te raden dat u zich inschrijft op de ports en ports-changes mailinglijsten. Op deze manier zal u altijd op de hoogte blijven van nieuwe of bijgewerkte ports en van veranderingen in de ports tree.

Testen

Er zijn twee soorten bijdragen op de mailinglijsten; nieuwe ports en updates. De nieuwe ports worden meestal geplaatst als een toegevoegde tarball of URL. Het is een goed idee om deze uit te pakken in de /usr/ports/mystuff directory en van hier uit te testen. Updates worden meestal geleverd als een diff tegen de -current ports tree, het is dus het beste om de port te kopiëren naar mystuff/ en hier de diff toe te passen om een kapotte tree te voorkomen.

Het stap-voor-stap bouwen is vereist om na te kunnen gaan dat ieder doel, zie ports(7), succesvol wordt volbracht:

• fetch
  • Nodig om na te gaan dat de distfile(s) juist zijn gedownload. Probeer alle gespecificeerde MASTER_SITES af te gaan om te controleren dat het goede bronnen zijn.
• checksum
  • Nagaan of de distfiles die zijn gedownload overeenkomen met de checksums in het distinfo bestand.
• extract
  • Elke distfile moet eerst zijn afhankelijkheden (zoals bzip2) installeren.
• patch
  • Patches zouden aangebracht moeten worden zonder enige waarschuwingen.
  • Er horen geen overgebleven .orig bestanden te zijn in de patches/ map.
  • Een andere veel voorkomende fout is in meenemen van de RCS tags in de patch; dit zal voor een foute port zorgen als deze wordt in gechecked en de RCS tag wordt uitgebreid.
• configure
  • Let op of de configure scripts de juiste informatie van uw platform herkennen.
  • GNU libtool is berucht voor z'n ongewenste 'mogelijkheden' op OpenBSD, dus zorg dat de port een recente versie gebruikt die de juiste bibliotheken zal aanmaken op uw architectuur.
  • Het configure script hoort geen 'verdwaalde' applicaties te vinden die al op uw systeem zijn geïnstalleerd zonder expliciete afhankelijkheden in de port.
• build
  • Let op compilatiefouten en verdachte waarschuwingen.
  • Waarschuwingen over problemen met tmpnam(3) horen opgelost te worden door het gebruik van mkstemp(3).
  • Verander de SEPARATE_BUILD variabele naar 'concurrent' en test of het compileren nog steeds werkt.
  • Kijk of de afhankelijkheid van GNU make daadwerkelijk nodig is.
  • Ga na of de port libtool gebruikt. Zo ja, probeer dan USE_LIBTOOL=Yes in te stellen. Op die manier zal de ports infrastructuur de libtool versie uit de ports tree gebruiken, in plaats van libtool versies die bij de broncode van de software gebundeld zitten.
• regress
  • Kijken of er fouten zijn opgetreden (lege tests betekenen OK).
• fake
  • Dit doel installeert de applicatie in een nepdirectory, dit om er zeker van te zijn dat tijdens het maken van de package het basissysteem onaangetast blijft.
  • De port mag nooit bestanden installeren buiten de nep directory (dus bijvoorbeeld naar /usr/local. Dit soort fout kan gemakkelijk opgemerkt worden door gebruik van USE_SYSTRACE=Yes.
  • GNU libtool heeft soms problemen met het herlinken van de bibliotheken tijdens het nepproces, op sommige architecturen.
  • Ga na of alle bestanden met de juiste eigendomsrechten en permissies geïnstalleerd worden.
• package
  • Het maken van de package kan fout gaan als pkg/PLIST* en/of pkg/PFRAG foutief zijn.
• lib-depends-check
  • Dit zal controleren of alle libraries waarvan de port afhangt, bereikt kunnen worden via ofwel LIB_DEPENDS ofwel WANTLIB. Het resultaat zou leeg moeten zijn. De bovenstaande variabelen moeten geïnspecteerd worden wanneer u lijnen ziet die beginnen met "Extra" of "Missing".
• install
  • De packages horen alle bestanden van hun package-lijsten succesvol te installeren en met de juiste permissies. Wees extra voorzichtig met bestanden waarbij setuid bits gezet zijn.
  • Zorg dat het INSTALL script correct werkt, en dat het geen bestanden in /etc overschrijft.
• deinstall
  • Dit hoort alle bestanden te verwijderen die geïnstalleerd zijn, behalve de bestanden in /etc.
  • Zorg dat het DEINSTALL script werkt zoals verwacht.

Overgebleven bestanden in pkg/ zoals DESCR en MESSAGE moeten worden gecontroleerd op grammatica en spelfouten. De paragrafen moeten geformatteerd zijn met behulp van fmt(1) en de regels mogen niet langer zijn dan 70 tekens.

Opmerkingen maken

Aan het eind van het testen komt een iets heel belangrijks: opmerkingen. Ook als de port goed werkt moeten er opmerkingen gemaakt worden. Als we tien berichten hebben waarin mensen zeggen dat de port het goed doet op verschillende architecturen, dan zal het eerder gecommit worden. Als het niet werkt, dan moet er aanvullende informatie worden gegeven. Er zijn tools beschikbaar voor deze taak, zoals portslogger, dit is een soort van een "intelligente tee" die de output naar een logbestand schrijft.

Voorbeeld:

    # make install 2>&1 | /usr/ports/infrastructure/build/portslogger .

Dit zal er voor zorgen dat de output naar een logbestand wordt geschreven in de huidige directory.

Tenslotte, zodra de port ok bevonden wordt, moeten ook afhankelijke ports getest worden, om na te gaan of ze nog steeds juist werken. De show-required-by make target zal u helpen om andere ports te vinden die afhangen van de huidige.

Meer testen

Controleer de Makefile van de port op juiste dependencies, spelfouten, onjuiste links, nutteloze of ontbrekende variabelen, en verbeter de licentie en categorieën. Mensen met meer ervaring kunnen helpen door patches uit te pluizen, patches in te zenden om bugs op te lossen, 'flavors' toe te voegen of andere verbeteringen.

Deze diffs kunnen gemaakt worden met de -uNr --exclude=CVS opties. Met cvs diff -uN kunnen patches worden gemaakt met behulp van de CVS repository.