PropertyDescriptorTester

Ouvrir dans ChatGPT

23.06 Expérimental

Java API

Le PropertyDescriptorTester dans webforJ simplifie le test des composants web tiers intégrés dans votre application. Il valide que les propriétés définies avec PropertyDescriptor sont correctement liées à leurs méthodes getter et setter et garantit que les comportements par défaut sont gérés de manière cohérente. Cet outil est particulièrement utile pour vérifier la fonctionnalité des propriétés exposées par des composants tiers sans nécessiter de logique de test répétitive.

Fonctionnalité expérimentale

Cette fonctionnalité est expérimentale et peut changer ou être supprimée dans une future version.

Aperçu

Lorsque vous travaillez avec des composants web tiers, il est essentiel de s'assurer que les propriétés se comportent comme prévu. Le PropertyDescriptorTester automatise ce processus en validant que les propriétés :

• Sont correctement mappées à leurs méthodes getter et setter.
• Conservent des valeurs par défaut et des comportements personnalisés attendus.
• Évitent des problèmes d'intégration courants, tels que des noms de propriétés non correspondants ou des valeurs par défaut incohérentes.

L'outil prend en charge des annotations pour des cas d'utilisation plus complexes, tels que l'exclusion de propriétés non pertinentes ou la définition de méthodes getter et setter personnalisées, ce qui en fait une option polyvalente pour les tests d'intégration.

Comment fonctionne PropertyDescriptorTester

Le processus de test implique plusieurs étapes automatisées :

1. Analyse de classe : Le PropertyDescriptorScanner identifie tous les champs PropertyDescriptor au sein d'une classe de composant, excluant automatiquement les champs annotés avec @PropertyExclude.

2. Résolution de méthode : Les méthodes getter et setter standards sont détectées en fonction des conventions de nommage (get<PropertyName>/set<PropertyName>). Pour les implémentations non standards, des annotations comme @PropertyMethods spécifient des noms de méthode ou des classes cibles personnalisées.

3. Validation : Les valeurs par défaut sont assignées en utilisant la méthode setter, récupérées en utilisant le getter, et comparées pour garantir leur exactitude. Toute incohérence déclenche une AssertionError, mettant en évidence le problème spécifique.

4. Rapport d'erreurs : Le testeur fournit un retour détaillé sur toute échec de validation, tel que des méthodes manquantes, des valeurs par défaut incohérentes ou des configurations de propriétés incorrectes.

Écriture de tests avec PropertyDescriptorTester

Voici un exemple démontrant la validation de base des propriétés pour un composant AppLayout :

Exemple : Validation de base

MyComponent.java

public class MyComponent extends ElementCompositeContainer {
  private final PropertyDescriptor<Boolean> drawerOpened =
      PropertyDescriptor.property("drawerOpened", false);
  private final PropertyDescriptor<String> headerTitle =
      PropertyDescriptor.property("headerTitle", "Titre par défaut");

  // setters et getters
}

Cas de test

MyComponentTest.java

import com.webforj.component.element.PropertyDescriptorTester;
import org.junit.jupiter.api.Test;

class MyComponentTest {

  MyComponent component = new MyComponent();

  @Test
  void validateProperties() {
    try {
      PropertyDescriptorTester.run(MyComponent.class, component);
    } catch (Exception e) {
      fail("Le test PropertyDescriptor a échoué : " + e.getMessage());
    }
  }
}

Ce test vérifie automatiquement :

• Que drawerOpened a des méthodes getter et setter valides.
• Que headerTitle par défaut à "Titre par défaut".

Cas d'utilisation avancés avec annotations

Pour des scénarios plus complexes, PropertyDescriptorTester prend en charge les annotations pour personnaliser ou exclure des propriétés des tests.

Exclure des propriétés avec @PropertyExclude

Exclure des propriétés qui dépendent de systèmes externes ou qui ne sont pas pertinentes pour le test. Par exemple :

@PropertyExclude
private final PropertyDescriptor<String> excludedProperty =
  PropertyDescriptor.property("excludedProperty", "Exclu");

Personnaliser les méthodes avec @PropertyMethods

Définir un getter, un setter ou une classe cible personnalisée lorsque les conventions de nommage par défaut ne s'appliquent pas :

@PropertyMethods(getter = "retrieveValue", setter = "updateValue", target = InnerClass.class)
private final PropertyDescriptor<String> customProperty =
  PropertyDescriptor.property("customProperty", "Valeur par défaut");