-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2183 from IFRCGo/feature/user-guest-permission
Create Guest User Permission with Public Content Access
- Loading branch information
Showing
23 changed files
with
314 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,7 +6,6 @@ exclude: | | |
| (?x)^( | ||
| \.git| | ||
| __pycache__| | ||
| .*snap_test_.*\.py| | ||
| .+\/.+\/migrations\/.*| | ||
| legacy| | ||
| \.venv | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Generated by Django 4.2.13 on 2024-07-30 07:53 | ||
|
|
||
| from django.db import migrations, models | ||
|
|
||
|
|
||
| class Migration(migrations.Migration): | ||
|
|
||
| dependencies = [ | ||
| ("api", "0211_alter_countrydirectory_unique_together_and_more"), | ||
| ] | ||
|
|
||
| operations = [ | ||
| migrations.AddField( | ||
| model_name="profile", | ||
| name="limit_access_to_guest", | ||
| field=models.BooleanField( | ||
| default=True, | ||
| help_text="If this value is set to true, the user is treated as a guest user regardless of any other permissions they may have, thereby depriving them of all non-guest user permissions.", | ||
| verbose_name="limit access to guest user permissions", | ||
| ), | ||
| ), | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,9 +10,162 @@ | |
| EventFeaturedDocumentFactory, | ||
| EventLinkFactory, | ||
| ) | ||
| from api.models import Profile | ||
| from deployments.factories.user import UserFactory | ||
| from main.test_case import APITestCase, SnapshotTestCase | ||
|
|
||
|
|
||
| class GuestUserPermissionTest(APITestCase): | ||
| def setUp(self): | ||
| # Create guest user | ||
| self.guest_user = User.objects.create(username="guest") | ||
| guest_profile = Profile.objects.get(user=self.guest_user) | ||
| guest_profile.limit_access_to_guest = True | ||
| guest_profile.save() | ||
|
|
||
| # Create go user | ||
| self.go_user = User.objects.create(username="go-user") | ||
| go_user_profile = Profile.objects.get(user=self.go_user) | ||
| go_user_profile.limit_access_to_guest = False | ||
| go_user_profile.save() | ||
|
|
||
| def test_guest_user_permission(self): | ||
| body = {} | ||
| guest_apis = [ | ||
| "/api/v2/add_subscription/", | ||
| "/api/v2/del_subscription/", | ||
| "/api/v2/external-token/", | ||
| "/api/v2/user/me/", | ||
| ] | ||
| id = 1 # NOTE: id is used just to test api that requires id, it doesnot indicate real id. It can be any number. | ||
| go_apis = [ | ||
| "/api/v2/dref/", | ||
| "/api/v2/dref-final-report/", | ||
| f"/api/v2/dref-final-report/{id}/publish/", | ||
| "/api/v2/dref-op-update/", | ||
| f"/api/v2/dref-op-update/{id}/publish/", | ||
| "/api/v2/dref-share/", | ||
| f"/api/v2/dref/{id}/publish/", | ||
| "/api/v2/flash-update/", | ||
| "/api/v2/flash-update-file/multiple/", | ||
| "/api/v2/local-units/", | ||
| f"/api/v2/local-units/{id}/validate/", | ||
| "/api/v2/pdf-export/", | ||
| "/api/v2/per-assessment/", | ||
| "/api/v2/per-document-upload/", | ||
| "/api/v2/per-file/multiple/", | ||
| "/api/v2/per-prioritization/", | ||
| "/api/v2/per-work-plan/", | ||
| "/api/v2/project/", | ||
| "/api/v2/dref-files/", | ||
| "/api/v2/dref-files/multiple/", | ||
| "/api/v2/field-report/", | ||
| "/api/v2/flash-update-file/", | ||
| "/api/v2/per-file/", | ||
| "/api/v2/share-flash-update/", | ||
| "/api/v2/add_cronjob_log/", | ||
| "/api/v2/profile/", | ||
| "/api/v2/subscription/", | ||
| "/api/v2/user/", | ||
| ] | ||
|
|
||
| get_apis = [ | ||
| "/api/v2/dref/", | ||
| "/api/v2/dref-files/", | ||
| "/api/v2/dref-final-report/", | ||
| f"/api/v2/dref-final-report/{id}/", | ||
| "/api/v2/dref-op-update/", | ||
| f"/api/v2/dref/{id}/", | ||
| "/api/v2/field-report/", | ||
| f"/api/v2/field-report/{id}/", | ||
| "/api/v2/flash-update/", | ||
| "/api/v2/flash-update-file/", | ||
| f"/api/v2/flash-update/{id}/", | ||
| "/api/v2/language/", | ||
| f"/api/v2/language/{id}/", | ||
| "/api/v2/local-units/", | ||
| f"/api/v2/local-units/{id}/", | ||
| "/api/v2/ops-learning/", | ||
| f"/api/v2/ops-learning/{id}/", | ||
| f"/api/v2/pdf-export/{id}/", | ||
| "/api/v2/per-assessment/", | ||
| f"/api/v2/per-assessment/{id}/", | ||
| "/api/v2/per-document-upload/", | ||
| f"/api/v2/per-document-upload/{id}/", | ||
| "/api/v2/per-file/", | ||
| "/api/v2/per-overview/", | ||
| f"/api/v2/per-overview/{id}/", | ||
| "/api/v2/per-prioritization/", | ||
| f"/api/v2/per-prioritization/{id}/", | ||
| "/api/v2/per-work-plan/", | ||
| f"/api/v2/per-work-plan/{id}/", | ||
| "/api/v2/profile/", | ||
| f"/api/v2/profile/{id}/", | ||
| f"/api/v2/share-flash-update/{id}/", | ||
| "/api/v2/subscription/", | ||
| f"/api/v2/subscription/{id}/", | ||
| "/api/v2/users/", | ||
| f"/api/v2/users/{id}/", | ||
| # Exports | ||
| f"/api/v2/export-flash-update/{1}/", | ||
| ] | ||
|
|
||
| # NOTE: With custom Content Negotiation: Look for main.utils.SpreadSheetContentNegotiation | ||
| get_custom_negotiation_apis = [ | ||
| f"/api/v2/export-per/{1}/", | ||
| ] | ||
|
|
||
| go_apis_req_additional_perm = [ | ||
| "/api/v2/ops-learning/", | ||
| "/api/v2/per-overview/", | ||
| f"/api/v2/user/{id}/accepted_license_terms/", | ||
| f"/api/v2/language/{id}/bulk-action/", | ||
| ] | ||
|
|
||
| self.authenticate(user=self.guest_user) | ||
|
|
||
| def _success_check(response): # NOTE: Only handles json responses | ||
| self.assertNotIn(response.status_code, [401, 403], response.content) | ||
| self.assertNotIn(response.json().get("error_code"), [401, 403], response.content) | ||
|
|
||
| def _failure_check(response, is_json=True): | ||
| self.assertIn(response.status_code, [401, 403], response.content) | ||
| if is_json: | ||
| self.assertIn(response.json()["error_code"], [401, 403], response.content) | ||
|
|
||
| for api_url in get_custom_negotiation_apis: | ||
| headers = { | ||
| "Accept": "text/html", | ||
| } | ||
| response = self.client.get(api_url, headers=headers, stream=True) | ||
| _failure_check(response, is_json=False) | ||
|
|
||
| # Guest user should not be able to access get apis that requires IsAuthenticated permission | ||
| for api_url in get_apis: | ||
| response = self.client.get(api_url) | ||
| _failure_check(response) | ||
|
|
||
| # Guest user should not be able to hit post apis. | ||
| for api_url in go_apis + go_apis_req_additional_perm: | ||
| response = self.client.post(api_url, json=body) | ||
| _failure_check(response) | ||
|
|
||
| # Guest user should be able to access guest apis | ||
| for api_url in guest_apis: | ||
| response = self.client.post(api_url, json=body) | ||
| _success_check(response) | ||
|
|
||
| # Go user should be able to access go_apis | ||
| self.authenticate(user=self.go_user) | ||
| for api_url in go_apis: | ||
| response = self.client.post(api_url, json=body) | ||
| _success_check(response) | ||
|
|
||
| for api_url in get_apis: | ||
| response = self.client.get(api_url) | ||
| _success_check(response) | ||
|
|
||
|
|
||
| class AuthTokenTest(APITestCase): | ||
| def setUp(self): | ||
| user = User.objects.create(username="jo") | ||
|
|
@@ -78,7 +231,7 @@ class FieldReportTest(APITestCase): | |
| fixtures = ["DisasterTypes", "Actions"] | ||
|
|
||
| def test_create_and_update(self): | ||
| user = User.objects.create(username="jo") | ||
| user = UserFactory(username="jo") | ||
| region = models.Region.objects.create(name=1) | ||
| country1 = models.Country.objects.create(name="abc", region=region) | ||
| country2 = models.Country.objects.create(name="xyz") | ||
|
|
@@ -204,21 +357,24 @@ def test_country_snippet_visibility(self): | |
| self.assertEqual(response["count"], 0) | ||
|
|
||
| # perform the request with an authenticated user | ||
| user = User.objects.create(username="foo") | ||
| user = UserFactory(username="foo") | ||
| self.client.force_authenticate(user=user) | ||
| response = self.client.get("/api/v2/country_snippet/").json() | ||
| # one snippets available to anonymous user | ||
| self.assertEqual(response["count"], 1) | ||
|
|
||
| # perform the request with an ifrc user | ||
| user2 = User.objects.create(username="bar") | ||
| user2 = UserFactory(username="bar") | ||
| user2.user_permissions.add(self.ifrc_permission) | ||
| self.client.force_authenticate(user=user2) | ||
| response = self.client.get("/api/v2/country_snippet/").json() | ||
| self.assertEqual(response["count"], 2) | ||
|
|
||
| # perform the request with a superuser | ||
| super_user = User.objects.create_superuser(username="baz", email="[email protected]", password="12345678") | ||
| super_user = UserFactory(username="baz", email="[email protected]", password="12345678") | ||
| super_user.is_superuser = True | ||
| super_user.save() | ||
|
|
||
| self.client.force_authenticate(user=super_user) | ||
| response = self.client.get("/api/v2/country_snippet/").json() | ||
| self.assertEqual(response["count"], 2) | ||
|
|
||
Oops, something went wrong.