tcms.rpc.api.environment module

tcms.rpc.api.environment.add_property(environment_id, name, value)[source]
Environment.add_property(environment_id, name, value)

Add property to environment! Duplicates are skipped without errors.

Parameters:
Returns:

Serialized tcms.testruns.models.EnvironmentProperty object.

Return type:

dict

Raises:

PermissionDenied – if missing testruns.add_environmentproperty permission

tcms.rpc.api.environment.create(values)[source]
RPC Environment.create(values)

Create a new environment object and store it in the database.

Parameters:

values (dict) – Field values for tcms.testruns.models.Environment

Returns:

Serialized tcms.testruns.models.Environment object

Return type:

dict

Raises:

  • ValueError – if input values don’t validate

  • PermissionDenied – if missing testruns.add_environment permission

tcms.rpc.api.environment.filter(query=None)[source]
Environment.filter(query)

Return environment for the specified query.

Parameters:

query (dict) – Field lookups for tcms.testruns.models.Environment

Returns:

Serialized list of tcms.testruns.models.Environment objects.

Return type:

list(dict)

Raises:

PermissionDenied – if missing testruns.view_environment permission

tcms.rpc.api.environment.properties(query=None)[source]
Environment.properties(query)

Return all properties for the specified environment(s).

Parameters:

query (dict) – Field lookups for tcms.testruns.models.EnvironmentProperty

Returns:

Serialized list of tcms.testruns.models.EnvironmentProperty objects.

Return type:

list(dict)

Raises:

PermissionDenied – if missing testruns.view_environmentproperty permission

tcms.rpc.api.environment.remove_property(query)[source]
Environment.remove_property(query)

Remove selected properties.

Parameters:

query (dict) – Field lookups for tcms.testruns.models.EnvironmentProperty

Raises:

PermissionDenied – if missing testruns.delete_environmentproperty permission