# -*- coding: utf-8 -*-
from django.contrib.auth import get_user_model
from django.contrib.auth.decorators import permission_required
from django.core.exceptions import ObjectDoesNotExist
from django.http import HttpResponseRedirect
from django.shortcuts import get_object_or_404, render
from django.urls import reverse
from django.utils.decorators import method_decorator
from django.utils.translation import gettext_lazy as _
from django.views.generic import DetailView
from django.views.generic.base import TemplateView, View
from django.views.generic.edit import UpdateView
from guardian.decorators import permission_required as object_permission_required
from tcms.core.contrib.linkreference.forms import LinkReferenceForm
from tcms.core.forms import SimpleCommentForm
from tcms.testcases.models import BugSystem, TestCase, TestCasePlan, TestCaseStatus
from tcms.testplans.models import TestPlan
from tcms.testruns.forms import NewRunForm, SearchRunForm
from tcms.testruns.models import (
Environment,
EnvironmentProperty,
TestExecutionStatus,
TestRun,
)
User = get_user_model() # pylint: disable=invalid-name
[docs]
@method_decorator(permission_required("testruns.add_testrun"), name="dispatch")
class NewTestRunView(View):
"""Display new test run page."""
template_name = "testruns/mutable.html"
http_method_names = ["post", "get"]
[docs]
def get(self, request, form_initial=None, is_cloning=False):
plan_id = request.GET.get("p")
# note: ordered by pk for test_show_create_new_run_page()
test_cases = (
TestCase.objects.filter(pk__in=request.GET.getlist("c"))
.select_related("author", "case_status", "category", "priority")
.order_by("pk")
)
test_plan = TestPlan.objects.filter(pk=plan_id).first()
if not form_initial:
form_initial = {
"summary": f"Test run for {test_plan.name}" if test_plan else "",
"manager": test_plan.author.email if test_plan else "",
"default_tester": request.user.email,
"notes": "",
"plan": plan_id,
}
form = NewRunForm(initial=form_initial)
form.populate(plan_id)
context_data = {
"plan_id": plan_id, # used for UI conditionals
"test_cases": test_cases,
"form": form,
"disabled_cases": get_disabled_test_cases_count(test_cases),
"is_cloning": is_cloning,
}
return render(request, self.template_name, context_data)
[docs]
def post(self, request):
form = NewRunForm(data=request.POST)
form.populate(request.POST.get("plan"))
if form.is_valid():
test_run = form.save()
# copy all of the selected properties into the test run
for prop in EnvironmentProperty.objects.filter(
environment__in=form.cleaned_data["environment"]
):
test_run.property_set.create(name=prop.name, value=prop.value)
loop = 1
for case in form.cleaned_data["case"]:
try:
tcp = TestCasePlan.objects.get(
plan=form.cleaned_data["plan"], case=case
)
sortkey = tcp.sortkey
except ObjectDoesNotExist:
sortkey = loop * 10
test_run.create_execution(
case=case,
assignee=form.cleaned_data["default_tester"],
sortkey=sortkey,
matrix_type=form.cleaned_data["matrix_type"],
)
loop += 1
return HttpResponseRedirect(
reverse(
"testruns-get",
args=[
test_run.pk,
],
)
)
test_cases = (
TestCase.objects.filter(pk__in=request.POST.getlist("case"))
.select_related("author", "case_status", "category", "priority")
.order_by("pk")
)
context_data = {
"plan_id": request.POST.get("plan"),
"test_cases": test_cases,
"form": form,
"disabled_cases": get_disabled_test_cases_count(test_cases),
}
return render(request, self.template_name, context_data)
[docs]
@method_decorator(permission_required("testruns.add_testrun"), name="dispatch")
class NewFromPlan(NewTestRunView):
"""
Handles the permalink /runs/from-plan/123/
"""
# note: post is handled directly by NewTestRunView
# b/c <form action> points to testruns-new URL
http_method_names = ["get"]
[docs]
def get(self, request, plan_id): # pylint: disable=arguments-differ
test_plan = get_object_or_404(TestPlan, pk=plan_id)
request.GET._mutable = True # pylint: disable=protected-access
request.GET["p"] = test_plan.pk
# if cases aren't selected, e.g. user entered the URL directly in the browser
# then preselect all confirmed test cases
if not request.GET.getlist("c"):
request.GET.setlist(
"c",
test_plan.cases.filter(case_status__is_confirmed=True).values_list(
"pk", flat=True
),
)
return super().get(request)
[docs]
@method_decorator(permission_required("testruns.view_testrun"), name="dispatch")
class SearchTestRunView(TemplateView):
template_name = "testruns/search.html"
[docs]
def get_context_data(self, **kwargs):
form = SearchRunForm(self.request.GET)
form.populate(product_id=self.request.GET.get("product", -1))
return {
"form": form,
}
[docs]
@method_decorator(
object_permission_required(
"testruns.view_testrun", (TestRun, "pk", "pk"), accept_global_perms=True
),
name="dispatch",
)
class GetTestRunView(DetailView):
template_name = "testruns/get.html"
http_method_names = ["get"]
model = TestRun
[docs]
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context["execution_statuses"] = TestExecutionStatus.objects.order_by(
"-weight", "name"
)
context["confirmed_statuses"] = TestCaseStatus.objects.filter(is_confirmed=True)
context["link_form"] = LinkReferenceForm()
context["bug_trackers"] = BugSystem.objects.all()
context["comment_form"] = SimpleCommentForm()
context["OBJECT_MENU_ITEMS"] = [
(
"...",
[
(
_("Edit"),
reverse("testruns-edit", args=[self.object.pk]),
),
(
_("Clone"),
reverse("testruns-clone", args=[self.object.pk]),
),
(
_("History"),
f"/admin/testruns/testrun/{self.object.pk}/history/",
),
("-", "-"),
(
_("Object permissions"),
reverse(
"admin:testruns_testrun_permissions",
args=[self.object.pk],
),
),
("-", "-"),
(
_("Delete"),
reverse(
"admin:testruns_testrun_delete",
args=[self.object.pk],
),
),
],
)
]
return context
[docs]
@method_decorator(
object_permission_required(
"testruns.change_testrun", (TestRun, "pk", "pk"), accept_global_perms=True
),
name="dispatch",
)
class EditTestRunView(UpdateView):
model = TestRun
template_name = "testruns/mutable.html"
form_class = NewRunForm
[docs]
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context["plan_id"] = self.object.plan
return context
[docs]
def get_initial(self):
return {
"manager": self.object.manager,
"default_tester": self.object.default_tester,
}
[docs]
@method_decorator(permission_required("testruns.add_testrun"), name="dispatch")
class CloneTestRunView(NewTestRunView):
# note: post is handled directly by NewTestRunView
# b/c <form action> points to testruns-new URL
http_method_names = ["get"]
[docs]
def get(self, request, pk): # pylint: disable=arguments-differ
test_run = get_object_or_404(TestRun, pk=pk)
request.GET._mutable = True # pylint: disable=protected-access
request.GET["p"] = test_run.plan_id
request.GET.setlist(
"c", test_run.executions.all().values_list("case", flat=True)
)
form_initial = {
"summary": _("Clone of ") + test_run.summary,
"notes": test_run.notes,
"manager": test_run.manager,
"build": test_run.build_id,
"default_tester": test_run.default_tester,
"plan": test_run.plan_id,
"planned_start": test_run.planned_start,
"planned_stop": test_run.planned_stop,
}
return super().get(request, form_initial=form_initial, is_cloning=True)
[docs]
def get_disabled_test_cases_count(test_cases):
return test_cases.filter(case_status__is_confirmed=False).count()
[docs]
@method_decorator(
object_permission_required(
"testruns.view_environment", (Environment, "pk", "pk"), accept_global_perms=True
),
name="dispatch",
)
class GetEnvironment(DetailView):
template_name = "testruns/environment.html"
http_method_names = ["get"]
model = Environment
[docs]
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context["OBJECT_MENU_ITEMS"] = [
(
"...",
[
(
_("Edit"),
reverse(
"admin:testruns_environment_change",
args=[self.object.pk],
),
),
("-", "-"),
(
_("Object permissions"),
reverse(
"admin:testruns_environment_permissions",
args=[self.object.pk],
),
),
("-", "-"),
(
_("Delete"),
reverse(
"admin:testruns_environment_delete",
args=[self.object.pk],
),
),
],
)
]
return context