Guide de Tests des Ports

Sommaire

• Introduction
• Comment
• Premier pas
• Tests
• Commentaires
• Plus de tests

Introduction

L'arborescence des ports est un dispositif conséquent qui permet aux utilisateurs d'OpenBSD d'utiliser des applications tierces sans perdre du temps à appliquer des correctifs, configurer ces applications et les installer séparement. Tout ce travail est effectué par un groupe de volontaires qui passent leur temps à porter et à tester des applications sur les différentes plates-formes supportées par OpenBSD. Beaucoup de gens pensent qu'ils ne peuvent pas contribuer à ce processus car ils n'ont pas les connaissances suffisantes; c'est faux car ils peuvent toujours aider les responsables de ports à travailler mieux et plus vite.

Comment

Tester les nouveautés ou les nouveaux ports soumis sur la liste de diffusion des ports. En faisant cela, vous réduisez la latence des changements effectués et vous augmentez également le nombre de ports qui vont être rajoutés (beaucoup de ports ne sont pas rajoutés car ils ne sont pas assez testés !).

Premier pas

L'arborescence des ports est developpée pour OpenBSD-current; il n'y a aucune garantie que les nouveaux ports ou mises à jour fonctionneront correctement sur les autres branches. Cela signifie également que vous devez mettre à jour votre système ainsi que l'arborescence des ports en -current (des instructions pour savoir comment faire peuvent être trouvées dans les pages anoncvs et Suivre la branche current). Il est également recommandé de vous abonner aux listes de diffusion ports et ports-changes. De cette façon vous serez averti des nouveaux ports ou des ports mis à jour ainsi que des changements effectués dans l'arborescence des ports.

Tests

Il y a deux types de soumission dans les listes de diffusion; les nouveaux ports et les mises à jour. Les nouveux ports sont généralement postés comme pièces jointes ou des URLs. Le plus facile est d'extraire les ports dans le répertoire /usr/ports/mystuff/ et de les tester là. Les mises à jour sont habituellement des changements effectués dans l'arborescence -current des ports, le mieux est donc de copier le port dans mystuff/ et d'appliquer les changements afin d'éviter tous problèmes dans l'arborescence des ports.

La conception pas-à-pas de ports est indispensable afin de vérifier que chaque étape, voir ports(7), est accomplie correctement :

• fetch
  • Nécessaire afin de vérifier que le(s) fichier(s) devant être installé(s) se télécharge(nt) correctement. Essayez de tester tous les MASTER_SITES spécifiés afin de s'assurer que ce sont des sources valides.
• checksum
  • Verifiez que le(s) fichier(s) devant être installé(s) correspond(ent) aux 'checksums' pré-enregistrées dans le fichier distinfo.
• extract
  • Chaque fichier devant être installé doit installer au préalable tout (tous) programme(s) dont il dépend (bzip2 par exemple).
• patch
  • Les correctifs doivent s'appliquer sans produire d'avertissements.
  • Plus aucun fichier .orig ne doit rester dans le répertoire patches/.
  • Une erreur habituelle est d'inclure les balises RCS dans un correctif; cela entrainera des problèmes lors de l'ajout du port dans l'arborescence et de l'expansion de la balise RCS.
• configure
  • Vérifiez que les scripts de configuration détectent correctement les spécificités de votre plate-forme.
  • GNU libtool est célèbre pour des 'options' non-désirées sur OpenBSD, dès lors veillez à ce que le port utilise une version récente qui crée des bibliothèques correctes sur votre architecture.
  • Le script de configuration ne doit pas détecter les applications installées au préalable sur votre système sans en avoir spécifier les dépendences dans le port.
• build
  • Vérifiez d'éventuelles erreurs de conceptions et d'avertissements suspects.
  • Les avertissements à propos de problèmes avec tmpnam(3) doivent pouvoir se résoudre en utilisant mkstemp(3).
  • Essayez de définir la variable SEPARATE_BUILD à 'concurrent' et testez si le port se compile toujours.
  • Assurez vous que les dépendences avec GNU make sont vraiment nécessaires.
  • Vérifiez si le port utilise libtool. Si c'est le cas, essayez USE_LIBTOOL=Yes. De cette manière, l'infrastructure des ports utilisera la version de libtool se trouvant dans l'arborescence, au lieu de versions de libtool incluses dans les sources du logiciel.
• regress
  • Vérifiez d'éventuelles erreurs (les tests vides signifient que tout est bon).
• fake
  • Cette option installe l'application dans un faux répertoire afin d'être certain que les fichiers peuvent être empaquetés sans affecter le système de base.
  • Le port ne doit jamais installer de fichiers en dehors du faux répertoire (comme dans /usr/local par exemple). Ce type d'erreurs est facilement détectable en utilisant USE_SYSTRACE=Yes.
  • GNU libtool a occasionnellement des problèmes quant il s'agit de lier des bibliothèques pendant la procédure de fausse installation sur certaines architectures.
  • Vérifiez que tous les fichiers s'installent avec les bons droits (propriétaires, permissions).
• package
  • La création d'un 'package' peut échouer si pkg/PLIST* et/ou pkg/PFRAG* sont incorrects.
• lib-depends-check
  • Ceci vérifiera que toutes les bibliothèques dont dépend le port sont accessibles soit via LIB_DEPENDS ou WANTLIB. Le résultat devrait être vide. Les variables précitées doivent être inspectées lorsque vous voyez des lignes qui commencent par "Extra" ou "Missing".
• install
  • Les paquetages doivent installer avec succès et avec les bonnes permissions tous les fichiers figurant dans leur liste de conditionnement. Soyez extrêmement prudent avec les fichiers ayant le bit suid défini.
  • Assurez vous que le script INSTALL du paquetage fonctionne correctement et n'écrase aucun fichier dans /etc.
• deinstall
  • Ceci devrait enlever tous les fichiers installés par le paquetage, excepté ceux présent dans /etc.
  • Soyez certain que le script DEINSTALL fonctionne comme prévu.

Les fichiers restant dans pkg/ comme DESCR et MESSAGE doivent être vérifiés au niveau de la grammaire et de l'orthographe. Les paragraphes doivent être formattés en utilisant fmt(1) et limités à 70 caractères.

Commentaires

Une fois les tests terminés vient la chose la plus importante : les commentaires. Même si le port fonctionne parfaitement, des commentaires doivent être effectués. Si nous avons dix personnes rapportant que le port fonctionne correctement sur plusieurs architectures différentes, son incorporation dans l'arborescence est effectuée plus rapidement. Si il ne fonctionne pas, certaines informations doivent être fournies. Certains outils existent et peuvent vous aider dans cette tâche, comme par exemple portslogger qui est une sorte de "tee intelligent" et redirige les données dans un fichier journal.

Exemple :

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

Ceci va rediriger les données dans un fichier journal se trouvant dans le répertoire courant.

Finalement, une fois que le port est jugé correct, les ports en dépendant devraient aussi être testés afin de vérifier leur bon fonctionnement. La cible make show-required-by permet d'identifier ces derniers.

Plus de tests

Vérifiez le Makefile du port au niveau de l'exactitude des dépendances, des fautes de typographie, des liens incorrects, des variables inutiles ou manquantes, des licences correctes et des catégories. Pour ceux qui possèdent plus de compétences peuvent aider à tester des correctifs, fournir des fichiers diff pour corriger des bogues, rajouter des saveurs ('flavors') au port ou encore d'autres améliorations.

Ces fichiers diff doivent être crées avec les options -uNr --exclude=CVS. cvs diff -uN peut également être employé pour générer des correctifs par rapport dépôt CVS.