Source code for tcms.testplans.models

# -*- coding: utf-8 -*-

from django.conf import settings
from django.core.exceptions import ObjectDoesNotExist
from django.db import models
from django.urls import reverse
from tree_queries.models import TreeNode
from uuslug import slugify

from tcms.core.history import KiwiHistoricalRecords
from tcms.core.models.base import UrlMixin
from tcms.core.templatetags.extra_filters import bleach_input
from import Version
from tcms.testcases.models import TestCasePlan

[docs] class PlanType(models.Model, UrlMixin): name = models.CharField(max_length=64, unique=True) description = models.TextField(blank=True, null=True) def __str__(self): return class Meta: ordering = ["name"]
[docs] class TestPlan(TreeNode, UrlMixin): """A plan within the TCMS""" history = KiwiHistoricalRecords() name = models.CharField(max_length=255, db_index=True) text = models.TextField(blank=True) create_date = models.DateTimeField(auto_now_add=True) is_active = models.BooleanField(default=True, db_index=True) extra_link = models.CharField(max_length=1024, default=None, blank=True, null=True) product_version = models.ForeignKey( Version, related_name="plans", on_delete=models.CASCADE ) author = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE) product = models.ForeignKey( "management.Product", related_name="plan", on_delete=models.CASCADE ) type = models.ForeignKey(PlanType, on_delete=models.CASCADE) tag = models.ManyToManyField( "management.Tag", through="testplans.TestPlanTag", related_name="plan" ) def __str__(self): return
[docs] def add_case(self, case, sortkey=None): if sortkey is None: lastcase = self.testcaseplan_set.order_by("-sortkey").first() if lastcase and lastcase.sortkey is not None: sortkey = lastcase.sortkey + 10 else: sortkey = 0 return TestCasePlan.objects.get_or_create( plan=self, case=case, defaults={"sortkey": sortkey} )[0]
[docs] def add_tag(self, tag): return TestPlanTag.objects.get_or_create(plan=self, tag=tag)
[docs] def remove_tag(self, tag): TestPlanTag.objects.filter(plan=self, tag=tag).delete()
[docs] def delete_case(self, case): TestCasePlan.objects.filter(,
def _get_absolute_url(self): return reverse("test_plan_url", args=[, slugify(])
[docs] def get_absolute_url(self): return self._get_absolute_url()
[docs] def get_full_url(self): return super().get_full_url().rstrip("/")
def _get_email_conf(self): try: # note: this is the reverse_name of a 1-to-1 field return self.email_settings # pylint: disable=no-member except ObjectDoesNotExist: return TestPlanEmailSettings.objects.create(plan=self) emailing = property(_get_email_conf)
[docs] def make_cloned_name(self): """Make default name of cloned plan""" return f"Copy of {}"
[docs] def clone( # pylint: disable=too-many-arguments self, name=None, product=None, version=None, new_author=None, set_parent=False, copy_testcases=False, **_kwargs, ): """Clone this plan :param name: New name of cloned plan. If not passed, make_cloned_name is called to generate a default one. :type name: str :param product: Product of cloned plan. If not passed, original plan's product is used. :type product: :class:`` :param version: Product version of cloned plan. If not passed use from source plan. :type version: :class:`` :param new_author: New author of cloned plan. If not passed, original plan's author is used. :type new_author: settings.AUTH_USER_MODEL :param set_parent: Whether to set original plan as parent of cloned plan. Default is False. :type set_parent: bool :param copy_testcases: Whether to copy cases to cloned plan instead of just linking them. Default is False. :type copy_testcases: bool :param \\**_kwargs: Unused catch-all variable container for any extra input which may be present :return: cloned plan :rtype: :class:`tcms.testplans.models.TestPlan` """ tp_dest = TestPlan.objects.create( name=name or self.make_cloned_name(), product=product or self.product, author=new_author or, type=self.type, product_version=version or self.product_version, create_date=self.create_date, is_active=self.is_active, extra_link=self.extra_link, parent=self if set_parent else None, text=self.text, ) # Copy the plan tags for tp_tag_src in self.tag.all(): tp_dest.add_tag(tag=tp_tag_src) # include TCs inside cloned TP qs = self.cases.all().annotate(sortkey=models.F("testcaseplan__sortkey")) for tc_src in qs: # this parameter should really be named clone_testcases b/c if set # it clones the source TC and then adds it to the new TP if copy_testcases: tc_src.clone(new_author, [tp_dest]) else: # otherwise just link the existing TC to the new TP tp_dest.add_case(tc_src, sortkey=tc_src.sortkey) return tp_dest
[docs] def tree_as_list(self): """ Returns the entire tree family as a list of TestPlan object with additional fields from tree_queries! """ plan = TestPlan.objects.with_tree_fields().get( tree_root = plan.ancestors(include_self=True).first() result = tree_root.descendants(include_self=True) return result
[docs] def tree_view_html(self): """ Returns nested tree structure represented as Patterfly TreeView! Relies on the fact that tree nodes are returned in DFS order! """ tree_nodes = self.tree_as_list() # TP is not part of a tree if len(tree_nodes) == 1: return "" result = "" previous_depth = -1 for test_plan in tree_nodes: # close tags for previously rendered node before rendering current one if test_plan.tree_depth == previous_depth: result += """ </div><!-- end-subtree --> </div> <!-- end-node -->""" # indent previous_depth = max(test_plan.tree_depth, previous_depth) # outdent did_outdent = False while test_plan.tree_depth < previous_depth: result += """ </div><!-- end-subtree --> </div> <!-- end-node -->""" previous_depth -= 1 did_outdent = True if did_outdent: result += """ </div><!-- end-subtree --> </div> <!-- end-node -->""" # render the current node active_class = "" if == active_class = "active" plan_name = bleach_input( result += f""" <!-- begin-node --> <div class="list-group-item {active_class}" style="border: none"> <div class="list-group-item-header kiwi-padding-0"> <div class="list-view-pf-main-info kiwi-padding-0"> <div class="list-view-pf-left" style="margin-left:3px; padding-right:10px"> <span class="fa fa-angle-right"></span> </div> <div class="list-view-pf-body"> <div class="list-view-pf-description"> <div class="list-group-item-text"> <a href="{test_plan.get_absolute_url()}"> TP-{}: {plan_name} </a> </div> </div> </div> </div> </div> <!-- /header --> <!-- begin-subtree --> <div class="list-group-item-container container-fluid" style="border: none"> """ # close after the last elements in the for loop while previous_depth >= 0: result += """ </div><!-- end-subtree --> </div> <!-- end-node -->""" previous_depth -= 1 # HTML sanity check begin_node = result.count("<!-- begin-node -->") end_node = result.count("<!-- end-node -->") begin_subtree = result.count("<!-- begin-subtree -->") end_subtree = result.count("<!-- end-subtree -->") # tese will make sure that we catch errors in production if begin_node != end_node: raise RuntimeError("Begin/End count for tree-view nodes don't match") if begin_subtree != end_subtree: raise RuntimeError("Begin/End count for tree-view subtrees don't match") return f""" <div id="test-plan-family-tree" class="list-group tree-list-view-pf kiwi-margin-top-0"> {result} </div> """
[docs] class TestPlanTag(models.Model): tag = models.ForeignKey("management.Tag", on_delete=models.CASCADE) plan = models.ForeignKey(TestPlan, on_delete=models.CASCADE)
[docs] class TestPlanEmailSettings(models.Model): plan = models.OneToOneField( TestPlan, related_name="email_settings", on_delete=models.CASCADE ) auto_to_plan_author = models.BooleanField(default=True) auto_to_case_owner = models.BooleanField(default=True) auto_to_case_default_tester = models.BooleanField(default=True) notify_on_plan_update = models.BooleanField(default=True) notify_on_case_update = models.BooleanField(default=True)