首页
/ Schemathesis项目中GraphQL自定义JSON标量类型的实现方法

Schemathesis项目中GraphQL自定义JSON标量类型的实现方法

2025-07-01 05:22:12作者:何将鹤

在GraphQL API测试中,处理自定义标量类型是一个常见需求。本文将以Schemathesis项目为例,详细介绍如何为GraphQL API实现JSON标量类型的测试数据生成。

问题背景

当使用Schemathesis测试GraphQL API时,如果API使用了自定义的JSON标量类型,直接使用Python字典作为测试数据会导致AST节点转换错误。这是因为GraphQL需要特定的AST节点结构来表示数据,而普通的Python字典不符合这一要求。

解决方案核心

关键在于将Python原生数据结构转换为GraphQL AST节点。这需要理解GraphQL的类型系统和AST节点结构。

AST节点转换函数

以下是实现这一转换的核心函数:

def dict_to_object_fields(data: dict) -> list:
    """将字典转换为ObjectFieldNode实例列表"""
    fields = []
    for key, value in data.items():
        name_node = graphql.NameNode(value=key)
        value_node = python_value_to_ast_node(value)
        field_node = graphql.ObjectFieldNode(name=name_node, value=value_node)
        fields.append(field_node)
    return fields

def python_value_to_ast_node(value):
    """将Python值转换为对应的GraphQL AST ValueNode"""
    if value is None:
        return graphql.NullValueNode()
    elif isinstance(value, bool):
        return graphql.BooleanValueNode(value=value)
    elif isinstance(value, int):
        return graphql.IntValueNode(value=str(value))
    elif isinstance(value, float):
        return graphql.FloatValueNode(value=str(value))
    elif isinstance(value, str):
        return graphql.StringValueNode(value=value)
    elif isinstance(value, list):
        ast_values = [python_value_to_ast_node(item) for item in value]
        return graphql.ListValueNode(values=tuple(ast_values))
    elif isinstance(value, dict):
        fields = dict_to_object_fields(value)
        return graphql.ObjectValueNode(fields=tuple(fields))
    raise ValueError("不支持的值类型")

注册JSON标量类型

使用Schemathesis的scalar方法注册JSON标量类型:

schemathesis.graphql.scalar(
    "JSON",
    st.dictionaries(
        keys=st.text(min_size=1, max_size=10, alphabet=alphabet),
        values=st.recursive(
            st.text(alphabet=alphabet)
            | st.integers()
            | st.floats(allow_nan=False, allow_infinity=False)
            | st.booleans()
            | st.none(),
            lambda strategy: st.lists(strategy, max_size=3)
            | st.dictionaries(
                  keys=st.text(min_size=1, max_size=10, alphabet=alphabet), 
                  values=strategy, 
                  max_size=3
              ),
        ),
        min_size=1,
        max_size=5,
    ).map(lambda d: nodes.Object(dict_to_object_fields(d))),
)

实现原理详解

  1. AST节点转换:GraphQL需要特定的AST节点来表示查询和数据。对于JSON这种复杂类型,需要递归地将Python数据结构转换为对应的AST节点。

  2. 类型映射

    • 字典转换为ObjectValueNode
    • 列表转换为ListValueNode
    • 基本类型(int, float, bool, str)转换为对应的ValueNode
    • None值转换为NullValueNode
  3. 数据生成策略:使用Hypothesis的st.dictionaries生成字典数据,并通过递归策略支持嵌套结构。

实际应用建议

  1. 对于简单的JSON结构,可以直接使用nodes.Object包装转换后的AST节点。

  2. 对于复杂结构,建议:

    • 先定义数据结构模式
    • 针对特定字段使用更精确的生成策略
    • 添加数据验证确保生成的JSON符合API预期
  3. 性能考虑:

    • 限制生成数据的深度和大小
    • 避免生成过于复杂的嵌套结构
    • 使用min_size/max_size控制数据规模

总结

通过实现AST节点转换函数,我们可以在Schemathesis中有效地测试GraphQL的JSON标量类型。这种方法不仅适用于JSON,也可以扩展到其他自定义标量类型。关键在于理解GraphQL的类型系统和AST表示,以及如何将Python原生数据结构转换为这些AST节点。

对于测试工程师来说,掌握这种转换技术可以大大提高测试GraphQL API的灵活性和覆盖率,特别是在处理复杂数据类型时。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8