PropertyDescriptorTester

PropertyDescriptorTester 在 webforJ 中简化了 第三方 Web 组件 集成到您的应用程序中的测试。它验证使用 PropertyDescriptor 定义的属性是否正确链接到它们的 getter 和 setter 方法，并确保默认行为的一致性。这个工具特别适合验证由第三方组件暴露的属性功能，而无需重复的测试逻辑。

实验性功能

此功能为实验性，未来版本可能会改变或删除。

概述

在处理第三方 Web 组件时，确保属性按预期行为是至关重要的。PropertyDescriptorTester 通过验证属性来自动化此过程：

正确映射到它们的 getter 和 setter 方法。
维护预期的默认值和自定义行为。
避免常见的集成问题，例如属性名称不匹配或不一致的默认值。

该工具支持对更复杂用例的注解，例如排除不相关的属性或定义自定义的 getter 和 setter 方法，因此它是集成测试的多功能选项。

`PropertyDescriptorTester` 的工作原理

测试过程涉及几个自动化步骤：

类扫描： PropertyDescriptorScanner 识别组件类中的所有 PropertyDescriptor 字段，自动排除带有 @PropertyExclude 注解的字段。
方法解析：基于命名约定 (get<PropertyName>/set<PropertyName>) 检测标准的 getter 和 setter 方法。对于非标准实现，@PropertyMethods 等注解指定自定义方法名称或目标类。
验证：使用 setter 方法分配默认值，通过 getter 方法检索并进行比较以确保正确性。任何不匹配都会触发 AssertionError，突出显示具体问题。
错误报告：测试器提供有关任何验证失败的详细反馈，例如缺失的方法、不一致的默认值或属性配置错误。

使用 `PropertyDescriptorTester` 编写测试

以下是一个演示 AppLayout 组件基本属性验证的示例：

示例：基本验证

MyComponent.java
public class MyComponent extends ElementCompositeContainer {
  private final PropertyDescriptor<Boolean> drawerOpened =
      PropertyDescriptor.property("drawerOpened", false);
  private final PropertyDescriptor<String> headerTitle =
      PropertyDescriptor.property("headerTitle", "Default Title");

  // setters 和 getters
}

测试案例

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("PropertyDescriptor 测试失败: " + e.getMessage());
    }
  }
}

此测试自动验证：

drawerOpened 具有有效的 getter 和 setter 方法。
headerTitle 默认值为 "Default Title"。

带注解的高级用例

对于更复杂的场景，PropertyDescriptorTester 支持注解以定制或排除属性的测试。

使用 `@PropertyExclude` 排除属性

排除依赖外部系统或与测试无关的属性。例如：

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

使用 `@PropertyMethods` 自定义方法

当默认命名约定不适用时，定义自定义的 getter、setter 或目标类：

@PropertyMethods(getter = "retrieveValue", setter = "updateValue", target = InnerClass.class)
private final PropertyDescriptor<String> customProperty =
  PropertyDescriptor.property("customProperty", "Default Value");

概述​

PropertyDescriptorTester 的工作原理​

使用 PropertyDescriptorTester 编写测试​

示例：基本验证​

测试案例​

带注解的高级用例​

使用 @PropertyExclude 排除属性​

使用 @PropertyMethods 自定义方法​

概述