tcms.testcases.models module¶

class tcms.testcases.models.BugSystem(*args, **kwargs)[source]¶

Bases: Model, UrlMixin

This model describes a bug tracking system used in Kiwi TCMS. Fields below can be configured via the admin interface and their meaning is:

name: a visual name for this bug tracker, e.g. Kiwi TCMS GitHub;
tracker_type: a select menu to specify what kind of external system we interface with, e.g. Bugzilla, JIRA, others; The available options for this field are automatically populated by Kiwi TCMS;

Warning

Once this field is set it can’t be reset to NULL. Although Kiwi TCMS takes care to handle misconfigurations we advise you to configure your API credentials properly!
base_url: base URL of this bug tracker.

Warning

If this field is left empty funtionality that depends on it will be disabled!
api_url, api_username, api_password: configuration for an internal RPC object that communicate to the issue tracking system when necessary. Depending on the actual type of IT we’re interfacing with some of these values may not be necessary. Refer to tcms.issuetracker.types for more information!

Warning

This is saved as plain-text in the database because it needs to be passed to the internal RPC object!

exception DoesNotExist¶: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: MultipleObjectsReturned

api_password¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

api_url¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

api_username¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

base_url¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

tracker_type¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class tcms.testcases.models.Category(id, name, product, description)[source]¶

Bases: Model, UrlMixin

exception DoesNotExist¶: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: MultipleObjectsReturned

category_case¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

description¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

product¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

product_id¶

class tcms.testcases.models.Property(id, name, value, case)[source]¶

Bases: Property

exception DoesNotExist¶: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: MultipleObjectsReturned

case¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

case_id¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

value¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class tcms.testcases.models.Template(id, name, text)[source]¶

Bases: Model

exception DoesNotExist¶: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: MultipleObjectsReturned

history = <django.db.models.manager.HistoryManagerFromHistoricalQuerySet object>¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

save_without_historical_record(*args, **kwargs)¶

Save model without saving a historical record

Make sure you know what you’re doing before you use this method.

text¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class tcms.testcases.models.TestCase(id, create_date, is_automated, script, arguments, extra_link, summary, requirement, notes, text, setup_duration, testing_duration, case_status, category, priority, author, default_tester, reviewer)[source]¶

Bases: Model, UrlMixin

exception DoesNotExist¶: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: MultipleObjectsReturned

add_component(component)[source]¶

add_tag(tag)[source]¶

arguments¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

author¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

author_id¶

case_status¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

case_status_id¶

category¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

category_id¶

clone(new_author, test_plans)[source]¶

component¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

create_date¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

default_tester¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

default_tester_id¶

email_settings¶

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

property emailing¶

executions¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property expected_duration¶

extra_link¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_absolute_url()[source]¶

get_next_by_create_date(*, field=<django.db.models.fields.DateTimeField: create_date>, is_next=True, **kwargs)¶

get_previous_by_create_date(*, field=<django.db.models.fields.DateTimeField: create_date>, is_next=False, **kwargs)¶

get_text_with_version(case_text_version=None)[source]¶

history = <django.db.models.manager.HistoryManagerFromHistoricalQuerySet object>¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_automated¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

notes¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

plan¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

priority¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

priority_id¶

property_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

remove_component(component)[source]¶

remove_tag(tag)[source]¶

requirement¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

reviewer¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

reviewer_id¶

save_without_historical_record(*args, **kwargs)¶

Save model without saving a historical record

Make sure you know what you’re doing before you use this method.

script¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

setup_duration¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

summary¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

tag¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

testcasecomponent_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

testcaseplan_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

testcasetag_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

testing_duration¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

text¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class tcms.testcases.models.TestCaseComponent(id, case, component)[source]¶

Bases: Model

exception DoesNotExist¶: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: MultipleObjectsReturned

case¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

case_id¶

component¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

component_id¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

class tcms.testcases.models.TestCaseEmailSettings(id, case, notify_on_case_update, notify_on_case_delete, auto_to_case_author, auto_to_case_tester, auto_to_run_manager, auto_to_run_tester, auto_to_execution_assignee, cc_list)[source]¶

Bases: Model

exception DoesNotExist¶: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: MultipleObjectsReturned

add_cc(email_addrs)[source]¶

Add email addresses to CC list

Arguments: - email_addrs: str or list, holding one or more email addresses

auto_to_case_author¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

auto_to_case_tester¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

auto_to_execution_assignee¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

auto_to_run_manager¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

auto_to_run_tester¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

case¶

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

case_id¶

cc_list¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_cc_list()[source]¶: Return the whole CC list

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

notify_on_case_delete¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

notify_on_case_update¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

remove_cc(email_addrs)[source]¶

Remove one or more email addresses from EmailSettings’ CC list

If any email_addr is unknown, remove_cc will keep quiet.

Arguments: - email_addrs: str or list, holding one or more email addresses

class tcms.testcases.models.TestCasePlan(id, plan, case, sortkey)[source]¶

Bases: Model

exception DoesNotExist¶: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: MultipleObjectsReturned

case¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

case_id¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

plan¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

plan_id¶

sortkey¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class tcms.testcases.models.TestCaseStatus(id, name, description, is_confirmed)[source]¶

Bases: Model, UrlMixin

exception DoesNotExist¶: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: MultipleObjectsReturned

description¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_confirmed¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name¶

objects = <django.db.models.manager.Manager object>¶

testcase_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

untranslated(fieldname)¶

class tcms.testcases.models.TestCaseTag(id, tag, case)[source]¶

Bases: Model

exception DoesNotExist¶: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: MultipleObjectsReturned

case¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

case_id¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

tag¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

tag_id¶

tcms.testcases.models module¶

Table of Contents

This Page