UCam Protobuf Testing Library

This project contains a support library to enable projects using python code autogenerated from protobuf files to be more easily tested.

Currently it contains an auto-factory function supporting creating factory-boy factories from betterproto generated python code.

Usage

Install the library via pip:

pip install ucam-protobuf-testing

Then create a factory from a dataclass or betterproto message:

@dataclass
class A:
    a_text: str
    integer: int
    value: float


class MyEnum(Enum):
    option1 = 1
    option2 = 2


@dataclass
class B:
    related: A
    an_enum: MyEnum
    list_of_str: list[str]


AFactory = auto_factory(A)
BFactory = auto_factory(B)

Local Development

Install poetry via:

pipx install poetry
pipx inject poetry poethepoet[poetry_plugin]

Install dependencies via:

poetry install

Build the library via:

poetry build

Run the tests via:

poetry poe tox

Dependencies

To add a new dependency for the library:

poetry add {dependency}

To add a new development-time dependency, used only during testing:

poetry add -G dev {dependency}

To remove a dependency which is no longer needed:

poetry remove {dependency}

CI configuration

The project is configured with Gitlab AutoDevOps via Gitlab CI using the .gitlab-ci.yml file.