kiwitcms/Kiwi

View on GitHub
tcms/rpc/api/component.py

Summary

Maintainability
B
5 hrs
Test Coverage
# -*- coding: utf-8 -*-
 
from django.contrib.auth import get_user_model
from django.forms.models import model_to_dict
from modernrpc.core import REQUEST_KEY, rpc_method
 
from tcms.management.models import Component
from tcms.rpc.api.forms.management import ComponentForm, ComponentUpdateForm
from tcms.rpc.decorators import permissions_required
 
User = get_user_model() # pylint: disable=invalid-name
 
 
@permissions_required("management.view_component")
@rpc_method(name="Component.filter")
def filter(query): # pylint: disable=redefined-builtin
"""
.. function:: RPC Component.filter(query)
 
Search and return the resulting list of components.
 
:param query: Field lookups for :class:`tcms.management.models.Component`
:type query: dict
:return: List of serialized :class:`tcms.management.models.Component` objects
:rtype: list(dict)
"""
return list(
Component.objects.filter(**query)
.values(
"id",
"name",
"product",
"initial_owner",
"initial_qa_contact",
"description",
"cases",
)
.distinct()
)
 
 
@permissions_required("management.add_component")
@rpc_method(name="Component.create")
def create(values, **kwargs):
"""
.. function:: RPC Component.create(values)
 
Create new component.
 
:param values: Field values for :class:`tcms.management.models.Component`
:type values: dict
:param \\**kwargs: Dict providing access to the current request, protocol,
entry point name and handler instance from the rpc method
:return: Serialized :class:`tcms.management.models.Component` object
:rtype: dict
:raises ValueError: if data validation fails
:raises PermissionDenied: if missing *management.add_component* permission
 
.. note::
 
If ``initial_owner_id`` or ``initial_qa_owner_id`` are
not specified or don't exist in the database these fields are set to the
user issuing the RPC request!
"""
request = kwargs.get(REQUEST_KEY)
if "initial_owner" not in values:
values["initial_owner"] = request.user.pk
 
if "initial_qa_contact" not in values:
values["initial_qa_contact"] = request.user.pk
 
if "description" not in values:
values["description"] = "Created via API"
 
form = ComponentForm(values)
 
if form.is_valid():
component = form.save()
return model_to_dict(component)
 
raise ValueError(list(form.errors.items()))
 
 
Similar blocks of code found in 2 locations. Consider refactoring.
@permissions_required("management.change_component")
@rpc_method(name="Component.update")
def update(component_id, values):
"""
.. function:: RPC Component.update
 
Update component with new values.
 
:param component_id: PK of Component to be updated
:type component_id: int
:param values: Fields and values to be updated
:type values: dict
:return: Serialized :class:`tcms.management.models.Component` object
:rtype: dict
:raises ValueError: if data validation fails
:raises PermissionDenied: if missing *management.change_component* permission
"""
component = Component.objects.get(pk=component_id)
form = ComponentUpdateForm(values, instance=component)
 
if form.is_valid():
component = form.save()
return model_to_dict(component)
 
raise ValueError(list(form.errors.items()))