loadero_python.resources.assert_precondition module

Loadero assert resource.

Assert resource is seperated into three parts

AssertPreconditionParams class describes assert preconditions attributes

AssertPreconditionAPI class that groups all API operations with assert preconditions attributes.

AssertPrecondition class combines AssertPreconditionParams and AssertPreconditionAPI.

Single AssertPrecondition object coresponds to a single assert precondition in Loadero.

class loadero_python.resources.assert_precondition.AssertPrecondition(test_id: int | None = None, assert_id: int | None = None, assert_precondition_id: int | None = None, params: AssertPreconditionParams | None = None)

Bases: LoaderoResource

AssertPrecondition class allows to perform CRUD operations on Loadero assert precondition resources.

APIClient must be previously initialized with a valid Loadero access token.

The target Loadero assert precondition resource is determined by AssertPreconditionParams.

create() → AssertPrecondition

Creates new assert precondition with given data.

Required attributes of params field that need to be populated, otherwise the method will raise an exception:

• test_id

• assert_id

• expected

• operator

• property

Raises:

ValueError: If resource params do not sufficiently identify parent resource or resource params required attributes are None.

APIException: If API call fails.

Returns:

AssertPrecondition: Created assert precondition resource.

delete() → AssertPrecondition

Deletes and existing assert precondition.

Required attributes of params field that need to be populated, otherwise the method will raise an exception:

• test_id

• assert_id

• assert_precondition_id

Raises:

ValueError: If resource params do not sufficiently identify resource.

APIException: If API call fails.

read() → AssertPrecondition

Reads information about an existing assert precondition.

Required attributes of params field that need to be populated, otherwise the method will raise an exception:

• test_id

• assert_id

• assert_precondition_id

Raises:

ValueError: If resource params do not sufficiently identify resource.

APIException: If API call fails.

Returns:

AssertPrecondition: Read assert precondition resource.

update() → AssertPrecondition

Updates assert precondition with given parameters.

Required attributes of params field that need to be populated, otherwise the method will raise an exception:

• test_id

• assert_id

• assert_precondition_id

• expected

• operator

• property

Raises:

ValueError: If resource params do not sufficiently identify resource or resource params required attributes are None.

APIException: If API call fails.

Returns:

AssertPrecondition: Updated assert precondition resource.

class loadero_python.resources.assert_precondition.AssertPreconditionAPI

Bases: object

AssertPreconditionAPI defines Loadero API operations for assert precondition resources.

static create(params: AssertPreconditionParams) → AssertPreconditionParams

Create a new assert precondition resource.

Args:

params (AssertPreconditionParams): Describes the assert precondition resource to be created.

Raises:

ValueError: If resource params do not sufficiently identify parent resource or resource params required attributes are None.

APIException: If API call fails.

Returns:

AssertPreconditionParams: Created assert precondition resource.

static delete(params: AssertPreconditionParams) → None

Delete an existing assert precondition resource.

Args:

params (AssertPreconditionParams): Describes the assert precondition resource to delete.

Raises:

ValueError: If resource params do not sufficiently identify resource.

APIException: If API call fails.

static read(params: AssertPreconditionParams) → AssertPreconditionParams

Read an existing assert precondition resource.

Args:

params (AssertPreconditionParams): Describes the assert precondition resource to be read.

Raises:

ValueError: If resource params do not sufficiently identify resource.

APIException: If API call fails.

Returns:

AssertPreconditionParams: Read assert precondition resource.

static read_all(test_id: int, assert_id: int, query_params: QueryParams | None = None) → PagedResponse

Read all assert precondition resources of assert.

Args:

test_id (int): Test resource id.

assert_id (int): Parent assert resource id.

query_params (QueryParams, optional): Describes query parameters.

Raises:

APIException: If API call fails.

Returns:

PagedResponse: Paged response of assert precondition resources.

static route(test_id: int, assert_id: int, assert_precondition_id: int | None = None) → str

Build assert precondition resource url route.

Args:

test_id (int): Test resource id.

assert_id (int): Assert resource id.

assert_precondition_id (int, optional): Assert precondition resource id. Defaults to None. If omitted the route will point to all assert preconditions of assert.

Returns:

str: Route to assert precondition resource/s.

static update(params: AssertPreconditionParams) → AssertPreconditionParams

Update an existing assert precondition resource.

Args:

params (AssertPreconditionParams): Describes the assert precondition resource to update.

Raises:

ValueError: If resource params do not sufficiently identify resource or resource params required attributes are None.

APIException: If API call fails.

Returns:

AssertPreconditionParams: Updated assert precondition resource.

class loadero_python.resources.assert_precondition.AssertPreconditionFilterKey(value)

Bases: FilterKey

AssertPreconditionFilterKey is an enum of all filter keys for assert precondition read all API operation.

EXPECTED = 'filter_expected'

OPERATOR = 'filter_operator'

PROPERTY = 'filter_property'

class loadero_python.resources.assert_precondition.AssertPreconditionParams(assert_precondition_id: int | None = None, assert_id: int | None = None, test_id: int | None = None, expected: str | None = None, operator: Operator | None = None, precondition_property: Property | None = None)

Bases: LoaderoResourceParams

AssertPreconditionParams describes single Loadero assert precondition resources attributes.

AssertPreconditionParams has a builder pattern for writeable attributes.

property created: datetime

Time when resource was created.

Returns:

datetime: Time when resource was created.

for_assert(assert_id: int) → AssertPreconditionParams

Set parent assert resource id.

Args:

assert_id (int): Assert resource id.

Returns:

AssertPreconditionParams: Resource params with set parent assert id.

in_test(test_id: int) → AssertPreconditionParams

Set parent test resource id.

Args:

test_id (int): Test resource id.

Returns:

AssertPreconditionParams: Resource params with set parent test

resource id.

property updated: datetime

Time when resource was last updated.

Returns:

datetime: Time when resource was last updated.

with_expected(expected: str) → AssertPreconditionParams

Set precondition expected value.

Args:

expected (str): Precondition expected value.

Returns:

AssertPreconditionParams: Resource params with set expected value.

with_id(assert_precondition_id: int) → AssertPreconditionParams

Set assert precondition id.

Args:

assert_precondition_id (int): Assert precondition id.

Returns:

AssertPreconditionParams: Resource params with set id.

with_operator(operator: Operator) → AssertPreconditionParams

Set precondition operator.

Args:

operator (Operator): Precondition operator.

Returns:

AssertPreconditionParams: Resource params with set operator.

with_property(precondition_property: Property) → AssertPreconditionParams

Set precondition property.

Args:

precondition_property (Property): Precondition property.

Returns:

AssertPreconditionParams: Resource params with set property.