Aller au contenu principal

PropertyDescriptorTester

Ouvrir dans ChatGPT
23.06 Experimental
Java API

Le PropertyDescriptorTester dans webforJ simplifie les tests pour les 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

L'adaptateur PropertyDescriptorTester de webforJ est actuellement une fonctionnalité expérimentale. Des changements importants peuvent être introduits à tout moment.

Aperçu​

Lorsqu'il s'agit de 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.
  • Maintiennent les valeurs par défaut et les comportements personnalisés attendus.
  • Évitent les problèmes d'intégration courants, tels que les noms de propriétés incompatibles 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, en faisant 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 dans une classe de composant, excluant automatiquement les champs annotés avec @PropertyExclude.

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

  3. Validation : Les valeurs par défaut sont assignées à l'aide de la méthode setter, récupérées à l'aide du getter, et comparées pour garantir leur exactitude. Tout désaccord déclenche une AssertionError, mettant en évidence le problème spécifique.

  4. Rapport d'erreur : Le testeur fournit des retours d'information détaillés sur toutes les pannes de validation, telles que des méthodes manquantes, des valeurs par défaut incohérentes ou des configurations de propriétés incorrectes.

Rédaction 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");

  // méthodes 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 est par défaut à "Titre par défaut".

Cas d'utilisation avancés avec annotations​

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

Exclure des propriétés avec @PropertyExclude​

Excluez des propriétés qui dépendent de systèmes externes ou 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éfinissez des méthodes getter, 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");