从零开始写一个契约测试工具——数据库设计

Posted 2022-06-30 点点寒彬

接上文，第一步需要设计我们的表结构，我初步的构想是两张表来装下它，后续肯定会有一些变动，因为我也是一边写工具一边记录的。

设计说明

工具应该有两块内容，第一块是契约的信息，这部分记录的契约的结构体。第二快是子契约，所有具体的值必须由子契约来承载，子契约的内容一旦定义后是不可变更的。而契约工具对消费端和生产端的具体报文内容都由子契约来承载。

环境说明

我使用的是sqlalchemy这个ORM框架来处理数据库交互的。表结构的代码如下

from sqlalchemy import Column, String, Integer
from sqlalchemy.ext.declarative import declarative_base

BaseModel = declarative_base()


class ContractStructure(BaseModel):
    __tablename__ = 'contract_structure'
    id = Column(Integer, primary_key=True)
    contract_name = Column(String(500), nullable=False)
    contract_consumer_body = Column(String(10000), nullable=False)
    contract_consumer_keys = Column(String(500), nullable=False)
    contract_provider_body = Column(String(5000), nullable=False)
    contract_stakeholders = Column(String(500), nullable=False)
    contract_child_ids = Column(String(500), nullable=True)
    contract_version = Column(Integer, default=1)
    contract_last_version = Column(String(1), nullable=False, default='Y')
    provider_url = Column(String(100), nullable=True)


class ContractChild(BaseModel):
    __tablename__ = 'contract_child'
    id = Column(Integer, primary_key=True)
    child_id = Column(String(40), nullable=False)
    child_name = Column(String(100), nullable=False)
    contract_id = Column(Integer)
    child_consumer_body = Column(String(10000), nullable=False)
    child_provider_body = Column(String(5000), nullable=False)

下面我们一个一个来说明我这样设计的想法

ContractStructure

这个表是用来存放契约结构以及契约的一些相关信息。

• contract_name

契约名称，一般来说方便认识的名字比较好，比如Consumer-Provider这种。

• contract_consumer_body

契约消费者的结构体，也就是consumer端发起的报文。

• contract_consumer_keys

契约消费者的结构体的key，由于契约测试中结构体是不可变的，因此必须要校验consumer端传过来结构的key值，用来确保报文结构的一致性

• contract_provider_body

契约生产者的结构体，也就是返回给consumer端的报文结构

• contract_stakeholders

契约的干系人，一旦契约发生变动，程序需要通知的对象

• contract_child_ids

契约子内容的id

• contract_version

契约的版本信息，一旦契约发生变更，那么版本也要对应的变更

• contract_last_version

标记改版本的契约是否为最新的契约

• provider_url

生产中的url地址，工具要能够给provider端发送契约内容，因此需要一个字段来记录url

contract_child

这个表用来存放子契约的内容

• child_name

子契约对应的名字

• contract_id

所属契约的id

• child_consumer_body

消费端的报文内容

• child_provider_body

生产端的报文内容

最后

以上，我们定义了工具的表，下面应该做的就是开始写具体的契约类。