Skip to content

Implement update team endpoint (TS-2314) #1116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions django/thunderstore/api/cyberstorm/serializers/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
CyberstormTeamAddMemberResponseSerializer,
CyberstormTeamMemberSerializer,
CyberstormTeamSerializer,
CyberstormTeamUpdateSerializer,
)

__all__ = [
Expand All @@ -25,4 +26,5 @@
"CyberstormTeamMemberSerializer",
"CyberstormTeamSerializer",
"PackagePermissionsSerializer",
"CyberstormTeamUpdateSerializer",
]
9 changes: 7 additions & 2 deletions django/thunderstore/api/cyberstorm/serializers/team.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
from typing import Optional

from django.core.validators import URLValidator
from rest_framework import serializers
from rest_framework.exceptions import ValidationError

from thunderstore.repository.forms import AddTeamMemberForm
from thunderstore.repository.models import Namespace, Team
from thunderstore.repository.validators import PackageReferenceComponentValidator
from thunderstore.social.utils import get_user_avatar_url

Expand Down Expand Up @@ -53,3 +52,9 @@ class CyberstormCreateTeamSerializer(serializers.Serializer):
name = serializers.CharField(
max_length=64, validators=[PackageReferenceComponentValidator("Author name")]
)


class CyberstormTeamUpdateSerializer(serializers.Serializer):
donation_link = serializers.CharField(
max_length=1024, validators=[URLValidator(["https"])]
)
11 changes: 11 additions & 0 deletions django/thunderstore/api/cyberstorm/services/team.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,14 @@ def create_team(user: UserType, team_name: str) -> Team:
team = Team.objects.create(name=team_name)
team.add_member(user=user, role=TeamMemberRole.owner)
return team


@transaction.atomic
def update_team(agent: UserType, team: Team, donation_link: str) -> Team:
team.ensure_user_can_access(agent)
team.ensure_user_can_edit_info(agent)

team.donation_link = donation_link
team.save()

return team
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from django.http import Http404

from thunderstore.api.cyberstorm.services import team as team_services
from thunderstore.core.exceptions import PermissionValidationError
from thunderstore.repository.models import Namespace, Team, TeamMemberRole


Expand Down Expand Up @@ -67,3 +68,38 @@ def test_create_team_success(user):
assert Team.objects.filter(name=team_name).exists()
assert team.name == team_name
assert team.members.filter(user=user, role=TeamMemberRole.owner).exists()


@pytest.mark.django_db
def test_update_team_success(team_owner):
team = team_owner.team
new_donation_link = "https://example.com/donate"
updated_team = team_services.update_team(
agent=team_owner.user, team=team, donation_link=new_donation_link
)

assert updated_team.donation_link == new_donation_link


@pytest.mark.django_db
def test_update_team_user_cannot_access(user, team):
new_donation_link = "https://example.com/donate"

error_msg = "Must be a member to access team"
with pytest.raises(PermissionValidationError, match=error_msg):
team_services.update_team(
agent=user, team=team, donation_link=new_donation_link
)


@pytest.mark.django_db
def test_update_team_user_cannot_edit_info(team_member):
new_donation_link = "https://example.com/donate"

error_msg = "Must be an owner to edit team info"
with pytest.raises(PermissionValidationError, match=error_msg):
team_services.update_team(
agent=team_member.user,
team=team_member.team,
donation_link=new_donation_link,
)
134 changes: 134 additions & 0 deletions django/thunderstore/api/cyberstorm/tests/test_team.py
Original file line number Diff line number Diff line change
Expand Up @@ -322,3 +322,137 @@ def test_team_member_add_api_view__when_adding_a_member__fails_because_user_is_n
.count()
== 0
)


@pytest.mark.django_db
def test_team_update_succeeds(
api_client: APIClient,
user: UserType,
team: Team,
):
TeamMemberFactory(team=team, user=user, role="owner")
api_client.force_authenticate(user)

new_donation_link = "https://example.com"

response = api_client.patch(
f"/api/cyberstorm/team/{team.name}/update/",
json.dumps({"donation_link": new_donation_link}),
content_type="application/json",
)

expected_response = {"donation_link": new_donation_link}
assert response.status_code == 200

assert response.json() == expected_response
assert Team.objects.get(pk=team.pk).donation_link == new_donation_link


@pytest.mark.django_db
def test_team_update_fails_user_not_authenticated(
api_client: APIClient,
team: Team,
):
new_donation_link = "https://example.com"

response = api_client.patch(
f"/api/cyberstorm/team/{team.name}/update/",
json.dumps({"donation_link": new_donation_link}),
content_type="application/json",
)

expected_response = {"detail": "Authentication credentials were not provided."}

assert response.status_code == 401
assert response.json() == expected_response
assert Team.objects.get(pk=team.pk).donation_link is None


@pytest.mark.django_db
def test_team_update_fails_validation(
api_client: APIClient,
user: UserType,
team: Team,
):
TeamMemberFactory(team=team, user=user, role="owner")
api_client.force_authenticate(user)

new_bad_donation_link = "example.com"

response = api_client.patch(
f"/api/cyberstorm/team/{team.name}/update/",
json.dumps({"donation_link": new_bad_donation_link}),
content_type="application/json",
)

expected_response = {"donation_link": ["Enter a valid URL."]}

assert response.status_code == 400
assert response.json() == expected_response


@pytest.mark.django_db
def test_team_update_fail_user_not_owner(
api_client: APIClient,
user: UserType,
team: Team,
):
TeamMemberFactory(team=team, user=user, role="member")
api_client.force_authenticate(user)

new_donation_link = "https://example.com"

response = api_client.patch(
f"/api/cyberstorm/team/{team.name}/update/",
json.dumps({"donation_link": new_donation_link}),
content_type="application/json",
)

expected_response = {"non_field_errors": ["Must be an owner to edit team info"]}

assert response.status_code == 403
assert response.json() == expected_response
assert Team.objects.get(pk=team.pk).donation_link is None


@pytest.mark.django_db
def test_team_update_fail_team_does_not_exist(
api_client: APIClient,
user: UserType,
):
api_client.force_authenticate(user)

new_donation_link = "https://example.com"

response = api_client.patch(
"/api/cyberstorm/team/FakeTeam/update/",
json.dumps({"donation_link": new_donation_link}),
content_type="application/json",
)

expected_response = {"detail": "Not found."}

assert response.status_code == 404
assert response.json() == expected_response


@pytest.mark.django_db
def test_team_update_fail_user_not_team_member(
api_client: APIClient,
user: UserType,
team: Team,
):
api_client.force_authenticate(user)

new_donation_link = "https://example.com"

response = api_client.patch(
f"/api/cyberstorm/team/{team.name}/update/",
json.dumps({"donation_link": new_donation_link}),
content_type="application/json",
)

expected_response = {"non_field_errors": ["Must be a member to access team"]}

assert response.status_code == 403
assert response.json() == expected_response
2 changes: 2 additions & 0 deletions django/thunderstore/api/cyberstorm/views/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
TeamMemberAddAPIView,
TeamMemberListAPIView,
TeamServiceAccountListAPIView,
UpdateTeamAPIView,
)

__all__ = [
Expand All @@ -49,4 +50,5 @@
"UpdatePackageListingCategoriesAPIView",
"RejectPackageListingAPIView",
"ApprovePackageListingAPIView",
"UpdateTeamAPIView",
]
39 changes: 35 additions & 4 deletions django/thunderstore/api/cyberstorm/views/team.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
from django.core.exceptions import ValidationError as DjangoValidationError
from django.db.models import Q, QuerySet
from rest_framework import status
from rest_framework.exceptions import PermissionDenied, ValidationError
Expand All @@ -16,8 +15,13 @@
CyberstormTeamAddMemberResponseSerializer,
CyberstormTeamMemberSerializer,
CyberstormTeamSerializer,
CyberstormTeamUpdateSerializer,
)
from thunderstore.api.cyberstorm.services.team import (
create_team,
disband_team,
update_team,
)
from thunderstore.api.cyberstorm.services import team as team_services
from thunderstore.api.ordering import StrictOrderingFilter
from thunderstore.api.utils import (
CyberstormAutoSchemaMixin,
Expand Down Expand Up @@ -66,7 +70,7 @@ def post(self, request, *args, **kwargs):
serializer = CyberstormCreateTeamSerializer(data=request.data)
serializer.is_valid(raise_exception=True)
team_name = serializer.validated_data["name"]
team = team_services.create_team(user=request.user, team_name=team_name)
team = create_team(user=request.user, team_name=team_name)
return_data = CyberstormTeamSerializer(team).data
return Response(return_data, status=status.HTTP_201_CREATED)

Expand Down Expand Up @@ -135,5 +139,32 @@ class DisbandTeamAPIView(APIView):
)
def delete(self, request, *args, **kwargs):
team_name = kwargs["team_name"]
team_services.disband_team(user=request.user, team_name=team_name)
disband_team(user=request.user, team_name=team_name)
return Response(status=status.HTTP_204_NO_CONTENT)


class UpdateTeamAPIView(APIView):
permission_classes = [IsAuthenticated]
serializer_class = CyberstormTeamUpdateSerializer
http_method_names = ["patch"]

@conditional_swagger_auto_schema(
operation_id="cyberstorm.team.update",
tags=["cyberstorm"],
request_body=CyberstormTeamUpdateSerializer,
responses={status.HTTP_200_OK: serializer_class},
)
def patch(self, request, team_name, *args, **kwargs):
team = get_object_or_404(Team.objects.exclude(is_active=False), name=team_name)

serializer = self.serializer_class(data=request.data)
serializer.is_valid(raise_exception=True)

updated_team = update_team(
agent=request.user,
team=team,
donation_link=serializer.validated_data["donation_link"],
)

return_data = self.serializer_class(instance=updated_team).data
return Response(return_data, status=status.HTTP_200_OK)
6 changes: 6 additions & 0 deletions django/thunderstore/api/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
TeamMemberListAPIView,
TeamServiceAccountListAPIView,
UpdatePackageListingCategoriesAPIView,
UpdateTeamAPIView,
)

cyberstorm_urls = [
Expand Down Expand Up @@ -126,6 +127,11 @@
TeamAPIView.as_view(),
name="cyberstorm.team",
),
path(
"team/<str:team_name>/update/",
UpdateTeamAPIView.as_view(),
name="cyberstorm.team.update",
),
path(
"team/<str:team_name>/disband/",
DisbandTeamAPIView.as_view(),
Expand Down
17 changes: 14 additions & 3 deletions django/thunderstore/repository/forms/team.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
from django.contrib.auth import get_user_model
from django.core.exceptions import ObjectDoesNotExist, ValidationError

from thunderstore.api.cyberstorm.services.team import update_team
from thunderstore.core.exceptions import PermissionValidationError
from thunderstore.core.types import UserType
from thunderstore.repository.models import (
Expand Down Expand Up @@ -183,10 +184,20 @@
def clean(self):
if not self.instance.pk:
raise ValidationError("Missing team instance")
self.instance.ensure_user_can_edit_info(self.user)
return super().clean()

@transaction.atomic
def save(self, **kwargs):
self.instance.ensure_user_can_edit_info(self.user)
return super().save(**kwargs)
if self.errors:
raise ValidationError(self.errors)

Check warning on line 192 in django/thunderstore/repository/forms/team.py

View check run for this annotation

Codecov / codecov/patch

django/thunderstore/repository/forms/team.py#L192

Added line #L192 was not covered by tests

try:
update_team(
agent=self.user,
team=self.instance,
donation_link=self.cleaned_data["donation_link"],
)
except ValidationError as e:
self.add_error(None, e)

return self.instance
4 changes: 4 additions & 0 deletions django/thunderstore/repository/tests/test_team_forms.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from typing import Optional

import pytest
from django.core.exceptions import ValidationError

from conftest import TestUserTypes
from thunderstore.core.factories import UserFactory
Expand Down Expand Up @@ -552,8 +553,11 @@ def test_form_donation_link_team_form_permissions(
team.refresh_from_db()
assert team.donation_link == link
else:
form.save()
assert form.is_valid() is False
assert form.errors
team.refresh_from_db()
assert team.donation_link is None


@pytest.mark.django_db
Expand Down
Loading
Loading